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

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\Db;
  20. use Pimcore\Event\DataObjectClassDefinitionEvents;
  21. use Pimcore\Event\Model\DataObject\ClassDefinitionEvent;
  22. use Pimcore\File;
  23. use Pimcore\Logger;
  24. use Pimcore\Model;
  25. use Pimcore\Model\DataObject;
  26. use Pimcore\Model\DataObject\ClassDefinition\Data\FieldDefinitionEnrichmentInterface;
  28. /**
  29.  * @method \Pimcore\Model\DataObject\ClassDefinition\Dao getDao()
  30.  */
  31. final class ClassDefinition extends Model\AbstractModel
  32. {
  33.     use DataObject\ClassDefinition\Helper\VarExport;
  34.     use DataObject\Traits\LocateFileTrait;
  36.     /**
  37.      * @internal
  38.      *
  39.      * @var string|null
  40.      */
  41.     public $id;
  43.     /**
  44.      * @internal
  45.      *
  46.      * @var string|null
  47.      */
  48.     public $name;
  50.     /**
  51.      * @internal
  52.      *
  53.      * @var string
  54.      */
  55.     public $description = '';
  57.     /**
  58.      * @internal
  59.      *
  60.      * @var int
  61.      */
  62.     public $creationDate = 0;
  64.     /**
  65.      * @internal
  66.      *
  67.      * @var int
  68.      */
  69.     public $modificationDate = 0;
  71.     /**
  72.      * @internal
  73.      *
  74.      * @var int
  75.      */
  76.     public $userOwner = 0;
  78.     /**
  79.      * @internal
  80.      *
  81.      * @var int
  82.      */
  83.     public $userModification = 0;
  85.     /**
  86.      * @internal
  87.      *
  88.      * @var string
  89.      */
  90.     public $parentClass = '';
  92.     /**
  93.      * Comma separated list of interfaces
  94.      *
  95.      * @internal
  96.      *
  97.      * @var string|null
  98.      */
  99.     public $implementsInterfaces;
  101.     /**
  102.      * Name of the listing parent class if set
  103.      *
  104.      * @internal
  105.      *
  106.      * @var string
  107.      */
  108.     public $listingParentClass = '';
  110.     /**
  111.      * @internal
  112.      *
  113.      * @var string
  114.      */
  115.     public $useTraits = '';
  117.     /**
  118.      * @internal
  119.      *
  120.      * @var string
  121.      */
  122.     public $listingUseTraits = '';
  124.     /**
  125.      * @internal
  126.      *
  127.      * @var bool
  128.      */
  129.     protected $encryption = false;
  131.     /**
  132.      * @internal
  133.      *
  134.      * @var array
  135.      */
  136.     protected $encryptedTables = [];
  138.     /**
  139.      * @internal
  140.      *
  141.      * @var bool
  142.      */
  143.     public $allowInherit = false;
  145.     /**
  146.      * @internal
  147.      *
  148.      * @var bool
  149.      */
  150.     public $allowVariants = false;
  152.     /**
  153.      * @internal
  154.      *
  155.      * @var bool
  156.      */
  157.     public $showVariants = false;
  159.     /**
  160.      * @internal
  161.      *
  162.      * @var DataObject\ClassDefinition\Data[]
  163.      */
  164.     public array $fieldDefinitions = [];
  166.     /**
  167.      * @internal
  168.      *
  169.      * @var DataObject\ClassDefinition\Layout|null
  170.      */
  171.     public $layoutDefinitions;
  173.     /**
  174.      * @internal
  175.      *
  176.      * @var string
  177.      */
  178.     public $icon;
  180.     /**
  181.      * @internal
  182.      *
  183.      * @var string
  184.      */
  185.     public $previewUrl;
  187.     /**
  188.      * @internal
  189.      *
  190.      * @var string
  191.      */
  192.     public $group;
  194.     /**
  195.      * @internal
  196.      *
  197.      * @var bool
  198.      */
  199.     public $showAppLoggerTab = false;
  201.     /**
  202.      * @internal
  203.      *
  204.      * @var string
  205.      */
  206.     public $linkGeneratorReference;
  208.     /**
  209.      * @internal
  210.      *
  211.      * @var string|null
  212.      */
  213.     public $previewGeneratorReference;
  215.     /**
  216.      * @internal
  217.      *
  218.      * @var array
  219.      */
  220.     public $compositeIndices = [];
  222.     /**
  223.      * @internal
  224.      *
  225.      * @var bool
  226.      */
  227.     public $generateTypeDeclarations = true;
  229.     /**
  230.      * @internal
  231.      *
  232.      * @var bool
  233.      */
  234.     public $showFieldLookup = false;
  236.     /**
  237.      * @internal
  238.      *
  239.      * @var array
  240.      */
  241.     public $propertyVisibility = [
  242.         'grid' => [
  243.             'id' => true,
  244.             'path' => true,
  245.             'published' => true,
  246.             'modificationDate' => true,
  247.             'creationDate' => true,
  248.         ],
  249.         'search' => [
  250.             'id' => true,
  251.             'path' => true,
  252.             'published' => true,
  253.             'modificationDate' => true,
  254.             'creationDate' => true,
  255.         ],
  256.     ];
  258.     /**
  259.      * @internal
  260.      *
  261.      * @var bool
  262.      */
  263.     public $enableGridLocking = false;
  265.     /**
  266.      * @param string $id
  267.      * @param bool $force
  268.      *
  269.      * @return null|ClassDefinition
  270.      *
  271.      * @throws \Exception
  272.      */
  273.     public static function getById(string $id, $force = false)
  274.     {
  275.         $cacheKey = 'class_' . $id;
  277.         try {
  278.             if ($force) {
  279.                 throw new \Exception('Forced load');
  280.             }
  281.             $class = \Pimcore\Cache\Runtime::get($cacheKey);
  282.             if (!$class) {
  283.                 throw new \Exception('Class in registry is null');
  284.             }
  285.         } catch (\Exception $e) {
  286.             try {
  287.                 $class = new self();
  288.                 $name = $class->getDao()->getNameById($id);
  289.                 $definitionFile = $class->getDefinitionFile($name);
  290.                 $class = @include $definitionFile;
  292.                 if (!$class instanceof self) {
  293.                     throw new \Exception('Class definition with name ' . $name . ' or ID ' . $id . ' does not exist');
  294.                 }
  296.                 $class->setId($id);
  298.                 \Pimcore\Cache\Runtime::set($cacheKey, $class);
  299.             } catch (\Exception $e) {
  300.                 Logger::info($e->getMessage());
  302.                 return null;
  303.             }
  304.         }
  306.         return $class;
  307.     }
  309.     /**
  310.      * @param string $name
  311.      *
  312.      * @return self|null
  313.      *
  314.      * @throws \Exception
  315.      */
  316.     public static function getByName($name)
  317.     {
  318.         try {
  319.             $class = new self();
  320.             $id = $class->getDao()->getIdByName($name);
  322.             return self::getById($id);
  323.         } catch (Model\Exception\NotFoundException $e) {
  324.             return null;
  325.         }
  326.     }
  328.     /**
  329.      * @param array $values
  330.      *
  331.      * @return self
  332.      */
  333.     public static function create($values = [])
  334.     {
  335.         $class = new self();
  336.         $class->setValues($values);
  338.         return $class;
  339.     }
  341.     /**
  342.      * @internal
  343.      *
  344.      * @param string $name
  345.      */
  346.     public function rename($name)
  347.     {
  348.         $this->deletePhpClasses();
  349.         $this->getDao()->updateClassNameInObjects($name);
  351.         $this->setName($name);
  352.         $this->save();
  353.     }
  355.     /**
  356.      * @param mixed $data
  357.      *
  358.      * @internal
  359.      */
  360.     public static function cleanupForExport(&$data)
  361.     {
  362.         if (!is_object($data)) {
  363.             return;
  364.         }
  366.         if ($data instanceof DataObject\ClassDefinition\Data\VarExporterInterface) {
  367.             $blockedVars = $data->resolveBlockedVars();
  368.             foreach ($blockedVars as $blockedVar) {
  369.                 if (isset($data->{$blockedVar})) {
  370.                     unset($data->{$blockedVar});
  371.                 }
  372.             }
  374.             if (isset($data->blockedVarsForExport)) {
  375.                 unset($data->blockedVarsForExport);
  376.             }
  377.         }
  379.         if (method_exists($data, 'getChildren')) {
  380.             $children = $data->getChildren();
  381.             if (is_array($children)) {
  382.                 foreach ($children as $child) {
  383.                     self::cleanupForExport($child);
  384.                 }
  385.             }
  386.         }
  387.     }
  389.     /**
  390.      * @return bool
  391.      */
  392.     private function exists()
  393.     {
  394.         $name = $this->getDao()->getNameById($this->getId());
  396.         return is_string($name);
  397.     }
  399.     /**
  400.      * @param bool $saveDefinitionFile
  401.      *
  402.      * @throws \Exception
  403.      */
  404.     public function save($saveDefinitionFile = true)
  405.     {
  406.         $fieldDefinitions = $this->getFieldDefinitions();
  407.         foreach ($fieldDefinitions as $fd) {
  408.             if ($fd->isForbiddenName()) {
  409.                 throw new \Exception(sprintf('Forbidden name used for field definition: %s', $fd->getName()));
  410.             }
  412.             if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  413.                 $fd->preSave($this);
  414.             }
  415.         }
  417.         if (!$this->getId()) {
  418.             $db = Db::get();
  419.             $maxId = $db->fetchOne('SELECT MAX(CAST(id AS SIGNED)) FROM classes;');
  420.             $this->setId($maxId ? $maxId + 1 : 1);
  421.         }
  423.         if (!preg_match('/[a-zA-Z][a-zA-Z0-9_]+/', $this->getName())) {
  424.             throw new \Exception(sprintf('Invalid name for class definition: %s', $this->getName()));
  425.         }
  427.         if (!preg_match('/[a-zA-Z0-9]([a-zA-Z0-9_]+)?/', $this->getId())) {
  428.             throw new \Exception(sprintf('Invalid ID `%s` for class definition %s', $this->getId(), $this->getName()));
  429.         }
  431.         foreach (['parentClass', 'listingParentClass', 'useTraits', 'listingUseTraits'] as $propertyName) {
  432.             $propertyValue = $this->{'get'.ucfirst($propertyName)}();
  433.             if ($propertyValue && !preg_match('/^[a-zA-Z_\x7f-\xff\\\][a-zA-Z0-9_\x7f-\xff\\\ ,]*$/', $propertyValue)) {
  434.                 throw new \Exception(sprintf('Invalid %s value for class definition: %s', $propertyName,
  435.                     $this->getParentClass()));
  436.             }
  437.         }
  439.         $isUpdate = $this->exists();
  440.         if ($isUpdate && !$this->isWritable()) {
  441.             throw new \Exception('definitions in config/pimcore folder cannot be overwritten');
  442.         }
  444.         if (!$isUpdate) {
  445.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_ADD);
  446.         } else {
  447.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_UPDATE);
  448.         }
  450.         $this->setModificationDate(time());
  452.         $this->getDao()->save($isUpdate);
  454.         $this->generateClassFiles($saveDefinitionFile);
  456.         // empty object cache
  457.         try {
  458.             Cache::clearTag('class_'.$this->getId());
  459.         } catch (\Exception $e) {
  460.         }
  462.         foreach ($fieldDefinitions as $fd) {
  463.             if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  464.                 $fd->postSave($this);
  465.             }
  466.         }
  468.         if ($isUpdate) {
  469.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_UPDATE);
  470.         } else {
  471.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_ADD);
  472.         }
  473.     }
  475.     /**
  476.      * @param bool $generateDefinitionFile
  477.      *
  478.      * @throws \Exception
  479.      *
  480.      * @internal
  481.      */
  482.     public function generateClassFiles($generateDefinitionFile = true)
  483.     {
  484.         $infoDocBlock = $this->getInfoDocBlock();
  486.         // create class for object
  487.         $extendClass = 'Concrete';
  488.         if ($this->getParentClass()) {
  489.             $extendClass = $this->getParentClass();
  490.             $extendClass = '\\'.ltrim($extendClass, '\\');
  491.         }
  493.         $cd = '<?php';
  494.         $cd .= "\n\n";
  495.         $cd .= $infoDocBlock;
  496.         $cd .= "\n\n";
  497.         $cd .= 'namespace Pimcore\\Model\\DataObject;';
  498.         $cd .= "\n\n";
  499.         $cd .= 'use Pimcore\Model\DataObject\Exception\InheritanceParentNotFoundException;';
  500.         $cd .= "\n";
  501.         $cd .= 'use Pimcore\Model\DataObject\PreGetValueHookInterface;';
  502.         $cd .= "\n\n";
  503.         $cd .= "/**\n";
  504.         $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst($this->getName()).'\Listing getList()'."\n";
  505.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  506.             foreach ($this->getFieldDefinitions() as $key => $def) {
  507.                 if ($def instanceof DataObject\ClassDefinition\Data\Localizedfields) {
  508.                     $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  509.                             $this->getName()
  510.                         ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  511.                             $this->getName()
  512.                         ).'|null getBy'.ucfirst(
  513.                             $def->getName()
  514.                         ).'($field, $value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  516.                     foreach ($def->getFieldDefinitions() as $localizedFieldDefinition) {
  517.                         $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  518.                                 $this->getName()
  519.                             ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  520.                                 $this->getName()
  521.                             ).'|null getBy'.ucfirst(
  522.                                 $localizedFieldDefinition->getName()
  523.                             ).'($value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  524.                     }
  525.                 } elseif ($def->isFilterable()) {
  526.                     $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  527.                             $this->getName()
  528.                         ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  529.                             $this->getName()
  530.                         ).'|null getBy'.ucfirst($def->getName()).'($value, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  531.                 }
  532.             }
  533.         }
  534.         $cd .= "*/\n\n";
  536.         $implementsParts = [];
  538.         $implements = DataObject\ClassDefinition\Service::buildImplementsInterfacesCode($implementsParts, $this->getImplementsInterfaces());
  540.         $cd .= 'class '.ucfirst($this->getName()).' extends '.$extendClass. $implements . "\n";
  541.         $cd .= '{' . "\n";
  543.         $useParts = [];
  545.         $cd .= DataObject\ClassDefinition\Service::buildUseTraitsCode($useParts, $this->getUseTraits());
  547.         $cd .= 'protected $o_classId = "' . $this->getId(). "\";\n";
  548.         $cd .= 'protected $o_className = "'.$this->getName().'"'.";\n";
  550.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  551.             foreach ($this->getFieldDefinitions() as $key => $def) {
  552.                 if (!$def instanceof DataObject\ClassDefinition\Data\ReverseObjectRelation && !$def instanceof DataObject\ClassDefinition\Data\CalculatedValue
  553.                 ) {
  554.                     $cd .= 'protected $'.$key.";\n";
  555.                 }
  556.             }
  557.         }
  559.         $cd .= "\n\n";
  561.         $cd .= '/**'."\n";
  562.         $cd .= '* @param array $values'."\n";
  563.         $cd .= '* @return \\Pimcore\\Model\\DataObject\\'.ucfirst($this->getName())."\n";
  564.         $cd .= '*/'."\n";
  565.         $cd .= 'public static function create($values = array()) {';
  566.         $cd .= "\n";
  567.         $cd .= "\t".'$object = new static();'."\n";
  568.         $cd .= "\t".'$object->setValues($values);'."\n";
  569.         $cd .= "\t".'return $object;'."\n";
  570.         $cd .= '}';
  572.         $cd .= "\n\n";
  574.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  575.             foreach ($this->getFieldDefinitions() as $key => $def) {
  576.                 if ($def instanceof DataObject\ClassDefinition\Data\ReverseObjectRelation) {
  577.                     continue;
  578.                 }
  580.                 // get setter and getter code
  581.                 $cd .= $def->getGetterCode($this);
  582.                 $cd .= $def->getSetterCode($this);
  584.                 // 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
  585.                 //TODO Pimcore 11 remove method_exists call
  586.                 if (!$def instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface && method_exists($def, 'classSaved')) {
  587.                     $def->classSaved($this);
  588.                 }
  589.             }
  590.         }
  592.         $cd .= "}\n";
  593.         $cd .= "\n";
  595.         if (File::put($this->getPhpClassFile(), $cd) === false) {
  596.             throw new \Exception(sprintf('Cannot write class file in %s please check the rights on this directory', $this->getPhpClassFile()));
  597.         }
  599.         // create class for object list
  600.         $extendListingClass = 'DataObject\\Listing\\Concrete';
  601.         if ($this->getListingParentClass()) {
  602.             $extendListingClass = $this->getListingParentClass();
  603.             $extendListingClass = '\\'.ltrim($extendListingClass, '\\');
  604.         }
  606.         // create list class
  607.         $cd = '<?php';
  609.         $cd .= "\n\n";
  610.         $cd .= 'namespace Pimcore\\Model\\DataObject\\'.ucfirst($this->getName()).';';
  611.         $cd .= "\n\n";
  612.         $cd .= 'use Pimcore\\Model\\DataObject;';
  613.         $cd .= "\n\n";
  614.         $cd .= "/**\n";
  615.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())." current()\n";
  616.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."[] load()\n";
  617.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."[] getData()\n";
  618.         $cd .= ' */';
  619.         $cd .= "\n\n";
  620.         $cd .= 'class Listing extends '.$extendListingClass . "\n";
  621.         $cd .= '{' . "\n";
  623.         $cd .= DataObject\ClassDefinition\Service::buildUseTraitsCode([], $this->getListingUseTraits());
  625.         $cd .= 'protected $classId = "'. $this->getId()."\";\n";
  626.         $cd .= 'protected $className = "'.$this->getName().'"'.";\n";
  628.         $cd .= "\n\n";
  630.         if (\is_array($this->getFieldDefinitions())) {
  631.             foreach ($this->getFieldDefinitions() as $key => $def) {
  632.                 if ($def instanceof DataObject\ClassDefinition\Data\Localizedfields) {
  633.                     foreach ($def->getFieldDefinitions() as $localizedFieldDefinition) {
  634.                         $cd .= $localizedFieldDefinition->getFilterCode();
  635.                     }
  636.                 } elseif ($def->isFilterable()) {
  637.                     $cd .= $def->getFilterCode();
  638.                 }
  639.             }
  640.         }
  642.         $cd .= "\n\n";
  643.         $cd .= "}\n";
  645.         if (File::put($this->getPhpListingClassFile(), $cd) === false) {
  646.             throw new \Exception(
  647.                 sprintf('Cannot write class file in %s please check the rights on this directory', $this->getPhpListingClassFile())
  648.             );
  649.         }
  651.         if ($generateDefinitionFile) {
  652.             // save definition as a php file
  653.             $definitionFile = $this->getDefinitionFile();
  654.             if (!is_writable(dirname($definitionFile)) || (is_file($definitionFile) && !is_writable($definitionFile))) {
  655.                 throw new \Exception(
  656.                     'Cannot write definition file in: '.$definitionFile.' please check write permission on this directory.'
  657.                 );
  658.             }
  659.             /** @var self $clone */
  660.             $clone = DataObject\Service::cloneDefinition($this);
  661.             $clone->setDao(null);
  662.             $clone->fieldDefinitions = [];
  664.             self::cleanupForExport($clone->layoutDefinitions);
  666.             $exportedClass = var_export($clone, true);
  668.             $data = '<?php';
  669.             $data .= "\n\n";
  670.             $data .= $infoDocBlock;
  671.             $data .= "\n\n";
  673.             $data .= "\nreturn ".$exportedClass.";\n";
  675.             \Pimcore\File::putPhpFile($definitionFile, $data);
  676.         }
  677.     }
  679.     /**
  680.      * @return string
  681.      *
  682.      * @internal
  683.      */
  684.     protected function getInfoDocBlock()
  685.     {
  686.         $cd = '/**' . "\n";
  687.         $cd .= '* Inheritance: '.($this->getAllowInherit() ? 'yes' : 'no')."\n";
  688.         $cd .= '* Variants: '.($this->getAllowVariants() ? 'yes' : 'no')."\n";
  690.         if ($this->getDescription()) {
  691.             $description = str_replace(['/**', '*/', '//'], '', $this->getDescription());
  692.             $description = str_replace("\n", "\n* ", $description);
  694.             $cd .= '* '.$description."\n";
  695.         }
  697.         $cd .= "\n\n";
  698.         $cd .= "Fields Summary:\n";
  700.         $cd = $this->getInfoDocBlockForFields($this, $cd, 1);
  702.         $cd .= '*/';
  704.         return $cd;
  705.     }
  707.     /**
  708.      * @internal
  709.      *
  710.      * @param ClassDefinition|ClassDefinition\Data $definition
  711.      * @param string $text
  712.      * @param int $level
  713.      *
  714.      * @return string
  715.      */
  716.     protected function getInfoDocBlockForFields($definition, $text, $level)
  717.     {
  718.         foreach ($definition->getFieldDefinitions() as $fd) {
  719.             $text .= str_pad('', $level, '-').' '.$fd->getName().' ['.$fd->getFieldtype()."]\n";
  720.             if (method_exists($fd, 'getFieldDefinitions')) {
  721.                 $text = $this->getInfoDocBlockForFields($fd, $text, $level + 1);
  722.             }
  723.         }
  725.         return $text;
  726.     }
  728.     public function delete()
  729.     {
  730.         \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_DELETE);
  732.         // delete all objects using this class
  733.         $list = new Listing();
  734.         $list->setCondition('o_classId = ?', $this->getId());
  735.         $list->load();
  737.         foreach ($list->getObjects() as $o) {
  738.             $o->delete();
  739.         }
  741.         $this->deletePhpClasses();
  743.         // empty object cache
  744.         try {
  745.             Cache::clearTag('class_'.$this->getId());
  746.         } catch (\Exception $e) {
  747.         }
  749.         // empty output cache
  750.         try {
  751.             Cache::clearTag('output');
  752.         } catch (\Exception $e) {
  753.         }
  755.         $customLayouts = new ClassDefinition\CustomLayout\Listing();
  756.         $customLayouts->setCondition('classId = ?', $this->getId());
  757.         $customLayouts = $customLayouts->load();
  759.         foreach ($customLayouts as $customLayout) {
  760.             $customLayout->delete();
  761.         }
  763.         $brickListing = new DataObject\Objectbrick\Definition\Listing();
  764.         $brickListing = $brickListing->load();
  765.         foreach ($brickListing as $brickDefinition) {
  766.             $modified = false;
  768.             $classDefinitions = $brickDefinition->getClassDefinitions();
  769.             if (is_array($classDefinitions)) {
  770.                 foreach ($classDefinitions as $key => $classDefinition) {
  771.                     if ($classDefinition['classname'] == $this->getId()) {
  772.                         unset($classDefinitions[$key]);
  773.                         $modified = true;
  774.                     }
  775.                 }
  776.             }
  777.             if ($modified) {
  778.                 $brickDefinition->setClassDefinitions($classDefinitions);
  779.                 $brickDefinition->save();
  780.             }
  781.         }
  783.         $this->getDao()->delete();
  785.         \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_DELETE);
  786.     }
  788.     private function deletePhpClasses()
  789.     {
  790.         // delete the class files
  791.         @unlink($this->getPhpClassFile());
  792.         @unlink($this->getPhpListingClassFile());
  793.         @rmdir(dirname($this->getPhpListingClassFile()));
  794.         @unlink($this->getDefinitionFile());
  795.     }
  797.     /**
  798.      * @internal
  799.      *
  800.      * @return bool
  801.      */
  802.     public function isWritable(): bool
  803.     {
  804.         if (getenv('PIMCORE_CLASS_DEFINITION_WRITABLE')) {
  805.             return true;
  806.         }
  808.         return !str_starts_with($this->getDefinitionFile(), PIMCORE_CUSTOM_CONFIGURATION_DIRECTORY);
  809.     }
  811.     /**
  812.      * @internal
  813.      *
  814.      * @param string|null $name
  815.      *
  816.      * @return string
  817.      */
  818.     public function getDefinitionFile($name = null)
  819.     {
  820.         return $this->locateFile($name ?? $this->getName(), 'definition_%s.php');
  821.     }
  823.     private function getPhpClassFile(): string
  824.     {
  825.         return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s.php');
  826.     }
  828.     private function getPhpListingClassFile(): string
  829.     {
  830.         return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s/Listing.php');
  831.     }
  833.     /**
  834.      * @return string|null
  835.      */
  836.     public function getId()
  837.     {
  838.         return $this->id;
  839.     }
  841.     /**
  842.      * @return string|null
  843.      */
  844.     public function getName()
  845.     {
  846.         return $this->name;
  847.     }
  849.     /**
  850.      * @return int
  851.      */
  852.     public function getCreationDate()
  853.     {
  854.         return $this->creationDate;
  855.     }
  857.     /**
  858.      * @return int
  859.      */
  860.     public function getModificationDate()
  861.     {
  862.         return $this->modificationDate;
  863.     }
  865.     /**
  866.      * @return int
  867.      */
  868.     public function getUserOwner()
  869.     {
  870.         return $this->userOwner;
  871.     }
  873.     /**
  874.      * @return int
  875.      */
  876.     public function getUserModification()
  877.     {
  878.         return $this->userModification;
  879.     }
  881.     /**
  882.      * @param string $id
  883.      *
  884.      * @return $this
  885.      */
  886.     public function setId($id)
  887.     {
  888.         $this->id = $id;
  890.         return $this;
  891.     }
  893.     /**
  894.      * @param string $name
  895.      *
  896.      * @return $this
  897.      */
  898.     public function setName($name)
  899.     {
  900.         $this->name = $name;
  902.         return $this;
  903.     }
  905.     /**
  906.      * @param int $creationDate
  907.      *
  908.      * @return $this
  909.      */
  910.     public function setCreationDate($creationDate)
  911.     {
  912.         $this->creationDate = (int)$creationDate;
  914.         return $this;
  915.     }
  917.     /**
  918.      * @param int $modificationDate
  919.      *
  920.      * @return $this
  921.      */
  922.     public function setModificationDate($modificationDate)
  923.     {
  924.         $this->modificationDate = (int)$modificationDate;
  926.         return $this;
  927.     }
  929.     /**
  930.      * @param int $userOwner
  931.      *
  932.      * @return $this
  933.      */
  934.     public function setUserOwner($userOwner)
  935.     {
  936.         $this->userOwner = (int)$userOwner;
  938.         return $this;
  939.     }
  941.     /**
  942.      * @param int $userModification
  943.      *
  944.      * @return $this
  945.      */
  946.     public function setUserModification($userModification)
  947.     {
  948.         $this->userModification = (int)$userModification;
  950.         return $this;
  951.     }
  953.     /**
  954.      * @param array $context
  955.      *
  956.      * @return DataObject\ClassDefinition\Data[]
  957.      */
  958.     public function getFieldDefinitions($context = [])
  959.     {
  960.         if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  961.             return $this->fieldDefinitions;
  962.         }
  964.         $enrichedFieldDefinitions = [];
  965.         foreach ($this->fieldDefinitions as $key => $fieldDefinition) {
  966.             $fieldDefinition = $this->doEnrichFieldDefinition($fieldDefinition, $context);
  967.             $enrichedFieldDefinitions[$key] = $fieldDefinition;
  968.         }
  970.         return $enrichedFieldDefinitions;
  971.     }
  973.     /**
  974.      * @internal
  975.      */
  976.     protected function doEnrichFieldDefinition($fieldDefinition, $context = [])
  977.     {
  978.         //TODO Pimcore 11: remove method_exists BC layer
  979.         if ($fieldDefinition instanceof FieldDefinitionEnrichmentInterface || method_exists($fieldDefinition, 'enrichFieldDefinition')) {
  980.             if (!$fieldDefinition instanceof FieldDefinitionEnrichmentInterface) {
  981.                 trigger_deprecation('pimcore/pimcore', '10.1',
  982.                     sprintf('Usage of method_exists is deprecated since version 10.1 and will be removed in Pimcore 11.' .
  983.                     'Implement the %s interface instead.', FieldDefinitionEnrichmentInterface::class));
  984.             }
  985.             $context['class'] = $this;
  986.             $fieldDefinition = $fieldDefinition->enrichFieldDefinition($context);
  987.         }
  989.         return $fieldDefinition;
  990.     }
  992.     /**
  993.      * @return DataObject\ClassDefinition\Layout|null
  994.      */
  995.     public function getLayoutDefinitions()
  996.     {
  997.         return $this->layoutDefinitions;
  998.     }
  1000.     /**
  1001.      * @param DataObject\ClassDefinition\Data[] $fieldDefinitions
  1002.      *
  1003.      * @return $this
  1004.      */
  1005.     public function setFieldDefinitions(array $fieldDefinitions)
  1006.     {
  1007.         $this->fieldDefinitions = $fieldDefinitions;
  1009.         return $this;
  1010.     }
  1012.     /**
  1013.      * @param string $key
  1014.      * @param DataObject\ClassDefinition\Data $data
  1015.      *
  1016.      * @return $this
  1017.      */
  1018.     public function addFieldDefinition($key, $data)
  1019.     {
  1020.         $this->fieldDefinitions[$key] = $data;
  1022.         return $this;
  1023.     }
  1025.     /**
  1026.      * @param string $key
  1027.      * @param array $context
  1028.      *
  1029.      * @return DataObject\ClassDefinition\Data|null
  1030.      */
  1031.     public function getFieldDefinition($key, $context = [])
  1032.     {
  1033.         if (array_key_exists($key, $this->fieldDefinitions)) {
  1034.             if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  1035.                 return $this->fieldDefinitions[$key];
  1036.             }
  1037.             $fieldDefinition = $this->doEnrichFieldDefinition($this->fieldDefinitions[$key], $context);
  1039.             return $fieldDefinition;
  1040.         }
  1042.         return null;
  1043.     }
  1045.     /**
  1046.      * @param DataObject\ClassDefinition\Layout|null $layoutDefinitions
  1047.      *
  1048.      * @return $this
  1049.      */
  1050.     public function setLayoutDefinitions($layoutDefinitions)
  1051.     {
  1052.         $this->layoutDefinitions = $layoutDefinitions;
  1054.         $this->fieldDefinitions = [];
  1055.         $this->extractDataDefinitions($this->layoutDefinitions);
  1057.         return $this;
  1058.     }
  1060.     /**
  1061.      * @param DataObject\ClassDefinition\Layout|DataObject\ClassDefinition\Data $def
  1062.      */
  1063.     private function extractDataDefinitions($def)
  1064.     {
  1065.         if ($def instanceof DataObject\ClassDefinition\Layout) {
  1066.             if ($def->hasChildren()) {
  1067.                 foreach ($def->getChildren() as $child) {
  1068.                     $this->extractDataDefinitions($child);
  1069.                 }
  1070.             }
  1071.         }
  1073.         if ($def instanceof DataObject\ClassDefinition\Data) {
  1074.             $existing = $this->getFieldDefinition($def->getName());
  1076.             if (!$existing && method_exists($def, 'addReferencedField') && method_exists($def, 'setReferencedFields')) {
  1077.                 $def->setReferencedFields([]);
  1078.             }
  1080.             if ($existing && method_exists($existing, 'addReferencedField')) {
  1081.                 // this is especially for localized fields which get aggregated here into one field definition
  1082.                 // in the case that there are more than one localized fields in the class definition
  1083.                 // see also pimcore.object.edit.addToDataFields();
  1084.                 $existing->addReferencedField($def);
  1085.             } else {
  1086.                 $this->addFieldDefinition($def->getName(), $def);
  1087.             }
  1088.         }
  1089.     }
  1091.     /**
  1092.      * @return string
  1093.      */
  1094.     public function getParentClass()
  1095.     {
  1096.         return $this->parentClass;
  1097.     }
  1099.     /**
  1100.      * @return string
  1101.      */
  1102.     public function getListingParentClass()
  1103.     {
  1104.         return $this->listingParentClass;
  1105.     }
  1107.     /**
  1108.      * @return string
  1109.      */
  1110.     public function getUseTraits()
  1111.     {
  1112.         return $this->useTraits;
  1113.     }
  1115.     /**
  1116.      * @param string $useTraits
  1117.      *
  1118.      * @return ClassDefinition
  1119.      */
  1120.     public function setUseTraits($useTraits)
  1121.     {
  1122.         $this->useTraits = (string) $useTraits;
  1124.         return $this;
  1125.     }
  1127.     /**
  1128.      * @return string
  1129.      */
  1130.     public function getListingUseTraits()
  1131.     {
  1132.         return $this->listingUseTraits;
  1133.     }
  1135.     /**
  1136.      * @param string $listingUseTraits
  1137.      *
  1138.      * @return ClassDefinition
  1139.      */
  1140.     public function setListingUseTraits($listingUseTraits)
  1141.     {
  1142.         $this->listingUseTraits = (string) $listingUseTraits;
  1144.         return $this;
  1145.     }
  1147.     /**
  1148.      * @return bool
  1149.      */
  1150.     public function getAllowInherit()
  1151.     {
  1152.         return $this->allowInherit;
  1153.     }
  1155.     /**
  1156.      * @return bool
  1157.      */
  1158.     public function getAllowVariants()
  1159.     {
  1160.         return $this->allowVariants;
  1161.     }
  1163.     /**
  1164.      * @param string $parentClass
  1165.      *
  1166.      * @return $this
  1167.      */
  1168.     public function setParentClass($parentClass)
  1169.     {
  1170.         $this->parentClass = $parentClass;
  1172.         return $this;
  1173.     }
  1175.     /**
  1176.      * @param string $listingParentClass
  1177.      *
  1178.      * @return $this
  1179.      */
  1180.     public function setListingParentClass($listingParentClass)
  1181.     {
  1182.         $this->listingParentClass = (string) $listingParentClass;
  1184.         return $this;
  1185.     }
  1187.     /**
  1188.      * @return bool
  1189.      */
  1190.     public function getEncryption(): bool
  1191.     {
  1192.         return $this->encryption;
  1193.     }
  1195.     /**
  1196.      * @param bool $encryption
  1197.      *
  1198.      * @return $this
  1199.      */
  1200.     public function setEncryption(bool $encryption)
  1201.     {
  1202.         $this->encryption = $encryption;
  1204.         return $this;
  1205.     }
  1207.     /**
  1208.      * @internal
  1209.      *
  1210.      * @param array $tables
  1211.      */
  1212.     public function addEncryptedTables(array $tables)
  1213.     {
  1214.         $this->encryptedTables = array_unique(array_merge($this->encryptedTables, $tables));
  1215.     }
  1217.     /**
  1218.      * @internal
  1219.      *
  1220.      * @param array $tables
  1221.      */
  1222.     public function removeEncryptedTables(array $tables)
  1223.     {
  1224.         foreach ($tables as $table) {
  1225.             if (($key = array_search($table, $this->encryptedTables)) !== false) {
  1226.                 unset($this->encryptedTables[$key]);
  1227.             }
  1228.         }
  1229.     }
  1231.     /**
  1232.      * @internal
  1233.      *
  1234.      * @param string $table
  1235.      *
  1236.      * @return bool
  1237.      */
  1238.     public function isEncryptedTable(string $table): bool
  1239.     {
  1240.         return (array_search($table, $this->encryptedTables) === false) ? false : true;
  1241.     }
  1243.     /**
  1244.      * @return bool
  1245.      */
  1246.     public function hasEncryptedTables(): bool
  1247.     {
  1248.         return (bool) count($this->encryptedTables);
  1249.     }
  1251.     /**
  1252.      * @internal
  1253.      *
  1254.      * @param array $encryptedTables
  1255.      *
  1256.      * @return $this
  1257.      */
  1258.     public function setEncryptedTables(array $encryptedTables)
  1259.     {
  1260.         $this->encryptedTables = $encryptedTables;
  1262.         return $this;
  1263.     }
  1265.     /**
  1266.      * @param bool $allowInherit
  1267.      *
  1268.      * @return $this
  1269.      */
  1270.     public function setAllowInherit($allowInherit)
  1271.     {
  1272.         $this->allowInherit = (bool)$allowInherit;
  1274.         return $this;
  1275.     }
  1277.     /**
  1278.      * @param bool $allowVariants
  1279.      *
  1280.      * @return $this
  1281.      */
  1282.     public function setAllowVariants($allowVariants)
  1283.     {
  1284.         $this->allowVariants = (bool)$allowVariants;
  1286.         return $this;
  1287.     }
  1289.     /**
  1290.      * @return string
  1291.      */
  1292.     public function getIcon()
  1293.     {
  1294.         return $this->icon;
  1295.     }
  1297.     /**
  1298.      * @param string $icon
  1299.      *
  1300.      * @return $this
  1301.      */
  1302.     public function setIcon($icon)
  1303.     {
  1304.         $this->icon = $icon;
  1306.         return $this;
  1307.     }
  1309.     /**
  1310.      * @return array
  1311.      */
  1312.     public function getPropertyVisibility()
  1313.     {
  1314.         return $this->propertyVisibility;
  1315.     }
  1317.     /**
  1318.      * @param array $propertyVisibility
  1319.      *
  1320.      * @return $this
  1321.      */
  1322.     public function setPropertyVisibility($propertyVisibility)
  1323.     {
  1324.         if (is_array($propertyVisibility)) {
  1325.             $this->propertyVisibility = $propertyVisibility;
  1326.         }
  1328.         return $this;
  1329.     }
  1331.     /**
  1332.      * @param string $previewUrl
  1333.      *
  1334.      * @return $this
  1335.      */
  1336.     public function setPreviewUrl($previewUrl)
  1337.     {
  1338.         $this->previewUrl = $previewUrl;
  1340.         return $this;
  1341.     }
  1343.     /**
  1344.      * @return string
  1345.      */
  1346.     public function getPreviewUrl()
  1347.     {
  1348.         return $this->previewUrl;
  1349.     }
  1351.     /**
  1352.      * @return string
  1353.      */
  1354.     public function getGroup()
  1355.     {
  1356.         return $this->group;
  1357.     }
  1359.     /**
  1360.      * @param string $group
  1361.      *
  1362.      * @return $this
  1363.      */
  1364.     public function setGroup($group)
  1365.     {
  1366.         $this->group = $group;
  1368.         return $this;
  1369.     }
  1371.     /**
  1372.      * @param string $description
  1373.      *
  1374.      * @return $this
  1375.      */
  1376.     public function setDescription($description)
  1377.     {
  1378.         $this->description = $description;
  1380.         return $this;
  1381.     }
  1383.     /**
  1384.      * @return string
  1385.      */
  1386.     public function getDescription()
  1387.     {
  1388.         return $this->description;
  1389.     }
  1391.     /**
  1392.      * @param bool $showVariants
  1393.      *
  1394.      * @return $this
  1395.      */
  1396.     public function setShowVariants($showVariants)
  1397.     {
  1398.         $this->showVariants = (bool)$showVariants;
  1400.         return $this;
  1401.     }
  1403.     /**
  1404.      * @return bool
  1405.      */
  1406.     public function getShowVariants()
  1407.     {
  1408.         return $this->showVariants;
  1409.     }
  1411.     /**
  1412.      * @return bool
  1413.      */
  1414.     public function getShowAppLoggerTab()
  1415.     {
  1416.         return $this->showAppLoggerTab;
  1417.     }
  1419.     /**
  1420.      * @param bool $showAppLoggerTab
  1421.      *
  1422.      * @return $this
  1423.      */
  1424.     public function setShowAppLoggerTab($showAppLoggerTab)
  1425.     {
  1426.         $this->showAppLoggerTab = (bool) $showAppLoggerTab;
  1428.         return $this;
  1429.     }
  1431.     /**
  1432.      * @return bool
  1433.      */
  1434.     public function getShowFieldLookup()
  1435.     {
  1436.         return $this->showFieldLookup;
  1437.     }
  1439.     /**
  1440.      * @param bool $showFieldLookup
  1441.      *
  1442.      * @return $this
  1443.      */
  1444.     public function setShowFieldLookup($showFieldLookup)
  1445.     {
  1446.         $this->showFieldLookup = (bool) $showFieldLookup;
  1448.         return $this;
  1449.     }
  1451.     /**
  1452.      * @return string
  1453.      */
  1454.     public function getLinkGeneratorReference()
  1455.     {
  1456.         return $this->linkGeneratorReference;
  1457.     }
  1459.     /**
  1460.      * @param string $linkGeneratorReference
  1461.      *
  1462.      * @return $this
  1463.      */
  1464.     public function setLinkGeneratorReference($linkGeneratorReference)
  1465.     {
  1466.         $this->linkGeneratorReference = $linkGeneratorReference;
  1468.         return $this;
  1469.     }
  1471.     /**
  1472.      * @return DataObject\ClassDefinition\LinkGeneratorInterface|null
  1473.      */
  1474.     public function getLinkGenerator()
  1475.     {
  1476.         return DataObject\ClassDefinition\Helper\LinkGeneratorResolver::resolveGenerator($this->getLinkGeneratorReference());
  1477.     }
  1479.     /**
  1480.      * @return string|null
  1481.      */
  1482.     public function getPreviewGeneratorReference(): ?string
  1483.     {
  1484.         return $this->previewGeneratorReference;
  1485.     }
  1487.     /**
  1488.      * @param string|null $previewGeneratorReference
  1489.      */
  1490.     public function setPreviewGeneratorReference(?string $previewGeneratorReference): void
  1491.     {
  1492.         $this->previewGeneratorReference = $previewGeneratorReference;
  1493.     }
  1495.     /**
  1496.      * @return DataObject\ClassDefinition\PreviewGeneratorInterface|null
  1497.      */
  1498.     public function getPreviewGenerator()
  1499.     {
  1500.         return DataObject\ClassDefinition\Helper\PreviewGeneratorResolver::resolveGenerator($this->getPreviewGeneratorReference());
  1501.     }
  1503.     /**
  1504.      * @return bool
  1505.      */
  1506.     public function isEnableGridLocking(): bool
  1507.     {
  1508.         return $this->enableGridLocking;
  1509.     }
  1511.     /**
  1512.      * @param bool $enableGridLocking
  1513.      */
  1514.     public function setEnableGridLocking(bool $enableGridLocking): void
  1515.     {
  1516.         $this->enableGridLocking = $enableGridLocking;
  1517.     }
  1519.     /**
  1520.      * @return string|null
  1521.      */
  1522.     public function getImplementsInterfaces(): ?string
  1523.     {
  1524.         return $this->implementsInterfaces;
  1525.     }
  1527.     /**
  1528.      * @param string|null $implementsInterfaces
  1529.      *
  1530.      * @return $this
  1531.      */
  1532.     public function setImplementsInterfaces(?string $implementsInterfaces)
  1533.     {
  1534.         $this->implementsInterfaces = $implementsInterfaces;
  1536.         return $this;
  1537.     }
  1539.     /**
  1540.      * @return array
  1541.      */
  1542.     public function getCompositeIndices(): array
  1543.     {
  1544.         return $this->compositeIndices;
  1545.     }
  1547.     /**
  1548.      * @param array $compositeIndices
  1549.      *
  1550.      * @return $this
  1551.      */
  1552.     public function setCompositeIndices($compositeIndices)
  1553.     {
  1554.         $this->compositeIndices = $compositeIndices ?? [];
  1556.         return $this;
  1557.     }
  1559.     /**
  1560.      * @return bool
  1561.      */
  1562.     public function getGenerateTypeDeclarations()
  1563.     {
  1564.         return (bool) $this->generateTypeDeclarations;
  1565.     }
  1567.     /**
  1568.      * @param bool $generateTypeDeclarations
  1569.      *
  1570.      * @return $this
  1571.      */
  1572.     public function setGenerateTypeDeclarations($generateTypeDeclarations)
  1573.     {
  1574.         $this->generateTypeDeclarations = (bool) $generateTypeDeclarations;
  1576.         return $this;
  1577.     }
  1578. }