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\Model;
  19. use Pimcore\Model\DataObject;
  20. use Pimcore\Model\DataObject\Exception\InheritanceParentNotFoundException;
  22. abstract class Data implements DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface
  23. {
  24. use DataObject\ClassDefinition\Helper\VarExport;
  26. /**
  27. * @var string
  28. */
  29. public $name;
  31. /**
  32. * @var string
  33. */
  34. public $title;
  36. /**
  37. * @var string
  38. */
  39. public $tooltip;
  41. /**
  42. * @var bool
  43. */
  44. public $mandatory;
  46. /**
  47. * @var bool
  48. */
  49. public $noteditable;
  51. /**
  52. * @var int
  53. */
  54. public $index;
  56. /**
  57. * @var bool
  58. */
  59. public $locked;
  61. /**
  62. * @var string
  63. */
  64. public $style;
  66. /**
  67. * @var array
  68. */
  69. public $permissions;
  71. /**
  72. * @var string
  73. */
  74. public $datatype = 'data';
  76. /**
  77. * @var string
  78. */
  79. public $fieldtype;
  81. /**
  82. * @var bool
  83. */
  84. public $relationType = false;
  86. /**
  87. * @var bool
  88. */
  89. public $invisible = false;
  91. /**
  92. * @var bool
  93. */
  94. public $visibleGridView = true;
  96. /**
  97. * @var bool
  98. */
  99. public $visibleSearch = true;
  101. /**
  102. * @var array
  103. */
  104. public static $validFilterOperators = [
  105. 'LIKE',
  106. 'NOT LIKE',
  107. '=',
  108. 'IS',
  109. 'IS NOT',
  110. '!=',
  111. '<',
  112. '>',
  113. '>=',
  114. '<=',
  115. ];
  117. /**
  118. * @var array
  119. */
  120. protected $forbiddenNames = [
  121. 'id', 'key', 'path', 'type', 'index', 'classname', 'creationdate', 'userowner', 'value', 'class', 'list',
  122. 'fullpath', 'childs', 'values', 'cachetag', 'cachetags', 'parent', 'published', 'valuefromparent',
  123. 'userpermissions', 'dependencies', 'modificationdate', 'usermodification', 'byid', 'bypath', 'data',
  124. 'versions', 'properties', 'permissions', 'permissionsforuser', 'childamount', 'apipluginbroker', 'resource',
  125. 'parentClass', 'definition', 'locked', 'language', 'omitmandatorycheck', 'idpath', 'object', 'fieldname',
  126. 'property', 'parentid', 'children', 'scheduledtasks',
  127. ];
  129. /**
  130. * Returns the data for the editmode
  131. *
  132. * @param mixed $data
  133. * @param null|DataObject\AbstractObject $object
  134. * @param mixed $params
  135. *
  136. * @return mixed
  137. */
  138. abstract public function getDataForEditmode($data, $object = null, $params = []);
  140. /**
  141. * Converts data from editmode to internal eg. Image-Id to Asset\Image object
  142. *
  143. * @param mixed $data
  144. * @param null|DataObject\AbstractObject $object
  145. * @param mixed $params
  146. *
  147. * @return mixed
  148. */
  149. abstract public function getDataFromEditmode($data, $object = null, $params = []);
  151. /**
  152. * Checks if data is valid for current data field
  153. *
  154. * @param mixed $data
  155. * @param bool $omitMandatoryCheck
  156. * @param array $params
  157. *
  158. * @throws \Exception
  159. */
  160. public function checkValidity($data, $omitMandatoryCheck = false, $params = [])
  161. {
  162. $isEmpty = true;
  164. // this is to do not treated "0" as empty
  165. if (is_string($data) || is_numeric($data)) {
  166. if (strlen($data) > 0) {
  167. $isEmpty = false;
  168. }
  169. }
  171. if (!empty($data)) {
  172. $isEmpty = false;
  173. }
  175. if (!$omitMandatoryCheck && $this->getMandatory() && $isEmpty) {
  176. throw new Model\Element\ValidationException('Empty mandatory field [ ' . $this->getName() . ' ]');
  177. }
  178. }
  180. /**
  181. * converts object data to a simple string value or CSV Export
  182. *
  183. * @internal
  184. *
  185. * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  186. * @param array $params
  187. *
  188. * @return string
  189. */
  190. public function getForCsvExport($object, $params = [])
  191. {
  192. return $this->getDataFromObjectParam($object, $params);
  193. }
  195. /**
  196. * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  197. * @param mixed $params
  198. *
  199. * @return string
  200. */
  201. public function getDataForSearchIndex($object, $params = [])
  202. {
  203. // this is the default, but csv doesn't work for all data types
  204. return $this->getForCsvExport($object, $params);
  205. }
  207. /**
  208. * @return string
  209. */
  210. public function getName()
  211. {
  212. return $this->name;
  213. }
  215. /**
  216. * @return string
  217. */
  218. public function getTitle()
  219. {
  220. return $this->title;
  221. }
  223. /**
  224. * @return bool
  225. */
  226. public function getMandatory()
  227. {
  228. return $this->mandatory;
  229. }
  231. /**
  232. * @return array
  233. */
  234. public function getPermissions()
  235. {
  236. return $this->permissions;
  237. }
  239. /**
  240. * @param string $name
  241. *
  242. * @return $this
  243. */
  244. public function setName($name)
  245. {
  246. $this->name = $name;
  248. return $this;
  249. }
  251. /**
  252. * @param string $title
  253. *
  254. * @return $this
  255. */
  256. public function setTitle($title)
  257. {
  258. $this->title = $title;
  260. return $this;
  261. }
  263. /**
  264. * @param bool $mandatory
  265. *
  266. * @return $this
  267. */
  268. public function setMandatory($mandatory)
  269. {
  270. $this->mandatory = (bool)$mandatory;
  272. return $this;
  273. }
  275. /**
  276. * @param array $permissions
  277. *
  278. * @return $this
  279. */
  280. public function setPermissions($permissions)
  281. {
  282. $this->permissions = $permissions;
  284. return $this;
  285. }
  287. /**
  288. * @param array $data
  289. * @param array $blockedKeys
  290. *
  291. * @return $this
  292. */
  293. public function setValues($data = [], $blockedKeys = [])
  294. {
  295. foreach ($data as $key => $value) {
  296. if (!in_array($key, $blockedKeys)) {
  297. $method = 'set' . $key;
  298. if (method_exists($this, $method)) {
  299. $this->$method($value);
  300. }
  301. }
  302. }
  304. return $this;
  305. }
  307. /**
  308. * @return string
  309. */
  310. public function getDatatype()
  311. {
  312. return $this->datatype;
  313. }
  315. /**
  316. * @param string $datatype
  317. *
  318. * @return $this
  319. */
  320. public function setDatatype($datatype)
  321. {
  322. $this->datatype = $datatype;
  324. return $this;
  325. }
  327. /**
  328. * @return string
  329. */
  330. public function getFieldtype()
  331. {
  332. return $this->fieldtype;
  333. }
  335. /**
  336. * @return bool
  337. */
  338. public function getNoteditable()
  339. {
  340. return $this->noteditable;
  341. }
  343. /**
  344. * @param bool $noteditable
  345. *
  346. * @return $this
  347. */
  348. public function setNoteditable($noteditable)
  349. {
  350. $this->noteditable = (bool)$noteditable;
  352. return $this;
  353. }
  355. /**
  356. * @return int
  357. */
  358. public function getIndex()
  359. {
  360. return $this->index;
  361. }
  363. /**
  364. * @param int $index
  365. *
  366. * @return $this
  367. */
  368. public function setIndex($index)
  369. {
  370. $this->index = $index;
  372. return $this;
  373. }
  375. /**
  376. *
  377. * @return string
  378. */
  379. public function getStyle()
  380. {
  381. return $this->style;
  382. }
  384. /**
  385. * @param string|null $style
  386. *
  387. * @return $this
  388. */
  389. public function setStyle($style)
  390. {
  391. $this->style = (string)$style;
  393. return $this;
  394. }
  396. /**
  397. *
  398. * @return bool
  399. */
  400. public function getLocked()
  401. {
  402. return $this->locked;
  403. }
  405. /**
  406. * @param int|bool|null $locked
  407. *
  408. * @return $this
  409. */
  410. public function setLocked($locked)
  411. {
  412. $this->locked = (bool)$locked;
  414. return $this;
  415. }
  417. /**
  418. *
  419. * @return string
  420. */
  421. public function getTooltip()
  422. {
  423. return $this->tooltip;
  424. }
  426. /**
  427. * @param string|null $tooltip
  428. *
  429. * @return $this
  430. */
  431. public function setTooltip($tooltip)
  432. {
  433. $this->tooltip = (string)$tooltip;
  435. return $this;
  436. }
  438. /**
  439. *
  440. * @return bool
  441. */
  442. public function isRelationType()
  443. {
  444. return $this->relationType;
  445. }
  447. /**
  448. * @return bool
  449. */
  450. public function getInvisible()
  451. {
  452. return $this->invisible;
  453. }
  455. /**
  456. * @param bool|int|null $invisible
  457. *
  458. * @return $this
  459. */
  460. public function setInvisible($invisible)
  461. {
  462. $this->invisible = (bool)$invisible;
  464. return $this;
  465. }
  467. /**
  468. * @return bool
  469. */
  470. public function getVisibleGridView()
  471. {
  472. return $this->visibleGridView;
  473. }
  475. /**
  476. * @param bool|int|null $visibleGridView
  477. *
  478. * @return $this
  479. */
  480. public function setVisibleGridView($visibleGridView)
  481. {
  482. $this->visibleGridView = (bool)$visibleGridView;
  484. return $this;
  485. }
  487. /**
  488. * @return bool
  489. */
  490. public function getVisibleSearch()
  491. {
  492. return $this->visibleSearch;
  493. }
  495. /**
  496. * @param bool|int|null $visibleSearch
  497. *
  498. * @return $this
  499. */
  500. public function setVisibleSearch($visibleSearch)
  501. {
  502. $this->visibleSearch = (bool)$visibleSearch;
  504. return $this;
  505. }
  507. /**
  508. * @param mixed $data
  509. * @param array $tags
  510. *
  511. * @return array
  512. */
  513. public function getCacheTags($data, array $tags = [])
  514. {
  515. return $tags;
  516. }
  518. /**
  519. * @param mixed $data
  520. *
  521. * @return array
  522. */
  523. public function resolveDependencies($data)
  524. {
  525. return [];
  526. }
  528. /**
  529. * returns sql query statement to filter according to this data types value(s)
  530. *
  531. * @param mixed $value
  532. * @param string $operator
  533. * @param mixed $params
  534. *
  535. * @return string
  536. *
  537. */
  538. public function getFilterCondition($value, $operator, $params = [])
  539. {
  540. $params['name'] = $this->name;
  542. return $this->getFilterConditionExt(
  543. $value,
  544. $operator,
  545. $params
  546. );
  547. }
  549. /**
  550. * returns sql query statement to filter according to this data types value(s)
  551. *
  552. * @param string|array|object $value
  553. * @param string $operator
  554. * @param array $params optional params used to change the behavior
  555. *
  556. * @return string
  557. */
  558. public function getFilterConditionExt($value, $operator, $params = [])
  559. {
  560. $db = \Pimcore\Db::get();
  561. $name = $params['name'] ? $params['name'] : $this->name;
  562. $key = $db->quoteIdentifier($name);
  563. if (!empty($params['brickPrefix'])) {
  564. $key = $params['brickPrefix'].$key;
  565. }
  567. if ($value === 'NULL') {
  568. if ($operator === '=') {
  569. $operator = 'IS';
  570. } elseif ($operator === '!=') {
  571. $operator = 'IS NOT';
  572. }
  573. } elseif (!is_array($value) && !is_object($value)) {
  574. if ($operator === 'LIKE') {
  575. $value = $db->quote('%' . $value . '%');
  576. } else {
  577. $value = $db->quote($value);
  578. }
  579. }
  581. if (in_array($operator, DataObject\ClassDefinition\Data::$validFilterOperators)) {
  582. return $key . ' ' . $operator . ' ' . $value . ' ';
  583. }
  585. return '';
  586. }
  588. /**
  589. * @param string $key
  590. *
  591. * @return string
  592. */
  593. protected function getPreGetValueHookCode(string $key): string
  594. {
  595. $code = "\t" . 'if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {' . "\n";
  596. $code .= "\t\t" . '$preValue = $this->preGetValue("' . $key . '");' . "\n";
  597. $code .= "\t\t" . 'if ($preValue !== null) {' . "\n";
  598. $code .= "\t\t\t" . 'return $preValue;' . "\n";
  599. $code .= "\t\t" . '}' . "\n";
  600. $code .= "\t" . '}' . "\n\n";
  602. return $code;
  603. }
  605. /**
  606. * Creates getter code which is used for generation of php file for object classes using this data type
  607. *
  608. * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  609. *
  610. * @return string
  611. */
  612. public function getGetterCode($class)
  613. {
  614. $key = $this->getName();
  616. if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  617. $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  618. } else {
  619. $typeDeclaration = '';
  620. }
  622. $code = '/**' . "\n";
  623. $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  624. $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  625. $code .= '*/' . "\n";
  626. $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  627. $code .= '{' . "\n";
  629. $code .= $this->getPreGetValueHookCode($key);
  631. //TODO Pimcore 11: remove method_exists BC layer
  632. if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface ||method_exists($this, 'preGetData')) {
  633. $code .= "\t" . '$data = $this->getClass()->getFieldDefinition("' . $key . '")->preGetData($this);' . "\n\n";
  634. } else {
  635. $code .= "\t" . '$data = $this->' . $key . ";\n\n";
  636. }
  638. // insert this line if inheritance from parent objects is allowed
  639. if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit() && $this->supportsInheritance()) {
  640. $code .= "\t" . 'if (\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("' . $key . '")->isEmpty($data)) {' . "\n";
  641. $code .= "\t\t" . 'try {' . "\n";
  642. $code .= "\t\t\t" . 'return $this->getValueFromParent("' . $key . '");' . "\n";
  643. $code .= "\t\t" . '} catch (InheritanceParentNotFoundException $e) {' . "\n";
  644. $code .= "\t\t\t" . '// no data from parent available, continue ...' . "\n";
  645. $code .= "\t\t" . '}' . "\n";
  646. $code .= "\t" . '}' . "\n\n";
  647. }
  649. $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  650. $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  651. $code .= "\t" . '}' . "\n\n";
  653. $code .= "\t" . 'return $data;' . "\n";
  654. $code .= "}\n\n";
  656. return $code;
  657. }
  659. /**
  660. * Creates setter code which is used for generation of php file for object classes using this data type
  661. *
  662. * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  663. *
  664. * @return string
  665. */
  666. public function getSetterCode($class)
  667. {
  668. if ($class instanceof DataObject\Objectbrick\Definition) {
  669. $classname = 'Objectbrick\\Data\\' . ucfirst($class->getKey());
  670. } elseif ($class instanceof DataObject\Fieldcollection\Definition) {
  671. $classname = 'Fieldcollection\\Data\\' . ucfirst($class->getKey());
  672. } else {
  673. $classname = $class->getName();
  674. }
  676. $key = $this->getName();
  678. if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  679. $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  680. } else {
  681. $typeDeclaration = '';
  682. }
  684. $code = '/**' . "\n";
  685. $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  686. $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  687. $code .= '* @return \\Pimcore\\Model\\DataObject\\' . ucfirst($classname) . "\n";
  688. $code .= '*/' . "\n";
  689. $code .= 'public function set' . ucfirst($key) . '(' . $typeDeclaration . '$' . $key . ')' . "\n";
  690. $code .= '{' . "\n";
  692. if (
  693. (
  694. $this->supportsDirtyDetection() &&
  695. $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  696. ) || method_exists($this, 'preSetData')
  697. ) {
  698. $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  699. $code .= "\t" . '$fd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  700. }
  702. if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  703. if ($this->getDelegate()) {
  704. $code .= "\t" . '$encryptedFd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  705. $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  706. $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  707. $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  708. $code .= "\t" . '}' . "\n";
  709. }
  710. }
  712. if ($this->supportsDirtyDetection()) {
  713. if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  714. $code .= "\t" . '$inheritValues = self::getGetInheritedValues();'."\n";
  715. $code .= "\t" . 'self::setGetInheritedValues(false);'."\n";
  716. }
  718. $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  719. $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  720. $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  721. $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  723. if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  724. $code .= "\t" . 'self::setGetInheritedValues($inheritValues);'."\n";
  725. }
  726. if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  727. $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  728. $code .= "\t" . 'if (!$isEqual) {' . "\n";
  729. $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  730. $code .= "\t" . '}' . "\n";
  731. } else {
  732. $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  733. }
  734. }
  736. //TODO Pimcore 11: remove method_exists BC layer
  737. if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  738. $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  739. } else {
  740. $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  741. }
  743. $code .= "\t" . 'return $this;' . "\n";
  744. $code .= "}\n\n";
  746. return $code;
  747. }
  749. /**
  750. * Creates getter code which is used for generation of php file for object brick classes using this data type
  751. *
  752. * @param DataObject\Objectbrick\Definition $brickClass
  753. *
  754. * @return string
  755. */
  756. public function getGetterCodeObjectbrick($brickClass)
  757. {
  758. $key = $this->getName();
  760. if ($brickClass->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  761. $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  762. } else {
  763. $typeDeclaration = '';
  764. }
  766. $code = '';
  767. $code .= '/**' . "\n";
  768. $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  769. $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  770. $code .= '*/' . "\n";
  771. $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  772. $code .= '{' . "\n";
  774. //TODO Pimcore 11: remove method_exists BC layer
  775. if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface ||method_exists($this, 'preGetData')) {
  776. $code .= "\t" . '$data = $this->getDefinition()->getFieldDefinition("' . $key . '")->preGetData($this);' . "\n";
  777. } else {
  778. $code .= "\t" . '$data = $this->' . $key . ";\n";
  779. }
  781. if ($this->supportsInheritance()) {
  782. $code .= "\t" . 'if(\Pimcore\Model\DataObject::doGetInheritedValues($this->getObject()) && $this->getDefinition()->getFieldDefinition("' . $key . '")->isEmpty($data)) {' . "\n";
  783. $code .= "\t\t" . 'try {' . "\n";
  784. $code .= "\t\t\t" . 'return $this->getValueFromParent("' . $key . '");' . "\n";
  785. $code .= "\t\t" . '} catch (InheritanceParentNotFoundException $e) {' . "\n";
  786. $code .= "\t\t\t" . '// no data from parent available, continue ...' . "\n";
  787. $code .= "\t\t" . '}' . "\n";
  788. $code .= "\t" . '}' . "\n";
  789. }
  791. $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  792. $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  793. $code .= "\t" . '}' . "\n\n";
  795. $code .= "\t" . 'return $data;' . "\n";
  796. $code .= "}\n\n";
  798. return $code;
  799. }
  801. /**
  802. * Creates setter code which is used for generation of php file for object brick classes using this data type
  803. *
  804. * @param DataObject\Objectbrick\Definition $brickClass
  805. *
  806. * @return string
  807. */
  808. public function getSetterCodeObjectbrick($brickClass)
  809. {
  810. $key = $this->getName();
  812. if ($brickClass->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  813. $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  814. } else {
  815. $typeDeclaration = '';
  816. }
  818. $code = '/**' . "\n";
  819. $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  820. $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  821. $code .= '* @return \\Pimcore\\Model\\DataObject\\Objectbrick\\Data\\' . ucfirst($brickClass->getKey()) . "\n";
  822. $code .= '*/' . "\n";
  823. $code .= 'public function set' . ucfirst($key) . ' (' . $typeDeclaration . '$' . $key . ')' . "\n";
  824. $code .= '{' . "\n";
  826. if (
  827. (
  828. $this->supportsDirtyDetection() &&
  829. $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  830. ) || method_exists($this, 'preSetData')
  831. ) {
  832. $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  833. $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  834. }
  836. if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  837. if ($this->getDelegate()) {
  838. $code .= "\t" . '/** @var \\' . static::class . ' $encryptedFd */' . "\n";
  839. $code .= "\t" . '$encryptedFd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  840. $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  841. $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  842. $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  843. $code .= "\t" . '}' . "\n";
  844. }
  845. }
  847. if ($this->supportsDirtyDetection()) {
  848. $code .= "\t" . '$class = $this->getObject() ? $this->getObject()->getClass() : null;' . "\n";
  849. $code .= "\t" . 'if ($class && $class->getAllowInherit()) {' . "\n";
  850. $code .= "\t\t" . '$inheritValues = $this->getObject()::getGetInheritedValues();'."\n";
  851. $code .= "\t\t" . '$this->getObject()::setGetInheritedValues(false);'."\n";
  852. $code .= "\t" . '}'."\n";
  854. $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  855. $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  856. $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  857. $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  859. $code .= "\t" . 'if($class && $class->getAllowInherit()) {' . "\n";
  860. $code .= "\t\t" . '$this->getObject()::setGetInheritedValues($inheritValues);'."\n";
  861. $code .= "\t" . '}' . "\n";
  862. if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  863. $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  864. $code .= "\t" . 'if (!$isEqual) {' . "\n";
  865. $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  866. $code .= "\t" . '}' . "\n";
  867. } else {
  868. $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  869. }
  870. }
  872. //TODO Pimcore 11: remove method_exists BC layer
  873. if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  874. $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  875. } else {
  876. $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  877. }
  879. $code .= "\t" . 'return $this;' . "\n";
  880. $code .= "}\n\n";
  882. return $code;
  883. }
  885. /**
  886. * Creates getter code which is used for generation of php file for fieldcollectionk classes using this data type
  887. *
  888. * @param DataObject\Fieldcollection\Definition $fieldcollectionDefinition
  889. *
  890. * @return string
  891. */
  892. public function getGetterCodeFieldcollection($fieldcollectionDefinition)
  893. {
  894. $key = $this->getName();
  896. if ($fieldcollectionDefinition->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  897. $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  898. } else {
  899. $typeDeclaration = '';
  900. }
  902. $code = '/**' . "\n";
  903. $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  904. $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  905. $code .= '*/' . "\n";
  906. $code .= 'public function get' . ucfirst($key) . '()' . $typeDeclaration . "\n";
  907. $code .= '{' . "\n";
  909. //TODO Pimcore 11: remove method_exists BC layer
  910. if ($this instanceof DataObject\ClassDefinition\Data\PreGetDataInterface || method_exists($this, 'preGetData')) {
  911. $code .= "\t" . '$container = $this;' . "\n";
  912. $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  913. $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  914. $code .= "\t" . '$data = $fd->preGetData($container);' . "\n";
  915. } else {
  916. $code .= "\t" . '$data = $this->' . $key . ";\n";
  917. }
  919. $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  920. $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  921. $code .= "\t" . '}' . "\n\n";
  923. $code .= "\t" . 'return $data;' . "\n";
  924. $code .= "}\n\n";
  926. return $code;
  927. }
  929. /**
  930. * Creates setter code which is used for generation of php file for fieldcollection classes using this data type
  931. *
  932. * @param DataObject\Fieldcollection\Definition $fieldcollectionDefinition
  933. *
  934. * @return string
  935. */
  936. public function getSetterCodeFieldcollection($fieldcollectionDefinition)
  937. {
  938. $key = $this->getName();
  940. if ($fieldcollectionDefinition->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  941. $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  942. } else {
  943. $typeDeclaration = '';
  944. }
  946. $code = '/**' . "\n";
  947. $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  948. $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  949. $code .= '* @return \\Pimcore\\Model\\DataObject\\Fieldcollection\\Data\\' . ucfirst($fieldcollectionDefinition->getKey()) . "\n";
  950. $code .= '*/' . "\n";
  951. $code .= 'public function set' . ucfirst($key) . '(' . $typeDeclaration . '$' . $key . ')' . "\n";
  952. $code .= '{' . "\n";
  954. if (
  955. (
  956. $this->supportsDirtyDetection() &&
  957. $this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface
  958. ) || method_exists($this, 'preSetData')
  959. ) {
  960. $code .= "\t" . '/** @var \\' . static::class . ' $fd */' . "\n";
  961. $code .= "\t" . '$fd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  962. }
  964. if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  965. if ($this->getDelegate()) {
  966. $code .= "\t" . '/** @var \\' . static::class . ' $encryptedFd */' . "\n";
  967. $code .= "\t" . '$encryptedFd = $this->getDefinition()->getFieldDefinition("' . $key . '");' . "\n";
  968. $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  969. $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  970. $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  971. $code .= "\t" . '}' . "\n";
  972. }
  973. }
  975. if ($this->supportsDirtyDetection()) {
  976. $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  977. $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  978. $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '();' . "\n";
  979. $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  981. if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  982. $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  983. $code .= "\t" . 'if (!$isEqual) {' . "\n";
  984. $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  985. $code .= "\t" . '}' . "\n";
  986. } else {
  987. $code .= "\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  988. }
  989. }
  991. //TODO Pimcore 11: remove method_exists BC layer
  992. if ($this instanceof DataObject\ClassDefinition\Data\PreSetDataInterface || method_exists($this, 'preSetData')) {
  993. $code .= "\t" . '$this->' . $key . ' = ' . '$fd->preSetData($this, $' . $key . ');' . "\n";
  994. } else {
  995. $code .= "\t" . '$this->' . $key . ' = ' . '$' . $key . ";\n\n";
  996. }
  998. $code .= "\t" . 'return $this;' . "\n";
  999. $code .= "}\n\n";
  1001. return $code;
  1002. }
  1004. /**
  1005. * Creates getter code which is used for generation of php file for localized fields in classes using this data type
  1006. *
  1007. * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  1008. *
  1009. * @return string
  1010. */
  1011. public function getGetterCodeLocalizedfields($class)
  1012. {
  1013. $key = $this->getName();
  1015. if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getReturnTypeDeclaration()) {
  1016. $typeDeclaration = ': ' . $this->getReturnTypeDeclaration();
  1017. } else {
  1018. $typeDeclaration = '';
  1019. }
  1021. $code = '/**' . "\n";
  1022. $code .= '* Get ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  1023. $code .= '* @return ' . $this->getPhpdocReturnType() . "\n";
  1024. $code .= '*/' . "\n";
  1025. $code .= 'public function get' . ucfirst($key) . '($language = null)' . $typeDeclaration . "\n";
  1026. $code .= '{' . "\n";
  1028. $code .= "\t" . '$data = $this->getLocalizedfields()->getLocalizedValue("' . $key . '", $language);' . "\n";
  1030. if (!$class instanceof DataObject\Fieldcollection\Definition) {
  1031. $code .= $this->getPreGetValueHookCode($key);
  1032. }
  1034. $code .= "\t" . 'if ($data instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField) {' . "\n";
  1035. $code .= "\t\t" . 'return $data->getPlain();' . "\n";
  1036. $code .= "\t" . '}' . "\n\n";
  1038. // we don't need to consider preGetData, because this is already managed directly by the localized fields within getLocalizedValue()
  1040. $code .= "\t" . 'return $data;' . "\n";
  1041. $code .= "}\n\n";
  1043. return $code;
  1044. }
  1046. /**
  1047. * Creates setter code which is used for generation of php file for localized fields in classes using this data type
  1048. *
  1049. * @param DataObject\ClassDefinition|DataObject\Objectbrick\Definition|DataObject\Fieldcollection\Definition $class
  1050. *
  1051. * @return string
  1052. */
  1053. public function getSetterCodeLocalizedfields($class)
  1054. {
  1055. $key = $this->getName();
  1056. if ($class instanceof DataObject\Objectbrick\Definition) {
  1057. $classname = 'Objectbrick\\Data\\' . ucfirst($class->getKey());
  1058. $containerGetter = 'getDefinition';
  1059. } elseif ($class instanceof DataObject\Fieldcollection\Definition) {
  1060. $classname = 'Fieldcollection\\Data\\' . ucfirst($class->getKey());
  1061. $containerGetter = 'getDefinition';
  1062. } else {
  1063. $classname = $class->getName();
  1064. $containerGetter = 'getClass';
  1065. }
  1067. if ($class->getGenerateTypeDeclarations() && $this instanceof DataObject\ClassDefinition\Data\TypeDeclarationSupportInterface && $this->getParameterTypeDeclaration()) {
  1068. $typeDeclaration = $this->getParameterTypeDeclaration() . ' ';
  1069. } else {
  1070. $typeDeclaration = '';
  1071. }
  1073. $code = '/**' . "\n";
  1074. $code .= '* Set ' . str_replace(['/**', '*/', '//'], '', $this->getName()) . ' - ' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . "\n";
  1075. $code .= '* @param ' . $this->getPhpdocInputType() . ' $' . $key . "\n";
  1076. $code .= '* @return \\Pimcore\\Model\\DataObject\\' . ucfirst($classname) . "\n";
  1077. $code .= '*/' . "\n";
  1078. $code .= 'public function set' . ucfirst($key) . ' (' . $typeDeclaration . '$' . $key . ', $language = null)' . "\n";
  1079. $code .= '{' . "\n";
  1081. if ($this->supportsDirtyDetection()) {
  1082. $code .= "\t" . '$fd = $this->' . $containerGetter . '()->getFieldDefinition("localizedfields")->getFieldDefinition("' . $key . '");' . "\n";
  1083. }
  1085. if ($this instanceof DataObject\ClassDefinition\Data\EncryptedField) {
  1086. if ($this->getDelegate()) {
  1087. $code .= "\t" . '$encryptedFd = $this->getClass()->getFieldDefinition("' . $key . '");' . "\n";
  1088. $code .= "\t" . '$delegate = $encryptedFd->getDelegate();' . "\n";
  1089. $code .= "\t" . 'if ($delegate && !($' . $key . ' instanceof \\Pimcore\\Model\\DataObject\\Data\\EncryptedField)) {' . "\n";
  1090. $code .= "\t\t" . '$' . $key . ' = new \\Pimcore\\Model\\DataObject\\Data\\EncryptedField($delegate, $' . $key . ');' . "\n";
  1091. $code .= "\t" . '}' . "\n";
  1092. }
  1093. }
  1095. if ($this->supportsDirtyDetection()) {
  1096. if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  1097. $code .= "\t" . '$inheritValues = self::getGetInheritedValues();'."\n";
  1098. $code .= "\t" . 'self::setGetInheritedValues(false);'."\n";
  1099. }
  1101. $code .= "\t" . '$hideUnpublished = \\Pimcore\\Model\\DataObject\\Concrete::getHideUnpublished();' . "\n";
  1102. $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished(false);' . "\n";
  1103. $code .= "\t" . '$currentData = $this->get' . ucfirst($this->getName()) . '($language);' . "\n";
  1104. $code .= "\t" . '\\Pimcore\\Model\\DataObject\\Concrete::setHideUnpublished($hideUnpublished);' . "\n";
  1106. if ($class instanceof DataObject\ClassDefinition && $class->getAllowInherit()) {
  1107. $code .= "\t" . 'self::setGetInheritedValues($inheritValues);'."\n";
  1108. }
  1109. if ($this instanceof DataObject\ClassDefinition\Data\EqualComparisonInterface) {
  1110. $code .= "\t" . '$isEqual = $fd->isEqual($currentData, $' . $key . ');' . "\n";
  1111. } else {
  1112. $code .= "\t" . '$isEqual = false;' . "\n";
  1113. }
  1115. $code .= "\t" . 'if (!$isEqual) {' . "\n";
  1116. $code .= "\t\t" . '$this->markFieldDirty("' . $key . '", true);' . "\n";
  1117. $code .= "\t" . '}' . "\n";
  1118. } else {
  1119. $code .= "\t" . '$isEqual = false;' . "\n";
  1120. }
  1122. $code .= "\t" . '$this->getLocalizedfields()->setLocalizedValue("' . $key . '", $' . $key . ', $language, !$isEqual)' . ";\n\n";
  1124. $code .= "\t" . 'return $this;' . "\n";
  1125. $code .= "}\n\n";
  1127. return $code;
  1128. }
  1130. /**
  1131. * Creates filter method code for listing classes
  1132. *
  1133. * @return string
  1134. */
  1135. public function getFilterCode()
  1136. {
  1137. $key = $this->getName();
  1139. $code = '/**' . "\n";
  1140. $code .= '* Filter by ' . str_replace(['/**', '*/', '//'], '', $key) . ' (' . str_replace(['/**', '*/', '//'], '', $this->getTitle()) . ")\n";
  1142. $dataParamDoc = 'mixed $data';
  1143. $reflectionMethod = new \ReflectionMethod($this, 'addListingFilter');
  1144. if (preg_match('/@param\s+([^\s]+)\s+\$data(.*)/', $reflectionMethod->getDocComment(), $dataParam)) {
  1145. $dataParamDoc = $dataParam[1].' $data '.$dataParam[2];
  1146. }
  1148. $operatorParamDoc = 'string $operator SQL comparison operator, e.g. =, <, >= etc. You can use "?" as placeholder, e.g. "IN (?)"';
  1149. if (preg_match('/@param\s+([^\s]+)\s+\$operator(.*)/', $reflectionMethod->getDocComment(), $dataParam)) {
  1150. $operatorParamDoc = $dataParam[1].' $operator '.$dataParam[2];
  1151. }
  1153. $code .= '* @param '.$dataParamDoc."\n";
  1154. $code .= '* @param '.$operatorParamDoc."\n";
  1155. $code .= '* @return static'."\n";
  1156. $code .= '*/' . "\n";
  1158. $code .= 'public function filterBy' . ucfirst($key) .' ($data, $operator = \'=\')' . "\n";
  1159. $code .= '{' . "\n";
  1160. $code .= "\t" . '$this->getClass()->getFieldDefinition("' . $key . '")->addListingFilter($this, $data, $operator);' . "\n";
  1161. $code .= "\treturn " . '$this' . ";\n";
  1162. $code .= "}\n\n";
  1164. return $code;
  1165. }
  1167. /**
  1168. * @param int|string|null $number
  1169. *
  1170. * @return int|null
  1171. */
  1172. public function getAsIntegerCast($number)
  1173. {
  1174. return strlen($number) === 0 ? '' : (int)$number;
  1175. }
  1177. /**
  1178. * @param mixed $number
  1179. *
  1180. * @return float
  1181. */
  1182. public function getAsFloatCast($number)
  1183. {
  1184. return strlen($number) === 0 ? '' : (float)$number;
  1185. }
  1187. /**
  1188. * @param mixed $data
  1189. * @param DataObject\Concrete|null $object
  1190. * @param mixed $params
  1191. *
  1192. * @return string
  1193. */
  1194. public function getVersionPreview($data, $object = null, $params = [])
  1195. {
  1196. return 'no preview';
  1197. }
  1199. /**
  1200. * @param mixed $data
  1201. *
  1202. * @return bool
  1203. */
  1204. public function isEmpty($data)
  1205. {
  1206. return empty($data);
  1207. }
  1209. /** True if change is allowed in edit mode.
  1210. * @param DataObject\Concrete $object
  1211. * @param mixed $params
  1212. *
  1213. * @return bool
  1214. */
  1215. public function isDiffChangeAllowed($object, $params = [])
  1216. {
  1217. return false;
  1218. }
  1220. /** Converts the data sent from the object merger back to the internal object. Similar to
  1221. * getDiffDataForEditMode() an array of data elements is passed in containing the following attributes:
  1222. * - "field" => the name of (this) field
  1223. * - "key" => the key of the data element
  1224. * - "data" => the data
  1225. *
  1226. * @param array $data
  1227. * @param DataObject\Concrete|null $object
  1228. * @param mixed $params
  1229. *
  1230. * @return mixed
  1231. */
  1232. public function getDiffDataFromEditmode($data, $object = null, $params = [])
  1233. {
  1234. $thedata = $this->getDataFromEditmode($data[0]['data'], $object, $params);
  1236. return $thedata;
  1237. }
  1239. /**
  1240. * Returns the data for the editmode in the format expected by the object merger plugin.
  1241. * The return value is a list of data definitions containing the following attributes:
  1242. * - "field" => the name of the object field
  1243. * - "key" => a unique key identifying the data element
  1244. * - "type" => the type of the data component
  1245. * - "value" => the value used as preview
  1246. * - "data" => the actual data which is then sent back again by the editor. Note that the data is opaque
  1247. * and will not be touched by the editor in any way.
  1248. * - "disabled" => whether the data element can be edited or not
  1249. * - "title" => pretty name describing the data element
  1250. *
  1251. *
  1252. * @param mixed $data
  1253. * @param null|DataObject\AbstractObject $object
  1254. * @param mixed $params
  1255. *
  1256. * @return null|array
  1257. */
  1258. public function getDiffDataForEditMode($data, $object = null, $params = [])
  1259. {
  1260. $diffdata = [];
  1261. $diffdata['data'] = $this->getDataForEditmode($data, $object, $params);
  1262. $diffdata['disabled'] = !($this->isDiffChangeAllowed($object));
  1263. $diffdata['field'] = $this->getName();
  1264. $diffdata['key'] = $this->getName();
  1265. $diffdata['type'] = $this->fieldtype;
  1267. if (method_exists($this, 'getDiffVersionPreview')) {
  1268. $value = $this->getDiffVersionPreview($data, $object, $params);
  1269. } else {
  1270. $value = $this->getVersionPreview($data, $object, $params);
  1271. }
  1273. $diffdata['title'] = !empty($this->title) ? $this->title : $this->name;
  1274. $diffdata['value'] = $value;
  1276. $result = [];
  1277. $result[] = $diffdata;
  1279. return $result;
  1280. }
  1282. /**
  1283. * @return bool
  1284. */
  1285. public function getUnique()
  1286. {
  1287. return false;
  1288. }
  1290. /**
  1291. * @param DataObject\Concrete|DataObject\Localizedfield|DataObject\Objectbrick\Data\AbstractData|DataObject\Fieldcollection\Data\AbstractData $object
  1292. * @param array $params
  1293. *
  1294. * @return mixed
  1295. *
  1296. * @throws \Exception
  1297. */
  1298. protected function getDataFromObjectParam($object, $params = [])
  1299. {
  1300. $data = null;
  1302. if (array_key_exists('injectedData', $params)) {
  1303. return $params['injectedData'];
  1304. }
  1306. $context = $params['context'] ?? null;
  1308. if (isset($context['containerType'])) {
  1309. if ($context['containerType'] === 'fieldcollection' || $context['containerType'] === 'block') {
  1310. if ($this instanceof DataObject\ClassDefinition\Data\Localizedfields || $object instanceof DataObject\Localizedfield) {
  1311. $fieldname = $context['fieldname'];
  1312. $index = $context['index'] ?? null;
  1314. if ($object instanceof DataObject\Concrete) {
  1315. $containerGetter = 'get' . ucfirst($fieldname);
  1316. $container = $object->$containerGetter();
  1317. if (!$container && $context['containerType'] === 'block') {
  1318. // no data, so check if inheritance is enabled + there is parent value
  1319. if ($object->getClass()->getAllowInherit()) {
  1320. try {
  1321. $container = $object->getValueFromParent($fieldname);
  1322. } catch (InheritanceParentNotFoundException $e) {
  1323. //nothing to do here - just no parent data available
  1324. }
  1325. }
  1326. }
  1328. if ($container) {
  1329. $originalIndex = $context['oIndex'] ?? null;
  1331. // field collection or block items
  1332. if ($originalIndex !== null) {
  1333. if ($context['containerType'] === 'block') {
  1334. $items = $container;
  1335. } else {
  1336. $items = $container->getItems();
  1337. }
  1339. if ($items && count($items) > $originalIndex) {
  1340. $item = $items[$originalIndex];
  1342. if ($context['containerType'] === 'block') {
  1343. $data = $item[$this->getName()] ?? null;
  1344. if ($data instanceof DataObject\Data\BlockElement) {
  1345. $data = $data->getData();
  1347. return $data;
  1348. }
  1349. } else {
  1350. $getter = 'get' . ucfirst($this->getName());
  1351. $data = $item->$getter();
  1352. }
  1354. return $data;
  1355. }
  1357. throw new \Exception('object seems to be modified, item with orginal index ' . $originalIndex . ' not found, new index: ' . $index);
  1358. } else {
  1359. return null;
  1360. }
  1361. } else {
  1362. return null;
  1363. }
  1364. } elseif ($object instanceof DataObject\Localizedfield) {
  1365. $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1367. return $data;
  1368. }
  1369. }
  1370. } elseif ($context['containerType'] === 'objectbrick' && ($this instanceof DataObject\ClassDefinition\Data\Localizedfields || $object instanceof DataObject\Localizedfield)) {
  1371. $fieldname = $context['fieldname'];
  1373. if ($object instanceof DataObject\Concrete) {
  1374. $containerGetter = 'get' . ucfirst($fieldname);
  1375. $container = $object->$containerGetter();
  1376. if ($container) {
  1377. $brickGetter = 'get' . ucfirst($context['containerKey']);
  1378. $brickData = $container->$brickGetter();
  1380. if ($brickData instanceof DataObject\Objectbrick\Data\AbstractData) {
  1381. return $brickData->get('localizedfields');
  1382. }
  1383. }
  1385. return null;
  1386. } elseif ($object instanceof DataObject\Localizedfield) {
  1387. $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1389. return $data;
  1390. }
  1391. } elseif ($context['containerType'] === 'classificationstore') {
  1392. $fieldname = $context['fieldname'];
  1393. $getter = 'get' . ucfirst($fieldname);
  1394. if (method_exists($object, $getter)) {
  1395. $groupId = $context['groupId'];
  1396. $keyId = $context['keyId'];
  1397. $language = $context['language'];
  1399. /** @var DataObject\Classificationstore $classificationStoreData */
  1400. $classificationStoreData = $object->$getter();
  1401. $data = $classificationStoreData->getLocalizedKeyValue($groupId, $keyId, $language, true, true);
  1403. return $data;
  1404. }
  1405. }
  1406. }
  1408. $container = $object;
  1410. $getter = 'get' . ucfirst($this->getName());
  1411. if (method_exists($container, $getter)) { // for DataObject\Concrete, DataObject\Fieldcollection\Data\AbstractData, DataObject\Objectbrick\Data\AbstractData
  1412. $data = $container->$getter();
  1413. } elseif ($object instanceof DataObject\Localizedfield) {
  1414. $data = $object->getLocalizedValue($this->getName(), $params['language'], true);
  1415. }
  1417. return $data;
  1418. }
  1420. /**
  1421. * @param DataObject\ClassDefinition\Data $masterDefinition
  1422. */
  1423. public function synchronizeWithMasterDefinition(DataObject\ClassDefinition\Data $masterDefinition)
  1424. {
  1425. // implement in child classes
  1426. }
  1428. /**
  1429. * @param DataObject\ClassDefinition\Data $masterDefinition
  1430. */
  1431. public function adoptMasterDefinition(DataObject\ClassDefinition\Data $masterDefinition)
  1432. {
  1433. $vars = get_object_vars($this);
  1434. $protectedFields = ['noteditable', 'invisible'];
  1435. foreach ($vars as $name => $value) {
  1436. if (!in_array($name, $protectedFields)) {
  1437. unset($this->$name);
  1438. }
  1439. }
  1440. $vars = get_object_vars($masterDefinition);
  1441. foreach ($vars as $name => $value) {
  1442. if (!in_array($name, $protectedFields)) {
  1443. $this->$name = $value;
  1444. }
  1445. }
  1446. }
  1448. /**
  1449. * @param array|null $existingData
  1450. * @param array $additionalData
  1451. *
  1452. * @return mixed
  1453. */
  1454. public function appendData($existingData, $additionalData)
  1455. {
  1456. return $existingData;
  1457. }
  1459. /**
  1460. * @param mixed $existingData
  1461. * @param mixed $removeData
  1462. *
  1463. * @return mixed
  1464. */
  1465. public function removeData($existingData, $removeData)
  1466. {
  1467. return $existingData;
  1468. }
  1470. /**
  1471. * Returns if datatype supports data inheritance
  1472. *
  1473. * @return bool
  1474. */
  1475. public function supportsInheritance()
  1476. {
  1477. return true;
  1478. }
  1480. /**
  1481. * @return bool
  1482. */
  1483. public function supportsDirtyDetection()
  1484. {
  1485. return false;
  1486. }
  1488. /**
  1489. * @param DataObject\Concrete $object
  1490. */
  1491. public function markLazyloadedFieldAsLoaded($object)
  1492. {
  1493. if ($object instanceof DataObject\LazyLoadedFieldsInterface) {
  1494. $object->markLazyKeyAsLoaded($this->getName());
  1495. }
  1496. }
  1498. /**
  1499. * Returns if datatype supports listing filters: getBy, filterBy
  1500. *
  1501. * @return bool
  1502. */
  1503. public function isFilterable(): bool
  1504. {
  1505. return false;
  1506. }
  1508. /**
  1509. * @param DataObject\Listing $listing
  1510. * @param string|int|float|array|Model\Element\ElementInterface $data comparison data, can be scalar or array (if operator is e.g. "IN (?)")
  1511. * @param string $operator SQL comparison operator, e.g. =, <, >= etc. You can use "?" as placeholder, e.g. "IN (?)"
  1512. *
  1513. * @return DataObject\Listing
  1514. */
  1515. public function addListingFilter(DataObject\Listing $listing, $data, $operator = '=')
  1516. {
  1517. return $listing->addFilterByField($this->getName(), $operator, $data);
  1518. }
  1520. public function isForbiddenName()
  1521. {
  1522. return in_array($this->getName(), $this->forbiddenNames);
  1523. }
  1524. }