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

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 bool
  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.      * @deprecated Will be removed with Pimcore 11
  74.      *
  75.      * @var string
  76.      */
  77.     public $datatype = 'data';
  79.     /**
  80.      * @var string
  81.      */
  82.     public $fieldtype;
  84.     /**
  85.      * @var bool
  86.      */
  87.     public $relationType = false;
  89.     /**
  90.      * @var bool
  91.      */
  92.     public $invisible = false;
  94.     /**
  95.      * @var bool
  96.      */
  97.     public $visibleGridView = true;
  99.     /**
  100.      * @var bool
  101.      */
  102.     public $visibleSearch = true;
  104.     /**
  105.      * @var array
  106.      */
  107.     public static $validFilterOperators = [
  108.         'LIKE',
  109.         'NOT LIKE',
  110.         '=',
  111.         'IS',
  112.         'IS NOT',
  113.         '!=',
  114.         '<',
  115.         '>',
  116.         '>=',
  117.         '<=',
  118.     ];
  120.     /**
  121.      * @var array
  122.      */
  123.     protected const FORBIDDEN_NAMES = [
  124.         'id', 'key', 'path', 'type', 'index', 'classname', 'creationdate', 'userowner', 'value', 'class', 'list',
  125.         'fullpath', 'childs', 'children', 'values', 'cachetag', 'cachetags', 'parent', 'published', 'valuefromparent',
  126.         'userpermissions', 'dependencies', 'modificationdate', 'usermodification', 'byid', 'bypath', 'data',
  127.         'versions', 'properties', 'permissions', 'permissionsforuser', 'childamount', 'apipluginbroker', 'resource',
  128.         'parentClass', 'definition', 'locked', 'language', 'omitmandatorycheck', 'idpath', 'object', 'fieldname',
  129.         'property', 'parentid', 'children', 'scheduledtasks', 'latestVersion',
  130.     ];
  132.     /**
  133.      * Returns the data for the editmode
  134.      *
  135.      * @param mixed $data
  136.      * @param null|DataObject\AbstractObject $object
  137.      * @param mixed $params
  138.      *
  139.      * @return mixed
  140.      */
  141.     abstract public function getDataForEditmode($data, $object = null, $params = []);
  143.     /**
  144.      * Converts data from editmode to internal eg. Image-Id to Asset\Image object
  145.      *
  146.      * @param mixed $data
  147.      * @param null|DataObject\AbstractObject $object
  148.      * @param mixed $params
  149.      *
  150.      * @return mixed
  151.      */
  152.     abstract public function getDataFromEditmode($data, $object = null, $params = []);
  154.     /**
  155.      * Checks if data is valid for current data field
  156.      *
  157.      * @param mixed $data
  158.      * @param bool $omitMandatoryCheck
  159.      * @param array $params
  160.      *
  161.      * @throws \Exception
  162.      */
  163.     public function checkValidity($data, $omitMandatoryCheck = false, $params = [])
  164.     {
  165.         $isEmpty = true;
  167.         // this is to do not treated "0" as empty
  168.         if (is_string($data) || is_numeric($data)) {
  169.             if (strlen($data) > 0) {
  170.                 $isEmpty = false;
  171.             }
  172.         }
  174.         if (!empty($data)) {
  175.             $isEmpty = false;
  176.         }
  178.         if (!$omitMandatoryCheck && $this->getMandatory() && $isEmpty) {
  179.             throw new Model\Element\ValidationException('Empty mandatory field [ ' . $this->getName() . ' ]');
  180.         }
  181.     }
  183.     /**
  184.      * converts object data to a simple string value or CSV Export
  185.      *
  186.      * @internal
  187.      *
  188.      * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  189.      * @param array $params
  190.      *
  191.      * @return string
  192.      */
  193.     public function getForCsvExport($object, $params = [])
  194.     {
  195.         return $this->getDataFromObjectParam($object, $params);
  196.     }
  198.     /**
  199.      * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  200.      * @param mixed $params
  201.      *
  202.      * @return string
  203.      */
  204.     public function getDataForSearchIndex($object, $params = [])
  205.     {
  206.         // this is the default, but csv doesn't work for all data types
  207.         return $this->getForCsvExport($object, $params);
  208.     }
  210.     /**
  211.      * @return string|null
  212.      */
  213.     public function getName()
  214.     {
  215.         return $this->name;
  216.     }
  218.     /**
  219.      * @return string
  220.      */
  221.     public function getTitle()
  222.     {
  223.         return $this->title ?? '';
  224.     }
  226.     /**
  227.      * @return bool
  228.      */
  229.     public function getMandatory()
  230.     {
  231.         return $this->mandatory;
  232.     }
  234.     /**
  235.      * @return array
  236.      */
  237.     public function getPermissions()
  238.     {
  239.         return $this->permissions;
  240.     }
  242.     /**
  243.      * @param string $name
  244.      *
  245.      * @return $this
  246.      */
  247.     public function setName($name)
  248.     {
  249.         $this->name = $name;
  251.         return $this;
  252.     }
  254.     /**
  255.      * @param string $title
  256.      *
  257.      * @return $this
  258.      */
  259.     public function setTitle($title)
  260.     {
  261.         $this->title = $title;
  263.         return $this;
  264.     }
  266.     /**
  267.      * @param bool $mandatory
  268.      *
  269.      * @return $this
  270.      */
  271.     public function setMandatory($mandatory)
  272.     {
  273.         $this->mandatory = (bool)$mandatory;
  275.         return $this;
  276.     }
  278.     /**
  279.      * @param array $permissions
  280.      *
  281.      * @return $this
  282.      */
  283.     public function setPermissions($permissions)
  284.     {
  285.         $this->permissions = $permissions;
  287.         return $this;
  288.     }
  290.     /**
  291.      * @param array $data
  292.      * @param array $blockedKeys
  293.      *
  294.      * @return $this
  295.      */
  296.     public function setValues($data = [], $blockedKeys = [])
  297.     {
  298.         foreach ($data as $key => $value) {
  299.             if (!in_array($key, $blockedKeys)) {
  300.                 $method = 'set' . $key;
  301.                 if (method_exists($this, $method)) {
  302.                     $this->$method($value);
  303.                 }
  304.             }
  305.         }
  307.         return $this;
  308.     }
  310.     /**
  311.      * @deprecated Will be removed with Pimcore 11
  312.      *
  313.      * @return string
  314.      */
  315.     public function getDatatype()
  316.     {
  317.         return $this->datatype;
  318.     }
  320.     /**
  321.      * @deprecated Will be removed with Pimcore 11
  322.      *
  323.      * @param string $datatype
  324.      *
  325.      * @return $this
  326.      */
  327.     public function setDatatype($datatype)
  328.     {
  329.         $this->datatype = $datatype;
  331.         return $this;
  332.     }
  334.     /**
  335.      * @return string
  336.      */
  337.     public function getFieldtype()
  338.     {
  339.         return $this->fieldtype;
  340.     }
  342.     /**
  343.      * @return bool
  344.      */
  345.     public function getNoteditable()
  346.     {
  347.         return $this->noteditable;
  348.     }
  350.     /**
  351.      * @param bool $noteditable
  352.      *
  353.      * @return $this
  354.      */
  355.     public function setNoteditable($noteditable)
  356.     {
  357.         $this->noteditable = (bool)$noteditable;
  359.         return $this;
  360.     }
  362.     /**
  363.      * @return bool
  364.      */
  365.     public function getIndex()
  366.     {
  367.         return $this->index;
  368.     }
  370.     /**
  371.      * @param bool $index
  372.      *
  373.      * @return $this
  374.      */
  375.     public function setIndex($index)
  376.     {
  377.         $this->index = (bool) $index;
  379.         return $this;
  380.     }
  382.     /**
  383.      *
  384.      * @return string
  385.      */
  386.     public function getStyle()
  387.     {
  388.         return $this->style;
  389.     }
  391.     /**
  392.      * @param string|null $style
  393.      *
  394.      * @return $this
  395.      */
  396.     public function setStyle($style)
  397.     {
  398.         $this->style = (string)$style;
  400.         return $this;
  401.     }
  403.     /**
  404.      *
  405.      * @return bool
  406.      */
  407.     public function getLocked()
  408.     {
  409.         return $this->locked;
  410.     }
  412.     /**
  413.      * @param bool $locked
  414.      *
  415.      * @return $this
  416.      */
  417.     public function setLocked($locked)
  418.     {
  419.         $this->locked = (bool)$locked;
  421.         return $this;
  422.     }
  424.     /**
  425.      *
  426.      * @return string|null
  427.      */
  428.     public function getTooltip()
  429.     {
  430.         return $this->tooltip;
  431.     }
  433.     /**
  434.      * @param string|null $tooltip
  435.      *
  436.      * @return $this
  437.      */
  438.     public function setTooltip($tooltip)
  439.     {
  440.         $this->tooltip = (string)$tooltip;
  442.         return $this;
  443.     }
  445.     /**
  446.      *
  447.      * @return bool
  448.      */
  449.     public function isRelationType()
  450.     {
  451.         return $this->relationType;
  452.     }
  454.     /**
  455.      * @return bool
  456.      */
  457.     public function getInvisible()
  458.     {
  459.         return $this->invisible;
  460.     }
  462.     /**
  463.      * @param bool $invisible
  464.      *
  465.      * @return $this
  466.      */
  467.     public function setInvisible($invisible)
  468.     {
  469.         $this->invisible = (bool)$invisible;
  471.         return $this;
  472.     }
  474.     /**
  475.      * @return bool
  476.      */
  477.     public function getVisibleGridView()
  478.     {
  479.         return $this->visibleGridView;
  480.     }
  482.     /**
  483.      * @param bool $visibleGridView
  484.      *
  485.      * @return $this
  486.      */
  487.     public function setVisibleGridView($visibleGridView)
  488.     {
  489.         $this->visibleGridView = (bool)$visibleGridView;
  491.         return $this;
  492.     }
  494.     /**
  495.      * @return bool
  496.      */
  497.     public function getVisibleSearch()
  498.     {
  499.         return $this->visibleSearch;
  500.     }
  502.     /**
  503.      * @param bool $visibleSearch
  504.      *
  505.      * @return $this
  506.      */
  507.     public function setVisibleSearch($visibleSearch)
  508.     {
  509.         $this->visibleSearch = (bool)$visibleSearch;
  511.         return $this;
  512.     }
  514.     /**
  515.      * @param mixed $data
  516.      * @param array $tags
  517.      *
  518.      * @return array
  519.      */
  520.     public function getCacheTags($data, array $tags = [])
  521.     {
  522.         return $tags;
  523.     }
  525.     /**
  526.      * @param mixed $data
  527.      *
  528.      * @return array
  529.      */
  530.     public function resolveDependencies($data)
  531.     {
  532.         return [];
  533.     }
  535.     /**
  536.      * returns sql query statement to filter according to this data types value(s)
  537.      *
  538.      * @param  mixed $value
  539.      * @param  string $operator
  540.      * @param  mixed $params
  541.      *
  542.      * @return string
  543.      *
  544.      */
  545.     public function getFilterCondition($value, $operator, $params = [])
  546.     {
  547.         $params['name'] = $this->name;
  549.         return $this->getFilterConditionExt(
  550.             $value,
  551.             $operator,
  552.             $params
  553.         );
  554.     }
  556.     /**
  557.      * returns sql query statement to filter according to this data types value(s)
  558.      *
  559.      * @param mixed $value
  560.      * @param string $operator
  561.      * @param array $params optional params used to change the behavior
  562.      *
  563.      * @return string
  564.      */
  565.     public function getFilterConditionExt($value, $operator, $params = [])
  566.     {
  567.         if (is_array($value) && empty($value)) {
  568.             return '';
  569.         }
  571.         $db = \Pimcore\Db::get();
  572.         $name = $params['name'] ?: $this->name;
  573.         $key = $db->quoteIdentifier($name);
  574.         if (!empty($params['brickPrefix'])) {
  575.             $key = $params['brickPrefix'].$key;
  576.         }
  578.         if ($value === 'NULL') {
  579.             if ($operator === '=') {
  580.                 $operator = 'IS';
  581.             } elseif ($operator === '!=') {
  582.                 $operator = 'IS NOT';
  583.             }
  584.         } elseif (!is_array($value) && !is_object($value)) {
  585.             if ($operator === 'LIKE') {
  586.                 $value = $db->quote('%' . $value . '%');
  587.             } else {
  588.                 $value = $db->quote($value);
  589.             }
  590.         }
  592.         if (in_array($operator, DataObject\ClassDefinition\Data::$validFilterOperators)) {
  593.             $trailer = '';
  594.             //the db interprets 0 as NULL -> if empty (0) is selected in the filter, we must also filter for NULL
  595.             if ($value === '\'0\'' || is_array($value) && in_array(0, $value)) {
  596.                 $trailer = ' OR ' . $key . ' IS NULL';
  597.             }
  599.             if (str_contains($name, 'cskey') && is_array($value) && !empty($value)) {
  600.                 $values = array_map(function ($val) use ($db) {
  601.                     return $db->quote(Helper::escapeLike($val));
  602.                 }, $value);
  604.                 return $key . ' ' . $operator . ' ' . implode(' OR ' . $key . ' ' . $operator . ' ', $values) . $trailer;
  605.             }
  607.             return $key . ' ' . $operator . ' ' . $value . ' ' . $trailer;
  608.         }
  610.         return '';
  611.     }
  613.     /**
  614.      * @param string $key
  615.      *
  616.      * @return string
  617.      */
  618.     protected function getPreGetValueHookCode(string $key): string
  619.     {
  620.         $code = "\t" . 'if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {' . "\n";
  621.         $code .= "\t\t" . '$preValue = $this->preGetValue("' . $key . '");' . "\n";
  622.         $code .= "\t\t" . 'if ($preValue !== null) {' . "\n";
  623.         $code .= "\t\t\t" . 'return $preValue;' . "\n";
  624.         $code .= "\t\t" . '}' . "\n";
  625.         $code .= "\t" . '}' . "\n\n";
  627.         return $code;
  628.     }
  630.     /**
  631.      * Creates getter code which is used for generation of php file for object classes using this data type
  632.      *
  633.      * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  634.      *
  635.      * @return string
  636.      */
  637.     public function getGetterCode($class)
  638.     {
  639.         $key = $this->getName();
  641.         if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  642.             $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  643.         } else {
  644.             $typeDeclaration = '';
  645.         }
  647.         $code = '/**' . "\n";
  648.         $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  649.         $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  650.         $code .= '*/' . "\n";
  651.         $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  652.         $code .= '{' . "\n";
  654.         $code .= $this->getPreGetValueHookCode($key);
  656.         //TODO Pimcore 11: remove method_exists BC layer
  657.         if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface ||method_exists($this, 'preGetData')) {
  658.             $code .= "\t" . '$data = $this->getClass()->getFieldDefinition("' . $key . '")->preGetData($this);' . "\n\n";
  659.         } else {
  660.             $code .= "\t" . '$data = $this->' . $key . ";\n\n";
  661.         }
  663.         // insert this line if inheritance from parent objects is allowed
  664.         if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit() && $this->supportsInheritance()) {
  665.             $code .= "\t" . 'if (\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("' . $key . '")->isEmpty($data)) {' . "\n";
  666.             $code .= "\t\t" . 'try {' . "\n";
  667.             $code .= "\t\t\t" . 'return $this->getValueFromParent("' . $key . '");' . "\n";
  668.             $code .= "\t\t" . '} catch (InheritanceParentNotFoundException $e) {' . "\n";
  669.             $code .= "\t\t\t" . '// no data from parent available, continue ...' . "\n";
  670.             $code .= "\t\t" . '}' . "\n";
  671.             $code .= "\t" . '}' . "\n\n";
  672.         }
  674.         $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  675.         $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  676.         $code .= "\t" . '}' . "\n\n";
  678.         $code .= "\t" . 'return $data;' . "\n";
  679.         $code .= "}\n\n";
  681.         return $code;
  682.     }
  684.     /**
  685.      * Creates setter code which is used for generation of php file for object classes using this data type
  686.      *
  687.      * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  688.      *
  689.      * @return string
  690.      */
  691.     public function getSetterCode($class)
  692.     {
  693.         if ($class instanceof DataObject\Objectbrick\Definition) {
  694.             $classname = 'Objectbrick\\Data\\' . ucfirst($class->getKey());
  695.         } elseif ($class instanceof DataObject\Fieldcollection\Definition) {
  696.             $classname = 'Fieldcollection\\Data\\' . ucfirst($class->getKey());
  697.         } else {
  698.             $classname = $class->getName();
  699.         }
  701.         $key = $this->getName();
  703.         if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  704.             $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  705.         } else {
  706.             $typeDeclaration = '';
  707.         }
  709.         $code = '/**' . "\n";
  710.         $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  711.         $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  712.         $code .= '* @return \\Pimcore\\Model\\DataObject\\' . ucfirst($classname) . "\n";
  713.         $code .= '*/' . "\n";
  714.         $code .= 'public function set' . ucfirst($key) . '(' . $typeDeclaration . '$' . $key . ')' . "\n";
  715.         $code .= '{' . "\n";
  717.         if (
  718.             (
  719.                 $this->supportsDirtyDetection() &&
  720.                 $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  721.             ) || method_exists($this, 'preSetData')
  722.         ) {
  723.             $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  724.             $code .= "\t" . '$fd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  725.         }
  727.         if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  728.             if ($this->getDelegate()) {
  729.                 $code .= "\t" . '$encryptedFd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  730.                 $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  731.                 $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  732.                 $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  733.                 $code .= "\t" . '}' . "\n";
  734.             }
  735.         }
  737.         if ($this->supportsDirtyDetection()) {
  738.             if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  739.                 $code .= "\t" . '$inheritValues = self::getGetInheritedValues();'."\n";
  740.                 $code .= "\t" . 'self::setGetInheritedValues(false);'."\n";
  741.             }
  743.             $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  744.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  745.             $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  746.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  748.             if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  749.                 $code .= "\t" . 'self::setGetInheritedValues($inheritValues);'."\n";
  750.             }
  751.             if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  752.                 $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  753.                 $code .= "\t" . 'if (!$isEqual) {' . "\n";
  754.                 $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  755.                 $code .= "\t" . '}' . "\n";
  756.             } else {
  757.                 $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  758.             }
  759.         }
  761.         //TODO Pimcore 11: remove method_exists BC layer
  762.         if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  763.             $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  764.         } else {
  765.             $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  766.         }
  768.         $code .= "\t" . 'return $this;' . "\n";
  769.         $code .= "}\n\n";
  771.         return $code;
  772.     }
  774.     /**
  775.      * Creates getter code which is used for generation of php file for object brick classes using this data type
  776.      *
  777.      * @param DataObject\Objectbrick\Definition $brickClass
  778.      *
  779.      * @return string
  780.      */
  781.     public function getGetterCodeObjectbrick($brickClass)
  782.     {
  783.         $key = $this->getName();
  785.         if ($brickClass->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  786.             $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  787.         } else {
  788.             $typeDeclaration = '';
  789.         }
  791.         $code = '';
  792.         $code .= '/**' . "\n";
  793.         $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  794.         $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  795.         $code .= '*/' . "\n";
  796.         $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  797.         $code .= '{' . "\n";
  799.         //TODO Pimcore 11: remove method_exists BC layer
  800.         if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface ||method_exists($this, 'preGetData')) {
  801.             $code .= "\t" . '$data = $this->getDefinition()->getFieldDefinition("' . $key . '")->preGetData($this);' . "\n";
  802.         } else {
  803.             $code .= "\t" . '$data = $this->' . $key . ";\n";
  804.         }
  806.         if ($this->supportsInheritance()) {
  807.             $code .= "\t" . 'if(\Pimcore\Model\DataObject::doGetInheritedValues($this->getObject()) && $this->getDefinition()->getFieldDefinition("' . $key . '")->isEmpty($data)) {' . "\n";
  808.             $code .= "\t\t" . 'try {' . "\n";
  809.             $code .= "\t\t\t" . 'return $this->getValueFromParent("' . $key . '");' . "\n";
  810.             $code .= "\t\t" . '} catch (InheritanceParentNotFoundException $e) {' . "\n";
  811.             $code .= "\t\t\t" . '// no data from parent available, continue ...' . "\n";
  812.             $code .= "\t\t" . '}' . "\n";
  813.             $code .= "\t" . '}' . "\n";
  814.         }
  816.         $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  817.         $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  818.         $code .= "\t" . '}' . "\n\n";
  820.         $code .= "\t" . 'return $data;' . "\n";
  821.         $code .= "}\n\n";
  823.         return $code;
  824.     }
  826.     /**
  827.      * Creates setter code which is used for generation of php file for object brick classes using this data type
  828.      *
  829.      * @param DataObject\Objectbrick\Definition $brickClass
  830.      *
  831.      * @return string
  832.      */
  833.     public function getSetterCodeObjectbrick($brickClass)
  834.     {
  835.         $key = $this->getName();
  837.         if ($brickClass->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  838.             $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  839.         } else {
  840.             $typeDeclaration = '';
  841.         }
  843.         $code = '/**' . "\n";
  844.         $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  845.         $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  846.         $code .= '* @return \\Pimcore\\Model\\DataObject\\Objectbrick\\Data\\' . ucfirst($brickClass->getKey()) . "\n";
  847.         $code .= '*/' . "\n";
  848.         $code .= 'public function set' . ucfirst($key) . ' (' . $typeDeclaration . '$' . $key . ')' . "\n";
  849.         $code .= '{' . "\n";
  851.         if (
  852.             (
  853.                 $this->supportsDirtyDetection() &&
  854.                 $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  855.             ) || method_exists($this, 'preSetData')
  856.         ) {
  857.             $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  858.             $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  859.         }
  861.         if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  862.             if ($this->getDelegate()) {
  863.                 $code .= "\t" . '/** @var \\' . static::class . ' $encryptedFd */' . "\n";
  864.                 $code .= "\t" . '$encryptedFd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  865.                 $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  866.                 $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  867.                 $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  868.                 $code .= "\t" . '}' . "\n";
  869.             }
  870.         }
  872.         if ($this->supportsDirtyDetection()) {
  873.             $code .= "\t" . '$class = $this->getObject() ? $this->getObject()->getClass() : null;' . "\n";
  874.             $code .= "\t" . 'if ($class && $class->getAllowInherit()) {' . "\n";
  875.             $code .= "\t\t" . '$inheritValues = $this->getObject()::getGetInheritedValues();'."\n";
  876.             $code .= "\t\t" . '$this->getObject()::setGetInheritedValues(false);'."\n";
  877.             $code .= "\t" . '}'."\n";
  879.             $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  880.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  881.             $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  882.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  884.             $code .= "\t" . 'if($class && $class->getAllowInherit()) {' . "\n";
  885.             $code .= "\t\t" . '$this->getObject()::setGetInheritedValues($inheritValues);'."\n";
  886.             $code .= "\t" . '}' . "\n";
  887.             if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  888.                 $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  889.                 $code .= "\t" . 'if (!$isEqual) {' . "\n";
  890.                 $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  891.                 $code .= "\t" . '}' . "\n";
  892.             } else {
  893.                 $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  894.             }
  895.         }
  897.         //TODO Pimcore 11: remove method_exists BC layer
  898.         if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  899.             $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  900.         } else {
  901.             $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  902.         }
  904.         $code .= "\t" . 'return $this;' . "\n";
  905.         $code .= "}\n\n";
  907.         return $code;
  908.     }
  910.     /**
  911.      * Creates getter code which is used for generation of php file for fieldcollectionk classes using this data type
  912.      *
  913.      * @param DataObject\Fieldcollection\Definition $fieldcollectionDefinition
  914.      *
  915.      * @return string
  916.      */
  917.     public function getGetterCodeFieldcollection($fieldcollectionDefinition)
  918.     {
  919.         $key = $this->getName();
  921.         if ($fieldcollectionDefinition->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  922.             $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  923.         } else {
  924.             $typeDeclaration = '';
  925.         }
  927.         $code = '/**' . "\n";
  928.         $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  929.         $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  930.         $code .= '*/' . "\n";
  931.         $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  932.         $code .= '{' . "\n";
  934.         //TODO Pimcore 11: remove method_exists BC layer
  935.         if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface || method_exists($this, 'preGetData')) {
  936.             $code .= "\t" . '$container = $this;' . "\n";
  937.             $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  938.             $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  939.             $code .= "\t" . '$data = $fd->preGetData($container);' . "\n";
  940.         } else {
  941.             $code .= "\t" . '$data = $this->' . $key . ";\n";
  942.         }
  944.         $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  945.         $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  946.         $code .= "\t" . '}' . "\n\n";
  948.         $code .= "\t" . 'return $data;' . "\n";
  949.         $code .= "}\n\n";
  951.         return $code;
  952.     }
  954.     /**
  955.      * Creates setter code which is used for generation of php file for fieldcollection classes using this data type
  956.      *
  957.      * @param DataObject\Fieldcollection\Definition $fieldcollectionDefinition
  958.      *
  959.      * @return string
  960.      */
  961.     public function getSetterCodeFieldcollection($fieldcollectionDefinition)
  962.     {
  963.         $key = $this->getName();
  965.         if ($fieldcollectionDefinition->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  966.             $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  967.         } else {
  968.             $typeDeclaration = '';
  969.         }
  971.         $code = '/**' . "\n";
  972.         $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  973.         $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  974.         $code .= '* @return \\Pimcore\\Model\\DataObject\\Fieldcollection\\Data\\' . ucfirst($fieldcollectionDefinition->getKey()) . "\n";
  975.         $code .= '*/' . "\n";
  976.         $code .= 'public function set' . ucfirst($key) . '(' . $typeDeclaration . '$' . $key . ')' . "\n";
  977.         $code .= '{' . "\n";
  979.         if (
  980.             (
  981.                 $this->supportsDirtyDetection() &&
  982.                 $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  983.             ) || method_exists($this, 'preSetData')
  984.         ) {
  985.             $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  986.             $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  987.         }
  989.         if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  990.             if ($this->getDelegate()) {
  991.                 $code .= "\t" . '/** @var \\' . static::class . ' $encryptedFd */' . "\n";
  992.                 $code .= "\t" . '$encryptedFd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  993.                 $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  994.                 $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  995.                 $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  996.                 $code .= "\t" . '}' . "\n";
  997.             }
  998.         }
  1000.         if ($this->supportsDirtyDetection()) {
  1001.             $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  1002.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  1003.             $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  1004.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  1006.             if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  1007.                 $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  1008.                 $code .= "\t" . 'if (!$isEqual) {' . "\n";
  1009.                 $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  1010.                 $code .= "\t" . '}' . "\n";
  1011.             } else {
  1012.                 $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  1013.             }
  1014.         }
  1016.         //TODO Pimcore 11: remove method_exists BC layer
  1017.         if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  1018.             $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  1019.         } else {
  1020.             $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  1021.         }
  1023.         $code .= "\t" . 'return $this;' . "\n";
  1024.         $code .= "}\n\n";
  1026.         return $code;
  1027.     }
  1029.     /**
  1030.      * Creates getter code which is used for generation of php file for localized fields in classes using this data type
  1031.      *
  1032.      * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  1033.      *
  1034.      * @return string
  1035.      */
  1036.     public function getGetterCodeLocalizedfields($class)
  1037.     {
  1038.         $key = $this->getName();
  1040.         if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  1041.             $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  1042.         } else {
  1043.             $typeDeclaration = '';
  1044.         }
  1046.         $code = '/**' . "\n";
  1047.         $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  1048.         $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  1049.         $code .= '*/' . "\n";
  1050.         $code .= 'public function get' . ucfirst($key) . '($language = null)' . $typeDeclaration . "\n";
  1051.         $code .= '{' . "\n";
  1053.         $code .= "\t" . '$data = $this->getLocalizedfields()->getLocalizedValue("' . $key . '", $language);' . "\n";
  1055.         if (!$class instanceof DataObject\Fieldcollection\Definition) {
  1056.             $code .= $this->getPreGetValueHookCode($key);
  1057.         }
  1059.         $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  1060.         $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  1061.         $code .= "\t" . '}' . "\n\n";
  1063.         // we don't need to consider preGetData, because this is already managed directly by the localized fields within getLocalizedValue()
  1065.         $code .= "\t" . 'return $data;' . "\n";
  1066.         $code .= "}\n\n";
  1068.         return $code;
  1069.     }
  1071.     /**
  1072.      * Creates setter code which is used for generation of php file for localized fields in classes using this data type
  1073.      *
  1074.      * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  1075.      *
  1076.      * @return string
  1077.      */
  1078.     public function getSetterCodeLocalizedfields($class)
  1079.     {
  1080.         $key = $this->getName();
  1081.         if ($class instanceof DataObject\Objectbrick\Definition) {
  1082.             $classname = 'Objectbrick\\Data\\' . ucfirst($class->getKey());
  1083.             $containerGetter = 'getDefinition';
  1084.         } elseif ($class instanceof DataObject\Fieldcollection\Definition) {
  1085.             $classname = 'Fieldcollection\\Data\\' . ucfirst($class->getKey());
  1086.             $containerGetter = 'getDefinition';
  1087.         } else {
  1088.             $classname = $class->getName();
  1089.             $containerGetter = 'getClass';
  1090.         }
  1092.         if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  1093.             $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  1094.         } else {
  1095.             $typeDeclaration = '';
  1096.         }
  1098.         $code = '/**' . "\n";
  1099.         $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  1100.         $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  1101.         $code .= '* @return \\Pimcore\\Model\\DataObject\\' . ucfirst($classname) . "\n";
  1102.         $code .= '*/' . "\n";
  1103.         $code .= 'public function set' . ucfirst($key) . ' (' . $typeDeclaration . '$' . $key . ', $language = null)' . "\n";
  1104.         $code .= '{' . "\n";
  1106.         if ($this->supportsDirtyDetection()) {
  1107.             $code .= "\t" . '$fd = $this->' . $containerGetter . '()->getFieldDefinition("localizedfields")->getFieldDefinition("' . $key . '");' . "\n";
  1108.         }
  1110.         if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  1111.             if ($this->getDelegate()) {
  1112.                 $code .= "\t" . '$encryptedFd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  1113.                 $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  1114.                 $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  1115.                 $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  1116.                 $code .= "\t" . '}' . "\n";
  1117.             }
  1118.         }
  1120.         if ($this->supportsDirtyDetection()) {
  1121.             if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  1122.                 $code .= "\t" . '$inheritValues = self::getGetInheritedValues();'."\n";
  1123.                 $code .= "\t" . 'self::setGetInheritedValues(false);'."\n";
  1124.             }
  1126.             $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  1127.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  1128.             $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '($language);' . "\n";
  1129.             $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  1131.             if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  1132.                 $code .= "\t" . 'self::setGetInheritedValues($inheritValues);'."\n";
  1133.             }
  1134.             if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  1135.                 $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  1136.             } else {
  1137.                 $code .= "\t" . '$isEqual = false;' . "\n";
  1138.             }
  1140.             $code .= "\t" . 'if (!$isEqual) {' . "\n";
  1141.             $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  1142.             $code .= "\t" . '}' . "\n";
  1143.         } else {
  1144.             $code .= "\t" . '$isEqual = false;' . "\n";
  1145.         }
  1147.         $code .= "\t" . '$this->getLocalizedfields()->setLocalizedValue("' . $key . '", $' . $key . ', $language, !$isEqual)' . ";\n\n";
  1149.         $code .= "\t" . 'return $this;' . "\n";
  1150.         $code .= "}\n\n";
  1152.         return $code;
  1153.     }
  1155.     /**
  1156.      * Creates filter method code for listing classes
  1157.      *
  1158.      * @return string
  1159.      */
  1160.     public function getFilterCode()
  1161.     {
  1162.         $key = $this->getName();
  1164.         $code = '/**' . "\n";
  1165.         $code .= '* Filter by ' . str_replace(['/**', '*/', '//'], '', $key) . ' (' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . ")\n";
  1167.         $dataParamDoc = 'mixed $data';
  1168.         $reflectionMethod = new \ReflectionMethod($this, 'addListingFilter');
  1169.         $docComment = $reflectionMethod->getDocComment();
  1170.         if ($docComment && preg_match('/@param\s+([^\s]+)\s+\$data(.*)/', $docComment, $dataParam)) {
  1171.             $dataParamDoc = $dataParam[1].' $data '.$dataParam[2];
  1172.         }
  1174.         $operatorParamDoc = 'string $operator SQL comparison operator, e.g. =, <, >= etc. You can use "?" as placeholder, e.g. "IN (?)"';
  1175.         if ($docComment && preg_match('/@param\s+([^\s]+)\s+\$operator(.*)/', $docComment, $dataParam)) {
  1176.             $operatorParamDoc = $dataParam[1].' $operator '.$dataParam[2];
  1177.         }
  1179.         $code .= '* @param '.$dataParamDoc."\n";
  1180.         $code .= '* @param '.$operatorParamDoc."\n";
  1181.         $code .= '* @return static'."\n";
  1182.         $code .= '*/' . "\n";
  1184.         $code .= 'public function filterBy' . ucfirst($key) .' ($data, $operator = \'=\')' . "\n";
  1185.         $code .= '{' . "\n";
  1186.         $code .= "\t" . '$this->getClass()->getFieldDefinition("' . $key . '")->addListingFilter($this, $data, $operator);' . "\n";
  1187.         $code .= "\treturn " . '$this' . ";\n";
  1188.         $code .= "}\n\n";
  1190.         return $code;
  1191.     }
  1193.     /**
  1194.      * @param mixed $number
  1195.      *
  1196.      * @return int|null
  1197.      */
  1198.     public function getAsIntegerCast($number)
  1199.     {
  1200.         return strlen((string) $number) === 0 ? null : (int)$number;
  1201.     }
  1203.     /**
  1204.      * @param mixed $number
  1205.      *
  1206.      * @return float|null
  1207.      */
  1208.     public function getAsFloatCast($number)
  1209.     {
  1210.         return strlen((string) $number) === 0 ? null : (float)$number;
  1211.     }
  1213.     /**
  1214.      * @param mixed $data
  1215.      * @param DataObject\Concrete|null $object
  1216.      * @param mixed $params
  1217.      *
  1218.      * @return string
  1219.      */
  1220.     public function getVersionPreview($data, $object = null, $params = [])
  1221.     {
  1222.         return 'no preview';
  1223.     }
  1225.     /**
  1226.      * @param mixed $data
  1227.      *
  1228.      * @return bool
  1229.      */
  1230.     public function isEmpty($data)
  1231.     {
  1232.         return empty($data);
  1233.     }
  1235.     /** True if change is allowed in edit mode.
  1236.      * @param DataObject\Concrete $object
  1237.      * @param mixed $params
  1238.      *
  1239.      * @return bool
  1240.      */
  1241.     public function isDiffChangeAllowed($object, $params = [])
  1242.     {
  1243.         return false;
  1244.     }
  1246.     /** Converts the data sent from the object merger back to the internal object. Similar to
  1247.      * getDiffDataForEditMode() an array of data elements is passed in containing the following attributes:
  1248.      *  - "field" => the name of (this) field
  1249.      *  - "key" => the key of the data element
  1250.      *  - "data" => the data
  1251.      *
  1252.      * @param array $data
  1253.      * @param DataObject\Concrete|null $object
  1254.      * @param mixed $params
  1255.      *
  1256.      * @return mixed
  1257.      */
  1258.     public function getDiffDataFromEditmode($data, $object = null, $params = [])
  1259.     {
  1260.         $thedata = $this->getDataFromEditmode($data[0]['data'], $object, $params);
  1262.         return $thedata;
  1263.     }
  1265.     /**
  1266.      * Returns the data for the editmode in the format expected by the object merger plugin.
  1267.      * The return value is a list of data definitions containing the following attributes:
  1268.      *      - "field" => the name of the object field
  1269.      *      - "key" => a unique key identifying the data element
  1270.      *      - "type" => the type of the data component
  1271.      *      - "value" => the value used as preview
  1272.      *      - "data" => the actual data which is then sent back again by the editor. Note that the data is opaque
  1273.      *                          and will not be touched by the editor in any way.
  1274.      *      - "disabled" => whether the data element can be edited or not
  1275.      *      - "title" => pretty name describing the data element
  1276.      *
  1277.      *
  1278.      * @param mixed $data
  1279.      * @param DataObject\Concrete|null $object
  1280.      * @param mixed $params
  1281.      *
  1282.      * @return null|array
  1283.      */
  1284.     public function getDiffDataForEditMode($data, $object = null, $params = [])
  1285.     {
  1286.         $diffdata = [];
  1287.         $diffdata['data'] = $this->getDataForEditmode($data, $object, $params);
  1288.         $diffdata['disabled'] = !($this->isDiffChangeAllowed($object));
  1289.         $diffdata['field'] = $this->getName();
  1290.         $diffdata['key'] = $this->getName();
  1291.         $diffdata['type'] = $this->fieldtype;
  1293.         if (method_exists($this, 'getDiffVersionPreview')) {
  1294.             $value = $this->getDiffVersionPreview($data, $object, $params);
  1295.         } else {
  1296.             $value = $this->getVersionPreview($data, $object, $params);
  1297.         }
  1299.         $diffdata['title'] = !empty($this->title) ? $this->title : $this->name;
  1300.         $diffdata['value'] = $value;
  1302.         $result = [];
  1303.         $result[] = $diffdata;
  1305.         return $result;
  1306.     }
  1308.     /**
  1309.      * @return bool
  1310.      */
  1311.     public function getUnique()
  1312.     {
  1313.         return false;
  1314.     }
  1316.     /**
  1317.      * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  1318.      * @param array $params
  1319.      *
  1320.      * @return mixed
  1321.      *
  1322.      * @throws \Exception
  1323.      */
  1324.     protected function getDataFromObjectParam($object, $params = [])
  1325.     {
  1326.         $data = null;
  1328.         if (array_key_exists('injectedData', $params)) {
  1329.             return $params['injectedData'];
  1330.         }
  1332.         $context = $params['context'] ?? null;
  1334.         if (isset($context['containerType'])) {
  1335.             if ($context['containerType'] === 'fieldcollection' || $context['containerType'] === 'block') {
  1336.                 if ($this instanceof DataObject\ClassDefinition\Data\Localizedfields || $object instanceof DataObject\Localizedfield) {
  1337.                     $fieldname = $context['fieldname'];
  1338.                     $index = $context['index'] ?? null;
  1340.                     if ($object instanceof DataObject\Concrete) {
  1341.                         $containerGetter = 'get' . ucfirst($fieldname);
  1342.                         $container = $object->$containerGetter();
  1343.                         if (!$container && $context['containerType'] === 'block') {
  1344.                             // no data, so check if inheritance is enabled + there is parent value
  1345.                             if ($object->getClass()->getAllowInherit()) {
  1346.                                 try {
  1347.                                     $container = $object->getValueFromParent($fieldname);
  1348.                                 } catch (InheritanceParentNotFoundException $e) {
  1349.                                     //nothing to do here - just no parent data available
  1350.                                 }
  1351.                             }
  1352.                         }
  1354.                         if ($container) {
  1355.                             $originalIndex = $context['oIndex'] ?? null;
  1357.                             // field collection or block items
  1358.                             if ($originalIndex !== null) {
  1359.                                 if ($context['containerType'] === 'block') {
  1360.                                     $items = $container;
  1361.                                 } else {
  1362.                                     $items = $container->getItems();
  1363.                                 }
  1365.                                 if ($items && (count($items) > $originalIndex || count($items) > --$originalIndex)) {
  1366.                                     $item = $items[$originalIndex];
  1368.                                     if ($context['containerType'] === 'block') {
  1369.                                         $data = $item[$this->getName()] ?? null;
  1370.                                         if ($data instanceof DataObject\Data\BlockElement) {
  1371.                                             $data = $data->getData();
  1373.                                             return $data;
  1374.                                         }
  1375.                                     } else {
  1376.                                         $getter = 'get' . ucfirst($this->getName());
  1377.                                         $data = $item->$getter();
  1378.                                     }
  1380.                                     return $data;
  1381.                                 }
  1383.                                 throw new \Exception('object seems to be modified, item with orginal index ' . $originalIndex . ' not found, new index: ' . $index);
  1384.                             } else {
  1385.                                 return null;
  1386.                             }
  1387.                         } else {
  1388.                             return null;
  1389.                         }
  1390.                     } elseif ($object instanceof DataObject\Localizedfield) {
  1391.                         $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1393.                         return $data;
  1394.                     }
  1395.                 }
  1396.             } elseif ($context['containerType'] === 'objectbrick' && ($this instanceof DataObject\ClassDefinition\Data\Localizedfields || $object instanceof DataObject\Localizedfield)) {
  1397.                 $fieldname = $context['fieldname'];
  1399.                 if ($object instanceof DataObject\Concrete) {
  1400.                     $containerGetter = 'get' . ucfirst($fieldname);
  1401.                     $container = $object->$containerGetter();
  1402.                     if ($container) {
  1403.                         $brickGetter = 'get' . ucfirst($context['containerKey']);
  1404.                         $brickData = $container->$brickGetter();
  1406.                         if ($brickData instanceof DataObject\Objectbrick\Data\AbstractData) {
  1407.                             return $brickData->get('localizedfields');
  1408.                         }
  1409.                     }
  1411.                     return null;
  1412.                 } elseif ($object instanceof DataObject\Localizedfield) {
  1413.                     $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1415.                     return $data;
  1416.                 }
  1417.             } elseif ($context['containerType'] === 'classificationstore') {
  1418.                 $fieldname = $context['fieldname'];
  1419.                 $getter = 'get' . ucfirst($fieldname);
  1420.                 if (method_exists($object, $getter)) {
  1421.                     $groupId = $context['groupId'];
  1422.                     $keyId = $context['keyId'];
  1423.                     $language = $context['language'];
  1425.                     /** @var DataObject\Classificationstore $classificationStoreData */
  1426.                     $classificationStoreData = $object->$getter();
  1427.                     $data = $classificationStoreData->getLocalizedKeyValue($groupId, $keyId, $language, true, true);
  1429.                     return $data;
  1430.                 }
  1431.             }
  1432.         }
  1434.         $container = $object;
  1436.         $getter = 'get' . ucfirst($this->getName());
  1437.         if (method_exists($container, $getter)) { // for DataObject\Concrete, DataObject\Fieldcollection\Data\AbstractData, DataObject\Objectbrick\Data\AbstractData
  1438.             $data = $container->$getter();
  1439.         } elseif ($object instanceof DataObject\Localizedfield) {
  1440.             $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1441.         }
  1443.         return $data;
  1444.     }
  1446.     /**
  1447.      * @param DataObject\ClassDefinition\Data $mainDefinition
  1448.      */
  1449.     public function synchronizeWithMainDefinition(DataObject\ClassDefinition\Data $mainDefinition)
  1450.     {
  1451.         // implement in child classes
  1452.     }
  1454.     /**
  1455.      * @deprecated will be removed in Pimcore 11
  1456.      *
  1457.      * @param DataObject\ClassDefinition\Data $masterDefinition
  1458.      */
  1459.     public function synchronizeWithMasterDefinition(DataObject\ClassDefinition\Data $masterDefinition)
  1460.     {
  1461.         trigger_deprecation(
  1462.             'pimcore/pimcore',
  1463.             '10.6.0',
  1464.             sprintf('%s is deprecated and will be removed in Pimcore 11. Use %s instead.', __METHOD__, str_replace('Master', 'Main', __METHOD__))
  1465.         );
  1467.         $this->synchronizeWithMainDefinition($masterDefinition);
  1468.     }
  1470.     /**
  1471.      * @param DataObject\ClassDefinition\Data $mainDefinition
  1472.      */
  1473.     public function adoptMainDefinition(DataObject\ClassDefinition\Data $mainDefinition)
  1474.     {
  1475.         $vars = get_object_vars($this);
  1476.         $protectedFields = ['noteditable', 'invisible'];
  1477.         foreach ($vars as $name => $value) {
  1478.             if (!in_array($name, $protectedFields)) {
  1479.                 unset($this->$name);
  1480.             }
  1481.         }
  1482.         $vars = get_object_vars($mainDefinition);
  1483.         foreach ($vars as $name => $value) {
  1484.             if (!in_array($name, $protectedFields)) {
  1485.                 $this->$name = $value;
  1486.             }
  1487.         }
  1488.     }
  1490.     /**
  1491.      * @deprecated will be removed in Pimcore 11
  1492.      *
  1493.      * @param DataObject\ClassDefinition\Data $masterDefinition
  1494.      */
  1495.     public function adoptMasterDefinition(DataObject\ClassDefinition\Data $masterDefinition)
  1496.     {
  1497.         $vars = get_object_vars($this);
  1498.         $protectedFields = ['noteditable', 'invisible'];
  1499.         foreach ($vars as $name => $value) {
  1500.             if (!in_array($name, $protectedFields)) {
  1501.                 unset($this->$name);
  1502.             }
  1503.         }
  1504.         $vars = get_object_vars($masterDefinition);
  1505.         foreach ($vars as $name => $value) {
  1506.             if (!in_array($name, $protectedFields)) {
  1507.                 $this->$name = $value;
  1508.             }
  1509.         }
  1510.     }
  1512.     /**
  1513.      * @param array|null $existingData
  1514.      * @param array $additionalData
  1515.      *
  1516.      * @return array|null
  1517.      */
  1518.     public function appendData($existingData, $additionalData)
  1519.     {
  1520.         return $existingData;
  1521.     }
  1523.     /**
  1524.      * @param mixed $existingData
  1525.      * @param mixed $removeData
  1526.      *
  1527.      * @return mixed
  1528.      */
  1529.     public function removeData($existingData, $removeData)
  1530.     {
  1531.         return $existingData;
  1532.     }
  1534.     /**
  1535.      * Returns if datatype supports data inheritance
  1536.      *
  1537.      * @return bool
  1538.      */
  1539.     public function supportsInheritance()
  1540.     {
  1541.         return true;
  1542.     }
  1544.     /**
  1545.      * @return bool
  1546.      */
  1547.     public function supportsDirtyDetection()
  1548.     {
  1549.         return false;
  1550.     }
  1552.     /**
  1553.      * @param DataObject\Concrete $object
  1554.      */
  1555.     public function markLazyloadedFieldAsLoaded($object)
  1556.     {
  1557.         if ($object instanceof DataObject\LazyLoadedFieldsInterface) {
  1558.             $object->markLazyKeyAsLoaded($this->getName());
  1559.         }
  1560.     }
  1562.     /**
  1563.      * Returns if datatype supports listing filters: getBy, filterBy
  1564.      *
  1565.      * @return bool
  1566.      */
  1567.     public function isFilterable(): bool
  1568.     {
  1569.         return false;
  1570.     }
  1572.     /**
  1573.      * @param DataObject\Listing $listing
  1574.      * @param string|int|float|array|Model\Element\ElementInterface $data comparison data, can be scalar or array (if operator is e.g. "IN (?)")
  1575.      * @param string $operator SQL comparison operator, e.g. =, <, >= etc. You can use "?" as placeholder, e.g. "IN (?)"
  1576.      *
  1577.      * @return DataObject\Listing
  1578.      */
  1579.     public function addListingFilter(DataObject\Listing $listing, $data, $operator = '=')
  1580.     {
  1581.         return $listing->addFilterByField($this->getName(), $operator, $data);
  1582.     }
  1584.     /**
  1585.      * @return bool
  1586.      */
  1587.     public function isForbiddenName()
  1588.     {
  1589.         return in_array($this->getName(), self::FORBIDDEN_NAMES);
  1590.     }
  1591. }