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

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\Event\Traits\RecursionBlockingEventDispatchHelperTrait;
  23. use Pimcore\File;
  24. use Pimcore\Logger;
  25. use Pimcore\Model;
  26. use Pimcore\Model\DataObject;
  27. use Pimcore\Model\DataObject\ClassDefinition\Data\FieldDefinitionEnrichmentInterface;
  29. /**
  30.  * @method \Pimcore\Model\DataObject\ClassDefinition\Dao getDao()
  31.  */
  32. final class ClassDefinition extends Model\AbstractModel
  33. {
  34.     use DataObject\ClassDefinition\Helper\VarExport;
  35.     use DataObject\Traits\LocateFileTrait;
  36.     use RecursionBlockingEventDispatchHelperTrait;
  38.     /**
  39.      * @internal
  40.      *
  41.      * @var string|null
  42.      */
  43.     public $id;
  45.     /**
  46.      * @internal
  47.      *
  48.      * @var string|null
  49.      */
  50.     public $name;
  52.     /**
  53.      * @internal
  54.      *
  55.      * @var string
  56.      */
  57.     public $description = '';
  59.     /**
  60.      * @internal
  61.      *
  62.      * @var int|null
  63.      */
  64.     public $creationDate;
  66.     /**
  67.      * @internal
  68.      *
  69.      * @var int|null
  70.      */
  71.     public $modificationDate;
  73.     /**
  74.      * @internal
  75.      *
  76.      * @var int|null
  77.      */
  78.     public $userOwner;
  80.     /**
  81.      * @internal
  82.      *
  83.      * @var int|null
  84.      */
  85.     public $userModification;
  87.     /**
  88.      * @internal
  89.      *
  90.      * @var string
  91.      */
  92.     public $parentClass = '';
  94.     /**
  95.      * Comma separated list of interfaces
  96.      *
  97.      * @internal
  98.      *
  99.      * @var string|null
  100.      */
  101.     public $implementsInterfaces;
  103.     /**
  104.      * Name of the listing parent class if set
  105.      *
  106.      * @internal
  107.      *
  108.      * @var string
  109.      */
  110.     public $listingParentClass = '';
  112.     /**
  113.      * @internal
  114.      *
  115.      * @var string
  116.      */
  117.     public $useTraits = '';
  119.     /**
  120.      * @internal
  121.      *
  122.      * @var string
  123.      */
  124.     public $listingUseTraits = '';
  126.     /**
  127.      * @internal
  128.      *
  129.      * @var bool
  130.      */
  131.     protected $encryption = false;
  133.     /**
  134.      * @internal
  135.      *
  136.      * @var array
  137.      */
  138.     protected $encryptedTables = [];
  140.     /**
  141.      * @internal
  142.      *
  143.      * @var bool
  144.      */
  145.     public $allowInherit = false;
  147.     /**
  148.      * @internal
  149.      *
  150.      * @var bool
  151.      */
  152.     public $allowVariants = false;
  154.     /**
  155.      * @internal
  156.      *
  157.      * @var bool
  158.      */
  159.     public $showVariants = false;
  161.     /**
  162.      * @internal
  163.      *
  164.      * @var DataObject\ClassDefinition\Data[]
  165.      */
  166.     public array $fieldDefinitions = [];
  168.     /**
  169.      * @internal
  170.      *
  171.      * @var DataObject\ClassDefinition\Layout|null
  172.      */
  173.     public $layoutDefinitions;
  175.     /**
  176.      * @internal
  177.      *
  178.      * @var string
  179.      */
  180.     public $icon;
  182.     /**
  183.      * @internal
  184.      *
  185.      * @var string
  186.      */
  187.     public $previewUrl;
  189.     /**
  190.      * @internal
  191.      *
  192.      * @var string
  193.      */
  194.     public $group;
  196.     /**
  197.      * @internal
  198.      *
  199.      * @var bool
  200.      */
  201.     public $showAppLoggerTab = false;
  203.     /**
  204.      * @internal
  205.      *
  206.      * @var string
  207.      */
  208.     public $linkGeneratorReference;
  210.     /**
  211.      * @internal
  212.      *
  213.      * @var string|null
  214.      */
  215.     public $previewGeneratorReference;
  217.     /**
  218.      * @internal
  219.      *
  220.      * @var array
  221.      */
  222.     public $compositeIndices = [];
  224.     /**
  225.      * @internal
  226.      *
  227.      * @var bool
  228.      */
  229.     public $generateTypeDeclarations = true;
  231.     /**
  232.      * @internal
  233.      *
  234.      * @var bool
  235.      */
  236.     public $showFieldLookup = false;
  238.     /**
  239.      * @internal
  240.      *
  241.      * @var array
  242.      */
  243.     public $propertyVisibility = [
  244.         'grid' => [
  245.             'id' => true,
  246.             'path' => true,
  247.             'published' => true,
  248.             'modificationDate' => true,
  249.             'creationDate' => true,
  250.         ],
  251.         'search' => [
  252.             'id' => true,
  253.             'path' => true,
  254.             'published' => true,
  255.             'modificationDate' => true,
  256.             'creationDate' => true,
  257.         ],
  258.     ];
  260.     /**
  261.      * @internal
  262.      *
  263.      * @var bool
  264.      */
  265.     public $enableGridLocking = false;
  267.     /**
  268.      * @param string $id
  269.      * @param bool $force
  270.      *
  271.      * @return null|ClassDefinition
  272.      *
  273.      * @throws \Exception
  274.      */
  275.     public static function getById(string $id, $force = false)
  276.     {
  277.         $cacheKey = 'class_' . $id;
  279.         try {
  280.             if ($force) {
  281.                 throw new \Exception('Forced load');
  282.             }
  283.             $class = \Pimcore\Cache\Runtime::get($cacheKey);
  284.             if (!$class) {
  285.                 throw new \Exception('Class in registry is null');
  286.             }
  287.         } catch (\Exception $e) {
  288.             try {
  289.                 $class = new self();
  290.                 $name = $class->getDao()->getNameById($id);
  291.                 $definitionFile = $class->getDefinitionFile($name);
  292.                 $class = @include $definitionFile;
  294.                 if (!$class instanceof self) {
  295.                     throw new \Exception('Class definition with name ' . $name . ' or ID ' . $id . ' does not exist');
  296.                 }
  298.                 $class->setId($id);
  300.                 \Pimcore\Cache\Runtime::set($cacheKey, $class);
  301.             } catch (\Exception $e) {
  302.                 Logger::info($e->getMessage());
  304.                 return null;
  305.             }
  306.         }
  308.         return $class;
  309.     }
  311.     /**
  312.      * @param string $name
  313.      *
  314.      * @return self|null
  315.      *
  316.      * @throws \Exception
  317.      */
  318.     public static function getByName($name)
  319.     {
  320.         try {
  321.             $class = new self();
  322.             $id = $class->getDao()->getIdByName($name);
  324.             return self::getById($id);
  325.         } catch (Model\Exception\NotFoundException $e) {
  326.             return null;
  327.         }
  328.     }
  330.     /**
  331.      * @param array $values
  332.      *
  333.      * @return self
  334.      */
  335.     public static function create($values = [])
  336.     {
  337.         $class = new self();
  338.         $class->setValues($values);
  340.         return $class;
  341.     }
  343.     /**
  344.      * @internal
  345.      *
  346.      * @param string $name
  347.      */
  348.     public function rename($name)
  349.     {
  350.         $this->deletePhpClasses();
  351.         $this->getDao()->updateClassNameInObjects($name);
  353.         $this->setName($name);
  354.         $this->save();
  355.     }
  357.     /**
  358.      * @param mixed $data
  359.      *
  360.      * @internal
  361.      */
  362.     public static function cleanupForExport(&$data)
  363.     {
  364.         if (!is_object($data)) {
  365.             return;
  366.         }
  368.         if ($data instanceof DataObject\ClassDefinition\Data\VarExporterInterface) {
  369.             $blockedVars = $data->resolveBlockedVars();
  370.             foreach ($blockedVars as $blockedVar) {
  371.                 if (isset($data->{$blockedVar})) {
  372.                     unset($data->{$blockedVar});
  373.                 }
  374.             }
  376.             if (isset($data->blockedVarsForExport)) {
  377.                 unset($data->blockedVarsForExport);
  378.             }
  379.         }
  381.         if (method_exists($data, 'getChildren')) {
  382.             $children = $data->getChildren();
  383.             if (is_array($children)) {
  384.                 foreach ($children as $child) {
  385.                     self::cleanupForExport($child);
  386.                 }
  387.             }
  388.         }
  389.     }
  391.     /**
  392.      * @return bool
  393.      */
  394.     private function exists()
  395.     {
  396.         $name = $this->getDao()->getNameById($this->getId());
  398.         return is_string($name);
  399.     }
  401.     /**
  402.      * @param bool $saveDefinitionFile
  403.      *
  404.      * @throws \Exception
  405.      * @throws DataObject\Exception\DefinitionWriteException
  406.      */
  407.     public function save($saveDefinitionFile = true)
  408.     {
  409.         if ($saveDefinitionFile && !$this->isWritable()) {
  410.             throw new DataObject\Exception\DefinitionWriteException();
  411.         }
  413.         $fieldDefinitions = $this->getFieldDefinitions();
  414.         foreach ($fieldDefinitions as $fd) {
  415.             if ($fd->isForbiddenName()) {
  416.                 throw new \Exception(sprintf('Forbidden name used for field definition: %s', $fd->getName()));
  417.             }
  419.             if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  420.                 $fd->preSave($this);
  421.             }
  422.         }
  424.         if (!$this->getId()) {
  425.             $db = Db::get();
  426.             $maxId = $db->fetchOne('SELECT MAX(CAST(id AS SIGNED)) FROM classes;');
  427.             $this->setId($maxId ? $maxId + 1 : 1);
  428.         }
  430.         if (!preg_match('/[a-zA-Z][a-zA-Z0-9_]+/', $this->getName())) {
  431.             throw new \Exception(sprintf('Invalid name for class definition: %s', $this->getName()));
  432.         }
  434.         if (!preg_match('/[a-zA-Z0-9]([a-zA-Z0-9_]+)?/', $this->getId())) {
  435.             throw new \Exception(sprintf('Invalid ID `%s` for class definition %s', $this->getId(), $this->getName()));
  436.         }
  438.         foreach (['parentClass', 'listingParentClass', 'useTraits', 'listingUseTraits'] as $propertyName) {
  439.             $propertyValue = $this->{'get'.ucfirst($propertyName)}();
  440.             if ($propertyValue && !preg_match('/^[a-zA-Z_\x7f-\xff\\\][a-zA-Z0-9_\x7f-\xff\\\ ,]*$/', $propertyValue)) {
  441.                 throw new \Exception(sprintf('Invalid %s value for class definition: %s', $propertyName,
  442.                     $this->getParentClass()));
  443.             }
  444.         }
  446.         $isUpdate = $this->exists();
  448.         if (!$isUpdate) {
  449.             $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_ADD);
  450.         } else {
  451.             $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_UPDATE);
  452.         }
  454.         $this->setModificationDate(time());
  456.         $this->getDao()->save($isUpdate);
  458.         $this->generateClassFiles($saveDefinitionFile);
  460.         // empty object cache
  461.         try {
  462.             Cache::clearTag('class_'.$this->getId());
  463.         } catch (\Exception $e) {
  464.         }
  466.         foreach ($fieldDefinitions as $fd) {
  467.             if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  468.                 $fd->postSave($this);
  469.             }
  470.         }
  472.         if ($isUpdate) {
  473.             $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_UPDATE);
  474.         } else {
  475.             $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_ADD);
  476.         }
  477.     }
  479.     /**
  480.      * @param bool $generateDefinitionFile
  481.      *
  482.      * @throws \Exception
  483.      *
  484.      * @internal
  485.      */
  486.     public function generateClassFiles($generateDefinitionFile = true)
  487.     {
  488.         $infoDocBlock = $this->getInfoDocBlock();
  490.         // create class for object
  491.         $extendClass = 'Concrete';
  492.         if ($this->getParentClass()) {
  493.             $extendClass = $this->getParentClass();
  494.             $extendClass = '\\'.ltrim($extendClass, '\\');
  495.         }
  497.         $cd = '<?php';
  498.         $cd .= "\n\n";
  499.         $cd .= $infoDocBlock;
  500.         $cd .= "\n\n";
  501.         $cd .= 'namespace Pimcore\\Model\\DataObject;';
  502.         $cd .= "\n\n";
  503.         $cd .= 'use Pimcore\Model\DataObject\Exception\InheritanceParentNotFoundException;';
  504.         $cd .= "\n";
  505.         $cd .= 'use Pimcore\Model\DataObject\PreGetValueHookInterface;';
  506.         $cd .= "\n\n";
  507.         $cd .= "/**\n";
  508.         $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst($this->getName()).'\Listing getList(array $config = [])'."\n";
  509.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  510.             foreach ($this->getFieldDefinitions() as $key => $def) {
  511.                 if ($def instanceof DataObject\ClassDefinition\Data\Localizedfields) {
  512.                     $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  513.                             $this->getName()
  514.                         ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  515.                             $this->getName()
  516.                         ).'|null getBy'.ucfirst(
  517.                             $def->getName()
  518.                         ).'($field, $value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  520.                     foreach ($def->getFieldDefinitions() as $localizedFieldDefinition) {
  521.                         $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  522.                                 $this->getName()
  523.                             ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  524.                                 $this->getName()
  525.                             ).'|null getBy'.ucfirst(
  526.                                 $localizedFieldDefinition->getName()
  527.                             ).'($value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  528.                     }
  529.                 } elseif ($def->isFilterable()) {
  530.                     $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  531.                             $this->getName()
  532.                         ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  533.                             $this->getName()
  534.                         ).'|null getBy'.ucfirst($def->getName()).'($value, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  535.                 }
  536.             }
  537.         }
  538.         $cd .= "*/\n\n";
  540.         $implementsParts = [];
  542.         $implements = DataObject\ClassDefinition\Service::buildImplementsInterfacesCode($implementsParts, $this->getImplementsInterfaces());
  544.         $cd .= 'class '.ucfirst($this->getName()).' extends '.$extendClass. $implements . "\n";
  545.         $cd .= '{' . "\n";
  547.         $useParts = [];
  549.         $cd .= DataObject\ClassDefinition\Service::buildUseTraitsCode($useParts, $this->getUseTraits());
  551.         $cd .= 'protected $o_classId = "' . $this->getId(). "\";\n";
  552.         $cd .= 'protected $o_className = "'.$this->getName().'"'.";\n";
  554.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  555.             foreach ($this->getFieldDefinitions() as $key => $def) {
  556.                 if (!$def instanceof DataObject\ClassDefinition\Data\ReverseObjectRelation && !$def instanceof DataObject\ClassDefinition\Data\CalculatedValue
  557.                 ) {
  558.                     $cd .= 'protected $'.$key.";\n";
  559.                 }
  560.             }
  561.         }
  563.         $cd .= "\n\n";
  565.         $cd .= '/**'."\n";
  566.         $cd .= '* @param array $values'."\n";
  567.         $cd .= '* @return \\Pimcore\\Model\\DataObject\\'.ucfirst($this->getName())."\n";
  568.         $cd .= '*/'."\n";
  569.         $cd .= 'public static function create($values = array()) {';
  570.         $cd .= "\n";
  571.         $cd .= "\t".'$object = new static();'."\n";
  572.         $cd .= "\t".'$object->setValues($values);'."\n";
  573.         $cd .= "\t".'return $object;'."\n";
  574.         $cd .= '}';
  576.         $cd .= "\n\n";
  578.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  579.             foreach ($this->getFieldDefinitions() as $key => $def) {
  580.                 if ($def instanceof DataObject\ClassDefinition\Data\ReverseObjectRelation) {
  581.                     continue;
  582.                 }
  584.                 // get setter and getter code
  585.                 $cd .= $def->getGetterCode($this);
  586.                 $cd .= $def->getSetterCode($this);
  588.                 // 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
  589.                 //TODO Pimcore 11 remove method_exists call
  590.                 if (!$def instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface && method_exists($def, 'classSaved')) {
  591.                     $def->classSaved($this);
  592.                 }
  593.             }
  594.         }
  596.         $cd .= "}\n";
  597.         $cd .= "\n";
  599.         if (File::put($this->getPhpClassFile(), $cd) === false) {
  600.             throw new \Exception(sprintf('Cannot write class file in %s please check the rights on this directory', $this->getPhpClassFile()));
  601.         }
  603.         // create class for object list
  604.         $extendListingClass = 'DataObject\\Listing\\Concrete';
  605.         if ($this->getListingParentClass()) {
  606.             $extendListingClass = $this->getListingParentClass();
  607.             $extendListingClass = '\\'.ltrim($extendListingClass, '\\');
  608.         }
  610.         // create list class
  611.         $cd = '<?php';
  613.         $cd .= "\n\n";
  614.         $cd .= 'namespace Pimcore\\Model\\DataObject\\'.ucfirst($this->getName()).';';
  615.         $cd .= "\n\n";
  616.         $cd .= 'use Pimcore\\Model\\DataObject;';
  617.         $cd .= "\n\n";
  618.         $cd .= "/**\n";
  619.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."|false current()\n";
  620.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."[] load()\n";
  621.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."[] getData()\n";
  622.         $cd .= ' */';
  623.         $cd .= "\n\n";
  624.         $cd .= 'class Listing extends '.$extendListingClass . "\n";
  625.         $cd .= '{' . "\n";
  627.         $cd .= DataObject\ClassDefinition\Service::buildUseTraitsCode([], $this->getListingUseTraits());
  629.         $cd .= 'protected $classId = "'. $this->getId()."\";\n";
  630.         $cd .= 'protected $className = "'.$this->getName().'"'.";\n";
  632.         $cd .= "\n\n";
  634.         if (\is_array($this->getFieldDefinitions())) {
  635.             foreach ($this->getFieldDefinitions() as $key => $def) {
  636.                 if ($def instanceof DataObject\ClassDefinition\Data\Localizedfields) {
  637.                     foreach ($def->getFieldDefinitions() as $localizedFieldDefinition) {
  638.                         $cd .= $localizedFieldDefinition->getFilterCode();
  639.                     }
  640.                 } elseif ($def->isFilterable()) {
  641.                     $cd .= $def->getFilterCode();
  642.                 }
  643.             }
  644.         }
  646.         $cd .= "\n\n";
  647.         $cd .= "}\n";
  649.         if (File::put($this->getPhpListingClassFile(), $cd) === false) {
  650.             throw new \Exception(
  651.                 sprintf('Cannot write class file in %s please check the rights on this directory', $this->getPhpListingClassFile())
  652.             );
  653.         }
  655.         if ($generateDefinitionFile) {
  656.             // save definition as a php file
  657.             $definitionFile = $this->getDefinitionFile();
  658.             if (!is_writable(dirname($definitionFile)) || (is_file($definitionFile) && !is_writable($definitionFile))) {
  659.                 throw new \Exception(
  660.                     'Cannot write definition file in: '.$definitionFile.' please check write permission on this directory.'
  661.                 );
  662.             }
  663.             /** @var self $clone */
  664.             $clone = DataObject\Service::cloneDefinition($this);
  665.             $clone->setDao(null);
  666.             $clone->fieldDefinitions = [];
  668.             self::cleanupForExport($clone->layoutDefinitions);
  670.             $exportedClass = var_export($clone, true);
  672.             $data = '<?php';
  673.             $data .= "\n\n";
  674.             $data .= $infoDocBlock;
  675.             $data .= "\n\n";
  677.             $data .= "\nreturn ".$exportedClass.";\n";
  679.             \Pimcore\File::putPhpFile($definitionFile, $data);
  680.         }
  681.     }
  683.     /**
  684.      * @return string
  685.      *
  686.      * @internal
  687.      */
  688.     protected function getInfoDocBlock()
  689.     {
  690.         $cd = '/**' . "\n";
  691.         $cd .= '* Inheritance: '.($this->getAllowInherit() ? 'yes' : 'no')."\n";
  692.         $cd .= '* Variants: '.($this->getAllowVariants() ? 'yes' : 'no')."\n";
  694.         if ($this->getDescription()) {
  695.             $description = str_replace(['/**', '*/', '//'], '', $this->getDescription());
  696.             $description = str_replace("\n", "\n* ", $description);
  698.             $cd .= '* '.$description."\n";
  699.         }
  701.         $cd .= "\n\n";
  702.         $cd .= "Fields Summary:\n";
  704.         $cd = $this->getInfoDocBlockForFields($this, $cd, 1);
  706.         $cd .= '*/';
  708.         return $cd;
  709.     }
  711.     /**
  712.      * @internal
  713.      *
  714.      * @param ClassDefinition|ClassDefinition\Data $definition
  715.      * @param string $text
  716.      * @param int $level
  717.      *
  718.      * @return string
  719.      */
  720.     protected function getInfoDocBlockForFields($definition, $text, $level)
  721.     {
  722.         foreach ($definition->getFieldDefinitions() as $fd) {
  723.             $text .= str_pad('', $level, '-').' '.$fd->getName().' ['.$fd->getFieldtype()."]\n";
  724.             if (method_exists($fd, 'getFieldDefinitions')) {
  725.                 $text = $this->getInfoDocBlockForFields($fd, $text, $level + 1);
  726.             }
  727.         }
  729.         return $text;
  730.     }
  732.     public function delete()
  733.     {
  734.         $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_DELETE);
  736.         // delete all objects using this class
  737.         $list = new Listing();
  738.         $list->setCondition('o_classId = ?', $this->getId());
  739.         $list->load();
  741.         foreach ($list->getObjects() as $o) {
  742.             $o->delete();
  743.         }
  745.         $this->deletePhpClasses();
  747.         // empty object cache
  748.         try {
  749.             Cache::clearTag('class_'.$this->getId());
  750.         } catch (\Exception $e) {
  751.         }
  753.         // empty output cache
  754.         try {
  755.             Cache::clearTag('output');
  756.         } catch (\Exception $e) {
  757.         }
  759.         $customLayouts = new ClassDefinition\CustomLayout\Listing();
  760.         $customLayouts->setCondition('classId = ?', $this->getId());
  761.         $customLayouts = $customLayouts->load();
  763.         foreach ($customLayouts as $customLayout) {
  764.             $customLayout->delete();
  765.         }
  767.         $brickListing = new DataObject\Objectbrick\Definition\Listing();
  768.         $brickListing = $brickListing->load();
  769.         foreach ($brickListing as $brickDefinition) {
  770.             $modified = false;
  772.             $classDefinitions = $brickDefinition->getClassDefinitions();
  773.             if (is_array($classDefinitions)) {
  774.                 foreach ($classDefinitions as $key => $classDefinition) {
  775.                     if ($classDefinition['classname'] == $this->getId()) {
  776.                         unset($classDefinitions[$key]);
  777.                         $modified = true;
  778.                     }
  779.                 }
  780.             }
  781.             if ($modified) {
  782.                 $brickDefinition->setClassDefinitions($classDefinitions);
  783.                 $brickDefinition->save();
  784.             }
  785.         }
  787.         $this->getDao()->delete();
  789.         $this->dispatchEvent(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_DELETE);
  790.     }
  792.     private function deletePhpClasses()
  793.     {
  794.         // delete the class files
  795.         @unlink($this->getPhpClassFile());
  796.         @unlink($this->getPhpListingClassFile());
  797.         @rmdir(dirname($this->getPhpListingClassFile()));
  798.         @unlink($this->getDefinitionFile());
  799.     }
  801.     /**
  802.      * @internal
  803.      *
  804.      * @return bool
  805.      */
  806.     public function isWritable(): bool
  807.     {
  808.         if ($_SERVER['PIMCORE_CLASS_DEFINITION_WRITABLE'] ?? false) {
  809.             return true;
  810.         }
  812.         return !str_starts_with($this->getDefinitionFile(), PIMCORE_CUSTOM_CONFIGURATION_DIRECTORY);
  813.     }
  815.     /**
  816.      * @internal
  817.      *
  818.      * @param string|null $name
  819.      *
  820.      * @return string
  821.      */
  822.     public function getDefinitionFile($name = null)
  823.     {
  824.         return $this->locateDefinitionFile($name ?? $this->getName(), 'definition_%s.php');
  825.     }
  827.     private function getPhpClassFile(): string
  828.     {
  829.         return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s.php');
  830.     }
  832.     private function getPhpListingClassFile(): string
  833.     {
  834.         return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s/Listing.php');
  835.     }
  837.     /**
  838.      * @return string|null
  839.      */
  840.     public function getId()
  841.     {
  842.         return $this->id;
  843.     }
  845.     /**
  846.      * @return string|null
  847.      */
  848.     public function getName()
  849.     {
  850.         return $this->name;
  851.     }
  853.     /**
  854.      * @return int|null
  855.      */
  856.     public function getCreationDate()
  857.     {
  858.         return $this->creationDate;
  859.     }
  861.     /**
  862.      * @return int|null
  863.      */
  864.     public function getModificationDate()
  865.     {
  866.         return $this->modificationDate;
  867.     }
  869.     /**
  870.      * @return int|null
  871.      */
  872.     public function getUserOwner()
  873.     {
  874.         return $this->userOwner;
  875.     }
  877.     /**
  878.      * @return int|null
  879.      */
  880.     public function getUserModification()
  881.     {
  882.         return $this->userModification;
  883.     }
  885.     /**
  886.      * @param string $id
  887.      *
  888.      * @return $this
  889.      */
  890.     public function setId($id)
  891.     {
  892.         $this->id = $id;
  894.         return $this;
  895.     }
  897.     /**
  898.      * @param string $name
  899.      *
  900.      * @return $this
  901.      */
  902.     public function setName($name)
  903.     {
  904.         $this->name = $name;
  906.         return $this;
  907.     }
  909.     /**
  910.      * @param int $creationDate
  911.      *
  912.      * @return $this
  913.      */
  914.     public function setCreationDate($creationDate)
  915.     {
  916.         $this->creationDate = (int)$creationDate;
  918.         return $this;
  919.     }
  921.     /**
  922.      * @param int $modificationDate
  923.      *
  924.      * @return $this
  925.      */
  926.     public function setModificationDate($modificationDate)
  927.     {
  928.         $this->modificationDate = (int)$modificationDate;
  930.         return $this;
  931.     }
  933.     /**
  934.      * @param int $userOwner
  935.      *
  936.      * @return $this
  937.      */
  938.     public function setUserOwner($userOwner)
  939.     {
  940.         $this->userOwner = (int)$userOwner;
  942.         return $this;
  943.     }
  945.     /**
  946.      * @param int $userModification
  947.      *
  948.      * @return $this
  949.      */
  950.     public function setUserModification($userModification)
  951.     {
  952.         $this->userModification = (int)$userModification;
  954.         return $this;
  955.     }
  957.     /**
  958.      * @param array $context
  959.      *
  960.      * @return DataObject\ClassDefinition\Data[]
  961.      */
  962.     public function getFieldDefinitions($context = [])
  963.     {
  964.         if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  965.             return $this->fieldDefinitions;
  966.         }
  968.         $enrichedFieldDefinitions = [];
  969.         foreach ($this->fieldDefinitions as $key => $fieldDefinition) {
  970.             $fieldDefinition = $this->doEnrichFieldDefinition($fieldDefinition, $context);
  971.             $enrichedFieldDefinitions[$key] = $fieldDefinition;
  972.         }
  974.         return $enrichedFieldDefinitions;
  975.     }
  977.     /**
  978.      * @internal
  979.      */
  980.     protected function doEnrichFieldDefinition($fieldDefinition, $context = [])
  981.     {
  982.         //TODO Pimcore 11: remove method_exists BC layer
  983.         if ($fieldDefinition instanceof FieldDefinitionEnrichmentInterface || method_exists($fieldDefinition, 'enrichFieldDefinition')) {
  984.             if (!$fieldDefinition instanceof FieldDefinitionEnrichmentInterface) {
  985.                 trigger_deprecation('pimcore/pimcore', '10.1',
  986.                     sprintf('Usage of method_exists is deprecated since version 10.1 and will be removed in Pimcore 11.' .
  987.                     'Implement the %s interface instead.', FieldDefinitionEnrichmentInterface::class));
  988.             }
  989.             $context['class'] = $this;
  990.             $fieldDefinition = $fieldDefinition->enrichFieldDefinition($context);
  991.         }
  993.         return $fieldDefinition;
  994.     }
  996.     /**
  997.      * @return DataObject\ClassDefinition\Layout|null
  998.      */
  999.     public function getLayoutDefinitions()
  1000.     {
  1001.         return $this->layoutDefinitions;
  1002.     }
  1004.     /**
  1005.      * @param DataObject\ClassDefinition\Data[] $fieldDefinitions
  1006.      *
  1007.      * @return $this
  1008.      */
  1009.     public function setFieldDefinitions(array $fieldDefinitions)
  1010.     {
  1011.         $this->fieldDefinitions = $fieldDefinitions;
  1013.         return $this;
  1014.     }
  1016.     /**
  1017.      * @param string $key
  1018.      * @param DataObject\ClassDefinition\Data $data
  1019.      *
  1020.      * @return $this
  1021.      */
  1022.     public function addFieldDefinition($key, $data)
  1023.     {
  1024.         $this->fieldDefinitions[$key] = $data;
  1026.         return $this;
  1027.     }
  1029.     /**
  1030.      * @param string $key
  1031.      * @param array $context
  1032.      *
  1033.      * @return DataObject\ClassDefinition\Data|null
  1034.      */
  1035.     public function getFieldDefinition($key, $context = [])
  1036.     {
  1037.         if (array_key_exists($key, $this->fieldDefinitions)) {
  1038.             if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  1039.                 return $this->fieldDefinitions[$key];
  1040.             }
  1041.             $fieldDefinition = $this->doEnrichFieldDefinition($this->fieldDefinitions[$key], $context);
  1043.             return $fieldDefinition;
  1044.         }
  1046.         return null;
  1047.     }
  1049.     /**
  1050.      * @param DataObject\ClassDefinition\Layout|null $layoutDefinitions
  1051.      *
  1052.      * @return $this
  1053.      */
  1054.     public function setLayoutDefinitions($layoutDefinitions)
  1055.     {
  1056.         $this->layoutDefinitions = $layoutDefinitions;
  1058.         $this->fieldDefinitions = [];
  1059.         $this->extractDataDefinitions($this->layoutDefinitions);
  1061.         return $this;
  1062.     }
  1064.     /**
  1065.      * @param DataObject\ClassDefinition\Layout|DataObject\ClassDefinition\Data $def
  1066.      */
  1067.     private function extractDataDefinitions($def)
  1068.     {
  1069.         if ($def instanceof DataObject\ClassDefinition\Layout) {
  1070.             if ($def->hasChildren()) {
  1071.                 foreach ($def->getChildren() as $child) {
  1072.                     $this->extractDataDefinitions($child);
  1073.                 }
  1074.             }
  1075.         }
  1077.         if ($def instanceof DataObject\ClassDefinition\Data) {
  1078.             $existing = $this->getFieldDefinition($def->getName());
  1080.             if (!$existing && method_exists($def, 'addReferencedField') && method_exists($def, 'setReferencedFields')) {
  1081.                 $def->setReferencedFields([]);
  1082.             }
  1084.             if ($existing && method_exists($existing, 'addReferencedField')) {
  1085.                 // this is especially for localized fields which get aggregated here into one field definition
  1086.                 // in the case that there are more than one localized fields in the class definition
  1087.                 // see also pimcore.object.edit.addToDataFields();
  1088.                 $existing->addReferencedField($def);
  1089.             } else {
  1090.                 $this->addFieldDefinition($def->getName(), $def);
  1091.             }
  1092.         }
  1093.     }
  1095.     /**
  1096.      * @return string
  1097.      */
  1098.     public function getParentClass()
  1099.     {
  1100.         return $this->parentClass;
  1101.     }
  1103.     /**
  1104.      * @return string
  1105.      */
  1106.     public function getListingParentClass()
  1107.     {
  1108.         return $this->listingParentClass;
  1109.     }
  1111.     /**
  1112.      * @return string
  1113.      */
  1114.     public function getUseTraits()
  1115.     {
  1116.         return $this->useTraits;
  1117.     }
  1119.     /**
  1120.      * @param string $useTraits
  1121.      *
  1122.      * @return ClassDefinition
  1123.      */
  1124.     public function setUseTraits($useTraits)
  1125.     {
  1126.         $this->useTraits = (string) $useTraits;
  1128.         return $this;
  1129.     }
  1131.     /**
  1132.      * @return string
  1133.      */
  1134.     public function getListingUseTraits()
  1135.     {
  1136.         return $this->listingUseTraits;
  1137.     }
  1139.     /**
  1140.      * @param string $listingUseTraits
  1141.      *
  1142.      * @return ClassDefinition
  1143.      */
  1144.     public function setListingUseTraits($listingUseTraits)
  1145.     {
  1146.         $this->listingUseTraits = (string) $listingUseTraits;
  1148.         return $this;
  1149.     }
  1151.     /**
  1152.      * @return bool
  1153.      */
  1154.     public function getAllowInherit()
  1155.     {
  1156.         return $this->allowInherit;
  1157.     }
  1159.     /**
  1160.      * @return bool
  1161.      */
  1162.     public function getAllowVariants()
  1163.     {
  1164.         return $this->allowVariants;
  1165.     }
  1167.     /**
  1168.      * @param string $parentClass
  1169.      *
  1170.      * @return $this
  1171.      */
  1172.     public function setParentClass($parentClass)
  1173.     {
  1174.         $this->parentClass = $parentClass;
  1176.         return $this;
  1177.     }
  1179.     /**
  1180.      * @param string $listingParentClass
  1181.      *
  1182.      * @return $this
  1183.      */
  1184.     public function setListingParentClass($listingParentClass)
  1185.     {
  1186.         $this->listingParentClass = (string) $listingParentClass;
  1188.         return $this;
  1189.     }
  1191.     /**
  1192.      * @return bool
  1193.      */
  1194.     public function getEncryption(): bool
  1195.     {
  1196.         return $this->encryption;
  1197.     }
  1199.     /**
  1200.      * @param bool $encryption
  1201.      *
  1202.      * @return $this
  1203.      */
  1204.     public function setEncryption(bool $encryption)
  1205.     {
  1206.         $this->encryption = $encryption;
  1208.         return $this;
  1209.     }
  1211.     /**
  1212.      * @internal
  1213.      *
  1214.      * @param array $tables
  1215.      */
  1216.     public function addEncryptedTables(array $tables)
  1217.     {
  1218.         $this->encryptedTables = array_unique(array_merge($this->encryptedTables, $tables));
  1219.     }
  1221.     /**
  1222.      * @internal
  1223.      *
  1224.      * @param array $tables
  1225.      */
  1226.     public function removeEncryptedTables(array $tables)
  1227.     {
  1228.         foreach ($tables as $table) {
  1229.             if (($key = array_search($table, $this->encryptedTables)) !== false) {
  1230.                 unset($this->encryptedTables[$key]);
  1231.             }
  1232.         }
  1233.     }
  1235.     /**
  1236.      * @internal
  1237.      *
  1238.      * @param string $table
  1239.      *
  1240.      * @return bool
  1241.      */
  1242.     public function isEncryptedTable(string $table): bool
  1243.     {
  1244.         return (array_search($table, $this->encryptedTables) === false) ? false : true;
  1245.     }
  1247.     /**
  1248.      * @return bool
  1249.      */
  1250.     public function hasEncryptedTables(): bool
  1251.     {
  1252.         return (bool) count($this->encryptedTables);
  1253.     }
  1255.     /**
  1256.      * @internal
  1257.      *
  1258.      * @param array $encryptedTables
  1259.      *
  1260.      * @return $this
  1261.      */
  1262.     public function setEncryptedTables(array $encryptedTables)
  1263.     {
  1264.         $this->encryptedTables = $encryptedTables;
  1266.         return $this;
  1267.     }
  1269.     /**
  1270.      * @param bool $allowInherit
  1271.      *
  1272.      * @return $this
  1273.      */
  1274.     public function setAllowInherit($allowInherit)
  1275.     {
  1276.         $this->allowInherit = (bool)$allowInherit;
  1278.         return $this;
  1279.     }
  1281.     /**
  1282.      * @param bool $allowVariants
  1283.      *
  1284.      * @return $this
  1285.      */
  1286.     public function setAllowVariants($allowVariants)
  1287.     {
  1288.         $this->allowVariants = (bool)$allowVariants;
  1290.         return $this;
  1291.     }
  1293.     /**
  1294.      * @return string
  1295.      */
  1296.     public function getIcon()
  1297.     {
  1298.         return $this->icon;
  1299.     }
  1301.     /**
  1302.      * @param string $icon
  1303.      *
  1304.      * @return $this
  1305.      */
  1306.     public function setIcon($icon)
  1307.     {
  1308.         $this->icon = $icon;
  1310.         return $this;
  1311.     }
  1313.     /**
  1314.      * @return array
  1315.      */
  1316.     public function getPropertyVisibility()
  1317.     {
  1318.         return $this->propertyVisibility;
  1319.     }
  1321.     /**
  1322.      * @param array $propertyVisibility
  1323.      *
  1324.      * @return $this
  1325.      */
  1326.     public function setPropertyVisibility($propertyVisibility)
  1327.     {
  1328.         if (is_array($propertyVisibility)) {
  1329.             $this->propertyVisibility = $propertyVisibility;
  1330.         }
  1332.         return $this;
  1333.     }
  1335.     /**
  1336.      * @param string $previewUrl
  1337.      *
  1338.      * @return $this
  1339.      */
  1340.     public function setPreviewUrl($previewUrl)
  1341.     {
  1342.         $this->previewUrl = $previewUrl;
  1344.         return $this;
  1345.     }
  1347.     /**
  1348.      * @return string
  1349.      */
  1350.     public function getPreviewUrl()
  1351.     {
  1352.         return $this->previewUrl;
  1353.     }
  1355.     /**
  1356.      * @return string
  1357.      */
  1358.     public function getGroup()
  1359.     {
  1360.         return $this->group;
  1361.     }
  1363.     /**
  1364.      * @param string $group
  1365.      *
  1366.      * @return $this
  1367.      */
  1368.     public function setGroup($group)
  1369.     {
  1370.         $this->group = $group;
  1372.         return $this;
  1373.     }
  1375.     /**
  1376.      * @param string $description
  1377.      *
  1378.      * @return $this
  1379.      */
  1380.     public function setDescription($description)
  1381.     {
  1382.         $this->description = $description;
  1384.         return $this;
  1385.     }
  1387.     /**
  1388.      * @return string
  1389.      */
  1390.     public function getDescription()
  1391.     {
  1392.         return $this->description;
  1393.     }
  1395.     /**
  1396.      * @param bool $showVariants
  1397.      *
  1398.      * @return $this
  1399.      */
  1400.     public function setShowVariants($showVariants)
  1401.     {
  1402.         $this->showVariants = (bool)$showVariants;
  1404.         return $this;
  1405.     }
  1407.     /**
  1408.      * @return bool
  1409.      */
  1410.     public function getShowVariants()
  1411.     {
  1412.         return $this->showVariants;
  1413.     }
  1415.     /**
  1416.      * @return bool
  1417.      */
  1418.     public function getShowAppLoggerTab()
  1419.     {
  1420.         return $this->showAppLoggerTab;
  1421.     }
  1423.     /**
  1424.      * @param bool $showAppLoggerTab
  1425.      *
  1426.      * @return $this
  1427.      */
  1428.     public function setShowAppLoggerTab($showAppLoggerTab)
  1429.     {
  1430.         $this->showAppLoggerTab = (bool) $showAppLoggerTab;
  1432.         return $this;
  1433.     }
  1435.     /**
  1436.      * @return bool
  1437.      */
  1438.     public function getShowFieldLookup()
  1439.     {
  1440.         return $this->showFieldLookup;
  1441.     }
  1443.     /**
  1444.      * @param bool $showFieldLookup
  1445.      *
  1446.      * @return $this
  1447.      */
  1448.     public function setShowFieldLookup($showFieldLookup)
  1449.     {
  1450.         $this->showFieldLookup = (bool) $showFieldLookup;
  1452.         return $this;
  1453.     }
  1455.     /**
  1456.      * @return string
  1457.      */
  1458.     public function getLinkGeneratorReference()
  1459.     {
  1460.         return $this->linkGeneratorReference;
  1461.     }
  1463.     /**
  1464.      * @param string $linkGeneratorReference
  1465.      *
  1466.      * @return $this
  1467.      */
  1468.     public function setLinkGeneratorReference($linkGeneratorReference)
  1469.     {
  1470.         $this->linkGeneratorReference = $linkGeneratorReference;
  1472.         return $this;
  1473.     }
  1475.     /**
  1476.      * @return DataObject\ClassDefinition\LinkGeneratorInterface|null
  1477.      */
  1478.     public function getLinkGenerator()
  1479.     {
  1480.         return DataObject\ClassDefinition\Helper\LinkGeneratorResolver::resolveGenerator($this->getLinkGeneratorReference());
  1481.     }
  1483.     /**
  1484.      * @return string|null
  1485.      */
  1486.     public function getPreviewGeneratorReference(): ?string
  1487.     {
  1488.         return $this->previewGeneratorReference;
  1489.     }
  1491.     /**
  1492.      * @param string|null $previewGeneratorReference
  1493.      */
  1494.     public function setPreviewGeneratorReference(?string $previewGeneratorReference): void
  1495.     {
  1496.         $this->previewGeneratorReference = $previewGeneratorReference;
  1497.     }
  1499.     /**
  1500.      * @return DataObject\ClassDefinition\PreviewGeneratorInterface|null
  1501.      */
  1502.     public function getPreviewGenerator()
  1503.     {
  1504.         return DataObject\ClassDefinition\Helper\PreviewGeneratorResolver::resolveGenerator($this->getPreviewGeneratorReference());
  1505.     }
  1507.     /**
  1508.      * @return bool
  1509.      */
  1510.     public function isEnableGridLocking(): bool
  1511.     {
  1512.         return $this->enableGridLocking;
  1513.     }
  1515.     /**
  1516.      * @param bool $enableGridLocking
  1517.      */
  1518.     public function setEnableGridLocking(bool $enableGridLocking): void
  1519.     {
  1520.         $this->enableGridLocking = $enableGridLocking;
  1521.     }
  1523.     /**
  1524.      * @return string|null
  1525.      */
  1526.     public function getImplementsInterfaces(): ?string
  1527.     {
  1528.         return $this->implementsInterfaces;
  1529.     }
  1531.     /**
  1532.      * @param string|null $implementsInterfaces
  1533.      *
  1534.      * @return $this
  1535.      */
  1536.     public function setImplementsInterfaces(?string $implementsInterfaces)
  1537.     {
  1538.         $this->implementsInterfaces = $implementsInterfaces;
  1540.         return $this;
  1541.     }
  1543.     /**
  1544.      * @return array
  1545.      */
  1546.     public function getCompositeIndices(): array
  1547.     {
  1548.         return $this->compositeIndices;
  1549.     }
  1551.     /**
  1552.      * @param array|null $compositeIndices
  1553.      *
  1554.      * @return $this
  1555.      */
  1556.     public function setCompositeIndices($compositeIndices)
  1557.     {
  1558.         $this->compositeIndices = $compositeIndices ?? [];
  1560.         return $this;
  1561.     }
  1563.     /**
  1564.      * @return bool
  1565.      */
  1566.     public function getGenerateTypeDeclarations()
  1567.     {
  1568.         return (bool) $this->generateTypeDeclarations;
  1569.     }
  1571.     /**
  1572.      * @param bool $generateTypeDeclarations
  1573.      *
  1574.      * @return $this
  1575.      */
  1576.     public function setGenerateTypeDeclarations($generateTypeDeclarations)
  1577.     {
  1578.         $this->generateTypeDeclarations = (bool) $generateTypeDeclarations;
  1580.         return $this;
  1581.     }
  1582. }