vendor/pimcore/pimcore/models/DataObject/ClassDefinition/Data.php line 294

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Model\DataObject\ClassDefinition;
  18. use Pimcore\Db\Helper;
  19. use Pimcore\Model;
  20. use Pimcore\Model\DataObject;
  21. use Pimcore\Model\DataObject\Exception\InheritanceParentNotFoundException;
  23. abstract class Data implements DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface
  24. {
  25.     use DataObject\ClassDefinition\Helper\VarExport;
  27.     /**
  28.      * @var string|null
  29.      */
  30.     public $name;
  32.     /**
  33.      * @var string|null
  34.      */
  35.     public $title;
  37.     /**
  38.      * @var string|null
  39.      */
  40.     public $tooltip;
  42.     /**
  43.      * @var bool
  44.      */
  45.     public $mandatory;
  47.     /**
  48.      * @var bool
  49.      */
  50.     public $noteditable;
  52.     /**
  53.      * @var int|null
  54.      */
  55.     public $index;
  57.     /**
  58.      * @var bool
  59.      */
  60.     public $locked = false;
  62.     /**
  63.      * @var string
  64.      */
  65.     public $style;
  67.     /**
  68.      * @var array
  69.      */
  70.     public $permissions;
  72.     /**
  73.      * @var string
  74.      */
  75.     public $datatype = 'data';
  77.     /**
  78.      * @var string
  79.      */
  80.     public $fieldtype;
  82.     /**
  83.      * @var bool
  84.      */
  85.     public $relationType = false;
  87.     /**
  88.      * @var bool
  89.      */
  90.     public $invisible = false;
  92.     /**
  93.      * @var bool
  94.      */
  95.     public $visibleGridView = true;
  97.     /**
  98.      * @var bool
  99.      */
  100.     public $visibleSearch = true;
  102.     /**
  103.      * @var array
  104.      */
  105.     public static $validFilterOperators = [
  106.         'LIKE',
  107.         'NOT LIKE',
  108.         '=',
  109.         'IS',
  110.         'IS NOT',
  111.         '!=',
  112.         '<',
  113.         '>',
  114.         '>=',
  115.         '<=',
  116.     ];
  118.     /**
  119.      * @var array
  120.      */
  121.     protected const FORBIDDEN_NAMES = [
  122.         'id', 'key', 'path', 'type', 'index', 'classname', 'creationdate', 'userowner', 'value', 'class', 'list',
  123.         'fullpath', 'childs', 'children', 'values', 'cachetag', 'cachetags', 'parent', 'published', 'valuefromparent',
  124.         'userpermissions', 'dependencies', 'modificationdate', 'usermodification', 'byid', 'bypath', 'data',
  125.         'versions', 'properties', 'permissions', 'permissionsforuser', 'childamount', 'apipluginbroker', 'resource',
  126.         'parentClass', 'definition', 'locked', 'language', 'omitmandatorycheck', 'idpath', 'object', 'fieldname',
  127.         'property', 'parentid', 'children', 'scheduledtasks', 'latestVersion',
  128.     ];
  130.     /**
  131.      * Returns the data for the editmode
  132.      *
  133.      * @param mixed $data
  134.      * @param null|DataObject\AbstractObject $object
  135.      * @param mixed $params
  136.      *
  137.      * @return mixed
  138.      */
  139.     abstract public function getDataForEditmode($data, $object = null, $params = []);
  141.     /**
  142.      * Converts data from editmode to internal eg. Image-Id to Asset\Image object
  143.      *
  144.      * @param mixed $data
  145.      * @param null|DataObject\AbstractObject $object
  146.      * @param mixed $params
  147.      *
  148.      * @return mixed
  149.      */
  150.     abstract public function getDataFromEditmode($data, $object = null, $params = []);
  152.     /**
  153.      * Checks if data is valid for current data field
  154.      *
  155.      * @param mixed $data
  156.      * @param bool $omitMandatoryCheck
  157.      * @param array $params
  158.      *
  159.      * @throws \Exception
  160.      */
  161.     public function checkValidity($data, $omitMandatoryCheck = false, $params = [])
  162.     {
  163.         $isEmpty = true;
  165.         // this is to do not treated "0" as empty
  166.         if (is_string($data) || is_numeric($data)) {
  167.             if (strlen($data) > 0) {
  168.                 $isEmpty = false;
  169.             }
  170.         }
  172.         if (!empty($data)) {
  173.             $isEmpty = false;
  174.         }
  176.         if (!$omitMandatoryCheck && $this->getMandatory() && $isEmpty) {
  177.             throw new Model\Element\ValidationException('Empty mandatory field [ ' . $this->getName() . ' ]');
  178.         }
  179.     }
  181.     /**
  182.      * converts object data to a simple string value or CSV Export
  183.      *
  184.      * @internal
  185.      *
  186.      * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  187.      * @param array $params
  188.      *
  189.      * @return string
  190.      */
  191.     public function getForCsvExport($object, $params = [])
  192.     {
  193.         return $this->getDataFromObjectParam($object, $params);
  194.     }
  196.     /**
  197.      * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  198.      * @param mixed $params
  199.      *
  200.      * @return string
  201.      */
  202.     public function getDataForSearchIndex($object, $params = [])
  203.     {
  204.         // this is the default, but csv doesn't work for all data types
  205.         return $this->getForCsvExport($object, $params);
  206.     }
  208.     /**
  209.      * @return string|null
  210.      */
  211.     public function getName()
  212.     {
  213.         return $this->name;
  214.     }
  216.     /**
  217.      * @return string
  218.      */
  219.     public function getTitle()
  220.     {
  221.         return $this->title ?? '';
  222.     }
  224.     /**
  225.      * @return bool
  226.      */
  227.     public function getMandatory()
  228.     {
  229.         return $this->mandatory;
  230.     }
  232.     /**
  233.      * @return array
  234.      */
  235.     public function getPermissions()
  236.     {
  237.         return $this->permissions;
  238.     }
  240.     /**
  241.      * @param string $name
  242.      *
  243.      * @return $this
  244.      */
  245.     public function setName($name)
  246.     {
  247.         $this->name = $name;
  249.         return $this;
  250.     }
  252.     /**
  253.      * @param string $title
  254.      *
  255.      * @return $this
  256.      */
  257.     public function setTitle($title)
  258.     {
  259.         $this->title = $title;
  261.         return $this;
  262.     }
  264.     /**
  265.      * @param bool $mandatory
  266.      *
  267.      * @return $this
  268.      */
  269.     public function setMandatory($mandatory)
  270.     {
  271.         $this->mandatory = (bool)$mandatory;
  273.         return $this;
  274.     }
  276.     /**
  277.      * @param array $permissions
  278.      *
  279.      * @return $this
  280.      */
  281.     public function setPermissions($permissions)
  282.     {
  283.         $this->permissions = $permissions;
  285.         return $this;
  286.     }
  288.     /**
  289.      * @param array $data
  290.      * @param array $blockedKeys
  291.      *
  292.      * @return $this
  293.      */
  294.     public function setValues($data = [], $blockedKeys = [])
  295.     {
  296.         foreach ($data as $key => $value) {
  297.             if (!in_array($key, $blockedKeys)) {
  298.                 $method = 'set' . $key;
  299.                 if (method_exists($this, $method)) {
  300.                     $this->$method($value);
  301.                 }
  302.             }
  303.         }
  305.         return $this;
  306.     }
  308.     /**
  309.      * @return string
  310.      */
  311.     public function getDatatype()
  312.     {
  313.         return $this->datatype;
  314.     }
  316.     /**
  317.      * @param string $datatype
  318.      *
  319.      * @return $this
  320.      */
  321.     public function setDatatype($datatype)
  322.     {
  323.         $this->datatype = $datatype;
  325.         return $this;
  326.     }
  328.     /**
  329.      * @return string
  330.      */
  331.     public function getFieldtype()
  332.     {
  333.         return $this->fieldtype;
  334.     }
  336.     /**
  337.      * @return bool
  338.      */
  339.     public function getNoteditable()
  340.     {
  341.         return $this->noteditable;
  342.     }
  344.     /**
  345.      * @param bool $noteditable
  346.      *
  347.      * @return $this
  348.      */
  349.     public function setNoteditable($noteditable)
  350.     {
  351.         $this->noteditable = (bool)$noteditable;
  353.         return $this;
  354.     }
  356.     /**
  357.      * @return int|null
  358.      */
  359.     public function getIndex()
  360.     {
  361.         return $this->index;
  362.     }
  364.     /**
  365.      * @param int|null $index
  366.      *
  367.      * @return $this
  368.      */
  369.     public function setIndex($index)
  370.     {
  371.         $this->index = $index;
  373.         return $this;
  374.     }
  376.     /**
  377.      *
  378.      * @return string
  379.      */
  380.     public function getStyle()
  381.     {
  382.         return $this->style;
  383.     }
  385.     /**
  386.      * @param string|null $style
  387.      *
  388.      * @return $this
  389.      */
  390.     public function setStyle($style)
  391.     {
  392.         $this->style = (string)$style;
  394.         return $this;
  395.     }
  397.     /**
  398.      *
  399.      * @return bool
  400.      */
  401.     public function getLocked()
  402.     {
  403.         return $this->locked;
  404.     }
  406.     /**
  407.      * @param bool $locked
  408.      *
  409.      * @return $this
  410.      */
  411.     public function setLocked($locked)
  412.     {
  413.         $this->locked = (bool)$locked;
  415.         return $this;
  416.     }
  418.     /**
  419.      *
  420.      * @return string|null
  421.      */
  422.     public function getTooltip()
  423.     {
  424.         return $this->tooltip;
  425.     }
  427.     /**
  428.      * @param string|null $tooltip
  429.      *
  430.      * @return $this
  431.      */
  432.     public function setTooltip($tooltip)
  433.     {
  434.         $this->tooltip = (string)$tooltip;
  436.         return $this;
  437.     }
  439.     /**
  440.      *
  441.      * @return bool
  442.      */
  443.     public function isRelationType()
  444.     {
  445.         return $this->relationType;
  446.     }
  448.     /**
  449.      * @return bool
  450.      */
  451.     public function getInvisible()
  452.     {
  453.         return $this->invisible;
  454.     }
  456.     /**
  457.      * @param bool|int|null $invisible
  458.      *
  459.      * @return $this
  460.      */
  461.     public function setInvisible($invisible)
  462.     {
  463.         $this->invisible = (bool)$invisible;
  465.         return $this;
  466.     }
  468.     /**
  469.      * @return bool
  470.      */
  471.     public function getVisibleGridView()
  472.     {
  473.         return $this->visibleGridView;
  474.     }
  476.     /**
  477.      * @param bool|int|null $visibleGridView
  478.      *
  479.      * @return $this
  480.      */
  481.     public function setVisibleGridView($visibleGridView)
  482.     {
  483.         $this->visibleGridView = (bool)$visibleGridView;
  485.         return $this;
  486.     }
  488.     /**
  489.      * @return bool
  490.      */
  491.     public function getVisibleSearch()
  492.     {
  493.         return $this->visibleSearch;
  494.     }
  496.     /**
  497.      * @param bool|int|null $visibleSearch
  498.      *
  499.      * @return $this
  500.      */
  501.     public function setVisibleSearch($visibleSearch)
  502.     {
  503.         $this->visibleSearch = (bool)$visibleSearch;
  505.         return $this;
  506.     }
  508.     /**
  509.      * @param mixed $data
  510.      * @param array $tags
  511.      *
  512.      * @return array
  513.      */
  514.     public function getCacheTags($data, array $tags = [])
  515.     {
  516.         return $tags;
  517.     }
  519.     /**
  520.      * @param mixed $data
  521.      *
  522.      * @return array
  523.      */
  524.     public function resolveDependencies($data)
  525.     {
  526.         return [];
  527.     }
  529.     /**
  530.      * returns sql query statement to filter according to this data types value(s)
  531.      *
  532.      * @param  mixed $value
  533.      * @param  string $operator
  534.      * @param  mixed $params
  535.      *
  536.      * @return string
  537.      *
  538.      */
  539.     public function getFilterCondition($value, $operator, $params = [])
  540.     {
  541.         $params['name'] = $this->name;
  543.         return $this->getFilterConditionExt(
  544.             $value,
  545.             $operator,
  546.             $params
  547.         );
  548.     }
  550.     /**
  551.      * returns sql query statement to filter according to this data types value(s)
  552.      *
  553.      * @param mixed $value
  554.      * @param string $operator
  555.      * @param array $params optional params used to change the behavior
  556.      *
  557.      * @return string
  558.      */
  559.     public function getFilterConditionExt($value, $operator, $params = [])
  560.     {
  561.         if (is_array($value) && empty($value)) {
  562.             return '';
  563.         }
  565.         $db = \Pimcore\Db::get();
  566.         $name = $params['name'] ?: $this->name;
  567.         $key = $db->quoteIdentifier($name);
  568.         if (!empty($params['brickPrefix'])) {
  569.             $key = $params['brickPrefix'].$key;
  570.         }
  572.         if ($value === 'NULL') {
  573.             if ($operator === '=') {
  574.                 $operator = 'IS';
  575.             } elseif ($operator === '!=') {
  576.                 $operator = 'IS NOT';
  577.             }
  578.         } elseif (!is_array($value) && !is_object($value)) {
  579.             if ($operator === 'LIKE') {
  580.                 $value = $db->quote('%' . $value . '%');
  581.             } else {
  582.                 $value = $db->quote($value);
  583.             }
  584.         }
  586.         if (in_array($operator, DataObject\ClassDefinition\Data::$validFilterOperators)) {
  587.             $trailer = '';
  588.             //the db interprets 0 as NULL -> if empty (0) is selected in the filter, we must also filter for NULL
  589.             if ($value === '\'0\'' || is_array($value) && in_array(0, $value)) {
  590.                 $trailer = ' OR ' . $key . ' IS NULL';
  591.             }
  593.             if (str_contains($name, 'cskey') && is_array($value) && !empty($value)) {
  594.                 $values = array_map(function ($val) use ($db) {
  595.                     return $db->quote(Helper::escapeLike($val));
  596.                 }, $value);
  598.                 return $key . ' ' . $operator . ' ' . implode(' OR ' . $key . ' ' . $operator . ' ', $values) . $trailer;
  599.             }
  601.             return $key . ' ' . $operator . ' ' . $value . ' ' . $trailer;
  602.         }
  604.         return '';
  605.     }
  607.     /**
  608.      * @param string $key
  609.      *
  610.      * @return string
  611.      */
  612.     protected function getPreGetValueHookCode(string $key): string
  613.     {
  614.         $code = "\t" . 'if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {' . "\n";
  615.         $code .= "\t\t" . '$preValue = $this->preGetValue("' . $key . '");' . "\n";
  616.         $code .= "\t\t" . 'if ($preValue !== null) {' . "\n";
  617.         $code .= "\t\t\t" . 'return $preValue;' . "\n";
  618.         $code .= "\t\t" . '}' . "\n";
  619.         $code .= "\t" . '}' . "\n\n";
  621.         return $code;
  622.     }
  624.     /**
  625.      * Creates getter code which is used for generation of php file for object classes using this data type
  626.      *
  627.      * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  628.      *
  629.      * @return string
  630.      */
  631.     public function getGetterCode($class)
  632.     {
  633.         $key = $this->getName();
  635.         if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  636.             $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  637.         } else {
  638.             $typeDeclaration = '';
  639.         }
  641.         $code = '/**' . "\n";
  642.         $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  643.         $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  644.         $code .= '*/' . "\n";
  645.         $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  646.         $code .= '{' . "\n";
  648.         $code .= $this->getPreGetValueHookCode($key);
  650.         //TODO Pimcore 11: remove method_exists BC layer
  651.         if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface ||method_exists($this, 'preGetData')) {
  652.             $code .= "\t" . '$data = $this->getClass()->getFieldDefinition("' . $key . '")->preGetData($this);' . "\n\n";
  653.         } else {
  654.             $code .= "\t" . '$data = $this->' . $key . ";\n\n";
  655.         }
  657.         // insert this line if inheritance from parent objects is allowed
  658.         if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit() && $this->supportsInheritance()) {
  659.             $code .= "\t" . 'if (\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("' . $key . '")->isEmpty($data)) {' . "\n";
  660.             $code .= "\t\t" . 'try {' . "\n";
  661.             $code .= "\t\t\t" . 'return $this->getValueFromParent("' . $key . '");' . "\n";
  662.             $code .= "\t\t" . '} catch (InheritanceParentNotFoundException $e) {' . "\n";
  663.             $code .= "\t\t\t" . '// no data from parent available, continue ...' . "\n";
  664.             $code .= "\t\t" . '}' . "\n";
  665.             $code .= "\t" . '}' . "\n\n";
  666.         }
  668.         $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  669.         $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  670.         $code .= "\t" . '}' . "\n\n";
  672.         $code .= "\t" . 'return $data;' . "\n";
  673.         $code .= "}\n\n";
  675.         return $code;
  676.     }
  678.     /**
  679.      * Creates setter code which is used for generation of php file for object classes using this data type
  680.      *
  681.      * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  682.      *
  683.      * @return string
  684.      */
  685.     public function getSetterCode($class)
  686.     {
  687.         if ($class instanceof DataObject\Objectbrick\Definition) {
  688.             $classname = 'Objectbrick\\Data\\' . ucfirst($class->getKey());
  689.         } elseif ($class instanceof DataObject\Fieldcollection\Definition) {
  690.             $classname = 'Fieldcollection\\Data\\' . ucfirst($class->getKey());
  691.         } else {
  692.             $classname = $class->getName();
  693.         }
  695.         $key = $this->getName();
  697.         if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  698.             $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  699.         } else {
  700.             $typeDeclaration = '';
  701.         }
  703.         $code = '/**' . "\n";
  704.         $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  705.         $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  706.         $code .= '* @return \\Pimcore\\Model\\DataObject\\' . ucfirst($classname) . "\n";
  707.         $code .= '*/' . "\n";
  708.         $code .= 'public function set' . ucfirst($key) . '(' . $typeDeclaration . '$' . $key . ')' . "\n";
  709.         $code .= '{' . "\n";
  711.         if (
  712.             (
  713.                 $this->supportsDirtyDetection() &&
  714.                 $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  715.             ) || method_exists($this, 'preSetData')
  716.         ) {
  717.             $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  718.             $code .= "\t" . '$fd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  719.         }
  721.         if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  722.             if ($this->getDelegate()) {
  723.                 $code .= "\t" . '$encryptedFd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  724.                 $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  725.                 $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  726.                 $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  727.                 $code .= "\t" . '}' . "\n";
  728.             }
  729.         }
  731.         if ($this->supportsDirtyDetection()) {
  732.             if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  733.                 $code .= "\t" . '$inheritValues = self::getGetInheritedValues();'."\n";
  734.                 $code .= "\t" . 'self::setGetInheritedValues(false);'."\n";
  735.             }
  737.             $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  738.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  739.             $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  740.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  742.             if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  743.                 $code .= "\t" . 'self::setGetInheritedValues($inheritValues);'."\n";
  744.             }
  745.             if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  746.                 $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  747.                 $code .= "\t" . 'if (!$isEqual) {' . "\n";
  748.                 $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  749.                 $code .= "\t" . '}' . "\n";
  750.             } else {
  751.                 $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  752.             }
  753.         }
  755.         //TODO Pimcore 11: remove method_exists BC layer
  756.         if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  757.             $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  758.         } else {
  759.             $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  760.         }
  762.         $code .= "\t" . 'return $this;' . "\n";
  763.         $code .= "}\n\n";
  765.         return $code;
  766.     }
  768.     /**
  769.      * Creates getter code which is used for generation of php file for object brick classes using this data type
  770.      *
  771.      * @param DataObject\Objectbrick\Definition $brickClass
  772.      *
  773.      * @return string
  774.      */
  775.     public function getGetterCodeObjectbrick($brickClass)
  776.     {
  777.         $key = $this->getName();
  779.         if ($brickClass->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  780.             $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  781.         } else {
  782.             $typeDeclaration = '';
  783.         }
  785.         $code = '';
  786.         $code .= '/**' . "\n";
  787.         $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  788.         $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  789.         $code .= '*/' . "\n";
  790.         $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  791.         $code .= '{' . "\n";
  793.         //TODO Pimcore 11: remove method_exists BC layer
  794.         if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface ||method_exists($this, 'preGetData')) {
  795.             $code .= "\t" . '$data = $this->getDefinition()->getFieldDefinition("' . $key . '")->preGetData($this);' . "\n";
  796.         } else {
  797.             $code .= "\t" . '$data = $this->' . $key . ";\n";
  798.         }
  800.         if ($this->supportsInheritance()) {
  801.             $code .= "\t" . 'if(\Pimcore\Model\DataObject::doGetInheritedValues($this->getObject()) && $this->getDefinition()->getFieldDefinition("' . $key . '")->isEmpty($data)) {' . "\n";
  802.             $code .= "\t\t" . 'try {' . "\n";
  803.             $code .= "\t\t\t" . 'return $this->getValueFromParent("' . $key . '");' . "\n";
  804.             $code .= "\t\t" . '} catch (InheritanceParentNotFoundException $e) {' . "\n";
  805.             $code .= "\t\t\t" . '// no data from parent available, continue ...' . "\n";
  806.             $code .= "\t\t" . '}' . "\n";
  807.             $code .= "\t" . '}' . "\n";
  808.         }
  810.         $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  811.         $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  812.         $code .= "\t" . '}' . "\n\n";
  814.         $code .= "\t" . 'return $data;' . "\n";
  815.         $code .= "}\n\n";
  817.         return $code;
  818.     }
  820.     /**
  821.      * Creates setter code which is used for generation of php file for object brick classes using this data type
  822.      *
  823.      * @param DataObject\Objectbrick\Definition $brickClass
  824.      *
  825.      * @return string
  826.      */
  827.     public function getSetterCodeObjectbrick($brickClass)
  828.     {
  829.         $key = $this->getName();
  831.         if ($brickClass->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  832.             $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  833.         } else {
  834.             $typeDeclaration = '';
  835.         }
  837.         $code = '/**' . "\n";
  838.         $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  839.         $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  840.         $code .= '* @return \\Pimcore\\Model\\DataObject\\Objectbrick\\Data\\' . ucfirst($brickClass->getKey()) . "\n";
  841.         $code .= '*/' . "\n";
  842.         $code .= 'public function set' . ucfirst($key) . ' (' . $typeDeclaration . '$' . $key . ')' . "\n";
  843.         $code .= '{' . "\n";
  845.         if (
  846.             (
  847.                 $this->supportsDirtyDetection() &&
  848.                 $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  849.             ) || method_exists($this, 'preSetData')
  850.         ) {
  851.             $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  852.             $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  853.         }
  855.         if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  856.             if ($this->getDelegate()) {
  857.                 $code .= "\t" . '/** @var \\' . static::class . ' $encryptedFd */' . "\n";
  858.                 $code .= "\t" . '$encryptedFd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  859.                 $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  860.                 $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  861.                 $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  862.                 $code .= "\t" . '}' . "\n";
  863.             }
  864.         }
  866.         if ($this->supportsDirtyDetection()) {
  867.             $code .= "\t" . '$class = $this->getObject() ? $this->getObject()->getClass() : null;' . "\n";
  868.             $code .= "\t" . 'if ($class && $class->getAllowInherit()) {' . "\n";
  869.             $code .= "\t\t" . '$inheritValues = $this->getObject()::getGetInheritedValues();'."\n";
  870.             $code .= "\t\t" . '$this->getObject()::setGetInheritedValues(false);'."\n";
  871.             $code .= "\t" . '}'."\n";
  873.             $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  874.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  875.             $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  876.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  878.             $code .= "\t" . 'if($class && $class->getAllowInherit()) {' . "\n";
  879.             $code .= "\t\t" . '$this->getObject()::setGetInheritedValues($inheritValues);'."\n";
  880.             $code .= "\t" . '}' . "\n";
  881.             if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  882.                 $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  883.                 $code .= "\t" . 'if (!$isEqual) {' . "\n";
  884.                 $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  885.                 $code .= "\t" . '}' . "\n";
  886.             } else {
  887.                 $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  888.             }
  889.         }
  891.         //TODO Pimcore 11: remove method_exists BC layer
  892.         if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  893.             $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  894.         } else {
  895.             $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  896.         }
  898.         $code .= "\t" . 'return $this;' . "\n";
  899.         $code .= "}\n\n";
  901.         return $code;
  902.     }
  904.     /**
  905.      * Creates getter code which is used for generation of php file for fieldcollectionk classes using this data type
  906.      *
  907.      * @param DataObject\Fieldcollection\Definition $fieldcollectionDefinition
  908.      *
  909.      * @return string
  910.      */
  911.     public function getGetterCodeFieldcollection($fieldcollectionDefinition)
  912.     {
  913.         $key = $this->getName();
  915.         if ($fieldcollectionDefinition->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  916.             $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  917.         } else {
  918.             $typeDeclaration = '';
  919.         }
  921.         $code = '/**' . "\n";
  922.         $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  923.         $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  924.         $code .= '*/' . "\n";
  925.         $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  926.         $code .= '{' . "\n";
  928.         //TODO Pimcore 11: remove method_exists BC layer
  929.         if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface || method_exists($this, 'preGetData')) {
  930.             $code .= "\t" . '$container = $this;' . "\n";
  931.             $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  932.             $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  933.             $code .= "\t" . '$data = $fd->preGetData($container);' . "\n";
  934.         } else {
  935.             $code .= "\t" . '$data = $this->' . $key . ";\n";
  936.         }
  938.         $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  939.         $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  940.         $code .= "\t" . '}' . "\n\n";
  942.         $code .= "\t" . 'return $data;' . "\n";
  943.         $code .= "}\n\n";
  945.         return $code;
  946.     }
  948.     /**
  949.      * Creates setter code which is used for generation of php file for fieldcollection classes using this data type
  950.      *
  951.      * @param DataObject\Fieldcollection\Definition $fieldcollectionDefinition
  952.      *
  953.      * @return string
  954.      */
  955.     public function getSetterCodeFieldcollection($fieldcollectionDefinition)
  956.     {
  957.         $key = $this->getName();
  959.         if ($fieldcollectionDefinition->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  960.             $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  961.         } else {
  962.             $typeDeclaration = '';
  963.         }
  965.         $code = '/**' . "\n";
  966.         $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  967.         $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  968.         $code .= '* @return \\Pimcore\\Model\\DataObject\\Fieldcollection\\Data\\' . ucfirst($fieldcollectionDefinition->getKey()) . "\n";
  969.         $code .= '*/' . "\n";
  970.         $code .= 'public function set' . ucfirst($key) . '(' . $typeDeclaration . '$' . $key . ')' . "\n";
  971.         $code .= '{' . "\n";
  973.         if (
  974.             (
  975.                 $this->supportsDirtyDetection() &&
  976.                 $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  977.             ) || method_exists($this, 'preSetData')
  978.         ) {
  979.             $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  980.             $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  981.         }
  983.         if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  984.             if ($this->getDelegate()) {
  985.                 $code .= "\t" . '/** @var \\' . static::class . ' $encryptedFd */' . "\n";
  986.                 $code .= "\t" . '$encryptedFd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  987.                 $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  988.                 $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  989.                 $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  990.                 $code .= "\t" . '}' . "\n";
  991.             }
  992.         }
  994.         if ($this->supportsDirtyDetection()) {
  995.             $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  996.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  997.             $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  998.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  1000.             if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  1001.                 $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  1002.                 $code .= "\t" . 'if (!$isEqual) {' . "\n";
  1003.                 $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  1004.                 $code .= "\t" . '}' . "\n";
  1005.             } else {
  1006.                 $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  1007.             }
  1008.         }
  1010.         //TODO Pimcore 11: remove method_exists BC layer
  1011.         if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  1012.             $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  1013.         } else {
  1014.             $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  1015.         }
  1017.         $code .= "\t" . 'return $this;' . "\n";
  1018.         $code .= "}\n\n";
  1020.         return $code;
  1021.     }
  1023.     /**
  1024.      * Creates getter code which is used for generation of php file for localized fields in classes using this data type
  1025.      *
  1026.      * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  1027.      *
  1028.      * @return string
  1029.      */
  1030.     public function getGetterCodeLocalizedfields($class)
  1031.     {
  1032.         $key = $this->getName();
  1034.         if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  1035.             $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  1036.         } else {
  1037.             $typeDeclaration = '';
  1038.         }
  1040.         $code = '/**' . "\n";
  1041.         $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  1042.         $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  1043.         $code .= '*/' . "\n";
  1044.         $code .= 'public function get' . ucfirst($key) . '($language = null)' . $typeDeclaration . "\n";
  1045.         $code .= '{' . "\n";
  1047.         $code .= "\t" . '$data = $this->getLocalizedfields()->getLocalizedValue("' . $key . '", $language);' . "\n";
  1049.         if (!$class instanceof DataObject\Fieldcollection\Definition) {
  1050.             $code .= $this->getPreGetValueHookCode($key);
  1051.         }
  1053.         $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  1054.         $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  1055.         $code .= "\t" . '}' . "\n\n";
  1057.         // we don't need to consider preGetData, because this is already managed directly by the localized fields within getLocalizedValue()
  1059.         $code .= "\t" . 'return $data;' . "\n";
  1060.         $code .= "}\n\n";
  1062.         return $code;
  1063.     }
  1065.     /**
  1066.      * Creates setter code which is used for generation of php file for localized fields in classes using this data type
  1067.      *
  1068.      * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  1069.      *
  1070.      * @return string
  1071.      */
  1072.     public function getSetterCodeLocalizedfields($class)
  1073.     {
  1074.         $key = $this->getName();
  1075.         if ($class instanceof DataObject\Objectbrick\Definition) {
  1076.             $classname = 'Objectbrick\\Data\\' . ucfirst($class->getKey());
  1077.             $containerGetter = 'getDefinition';
  1078.         } elseif ($class instanceof DataObject\Fieldcollection\Definition) {
  1079.             $classname = 'Fieldcollection\\Data\\' . ucfirst($class->getKey());
  1080.             $containerGetter = 'getDefinition';
  1081.         } else {
  1082.             $classname = $class->getName();
  1083.             $containerGetter = 'getClass';
  1084.         }
  1086.         if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  1087.             $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  1088.         } else {
  1089.             $typeDeclaration = '';
  1090.         }
  1092.         $code = '/**' . "\n";
  1093.         $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  1094.         $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  1095.         $code .= '* @return \\Pimcore\\Model\\DataObject\\' . ucfirst($classname) . "\n";
  1096.         $code .= '*/' . "\n";
  1097.         $code .= 'public function set' . ucfirst($key) . ' (' . $typeDeclaration . '$' . $key . ', $language = null)' . "\n";
  1098.         $code .= '{' . "\n";
  1100.         if ($this->supportsDirtyDetection()) {
  1101.             $code .= "\t" . '$fd = $this->' . $containerGetter . '()->getFieldDefinition("localizedfields")->getFieldDefinition("' . $key . '");' . "\n";
  1102.         }
  1104.         if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  1105.             if ($this->getDelegate()) {
  1106.                 $code .= "\t" . '$encryptedFd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  1107.                 $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  1108.                 $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  1109.                 $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  1110.                 $code .= "\t" . '}' . "\n";
  1111.             }
  1112.         }
  1114.         if ($this->supportsDirtyDetection()) {
  1115.             if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  1116.                 $code .= "\t" . '$inheritValues = self::getGetInheritedValues();'."\n";
  1117.                 $code .= "\t" . 'self::setGetInheritedValues(false);'."\n";
  1118.             }
  1120.             $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  1121.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  1122.             $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '($language);' . "\n";
  1123.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  1125.             if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  1126.                 $code .= "\t" . 'self::setGetInheritedValues($inheritValues);'."\n";
  1127.             }
  1128.             if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  1129.                 $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  1130.             } else {
  1131.                 $code .= "\t" . '$isEqual = false;' . "\n";
  1132.             }
  1134.             $code .= "\t" . 'if (!$isEqual) {' . "\n";
  1135.             $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  1136.             $code .= "\t" . '}' . "\n";
  1137.         } else {
  1138.             $code .= "\t" . '$isEqual = false;' . "\n";
  1139.         }
  1141.         $code .= "\t" . '$this->getLocalizedfields()->setLocalizedValue("' . $key . '", $' . $key . ', $language, !$isEqual)' . ";\n\n";
  1143.         $code .= "\t" . 'return $this;' . "\n";
  1144.         $code .= "}\n\n";
  1146.         return $code;
  1147.     }
  1149.     /**
  1150.      * Creates filter method code for listing classes
  1151.      *
  1152.      * @return string
  1153.      */
  1154.     public function getFilterCode()
  1155.     {
  1156.         $key = $this->getName();
  1158.         $code = '/**' . "\n";
  1159.         $code .= '* Filter by ' . str_replace(['/**', '*/', '//'], '', $key) . ' (' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . ")\n";
  1161.         $dataParamDoc = 'mixed $data';
  1162.         $reflectionMethod = new \ReflectionMethod($this, 'addListingFilter');
  1163.         if (preg_match('/@param\s+([^\s]+)\s+\$data(.*)/', $reflectionMethod->getDocComment(), $dataParam)) {
  1164.             $dataParamDoc = $dataParam[1].' $data '.$dataParam[2];
  1165.         }
  1167.         $operatorParamDoc = 'string $operator SQL comparison operator, e.g. =, <, >= etc. You can use "?" as placeholder, e.g. "IN (?)"';
  1168.         if (preg_match('/@param\s+([^\s]+)\s+\$operator(.*)/', $reflectionMethod->getDocComment(), $dataParam)) {
  1169.             $operatorParamDoc = $dataParam[1].' $operator '.$dataParam[2];
  1170.         }
  1172.         $code .= '* @param '.$dataParamDoc."\n";
  1173.         $code .= '* @param '.$operatorParamDoc."\n";
  1174.         $code .= '* @return static'."\n";
  1175.         $code .= '*/' . "\n";
  1177.         $code .= 'public function filterBy' . ucfirst($key) .' ($data, $operator = \'=\')' . "\n";
  1178.         $code .= '{' . "\n";
  1179.         $code .= "\t" . '$this->getClass()->getFieldDefinition("' . $key . '")->addListingFilter($this, $data, $operator);' . "\n";
  1180.         $code .= "\treturn " . '$this' . ";\n";
  1181.         $code .= "}\n\n";
  1183.         return $code;
  1184.     }
  1186.     /**
  1187.      * @param mixed $number
  1188.      *
  1189.      * @return int|null
  1190.      */
  1191.     public function getAsIntegerCast($number)
  1192.     {
  1193.         return strlen((string) $number) === 0 ? null : (int)$number;
  1194.     }
  1196.     /**
  1197.      * @param mixed $number
  1198.      *
  1199.      * @return float|null
  1200.      */
  1201.     public function getAsFloatCast($number)
  1202.     {
  1203.         return strlen((string) $number) === 0 ? null : (float)$number;
  1204.     }
  1206.     /**
  1207.      * @param mixed $data
  1208.      * @param DataObject\Concrete|null $object
  1209.      * @param mixed $params
  1210.      *
  1211.      * @return string
  1212.      */
  1213.     public function getVersionPreview($data, $object = null, $params = [])
  1214.     {
  1215.         return 'no preview';
  1216.     }
  1218.     /**
  1219.      * @param mixed $data
  1220.      *
  1221.      * @return bool
  1222.      */
  1223.     public function isEmpty($data)
  1224.     {
  1225.         return empty($data);
  1226.     }
  1228.     /** True if change is allowed in edit mode.
  1229.      * @param DataObject\Concrete $object
  1230.      * @param mixed $params
  1231.      *
  1232.      * @return bool
  1233.      */
  1234.     public function isDiffChangeAllowed($object, $params = [])
  1235.     {
  1236.         return false;
  1237.     }
  1239.     /** Converts the data sent from the object merger back to the internal object. Similar to
  1240.      * getDiffDataForEditMode() an array of data elements is passed in containing the following attributes:
  1241.      *  - "field" => the name of (this) field
  1242.      *  - "key" => the key of the data element
  1243.      *  - "data" => the data
  1244.      *
  1245.      * @param array $data
  1246.      * @param DataObject\Concrete|null $object
  1247.      * @param mixed $params
  1248.      *
  1249.      * @return mixed
  1250.      */
  1251.     public function getDiffDataFromEditmode($data, $object = null, $params = [])
  1252.     {
  1253.         $thedata = $this->getDataFromEditmode($data[0]['data'], $object, $params);
  1255.         return $thedata;
  1256.     }
  1258.     /**
  1259.      * Returns the data for the editmode in the format expected by the object merger plugin.
  1260.      * The return value is a list of data definitions containing the following attributes:
  1261.      *      - "field" => the name of the object field
  1262.      *      - "key" => a unique key identifying the data element
  1263.      *      - "type" => the type of the data component
  1264.      *      - "value" => the value used as preview
  1265.      *      - "data" => the actual data which is then sent back again by the editor. Note that the data is opaque
  1266.      *                          and will not be touched by the editor in any way.
  1267.      *      - "disabled" => whether the data element can be edited or not
  1268.      *      - "title" => pretty name describing the data element
  1269.      *
  1270.      *
  1271.      * @param mixed $data
  1272.      * @param DataObject\Concrete|null $object
  1273.      * @param mixed $params
  1274.      *
  1275.      * @return null|array
  1276.      */
  1277.     public function getDiffDataForEditMode($data, $object = null, $params = [])
  1278.     {
  1279.         $diffdata = [];
  1280.         $diffdata['data'] = $this->getDataForEditmode($data, $object, $params);
  1281.         $diffdata['disabled'] = !($this->isDiffChangeAllowed($object));
  1282.         $diffdata['field'] = $this->getName();
  1283.         $diffdata['key'] = $this->getName();
  1284.         $diffdata['type'] = $this->fieldtype;
  1286.         if (method_exists($this, 'getDiffVersionPreview')) {
  1287.             $value = $this->getDiffVersionPreview($data, $object, $params);
  1288.         } else {
  1289.             $value = $this->getVersionPreview($data, $object, $params);
  1290.         }
  1292.         $diffdata['title'] = !empty($this->title) ? $this->title : $this->name;
  1293.         $diffdata['value'] = $value;
  1295.         $result = [];
  1296.         $result[] = $diffdata;
  1298.         return $result;
  1299.     }
  1301.     /**
  1302.      * @return bool
  1303.      */
  1304.     public function getUnique()
  1305.     {
  1306.         return false;
  1307.     }
  1309.     /**
  1310.      * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  1311.      * @param array $params
  1312.      *
  1313.      * @return mixed
  1314.      *
  1315.      * @throws \Exception
  1316.      */
  1317.     protected function getDataFromObjectParam($object, $params = [])
  1318.     {
  1319.         $data = null;
  1321.         if (array_key_exists('injectedData', $params)) {
  1322.             return $params['injectedData'];
  1323.         }
  1325.         $context = $params['context'] ?? null;
  1327.         if (isset($context['containerType'])) {
  1328.             if ($context['containerType'] === 'fieldcollection' || $context['containerType'] === 'block') {
  1329.                 if ($this instanceof DataObject\ClassDefinition\Data\Localizedfields || $object instanceof DataObject\Localizedfield) {
  1330.                     $fieldname = $context['fieldname'];
  1331.                     $index = $context['index'] ?? null;
  1333.                     if ($object instanceof DataObject\Concrete) {
  1334.                         $containerGetter = 'get' . ucfirst($fieldname);
  1335.                         $container = $object->$containerGetter();
  1336.                         if (!$container && $context['containerType'] === 'block') {
  1337.                             // no data, so check if inheritance is enabled + there is parent value
  1338.                             if ($object->getClass()->getAllowInherit()) {
  1339.                                 try {
  1340.                                     $container = $object->getValueFromParent($fieldname);
  1341.                                 } catch (InheritanceParentNotFoundException $e) {
  1342.                                     //nothing to do here - just no parent data available
  1343.                                 }
  1344.                             }
  1345.                         }
  1347.                         if ($container) {
  1348.                             $originalIndex = $context['oIndex'] ?? null;
  1350.                             // field collection or block items
  1351.                             if ($originalIndex !== null) {
  1352.                                 if ($context['containerType'] === 'block') {
  1353.                                     $items = $container;
  1354.                                 } else {
  1355.                                     $items = $container->getItems();
  1356.                                 }
  1358.                                 if ($items && count($items) > $originalIndex) {
  1359.                                     $item = $items[$originalIndex];
  1361.                                     if ($context['containerType'] === 'block') {
  1362.                                         $data = $item[$this->getName()] ?? null;
  1363.                                         if ($data instanceof DataObject\Data\BlockElement) {
  1364.                                             $data = $data->getData();
  1366.                                             return $data;
  1367.                                         }
  1368.                                     } else {
  1369.                                         $getter = 'get' . ucfirst($this->getName());
  1370.                                         $data = $item->$getter();
  1371.                                     }
  1373.                                     return $data;
  1374.                                 }
  1376.                                 throw new \Exception('object seems to be modified, item with orginal index ' . $originalIndex . ' not found, new index: ' . $index);
  1377.                             } else {
  1378.                                 return null;
  1379.                             }
  1380.                         } else {
  1381.                             return null;
  1382.                         }
  1383.                     } elseif ($object instanceof DataObject\Localizedfield) {
  1384.                         $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1386.                         return $data;
  1387.                     }
  1388.                 }
  1389.             } elseif ($context['containerType'] === 'objectbrick' && ($this instanceof DataObject\ClassDefinition\Data\Localizedfields || $object instanceof DataObject\Localizedfield)) {
  1390.                 $fieldname = $context['fieldname'];
  1392.                 if ($object instanceof DataObject\Concrete) {
  1393.                     $containerGetter = 'get' . ucfirst($fieldname);
  1394.                     $container = $object->$containerGetter();
  1395.                     if ($container) {
  1396.                         $brickGetter = 'get' . ucfirst($context['containerKey']);
  1397.                         $brickData = $container->$brickGetter();
  1399.                         if ($brickData instanceof DataObject\Objectbrick\Data\AbstractData) {
  1400.                             return $brickData->get('localizedfields');
  1401.                         }
  1402.                     }
  1404.                     return null;
  1405.                 } elseif ($object instanceof DataObject\Localizedfield) {
  1406.                     $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1408.                     return $data;
  1409.                 }
  1410.             } elseif ($context['containerType'] === 'classificationstore') {
  1411.                 $fieldname = $context['fieldname'];
  1412.                 $getter = 'get' . ucfirst($fieldname);
  1413.                 if (method_exists($object, $getter)) {
  1414.                     $groupId = $context['groupId'];
  1415.                     $keyId = $context['keyId'];
  1416.                     $language = $context['language'];
  1418.                     /** @var DataObject\Classificationstore $classificationStoreData */
  1419.                     $classificationStoreData = $object->$getter();
  1420.                     $data = $classificationStoreData->getLocalizedKeyValue($groupId, $keyId, $language, true, true);
  1422.                     return $data;
  1423.                 }
  1424.             }
  1425.         }
  1427.         $container = $object;
  1429.         $getter = 'get' . ucfirst($this->getName());
  1430.         if (method_exists($container, $getter)) { // for DataObject\Concrete, DataObject\Fieldcollection\Data\AbstractData, DataObject\Objectbrick\Data\AbstractData
  1431.             $data = $container->$getter();
  1432.         } elseif ($object instanceof DataObject\Localizedfield) {
  1433.             $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1434.         }
  1436.         return $data;
  1437.     }
  1439.     /**
  1440.      * @param DataObject\ClassDefinition\Data $masterDefinition
  1441.      */
  1442.     public function synchronizeWithMasterDefinition(DataObject\ClassDefinition\Data $masterDefinition)
  1443.     {
  1444.         // implement in child classes
  1445.     }
  1447.     /**
  1448.      * @param DataObject\ClassDefinition\Data $masterDefinition
  1449.      */
  1450.     public function adoptMasterDefinition(DataObject\ClassDefinition\Data $masterDefinition)
  1451.     {
  1452.         $vars = get_object_vars($this);
  1453.         $protectedFields = ['noteditable', 'invisible'];
  1454.         foreach ($vars as $name => $value) {
  1455.             if (!in_array($name, $protectedFields)) {
  1456.                 unset($this->$name);
  1457.             }
  1458.         }
  1459.         $vars = get_object_vars($masterDefinition);
  1460.         foreach ($vars as $name => $value) {
  1461.             if (!in_array($name, $protectedFields)) {
  1462.                 $this->$name = $value;
  1463.             }
  1464.         }
  1465.     }
  1467.     /**
  1468.      * @param array|null $existingData
  1469.      * @param array $additionalData
  1470.      *
  1471.      * @return array|null
  1472.      */
  1473.     public function appendData($existingData, $additionalData)
  1474.     {
  1475.         return $existingData;
  1476.     }
  1478.     /**
  1479.      * @param mixed $existingData
  1480.      * @param mixed $removeData
  1481.      *
  1482.      * @return mixed
  1483.      */
  1484.     public function removeData($existingData, $removeData)
  1485.     {
  1486.         return $existingData;
  1487.     }
  1489.     /**
  1490.      * Returns if datatype supports data inheritance
  1491.      *
  1492.      * @return bool
  1493.      */
  1494.     public function supportsInheritance()
  1495.     {
  1496.         return true;
  1497.     }
  1499.     /**
  1500.      * @return bool
  1501.      */
  1502.     public function supportsDirtyDetection()
  1503.     {
  1504.         return false;
  1505.     }
  1507.     /**
  1508.      * @param DataObject\Concrete $object
  1509.      */
  1510.     public function markLazyloadedFieldAsLoaded($object)
  1511.     {
  1512.         if ($object instanceof DataObject\LazyLoadedFieldsInterface) {
  1513.             $object->markLazyKeyAsLoaded($this->getName());
  1514.         }
  1515.     }
  1517.     /**
  1518.      * Returns if datatype supports listing filters: getBy, filterBy
  1519.      *
  1520.      * @return bool
  1521.      */
  1522.     public function isFilterable(): bool
  1523.     {
  1524.         return false;
  1525.     }
  1527.     /**
  1528.      * @param DataObject\Listing $listing
  1529.      * @param string|int|float|array|Model\Element\ElementInterface $data comparison data, can be scalar or array (if operator is e.g. "IN (?)")
  1530.      * @param string $operator SQL comparison operator, e.g. =, <, >= etc. You can use "?" as placeholder, e.g. "IN (?)"
  1531.      *
  1532.      * @return DataObject\Listing
  1533.      */
  1534.     public function addListingFilter(DataObject\Listing $listing, $data, $operator = '=')
  1535.     {
  1536.         return $listing->addFilterByField($this->getName(), $operator, $data);
  1537.     }
  1539.     /**
  1540.      * @return bool
  1541.      */
  1542.     public function isForbiddenName()
  1543.     {
  1544.         return in_array($this->getName(), self::FORBIDDEN_NAMES);
  1545.     }
  1546. }