vendor/pimcore/pimcore/models/DataObject/ClassDefinition.php line 306

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;
  18. use Pimcore\Cache;
  19. use Pimcore\Cache\RuntimeCache;
  20. use Pimcore\DataObject\ClassBuilder\FieldDefinitionDocBlockBuilderInterface;
  21. use Pimcore\DataObject\ClassBuilder\PHPClassDumperInterface;
  22. use Pimcore\Db;
  23. use Pimcore\Event\DataObjectClassDefinitionEvents;
  24. use Pimcore\Event\Model\DataObject\ClassDefinitionEvent;
  25. use Pimcore\Event\Traits\RecursionBlockingEventDispatchHelperTrait;
  26. use Pimcore\Logger;
  27. use Pimcore\Model;
  28. use Pimcore\Model\DataObject;
  29. use Pimcore\Model\DataObject\ClassDefinition\Data\FieldDefinitionEnrichmentInterface;
  30. use Pimcore\Model\DataObject\ClassDefinition\Data\ManyToOneRelation;
  32. /**
  33. * @method \Pimcore\Model\DataObject\ClassDefinition\Dao getDao()
  34. */
  35. final class ClassDefinition extends Model\AbstractModel
  36. {
  37. use DataObject\ClassDefinition\Helper\VarExport;
  38. use DataObject\Traits\LocateFileTrait;
  39. use RecursionBlockingEventDispatchHelperTrait;
  41. /**
  42. * @internal
  43. *
  44. * @var string|null
  45. */
  46. public $id;
  48. /**
  49. * @internal
  50. *
  51. * @var string|null
  52. */
  53. public $name;
  55. /**
  56. * @internal
  57. *
  58. * @var string
  59. */
  60. public $description = '';
  62. /**
  63. * @internal
  64. *
  65. * @var int|null
  66. */
  67. public $creationDate;
  69. /**
  70. * @internal
  71. *
  72. * @var int|null
  73. */
  74. public $modificationDate;
  76. /**
  77. * @internal
  78. *
  79. * @var int|null
  80. */
  81. public $userOwner;
  83. /**
  84. * @internal
  85. *
  86. * @var int|null
  87. */
  88. public $userModification;
  90. /**
  91. * @internal
  92. *
  93. * @var string
  94. */
  95. public $parentClass = '';
  97. /**
  98. * Comma separated list of interfaces
  99. *
  100. * @internal
  101. *
  102. * @var string|null
  103. */
  104. public $implementsInterfaces;
  106. /**
  107. * Name of the listing parent class if set
  108. *
  109. * @internal
  110. *
  111. * @var string
  112. */
  113. public $listingParentClass = '';
  115. /**
  116. * @internal
  117. *
  118. * @var string
  119. */
  120. public $useTraits = '';
  122. /**
  123. * @internal
  124. *
  125. * @var string
  126. */
  127. public $listingUseTraits = '';
  129. /**
  130. * @internal
  131. *
  132. * @var bool
  133. */
  134. protected $encryption = false;
  136. /**
  137. * @internal
  138. *
  139. * @var array
  140. */
  141. protected $encryptedTables = [];
  143. /**
  144. * @internal
  145. *
  146. * @var bool
  147. */
  148. public $allowInherit = false;
  150. /**
  151. * @internal
  152. *
  153. * @var bool
  154. */
  155. public $allowVariants = false;
  157. /**
  158. * @internal
  159. *
  160. * @var bool
  161. */
  162. public $showVariants = false;
  164. /**
  165. * @internal
  166. *
  167. * @var DataObject\ClassDefinition\Data[]
  168. */
  169. public array $fieldDefinitions = [];
  171. /**
  172. * @internal
  173. *
  174. * @var DataObject\ClassDefinition\Layout|null
  175. */
  176. public $layoutDefinitions;
  178. /**
  179. * @internal
  180. *
  181. * @var string|null
  182. */
  183. public $icon;
  185. /**
  186. * @internal
  187. *
  188. * @var string|null
  189. */
  190. public $previewUrl;
  192. /**
  193. * @internal
  194. *
  195. * @var string|null
  196. */
  197. public $group;
  199. /**
  200. * @internal
  201. *
  202. * @var bool
  203. */
  204. public $showAppLoggerTab = false;
  206. /**
  207. * @internal
  208. *
  209. * @var string
  210. */
  211. public $linkGeneratorReference;
  213. /**
  214. * @internal
  215. *
  216. * @var string|null
  217. */
  218. public $previewGeneratorReference;
  220. /**
  221. * @internal
  222. *
  223. * @var array
  224. */
  225. public $compositeIndices = [];
  227. /**
  228. * @internal
  229. *
  230. * @var bool
  231. */
  232. public $generateTypeDeclarations = true;
  234. /**
  235. * @internal
  236. *
  237. * @var bool
  238. */
  239. public $showFieldLookup = false;
  241. /**
  242. * @internal
  243. *
  244. * @var array
  245. */
  246. public $propertyVisibility = [
  247. 'grid' => [
  248. 'id' => true,
  249. 'path' => true,
  250. 'published' => true,
  251. 'modificationDate' => true,
  252. 'creationDate' => true,
  253. ],
  254. 'search' => [
  255. 'id' => true,
  256. 'path' => true,
  257. 'published' => true,
  258. 'modificationDate' => true,
  259. 'creationDate' => true,
  260. ],
  261. ];
  263. /**
  264. * @internal
  265. *
  266. * @var bool
  267. */
  268. public $enableGridLocking = false;
  270. /**
  271. * @internal
  272. *
  273. * @var ClassDefinition\Data[]
  274. */
  275. private array $deletedDataComponents = [];
  277. /**
  278. * @param string $id
  279. * @param bool $force
  280. *
  281. * @return null|ClassDefinition
  282. *
  283. * @throws \Exception
  284. */
  285. public static function getById(string $id, $force = false)
  286. {
  287. $cacheKey = 'class_' . $id;
  289. try {
  290. if ($force) {
  291. throw new \Exception('Forced load');
  292. }
  293. $class = RuntimeCache::get($cacheKey);
  294. if (!$class) {
  295. throw new \Exception('Class in registry is null');
  296. }
  297. } catch (\Exception $e) {
  298. try {
  299. $class = new self();
  300. $name = $class->getDao()->getNameById($id);
  301. if (!$name) {
  302. throw new \Exception('Class definition with name ' . $name . ' or ID ' . $id . ' does not exist');
  303. }
  305. $definitionFile = $class->getDefinitionFile($name);
  306. $class = @include $definitionFile;
  308. if (!$class instanceof self) {
  309. throw new \Exception('Class definition with name ' . $name . ' or ID ' . $id . ' does not exist');
  310. }
  312. $class->setId($id);
  314. RuntimeCache::set($cacheKey, $class);
  315. } catch (\Exception $e) {
  316. Logger::info($e->getMessage());
  318. return null;
  319. }
  320. }
  322. return $class;
  323. }
  325. /**
  326. * @param string $name
  327. *
  328. * @return self|null
  329. *
  330. * @throws \Exception
  331. */
  332. public static function getByName($name)
  333. {
  334. try {
  335. $class = new self();
  336. $id = $class->getDao()->getIdByName($name);
  338. return self::getById($id);
  339. } catch (Model\Exception\NotFoundException $e) {
  340. return null;
  341. }
  342. }
  344. /**
  345. * @param array $values
  346. *
  347. * @return self
  348. */
  349. public static function create($values = [])
  350. {
  351. $class = new self();
  352. $class->setValues($values);
  354. return $class;
  355. }
  357. /**
  358. * @internal
  359. *
  360. * @param string $name
  361. */
  362. public function rename($name)
  363. {
  364. $this->deletePhpClasses();
  365. $this->getDao()->updateClassNameInObjects($name);
  367. $this->setName($name);
  368. $this->save();
  369. }
  371. /**
  372. * @param mixed $data
  373. *
  374. * @internal
  375. */
  376. public static function cleanupForExport(&$data)
  377. {
  378. if (!is_object($data)) {
  379. return;
  380. }
  382. if ($data instanceof DataObject\ClassDefinition\Data\VarExporterInterface) {
  383. $blockedVars = $data->resolveBlockedVars();
  384. foreach ($blockedVars as $blockedVar) {
  385. if (isset($data->{$blockedVar})) {
  386. unset($data->{$blockedVar});
  387. }
  388. }
  390. if (isset($data->blockedVarsForExport)) {
  391. unset($data->blockedVarsForExport);
  392. }
  393. }
  395. if (method_exists($data, 'getChildren')) {
  396. $children = $data->getChildren();
  397. if (is_array($children)) {
  398. foreach ($children as $child) {
  399. self::cleanupForExport($child);
  400. }
  401. }
  402. }
  403. }
  405. /**
  406. * @return bool
  407. */
  408. private function exists()
  409. {
  410. $name = $this->getDao()->getNameById($this->getId());
  412. return is_string($name);
  413. }
  415. /**
  416. * @param bool $saveDefinitionFile
  417. *
  418. * @throws \Exception
  419. * @throws DataObject\Exception\DefinitionWriteException
  420. */
  421. public function save($saveDefinitionFile = true)
  422. {
  423. if ($saveDefinitionFile && !$this->isWritable()) {
  424. throw new DataObject\Exception\DefinitionWriteException();
  425. }
  427. $fieldDefinitions = $this->getFieldDefinitions();
  428. foreach ($fieldDefinitions as $fd) {
  429. if ($fd->isForbiddenName()) {
  430. throw new \Exception(sprintf('Forbidden name used for field definition: %s', $fd->getName()));
  431. }
  433. if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  434. $fd->preSave($this);
  435. }
  436. }
  438. if (!$this->getId()) {
  439. $db = Db::get();
  440. $maxId = $db->fetchOne('SELECT MAX(CAST(id AS SIGNED)) FROM classes;');
  441. $maxId = $maxId ? $maxId + 1 : 1;
  442. $this->setId((string) $maxId);
  443. }
  445. if (!preg_match('/[a-zA-Z][a-zA-Z0-9_]+/', $this->getName())) {
  446. throw new \Exception(sprintf('Invalid name for class definition: %s', $this->getName()));
  447. }
  449. if (!preg_match('/[a-zA-Z0-9]([a-zA-Z0-9_]+)?/', $this->getId())) {
  450. throw new \Exception(sprintf('Invalid ID `%s` for class definition %s', $this->getId(), $this->getName()));
  451. }
  453. foreach (['parentClass', 'listingParentClass', 'useTraits', 'listingUseTraits'] as $propertyName) {
  454. $propertyValue = $this->{'get'.ucfirst($propertyName)}();
  455. if ($propertyValue && !preg_match('/^[a-zA-Z_\x7f-\xff\\\][a-zA-Z0-9_\x7f-\xff\\\ ,]*$/', $propertyValue)) {
  456. throw new \Exception(sprintf('Invalid %s value for class definition: %s', $propertyName,
  457. $this->getParentClass()));
  458. }
  459. }
  461. $isUpdate = $this->exists();
  463. if (!$isUpdate) {
  464. $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_ADD);
  465. } else {
  466. $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_UPDATE);
  467. }
  469. $this->setModificationDate(time());
  471. $this->getDao()->save($isUpdate);
  473. $this->generateClassFiles($saveDefinitionFile);
  475. foreach ($fieldDefinitions as $fd) {
  476. // call the method "classSaved" if exists, this is used to create additional data tables or whatever which depends on the field definition, for example for localizedfields
  477. //TODO Pimcore 11 remove method_exists call
  478. if (!$fd instanceof ClassDefinition\Data\DataContainerAwareInterface && method_exists($fd, 'classSaved')) {
  479. $fd->classSaved($this);
  480. }
  481. }
  483. // empty object cache
  484. try {
  485. Cache::clearTag('class_'.$this->getId());
  486. } catch (\Exception $e) {
  487. }
  489. foreach ($fieldDefinitions as $fd) {
  490. if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  491. $fd->postSave($this);
  492. }
  493. }
  495. if ($isUpdate) {
  496. $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_UPDATE);
  497. } else {
  498. $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_ADD);
  499. }
  501. $this->deleteDeletedDataComponentsInCustomLayout();
  502. }
  504. /**
  505. * @param bool $generateDefinitionFile
  506. *
  507. * @throws \Exception
  508. *
  509. * @internal
  510. */
  511. public function generateClassFiles($generateDefinitionFile = true)
  512. {
  513. \Pimcore::getContainer()->get(PHPClassDumperInterface::class)->dumpPHPClasses($this);
  515. if ($generateDefinitionFile) {
  516. // save definition as a php file
  517. $definitionFile = $this->getDefinitionFile();
  518. if (!is_writable(dirname($definitionFile)) || (is_file($definitionFile) && !is_writable($definitionFile))) {
  519. throw new \Exception(
  520. 'Cannot write definition file in: '.$definitionFile.' please check write permission on this directory.'
  521. );
  522. }
  523. /** @var self $clone */
  524. $clone = DataObject\Service::cloneDefinition($this);
  525. $clone->setDao(null);
  526. $clone->fieldDefinitions = [];
  528. self::cleanupForExport($clone->layoutDefinitions);
  530. $exportedClass = var_export($clone, true);
  532. $data = '<?php';
  533. $data .= "\n\n";
  534. $data .= $this->getInfoDocBlock();
  535. $data .= "\n\n";
  537. $data .= 'return '.$exportedClass.";\n";
  539. \Pimcore\File::putPhpFile($definitionFile, $data);
  540. }
  541. }
  543. /**
  544. * @return string
  545. *
  546. * @internal
  547. */
  548. protected function getInfoDocBlock(): string
  549. {
  550. $cd = '/**' . "\n";
  551. $cd .= ' * Inheritance: '.($this->getAllowInherit() ? 'yes' : 'no')."\n";
  552. $cd .= ' * Variants: '.($this->getAllowVariants() ? 'yes' : 'no')."\n";
  554. if ($description = $this->getDescription()) {
  555. $description = str_replace(['/**', '*/', '//'], '', $description);
  556. $description = str_replace("\n", "\n * ", $description);
  558. $cd .= ' * '.$description."\n";
  559. }
  561. $cd .= " *\n";
  562. $cd .= " * Fields Summary:\n";
  564. $fieldDefinitionDocBlockBuilder = \Pimcore::getContainer()->get(FieldDefinitionDocBlockBuilderInterface::class);
  565. foreach ($this->getFieldDefinitions() as $fieldDefinition) {
  566. $cd .= ' * ' . str_replace("\n", "\n * ", trim($fieldDefinitionDocBlockBuilder->buildFieldDefinitionDocBlock($fieldDefinition))) . "\n";
  567. }
  569. $cd .= ' */';
  571. return $cd;
  572. }
  574. /**
  575. * @throws Exception\DefinitionWriteException
  576. */
  577. public function delete()
  578. {
  579. if (!$this->isWritable()) {
  580. throw new DataObject\Exception\DefinitionWriteException();
  581. }
  582. $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_DELETE);
  584. // delete all objects using this class
  585. $list = new Listing();
  586. $list->setCondition('o_classId = ?', $this->getId());
  587. $list->load();
  589. foreach ($list->getObjects() as $o) {
  590. $o->delete();
  591. }
  593. $this->deletePhpClasses();
  595. // empty object cache
  596. try {
  597. Cache::clearTag('class_'.$this->getId());
  598. } catch (\Exception $e) {
  599. }
  601. // empty output cache
  602. try {
  603. Cache::clearTag('output');
  604. } catch (\Exception $e) {
  605. }
  607. $customLayouts = new ClassDefinition\CustomLayout\Listing();
  608. $id = $this->getId();
  609. $customLayouts->setFilter(function (DataObject\ClassDefinition\CustomLayout $layout) use ($id) {
  610. return $layout->getClassId() === $id;
  611. });
  612. $customLayouts = $customLayouts->load();
  614. foreach ($customLayouts as $customLayout) {
  615. $customLayout->delete();
  616. }
  618. $brickListing = new DataObject\Objectbrick\Definition\Listing();
  619. $brickListing = $brickListing->load();
  620. foreach ($brickListing as $brickDefinition) {
  621. $modified = false;
  623. $classDefinitions = $brickDefinition->getClassDefinitions();
  624. if (is_array($classDefinitions)) {
  625. foreach ($classDefinitions as $key => $classDefinition) {
  626. if ($classDefinition['classname'] == $this->getId()) {
  627. unset($classDefinitions[$key]);
  628. $modified = true;
  629. }
  630. }
  631. }
  632. if ($modified) {
  633. $brickDefinition->setClassDefinitions($classDefinitions);
  634. $brickDefinition->save();
  635. }
  636. }
  638. $this->getDao()->delete();
  640. $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_DELETE);
  641. }
  643. private function deletePhpClasses()
  644. {
  645. // delete the class files
  646. @unlink($this->getPhpClassFile());
  647. @unlink($this->getPhpListingClassFile());
  648. @rmdir(dirname($this->getPhpListingClassFile()));
  649. @unlink($this->getDefinitionFile());
  650. }
  652. /**
  653. * @internal
  654. *
  655. * with PIMCORE_CLASS_DEFINITION_WRITABLE set, it globally allow/disallow creation and change in classes
  656. * when the ENV is not set, it allows modification and creation of new in classes in /var/classes but disables modification of classes in config/pimcore/classes
  657. * more details in 05_Deployment_Tools.md
  658. *
  659. * @return bool
  660. */
  661. public function isWritable(): bool
  662. {
  663. return $_SERVER['PIMCORE_CLASS_DEFINITION_WRITABLE'] ?? !str_starts_with($this->getDefinitionFile(), PIMCORE_CUSTOM_CONFIGURATION_DIRECTORY);
  664. }
  666. /**
  667. * @internal
  668. *
  669. * @param string|null $name
  670. *
  671. * @return string
  672. */
  673. public function getDefinitionFile($name = null)
  674. {
  675. return $this->locateDefinitionFile($name ?? $this->getName(), 'definition_%s.php');
  676. }
  678. /**
  679. * @internal
  680. */
  681. public function getPhpClassFile(): string
  682. {
  683. return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s.php');
  684. }
  686. /**
  687. * @internal
  688. */
  689. public function getPhpListingClassFile(): string
  690. {
  691. return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s/Listing.php');
  692. }
  694. /**
  695. * @return string|null
  696. */
  697. public function getId()
  698. {
  699. return $this->id;
  700. }
  702. /**
  703. * @return string|null
  704. */
  705. public function getName()
  706. {
  707. return $this->name;
  708. }
  710. /**
  711. * @return int|null
  712. */
  713. public function getCreationDate()
  714. {
  715. return $this->creationDate;
  716. }
  718. /**
  719. * @return int|null
  720. */
  721. public function getModificationDate()
  722. {
  723. return $this->modificationDate;
  724. }
  726. /**
  727. * @return int|null
  728. */
  729. public function getUserOwner()
  730. {
  731. return $this->userOwner;
  732. }
  734. /**
  735. * @return int|null
  736. */
  737. public function getUserModification()
  738. {
  739. return $this->userModification;
  740. }
  742. /**
  743. * @param string $id
  744. *
  745. * @return $this
  746. */
  747. public function setId($id)
  748. {
  749. $this->id = $id;
  751. return $this;
  752. }
  754. /**
  755. * @param string $name
  756. *
  757. * @return $this
  758. */
  759. public function setName($name)
  760. {
  761. $this->name = $name;
  763. return $this;
  764. }
  766. /**
  767. * @param int $creationDate
  768. *
  769. * @return $this
  770. */
  771. public function setCreationDate($creationDate)
  772. {
  773. $this->creationDate = (int)$creationDate;
  775. return $this;
  776. }
  778. /**
  779. * @param int $modificationDate
  780. *
  781. * @return $this
  782. */
  783. public function setModificationDate($modificationDate)
  784. {
  785. $this->modificationDate = (int)$modificationDate;
  787. return $this;
  788. }
  790. /**
  791. * @param int $userOwner
  792. *
  793. * @return $this
  794. */
  795. public function setUserOwner($userOwner)
  796. {
  797. $this->userOwner = (int)$userOwner;
  799. return $this;
  800. }
  802. /**
  803. * @param int $userModification
  804. *
  805. * @return $this
  806. */
  807. public function setUserModification($userModification)
  808. {
  809. $this->userModification = (int)$userModification;
  811. return $this;
  812. }
  814. /**
  815. * @param array $context
  816. *
  817. * @return DataObject\ClassDefinition\Data[]
  818. */
  819. public function getFieldDefinitions($context = [])
  820. {
  821. if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  822. return $this->fieldDefinitions;
  823. }
  825. $enrichedFieldDefinitions = [];
  826. foreach ($this->fieldDefinitions as $key => $fieldDefinition) {
  827. $fieldDefinition = $this->doEnrichFieldDefinition($fieldDefinition, $context);
  828. $enrichedFieldDefinitions[$key] = $fieldDefinition;
  829. }
  831. return $enrichedFieldDefinitions;
  832. }
  834. /**
  835. * @internal
  836. */
  837. protected function doEnrichFieldDefinition($fieldDefinition, $context = [])
  838. {
  839. //TODO Pimcore 11: remove method_exists BC layer
  840. if ($fieldDefinition instanceof FieldDefinitionEnrichmentInterface || method_exists($fieldDefinition, 'enrichFieldDefinition')) {
  841. if (!$fieldDefinition instanceof FieldDefinitionEnrichmentInterface) {
  842. trigger_deprecation('pimcore/pimcore', '10.1',
  843. sprintf('Usage of method_exists is deprecated since version 10.1 and will be removed in Pimcore 11.' .
  844. 'Implement the %s interface instead.', FieldDefinitionEnrichmentInterface::class));
  845. }
  846. $context['class'] = $this;
  847. $fieldDefinition = $fieldDefinition->enrichFieldDefinition($context);
  848. }
  850. return $fieldDefinition;
  851. }
  853. /**
  854. * @return DataObject\ClassDefinition\Layout|null
  855. */
  856. public function getLayoutDefinitions()
  857. {
  858. return $this->layoutDefinitions;
  859. }
  861. /**
  862. * @param DataObject\ClassDefinition\Data[] $fieldDefinitions
  863. *
  864. * @return $this
  865. */
  866. public function setFieldDefinitions(array $fieldDefinitions)
  867. {
  868. $this->fieldDefinitions = $fieldDefinitions;
  870. return $this;
  871. }
  873. /**
  874. * @param string $key
  875. * @param DataObject\ClassDefinition\Data $data
  876. *
  877. * @return $this
  878. */
  879. public function addFieldDefinition($key, $data)
  880. {
  881. $this->fieldDefinitions[$key] = $data;
  883. return $this;
  884. }
  886. /**
  887. * @param string $key
  888. * @param array $context
  889. *
  890. * @return DataObject\ClassDefinition\Data|null
  891. */
  892. public function getFieldDefinition($key, $context = [])
  893. {
  894. if (array_key_exists($key, $this->fieldDefinitions)) {
  895. if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  896. return $this->fieldDefinitions[$key];
  897. }
  898. $fieldDefinition = $this->doEnrichFieldDefinition($this->fieldDefinitions[$key], $context);
  900. return $fieldDefinition;
  901. }
  903. return null;
  904. }
  906. /**
  907. * @param DataObject\ClassDefinition\Layout|null $layoutDefinitions
  908. *
  909. * @return $this
  910. */
  911. public function setLayoutDefinitions($layoutDefinitions)
  912. {
  913. $oldFieldDefinitions = null;
  914. if ($this->layoutDefinitions !== null) {
  915. $this->setDeletedDataComponents([]);
  916. $oldFieldDefinitions = $this->getFieldDefinitions();
  917. }
  919. $this->layoutDefinitions = $layoutDefinitions;
  921. $this->fieldDefinitions = [];
  922. $this->extractDataDefinitions($this->layoutDefinitions);
  924. if ($oldFieldDefinitions !== null) {
  925. $newFieldDefinitions = $this->getFieldDefinitions();
  926. $deletedComponents = [];
  927. foreach ($oldFieldDefinitions as $fieldDefinition) {
  928. if (!array_key_exists($fieldDefinition->getName(), $newFieldDefinitions)) {
  929. array_push($deletedComponents, $fieldDefinition);
  930. }
  931. }
  932. $this->setDeletedDataComponents($deletedComponents);
  933. }
  935. return $this;
  936. }
  938. /**
  939. * @param DataObject\ClassDefinition\Layout|DataObject\ClassDefinition\Data $def
  940. */
  941. private function extractDataDefinitions($def)
  942. {
  943. if ($def instanceof DataObject\ClassDefinition\Layout) {
  944. if ($def->hasChildren()) {
  945. foreach ($def->getChildren() as $child) {
  946. $this->extractDataDefinitions($child);
  947. }
  948. }
  949. }
  951. if ($def instanceof DataObject\ClassDefinition\Data) {
  952. $existing = $this->getFieldDefinition($def->getName());
  954. if (!$existing && method_exists($def, 'addReferencedField') && method_exists($def, 'setReferencedFields')) {
  955. $def->setReferencedFields([]);
  956. }
  958. if ($existing && method_exists($existing, 'addReferencedField')) {
  959. // this is especially for localized fields which get aggregated here into one field definition
  960. // in the case that there are more than one localized fields in the class definition
  961. // see also pimcore.object.edit.addToDataFields();
  962. $existing->addReferencedField($def);
  963. } else {
  964. $this->addFieldDefinition($def->getName(), $def);
  965. }
  966. }
  967. }
  969. /**
  970. * @return string
  971. */
  972. public function getParentClass()
  973. {
  974. return $this->parentClass;
  975. }
  977. /**
  978. * @return string
  979. */
  980. public function getListingParentClass()
  981. {
  982. return $this->listingParentClass;
  983. }
  985. /**
  986. * @return string
  987. */
  988. public function getUseTraits()
  989. {
  990. return $this->useTraits;
  991. }
  993. /**
  994. * @param string $useTraits
  995. *
  996. * @return ClassDefinition
  997. */
  998. public function setUseTraits($useTraits)
  999. {
  1000. $this->useTraits = (string) $useTraits;
  1002. return $this;
  1003. }
  1005. /**
  1006. * @return string
  1007. */
  1008. public function getListingUseTraits()
  1009. {
  1010. return $this->listingUseTraits;
  1011. }
  1013. /**
  1014. * @param string $listingUseTraits
  1015. *
  1016. * @return ClassDefinition
  1017. */
  1018. public function setListingUseTraits($listingUseTraits)
  1019. {
  1020. $this->listingUseTraits = (string) $listingUseTraits;
  1022. return $this;
  1023. }
  1025. /**
  1026. * @return bool
  1027. */
  1028. public function getAllowInherit()
  1029. {
  1030. return $this->allowInherit;
  1031. }
  1033. /**
  1034. * @return bool
  1035. */
  1036. public function getAllowVariants()
  1037. {
  1038. return $this->allowVariants;
  1039. }
  1041. /**
  1042. * @param string $parentClass
  1043. *
  1044. * @return $this
  1045. */
  1046. public function setParentClass($parentClass)
  1047. {
  1048. $this->parentClass = (string) $parentClass;
  1050. return $this;
  1051. }
  1053. /**
  1054. * @param string $listingParentClass
  1055. *
  1056. * @return $this
  1057. */
  1058. public function setListingParentClass($listingParentClass)
  1059. {
  1060. $this->listingParentClass = (string) $listingParentClass;
  1062. return $this;
  1063. }
  1065. /**
  1066. * @return bool
  1067. */
  1068. public function getEncryption(): bool
  1069. {
  1070. return $this->encryption;
  1071. }
  1073. /**
  1074. * @param bool $encryption
  1075. *
  1076. * @return $this
  1077. */
  1078. public function setEncryption(bool $encryption)
  1079. {
  1080. $this->encryption = $encryption;
  1082. return $this;
  1083. }
  1085. /**
  1086. * @internal
  1087. *
  1088. * @param array $tables
  1089. */
  1090. public function addEncryptedTables(array $tables)
  1091. {
  1092. $this->encryptedTables = array_unique(array_merge($this->encryptedTables, $tables));
  1093. }
  1095. /**
  1096. * @internal
  1097. *
  1098. * @param array $tables
  1099. */
  1100. public function removeEncryptedTables(array $tables)
  1101. {
  1102. foreach ($tables as $table) {
  1103. if (($key = array_search($table, $this->encryptedTables)) !== false) {
  1104. unset($this->encryptedTables[$key]);
  1105. }
  1106. }
  1107. }
  1109. /**
  1110. * @internal
  1111. *
  1112. * @param string $table
  1113. *
  1114. * @return bool
  1115. */
  1116. public function isEncryptedTable(string $table): bool
  1117. {
  1118. return (array_search($table, $this->encryptedTables) === false) ? false : true;
  1119. }
  1121. /**
  1122. * @return bool
  1123. */
  1124. public function hasEncryptedTables(): bool
  1125. {
  1126. return (bool) count($this->encryptedTables);
  1127. }
  1129. /**
  1130. * @internal
  1131. *
  1132. * @param array $encryptedTables
  1133. *
  1134. * @return $this
  1135. */
  1136. public function setEncryptedTables(array $encryptedTables)
  1137. {
  1138. $this->encryptedTables = $encryptedTables;
  1140. return $this;
  1141. }
  1143. /**
  1144. * @param bool $allowInherit
  1145. *
  1146. * @return $this
  1147. */
  1148. public function setAllowInherit($allowInherit)
  1149. {
  1150. $this->allowInherit = (bool)$allowInherit;
  1152. return $this;
  1153. }
  1155. /**
  1156. * @param bool $allowVariants
  1157. *
  1158. * @return $this
  1159. */
  1160. public function setAllowVariants($allowVariants)
  1161. {
  1162. $this->allowVariants = (bool)$allowVariants;
  1164. return $this;
  1165. }
  1167. /**
  1168. * @return string|null
  1169. */
  1170. public function getIcon()
  1171. {
  1172. return $this->icon;
  1173. }
  1175. /**
  1176. * @param string|null $icon
  1177. *
  1178. * @return $this
  1179. */
  1180. public function setIcon($icon)
  1181. {
  1182. $this->icon = $icon;
  1184. return $this;
  1185. }
  1187. /**
  1188. * @return array
  1189. */
  1190. public function getPropertyVisibility()
  1191. {
  1192. return $this->propertyVisibility;
  1193. }
  1195. /**
  1196. * @param array $propertyVisibility
  1197. *
  1198. * @return $this
  1199. */
  1200. public function setPropertyVisibility($propertyVisibility)
  1201. {
  1202. if (is_array($propertyVisibility)) {
  1203. $this->propertyVisibility = $propertyVisibility;
  1204. }
  1206. return $this;
  1207. }
  1209. /**
  1210. * @param string|null $previewUrl
  1211. *
  1212. * @return $this
  1213. */
  1214. public function setPreviewUrl($previewUrl)
  1215. {
  1216. $this->previewUrl = $previewUrl;
  1218. return $this;
  1219. }
  1221. /**
  1222. * @return string|null
  1223. */
  1224. public function getPreviewUrl()
  1225. {
  1226. return $this->previewUrl;
  1227. }
  1229. /**
  1230. * @return string|null
  1231. */
  1232. public function getGroup()
  1233. {
  1234. return $this->group;
  1235. }
  1237. /**
  1238. * @param string|null $group
  1239. *
  1240. * @return $this
  1241. */
  1242. public function setGroup($group)
  1243. {
  1244. $this->group = $group;
  1246. return $this;
  1247. }
  1249. /**
  1250. * @param string $description
  1251. *
  1252. * @return $this
  1253. */
  1254. public function setDescription($description)
  1255. {
  1256. $this->description = (string) $description;
  1258. return $this;
  1259. }
  1261. /**
  1262. * @return string
  1263. */
  1264. public function getDescription()
  1265. {
  1266. return $this->description;
  1267. }
  1269. /**
  1270. * @param bool $showVariants
  1271. *
  1272. * @return $this
  1273. */
  1274. public function setShowVariants($showVariants)
  1275. {
  1276. $this->showVariants = (bool)$showVariants;
  1278. return $this;
  1279. }
  1281. /**
  1282. * @return bool
  1283. */
  1284. public function getShowVariants()
  1285. {
  1286. return $this->showVariants;
  1287. }
  1289. /**
  1290. * @return bool
  1291. */
  1292. public function getShowAppLoggerTab()
  1293. {
  1294. return $this->showAppLoggerTab;
  1295. }
  1297. /**
  1298. * @param bool $showAppLoggerTab
  1299. *
  1300. * @return $this
  1301. */
  1302. public function setShowAppLoggerTab($showAppLoggerTab)
  1303. {
  1304. $this->showAppLoggerTab = (bool) $showAppLoggerTab;
  1306. return $this;
  1307. }
  1309. /**
  1310. * @return bool
  1311. */
  1312. public function getShowFieldLookup()
  1313. {
  1314. return $this->showFieldLookup;
  1315. }
  1317. /**
  1318. * @param bool $showFieldLookup
  1319. *
  1320. * @return $this
  1321. */
  1322. public function setShowFieldLookup($showFieldLookup)
  1323. {
  1324. $this->showFieldLookup = (bool) $showFieldLookup;
  1326. return $this;
  1327. }
  1329. /**
  1330. * @return string
  1331. */
  1332. public function getLinkGeneratorReference()
  1333. {
  1334. return $this->linkGeneratorReference;
  1335. }
  1337. /**
  1338. * @param string $linkGeneratorReference
  1339. *
  1340. * @return $this
  1341. */
  1342. public function setLinkGeneratorReference($linkGeneratorReference)
  1343. {
  1344. $this->linkGeneratorReference = $linkGeneratorReference;
  1346. return $this;
  1347. }
  1349. /**
  1350. * @return DataObject\ClassDefinition\LinkGeneratorInterface|null
  1351. */
  1352. public function getLinkGenerator()
  1353. {
  1354. return DataObject\ClassDefinition\Helper\LinkGeneratorResolver::resolveGenerator($this->getLinkGeneratorReference());
  1355. }
  1357. /**
  1358. * @return string|null
  1359. */
  1360. public function getPreviewGeneratorReference(): ?string
  1361. {
  1362. return $this->previewGeneratorReference;
  1363. }
  1365. /**
  1366. * @param string|null $previewGeneratorReference
  1367. */
  1368. public function setPreviewGeneratorReference(?string $previewGeneratorReference): void
  1369. {
  1370. $this->previewGeneratorReference = $previewGeneratorReference;
  1371. }
  1373. /**
  1374. * @return DataObject\ClassDefinition\PreviewGeneratorInterface|null
  1375. */
  1376. public function getPreviewGenerator()
  1377. {
  1378. return DataObject\ClassDefinition\Helper\PreviewGeneratorResolver::resolveGenerator($this->getPreviewGeneratorReference());
  1379. }
  1381. /**
  1382. * @return bool
  1383. */
  1384. public function isEnableGridLocking(): bool
  1385. {
  1386. return $this->enableGridLocking;
  1387. }
  1389. /**
  1390. * @param bool $enableGridLocking
  1391. */
  1392. public function setEnableGridLocking(bool $enableGridLocking): void
  1393. {
  1394. $this->enableGridLocking = $enableGridLocking;
  1395. }
  1397. /**
  1398. * @return string|null
  1399. */
  1400. public function getImplementsInterfaces(): ?string
  1401. {
  1402. return $this->implementsInterfaces;
  1403. }
  1405. /**
  1406. * @param string|null $implementsInterfaces
  1407. *
  1408. * @return $this
  1409. */
  1410. public function setImplementsInterfaces(?string $implementsInterfaces)
  1411. {
  1412. $this->implementsInterfaces = $implementsInterfaces;
  1414. return $this;
  1415. }
  1417. /**
  1418. * @return array
  1419. */
  1420. public function getCompositeIndices(): array
  1421. {
  1422. return $this->compositeIndices;
  1423. }
  1425. /**
  1426. * @param array|null $compositeIndices
  1427. *
  1428. * @return $this
  1429. */
  1430. public function setCompositeIndices($compositeIndices)
  1431. {
  1432. $class = $this->getFieldDefinitions([]);
  1433. foreach ($compositeIndices as $indexInd => $compositeIndex) {
  1434. foreach ($compositeIndex['index_columns'] as $fieldInd => $fieldName) {
  1435. if (isset($class[$fieldName]) && $class[$fieldName] instanceof ManyToOneRelation) {
  1436. $compositeIndices[$indexInd]['index_columns'][$fieldInd] = $fieldName . '__id';
  1437. $compositeIndices[$indexInd]['index_columns'][] = $fieldName . '__type';
  1438. $compositeIndices[$indexInd]['index_columns'] = array_unique($compositeIndices[$indexInd]['index_columns']);
  1439. }
  1440. }
  1441. }
  1442. $this->compositeIndices = $compositeIndices ?? [];
  1444. return $this;
  1445. }
  1447. /**
  1448. * @return bool
  1449. */
  1450. public function getGenerateTypeDeclarations()
  1451. {
  1452. return (bool) $this->generateTypeDeclarations;
  1453. }
  1455. /**
  1456. * @param bool $generateTypeDeclarations
  1457. *
  1458. * @return $this
  1459. */
  1460. public function setGenerateTypeDeclarations($generateTypeDeclarations)
  1461. {
  1462. $this->generateTypeDeclarations = (bool) $generateTypeDeclarations;
  1464. return $this;
  1465. }
  1467. /**
  1468. * @return ClassDefinition\Data[]
  1469. */
  1470. public function getDeletedDataComponents()
  1471. {
  1472. return $this->deletedDataComponents;
  1473. }
  1475. /**
  1476. * @param ClassDefinition\Data[] $deletedDataComponents
  1477. *
  1478. * @return $this
  1479. */
  1480. public function setDeletedDataComponents(array $deletedDataComponents): ClassDefinition
  1481. {
  1482. $this->deletedDataComponents = $deletedDataComponents;
  1484. return $this;
  1485. }
  1487. private function deleteDeletedDataComponentsInCustomLayout(): void
  1488. {
  1489. if (empty($this->getDeletedDataComponents())) {
  1490. return;
  1491. }
  1492. $customLayouts = new ClassDefinition\CustomLayout\Listing();
  1493. $id = $this->getId();
  1494. $customLayouts->setFilter(function (DataObject\ClassDefinition\CustomLayout $layout) use ($id) {
  1495. return $layout->getClassId() === $id;
  1496. });
  1497. $customLayouts = $customLayouts->load();
  1499. foreach ($customLayouts as $customLayout) {
  1500. $layoutDefinition = $customLayout->getLayoutDefinitions();
  1501. if ($layoutDefinition === null) {
  1502. continue;
  1503. }
  1504. $this->deleteDeletedDataComponentsInLayoutDefinition($layoutDefinition);
  1505. $customLayout->setLayoutDefinitions($layoutDefinition);
  1506. $customLayout->save();
  1507. }
  1508. }
  1510. private function deleteDeletedDataComponentsInLayoutDefinition(ClassDefinition\Layout $layoutDefinition): void
  1511. {
  1512. $componentsToDelete = $this->getDeletedDataComponents();
  1513. $componentDeleted = false;
  1515. $children = &$layoutDefinition->getChildrenByRef();
  1516. $count = count($children);
  1517. for ($i = 0; $i < $count; $i++) {
  1518. $component = $children[$i];
  1519. if (in_array($component, $componentsToDelete)) {
  1520. unset($children[$i]);
  1521. $componentDeleted = true;
  1522. }
  1523. if ($component instanceof ClassDefinition\Layout) {
  1524. $this->deleteDeletedDataComponentsInLayoutDefinition($component);
  1525. }
  1526. }
  1527. if ($componentDeleted) {
  1528. $children = array_values($children);
  1529. }
  1530. }
  1532. public static function getByIdIgnoreCase(string $id): ClassDefinition|null
  1533. {
  1534. try {
  1535. $class = new self();
  1536. $name = $class->getDao()->getNameByIdIgnoreCase($id);
  1537. $definitionFile = $class->getDefinitionFile($name);
  1538. $class = @include $definitionFile;
  1540. if (!$class instanceof self) {
  1541. throw new \Exception('Class definition with name ' . $name . ' or ID ' . $id . ' does not exist');
  1542. }
  1544. $class->setId($id);
  1545. } catch (\Exception $e) {
  1546. Logger::info($e->getMessage());
  1548. return null;
  1549. }
  1551. return $class;
  1552. }
  1553. }