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

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|null
  61.      */
  62.     public $creationDate;
  64.     /**
  65.      * @internal
  66.      *
  67.      * @var int|null
  68.      */
  69.     public $modificationDate;
  71.     /**
  72.      * @internal
  73.      *
  74.      * @var int|null
  75.      */
  76.     public $userOwner;
  78.     /**
  79.      * @internal
  80.      *
  81.      * @var int|null
  82.      */
  83.     public $userModification;
  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.      * @throws DataObject\Exception\DefinitionWriteException
  404.      */
  405.     public function save($saveDefinitionFile = true)
  406.     {
  407.         if ($saveDefinitionFile && !$this->isWritable()) {
  408.             throw new DataObject\Exception\DefinitionWriteException();
  409.         }
  411.         $fieldDefinitions = $this->getFieldDefinitions();
  412.         foreach ($fieldDefinitions as $fd) {
  413.             if ($fd->isForbiddenName()) {
  414.                 throw new \Exception(sprintf('Forbidden name used for field definition: %s', $fd->getName()));
  415.             }
  417.             if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  418.                 $fd->preSave($this);
  419.             }
  420.         }
  422.         if (!$this->getId()) {
  423.             $db = Db::get();
  424.             $maxId = $db->fetchOne('SELECT MAX(CAST(id AS SIGNED)) FROM classes;');
  425.             $this->setId($maxId ? $maxId + 1 : 1);
  426.         }
  428.         if (!preg_match('/[a-zA-Z][a-zA-Z0-9_]+/', $this->getName())) {
  429.             throw new \Exception(sprintf('Invalid name for class definition: %s', $this->getName()));
  430.         }
  432.         if (!preg_match('/[a-zA-Z0-9]([a-zA-Z0-9_]+)?/', $this->getId())) {
  433.             throw new \Exception(sprintf('Invalid ID `%s` for class definition %s', $this->getId(), $this->getName()));
  434.         }
  436.         foreach (['parentClass', 'listingParentClass', 'useTraits', 'listingUseTraits'] as $propertyName) {
  437.             $propertyValue = $this->{'get'.ucfirst($propertyName)}();
  438.             if ($propertyValue && !preg_match('/^[a-zA-Z_\x7f-\xff\\\][a-zA-Z0-9_\x7f-\xff\\\ ,]*$/', $propertyValue)) {
  439.                 throw new \Exception(sprintf('Invalid %s value for class definition: %s', $propertyName,
  440.                     $this->getParentClass()));
  441.             }
  442.         }
  444.         $isUpdate = $this->exists();
  446.         if (!$isUpdate) {
  447.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_ADD);
  448.         } else {
  449.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_UPDATE);
  450.         }
  452.         $this->setModificationDate(time());
  454.         $this->getDao()->save($isUpdate);
  456.         $this->generateClassFiles($saveDefinitionFile);
  458.         // empty object cache
  459.         try {
  460.             Cache::clearTag('class_'.$this->getId());
  461.         } catch (\Exception $e) {
  462.         }
  464.         foreach ($fieldDefinitions as $fd) {
  465.             if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  466.                 $fd->postSave($this);
  467.             }
  468.         }
  470.         if ($isUpdate) {
  471.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_UPDATE);
  472.         } else {
  473.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_ADD);
  474.         }
  475.     }
  477.     /**
  478.      * @param bool $generateDefinitionFile
  479.      *
  480.      * @throws \Exception
  481.      *
  482.      * @internal
  483.      */
  484.     public function generateClassFiles($generateDefinitionFile = true)
  485.     {
  486.         $infoDocBlock = $this->getInfoDocBlock();
  488.         // create class for object
  489.         $extendClass = 'Concrete';
  490.         if ($this->getParentClass()) {
  491.             $extendClass = $this->getParentClass();
  492.             $extendClass = '\\'.ltrim($extendClass, '\\');
  493.         }
  495.         $cd = '<?php';
  496.         $cd .= "\n\n";
  497.         $cd .= $infoDocBlock;
  498.         $cd .= "\n\n";
  499.         $cd .= 'namespace Pimcore\\Model\\DataObject;';
  500.         $cd .= "\n\n";
  501.         $cd .= 'use Pimcore\Model\DataObject\Exception\InheritanceParentNotFoundException;';
  502.         $cd .= "\n";
  503.         $cd .= 'use Pimcore\Model\DataObject\PreGetValueHookInterface;';
  504.         $cd .= "\n\n";
  505.         $cd .= "/**\n";
  506.         $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst($this->getName()).'\Listing getList(array $config = [])'."\n";
  507.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  508.             foreach ($this->getFieldDefinitions() as $key => $def) {
  509.                 if ($def instanceof DataObject\ClassDefinition\Data\Localizedfields) {
  510.                     $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  511.                             $this->getName()
  512.                         ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  513.                             $this->getName()
  514.                         ).'|null getBy'.ucfirst(
  515.                             $def->getName()
  516.                         ).'($field, $value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  518.                     foreach ($def->getFieldDefinitions() as $localizedFieldDefinition) {
  519.                         $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  520.                                 $this->getName()
  521.                             ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  522.                                 $this->getName()
  523.                             ).'|null getBy'.ucfirst(
  524.                                 $localizedFieldDefinition->getName()
  525.                             ).'($value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  526.                     }
  527.                 } elseif ($def->isFilterable()) {
  528.                     $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  529.                             $this->getName()
  530.                         ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  531.                             $this->getName()
  532.                         ).'|null getBy'.ucfirst($def->getName()).'($value, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  533.                 }
  534.             }
  535.         }
  536.         $cd .= "*/\n\n";
  538.         $implementsParts = [];
  540.         $implements = DataObject\ClassDefinition\Service::buildImplementsInterfacesCode($implementsParts, $this->getImplementsInterfaces());
  542.         $cd .= 'class '.ucfirst($this->getName()).' extends '.$extendClass. $implements . "\n";
  543.         $cd .= '{' . "\n";
  545.         $useParts = [];
  547.         $cd .= DataObject\ClassDefinition\Service::buildUseTraitsCode($useParts, $this->getUseTraits());
  549.         $cd .= 'protected $o_classId = "' . $this->getId(). "\";\n";
  550.         $cd .= 'protected $o_className = "'.$this->getName().'"'.";\n";
  552.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  553.             foreach ($this->getFieldDefinitions() as $key => $def) {
  554.                 if (!$def instanceof DataObject\ClassDefinition\Data\ReverseObjectRelation && !$def instanceof DataObject\ClassDefinition\Data\CalculatedValue
  555.                 ) {
  556.                     $cd .= 'protected $'.$key.";\n";
  557.                 }
  558.             }
  559.         }
  561.         $cd .= "\n\n";
  563.         $cd .= '/**'."\n";
  564.         $cd .= '* @param array $values'."\n";
  565.         $cd .= '* @return \\Pimcore\\Model\\DataObject\\'.ucfirst($this->getName())."\n";
  566.         $cd .= '*/'."\n";
  567.         $cd .= 'public static function create($values = array()) {';
  568.         $cd .= "\n";
  569.         $cd .= "\t".'$object = new static();'."\n";
  570.         $cd .= "\t".'$object->setValues($values);'."\n";
  571.         $cd .= "\t".'return $object;'."\n";
  572.         $cd .= '}';
  574.         $cd .= "\n\n";
  576.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  577.             foreach ($this->getFieldDefinitions() as $key => $def) {
  578.                 if ($def instanceof DataObject\ClassDefinition\Data\ReverseObjectRelation) {
  579.                     continue;
  580.                 }
  582.                 // get setter and getter code
  583.                 $cd .= $def->getGetterCode($this);
  584.                 $cd .= $def->getSetterCode($this);
  586.                 // 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
  587.                 //TODO Pimcore 11 remove method_exists call
  588.                 if (!$def instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface && method_exists($def, 'classSaved')) {
  589.                     $def->classSaved($this);
  590.                 }
  591.             }
  592.         }
  594.         $cd .= "}\n";
  595.         $cd .= "\n";
  597.         if (File::put($this->getPhpClassFile(), $cd) === false) {
  598.             throw new \Exception(sprintf('Cannot write class file in %s please check the rights on this directory', $this->getPhpClassFile()));
  599.         }
  601.         // create class for object list
  602.         $extendListingClass = 'DataObject\\Listing\\Concrete';
  603.         if ($this->getListingParentClass()) {
  604.             $extendListingClass = $this->getListingParentClass();
  605.             $extendListingClass = '\\'.ltrim($extendListingClass, '\\');
  606.         }
  608.         // create list class
  609.         $cd = '<?php';
  611.         $cd .= "\n\n";
  612.         $cd .= 'namespace Pimcore\\Model\\DataObject\\'.ucfirst($this->getName()).';';
  613.         $cd .= "\n\n";
  614.         $cd .= 'use Pimcore\\Model\\DataObject;';
  615.         $cd .= "\n\n";
  616.         $cd .= "/**\n";
  617.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."|false current()\n";
  618.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."[] load()\n";
  619.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."[] getData()\n";
  620.         $cd .= ' */';
  621.         $cd .= "\n\n";
  622.         $cd .= 'class Listing extends '.$extendListingClass . "\n";
  623.         $cd .= '{' . "\n";
  625.         $cd .= DataObject\ClassDefinition\Service::buildUseTraitsCode([], $this->getListingUseTraits());
  627.         $cd .= 'protected $classId = "'. $this->getId()."\";\n";
  628.         $cd .= 'protected $className = "'.$this->getName().'"'.";\n";
  630.         $cd .= "\n\n";
  632.         if (\is_array($this->getFieldDefinitions())) {
  633.             foreach ($this->getFieldDefinitions() as $key => $def) {
  634.                 if ($def instanceof DataObject\ClassDefinition\Data\Localizedfields) {
  635.                     foreach ($def->getFieldDefinitions() as $localizedFieldDefinition) {
  636.                         $cd .= $localizedFieldDefinition->getFilterCode();
  637.                     }
  638.                 } elseif ($def->isFilterable()) {
  639.                     $cd .= $def->getFilterCode();
  640.                 }
  641.             }
  642.         }
  644.         $cd .= "\n\n";
  645.         $cd .= "}\n";
  647.         if (File::put($this->getPhpListingClassFile(), $cd) === false) {
  648.             throw new \Exception(
  649.                 sprintf('Cannot write class file in %s please check the rights on this directory', $this->getPhpListingClassFile())
  650.             );
  651.         }
  653.         if ($generateDefinitionFile) {
  654.             // save definition as a php file
  655.             $definitionFile = $this->getDefinitionFile();
  656.             if (!is_writable(dirname($definitionFile)) || (is_file($definitionFile) && !is_writable($definitionFile))) {
  657.                 throw new \Exception(
  658.                     'Cannot write definition file in: '.$definitionFile.' please check write permission on this directory.'
  659.                 );
  660.             }
  661.             /** @var self $clone */
  662.             $clone = DataObject\Service::cloneDefinition($this);
  663.             $clone->setDao(null);
  664.             $clone->fieldDefinitions = [];
  666.             self::cleanupForExport($clone->layoutDefinitions);
  668.             $exportedClass = var_export($clone, true);
  670.             $data = '<?php';
  671.             $data .= "\n\n";
  672.             $data .= $infoDocBlock;
  673.             $data .= "\n\n";
  675.             $data .= "\nreturn ".$exportedClass.";\n";
  677.             \Pimcore\File::putPhpFile($definitionFile, $data);
  678.         }
  679.     }
  681.     /**
  682.      * @return string
  683.      *
  684.      * @internal
  685.      */
  686.     protected function getInfoDocBlock()
  687.     {
  688.         $cd = '/**' . "\n";
  689.         $cd .= '* Inheritance: '.($this->getAllowInherit() ? 'yes' : 'no')."\n";
  690.         $cd .= '* Variants: '.($this->getAllowVariants() ? 'yes' : 'no')."\n";
  692.         if ($this->getDescription()) {
  693.             $description = str_replace(['/**', '*/', '//'], '', $this->getDescription());
  694.             $description = str_replace("\n", "\n* ", $description);
  696.             $cd .= '* '.$description."\n";
  697.         }
  699.         $cd .= "\n\n";
  700.         $cd .= "Fields Summary:\n";
  702.         $cd = $this->getInfoDocBlockForFields($this, $cd, 1);
  704.         $cd .= '*/';
  706.         return $cd;
  707.     }
  709.     /**
  710.      * @internal
  711.      *
  712.      * @param ClassDefinition|ClassDefinition\Data $definition
  713.      * @param string $text
  714.      * @param int $level
  715.      *
  716.      * @return string
  717.      */
  718.     protected function getInfoDocBlockForFields($definition, $text, $level)
  719.     {
  720.         foreach ($definition->getFieldDefinitions() as $fd) {
  721.             $text .= str_pad('', $level, '-').' '.$fd->getName().' ['.$fd->getFieldtype()."]\n";
  722.             if (method_exists($fd, 'getFieldDefinitions')) {
  723.                 $text = $this->getInfoDocBlockForFields($fd, $text, $level + 1);
  724.             }
  725.         }
  727.         return $text;
  728.     }
  730.     public function delete()
  731.     {
  732.         \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_DELETE);
  734.         // delete all objects using this class
  735.         $list = new Listing();
  736.         $list->setCondition('o_classId = ?', $this->getId());
  737.         $list->load();
  739.         foreach ($list->getObjects() as $o) {
  740.             $o->delete();
  741.         }
  743.         $this->deletePhpClasses();
  745.         // empty object cache
  746.         try {
  747.             Cache::clearTag('class_'.$this->getId());
  748.         } catch (\Exception $e) {
  749.         }
  751.         // empty output cache
  752.         try {
  753.             Cache::clearTag('output');
  754.         } catch (\Exception $e) {
  755.         }
  757.         $customLayouts = new ClassDefinition\CustomLayout\Listing();
  758.         $customLayouts->setCondition('classId = ?', $this->getId());
  759.         $customLayouts = $customLayouts->load();
  761.         foreach ($customLayouts as $customLayout) {
  762.             $customLayout->delete();
  763.         }
  765.         $brickListing = new DataObject\Objectbrick\Definition\Listing();
  766.         $brickListing = $brickListing->load();
  767.         foreach ($brickListing as $brickDefinition) {
  768.             $modified = false;
  770.             $classDefinitions = $brickDefinition->getClassDefinitions();
  771.             if (is_array($classDefinitions)) {
  772.                 foreach ($classDefinitions as $key => $classDefinition) {
  773.                     if ($classDefinition['classname'] == $this->getId()) {
  774.                         unset($classDefinitions[$key]);
  775.                         $modified = true;
  776.                     }
  777.                 }
  778.             }
  779.             if ($modified) {
  780.                 $brickDefinition->setClassDefinitions($classDefinitions);
  781.                 $brickDefinition->save();
  782.             }
  783.         }
  785.         $this->getDao()->delete();
  787.         \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_DELETE);
  788.     }
  790.     private function deletePhpClasses()
  791.     {
  792.         // delete the class files
  793.         @unlink($this->getPhpClassFile());
  794.         @unlink($this->getPhpListingClassFile());
  795.         @rmdir(dirname($this->getPhpListingClassFile()));
  796.         @unlink($this->getDefinitionFile());
  797.     }
  799.     /**
  800.      * @internal
  801.      *
  802.      * @return bool
  803.      */
  804.     public function isWritable(): bool
  805.     {
  806.         if ($_SERVER['PIMCORE_CLASS_DEFINITION_WRITABLE'] ?? false) {
  807.             return true;
  808.         }
  810.         return !str_starts_with($this->getDefinitionFile(), PIMCORE_CUSTOM_CONFIGURATION_DIRECTORY);
  811.     }
  813.     /**
  814.      * @internal
  815.      *
  816.      * @param string|null $name
  817.      *
  818.      * @return string
  819.      */
  820.     public function getDefinitionFile($name = null)
  821.     {
  822.         return $this->locateDefinitionFile($name ?? $this->getName(), 'definition_%s.php');
  823.     }
  825.     private function getPhpClassFile(): string
  826.     {
  827.         return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s.php');
  828.     }
  830.     private function getPhpListingClassFile(): string
  831.     {
  832.         return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s/Listing.php');
  833.     }
  835.     /**
  836.      * @return string|null
  837.      */
  838.     public function getId()
  839.     {
  840.         return $this->id;
  841.     }
  843.     /**
  844.      * @return string|null
  845.      */
  846.     public function getName()
  847.     {
  848.         return $this->name;
  849.     }
  851.     /**
  852.      * @return int|null
  853.      */
  854.     public function getCreationDate()
  855.     {
  856.         return $this->creationDate;
  857.     }
  859.     /**
  860.      * @return int|null
  861.      */
  862.     public function getModificationDate()
  863.     {
  864.         return $this->modificationDate;
  865.     }
  867.     /**
  868.      * @return int|null
  869.      */
  870.     public function getUserOwner()
  871.     {
  872.         return $this->userOwner;
  873.     }
  875.     /**
  876.      * @return int|null
  877.      */
  878.     public function getUserModification()
  879.     {
  880.         return $this->userModification;
  881.     }
  883.     /**
  884.      * @param string $id
  885.      *
  886.      * @return $this
  887.      */
  888.     public function setId($id)
  889.     {
  890.         $this->id = $id;
  892.         return $this;
  893.     }
  895.     /**
  896.      * @param string $name
  897.      *
  898.      * @return $this
  899.      */
  900.     public function setName($name)
  901.     {
  902.         $this->name = $name;
  904.         return $this;
  905.     }
  907.     /**
  908.      * @param int $creationDate
  909.      *
  910.      * @return $this
  911.      */
  912.     public function setCreationDate($creationDate)
  913.     {
  914.         $this->creationDate = (int)$creationDate;
  916.         return $this;
  917.     }
  919.     /**
  920.      * @param int $modificationDate
  921.      *
  922.      * @return $this
  923.      */
  924.     public function setModificationDate($modificationDate)
  925.     {
  926.         $this->modificationDate = (int)$modificationDate;
  928.         return $this;
  929.     }
  931.     /**
  932.      * @param int $userOwner
  933.      *
  934.      * @return $this
  935.      */
  936.     public function setUserOwner($userOwner)
  937.     {
  938.         $this->userOwner = (int)$userOwner;
  940.         return $this;
  941.     }
  943.     /**
  944.      * @param int $userModification
  945.      *
  946.      * @return $this
  947.      */
  948.     public function setUserModification($userModification)
  949.     {
  950.         $this->userModification = (int)$userModification;
  952.         return $this;
  953.     }
  955.     /**
  956.      * @param array $context
  957.      *
  958.      * @return DataObject\ClassDefinition\Data[]
  959.      */
  960.     public function getFieldDefinitions($context = [])
  961.     {
  962.         if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  963.             return $this->fieldDefinitions;
  964.         }
  966.         $enrichedFieldDefinitions = [];
  967.         foreach ($this->fieldDefinitions as $key => $fieldDefinition) {
  968.             $fieldDefinition = $this->doEnrichFieldDefinition($fieldDefinition, $context);
  969.             $enrichedFieldDefinitions[$key] = $fieldDefinition;
  970.         }
  972.         return $enrichedFieldDefinitions;
  973.     }
  975.     /**
  976.      * @internal
  977.      */
  978.     protected function doEnrichFieldDefinition($fieldDefinition, $context = [])
  979.     {
  980.         //TODO Pimcore 11: remove method_exists BC layer
  981.         if ($fieldDefinition instanceof FieldDefinitionEnrichmentInterface || method_exists($fieldDefinition, 'enrichFieldDefinition')) {
  982.             if (!$fieldDefinition instanceof FieldDefinitionEnrichmentInterface) {
  983.                 trigger_deprecation('pimcore/pimcore', '10.1',
  984.                     sprintf('Usage of method_exists is deprecated since version 10.1 and will be removed in Pimcore 11.' .
  985.                     'Implement the %s interface instead.', FieldDefinitionEnrichmentInterface::class));
  986.             }
  987.             $context['class'] = $this;
  988.             $fieldDefinition = $fieldDefinition->enrichFieldDefinition($context);
  989.         }
  991.         return $fieldDefinition;
  992.     }
  994.     /**
  995.      * @return DataObject\ClassDefinition\Layout|null
  996.      */
  997.     public function getLayoutDefinitions()
  998.     {
  999.         return $this->layoutDefinitions;
  1000.     }
  1002.     /**
  1003.      * @param DataObject\ClassDefinition\Data[] $fieldDefinitions
  1004.      *
  1005.      * @return $this
  1006.      */
  1007.     public function setFieldDefinitions(array $fieldDefinitions)
  1008.     {
  1009.         $this->fieldDefinitions = $fieldDefinitions;
  1011.         return $this;
  1012.     }
  1014.     /**
  1015.      * @param string $key
  1016.      * @param DataObject\ClassDefinition\Data $data
  1017.      *
  1018.      * @return $this
  1019.      */
  1020.     public function addFieldDefinition($key, $data)
  1021.     {
  1022.         $this->fieldDefinitions[$key] = $data;
  1024.         return $this;
  1025.     }
  1027.     /**
  1028.      * @param string $key
  1029.      * @param array $context
  1030.      *
  1031.      * @return DataObject\ClassDefinition\Data|null
  1032.      */
  1033.     public function getFieldDefinition($key, $context = [])
  1034.     {
  1035.         if (array_key_exists($key, $this->fieldDefinitions)) {
  1036.             if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  1037.                 return $this->fieldDefinitions[$key];
  1038.             }
  1039.             $fieldDefinition = $this->doEnrichFieldDefinition($this->fieldDefinitions[$key], $context);
  1041.             return $fieldDefinition;
  1042.         }
  1044.         return null;
  1045.     }
  1047.     /**
  1048.      * @param DataObject\ClassDefinition\Layout|null $layoutDefinitions
  1049.      *
  1050.      * @return $this
  1051.      */
  1052.     public function setLayoutDefinitions($layoutDefinitions)
  1053.     {
  1054.         $this->layoutDefinitions = $layoutDefinitions;
  1056.         $this->fieldDefinitions = [];
  1057.         $this->extractDataDefinitions($this->layoutDefinitions);
  1059.         return $this;
  1060.     }
  1062.     /**
  1063.      * @param DataObject\ClassDefinition\Layout|DataObject\ClassDefinition\Data $def
  1064.      */
  1065.     private function extractDataDefinitions($def)
  1066.     {
  1067.         if ($def instanceof DataObject\ClassDefinition\Layout) {
  1068.             if ($def->hasChildren()) {
  1069.                 foreach ($def->getChildren() as $child) {
  1070.                     $this->extractDataDefinitions($child);
  1071.                 }
  1072.             }
  1073.         }
  1075.         if ($def instanceof DataObject\ClassDefinition\Data) {
  1076.             $existing = $this->getFieldDefinition($def->getName());
  1078.             if (!$existing && method_exists($def, 'addReferencedField') && method_exists($def, 'setReferencedFields')) {
  1079.                 $def->setReferencedFields([]);
  1080.             }
  1082.             if ($existing && method_exists($existing, 'addReferencedField')) {
  1083.                 // this is especially for localized fields which get aggregated here into one field definition
  1084.                 // in the case that there are more than one localized fields in the class definition
  1085.                 // see also pimcore.object.edit.addToDataFields();
  1086.                 $existing->addReferencedField($def);
  1087.             } else {
  1088.                 $this->addFieldDefinition($def->getName(), $def);
  1089.             }
  1090.         }
  1091.     }
  1093.     /**
  1094.      * @return string
  1095.      */
  1096.     public function getParentClass()
  1097.     {
  1098.         return $this->parentClass;
  1099.     }
  1101.     /**
  1102.      * @return string
  1103.      */
  1104.     public function getListingParentClass()
  1105.     {
  1106.         return $this->listingParentClass;
  1107.     }
  1109.     /**
  1110.      * @return string
  1111.      */
  1112.     public function getUseTraits()
  1113.     {
  1114.         return $this->useTraits;
  1115.     }
  1117.     /**
  1118.      * @param string $useTraits
  1119.      *
  1120.      * @return ClassDefinition
  1121.      */
  1122.     public function setUseTraits($useTraits)
  1123.     {
  1124.         $this->useTraits = (string) $useTraits;
  1126.         return $this;
  1127.     }
  1129.     /**
  1130.      * @return string
  1131.      */
  1132.     public function getListingUseTraits()
  1133.     {
  1134.         return $this->listingUseTraits;
  1135.     }
  1137.     /**
  1138.      * @param string $listingUseTraits
  1139.      *
  1140.      * @return ClassDefinition
  1141.      */
  1142.     public function setListingUseTraits($listingUseTraits)
  1143.     {
  1144.         $this->listingUseTraits = (string) $listingUseTraits;
  1146.         return $this;
  1147.     }
  1149.     /**
  1150.      * @return bool
  1151.      */
  1152.     public function getAllowInherit()
  1153.     {
  1154.         return $this->allowInherit;
  1155.     }
  1157.     /**
  1158.      * @return bool
  1159.      */
  1160.     public function getAllowVariants()
  1161.     {
  1162.         return $this->allowVariants;
  1163.     }
  1165.     /**
  1166.      * @param string $parentClass
  1167.      *
  1168.      * @return $this
  1169.      */
  1170.     public function setParentClass($parentClass)
  1171.     {
  1172.         $this->parentClass = $parentClass;
  1174.         return $this;
  1175.     }
  1177.     /**
  1178.      * @param string $listingParentClass
  1179.      *
  1180.      * @return $this
  1181.      */
  1182.     public function setListingParentClass($listingParentClass)
  1183.     {
  1184.         $this->listingParentClass = (string) $listingParentClass;
  1186.         return $this;
  1187.     }
  1189.     /**
  1190.      * @return bool
  1191.      */
  1192.     public function getEncryption(): bool
  1193.     {
  1194.         return $this->encryption;
  1195.     }
  1197.     /**
  1198.      * @param bool $encryption
  1199.      *
  1200.      * @return $this
  1201.      */
  1202.     public function setEncryption(bool $encryption)
  1203.     {
  1204.         $this->encryption = $encryption;
  1206.         return $this;
  1207.     }
  1209.     /**
  1210.      * @internal
  1211.      *
  1212.      * @param array $tables
  1213.      */
  1214.     public function addEncryptedTables(array $tables)
  1215.     {
  1216.         $this->encryptedTables = array_unique(array_merge($this->encryptedTables, $tables));
  1217.     }
  1219.     /**
  1220.      * @internal
  1221.      *
  1222.      * @param array $tables
  1223.      */
  1224.     public function removeEncryptedTables(array $tables)
  1225.     {
  1226.         foreach ($tables as $table) {
  1227.             if (($key = array_search($table, $this->encryptedTables)) !== false) {
  1228.                 unset($this->encryptedTables[$key]);
  1229.             }
  1230.         }
  1231.     }
  1233.     /**
  1234.      * @internal
  1235.      *
  1236.      * @param string $table
  1237.      *
  1238.      * @return bool
  1239.      */
  1240.     public function isEncryptedTable(string $table): bool
  1241.     {
  1242.         return (array_search($table, $this->encryptedTables) === false) ? false : true;
  1243.     }
  1245.     /**
  1246.      * @return bool
  1247.      */
  1248.     public function hasEncryptedTables(): bool
  1249.     {
  1250.         return (bool) count($this->encryptedTables);
  1251.     }
  1253.     /**
  1254.      * @internal
  1255.      *
  1256.      * @param array $encryptedTables
  1257.      *
  1258.      * @return $this
  1259.      */
  1260.     public function setEncryptedTables(array $encryptedTables)
  1261.     {
  1262.         $this->encryptedTables = $encryptedTables;
  1264.         return $this;
  1265.     }
  1267.     /**
  1268.      * @param bool $allowInherit
  1269.      *
  1270.      * @return $this
  1271.      */
  1272.     public function setAllowInherit($allowInherit)
  1273.     {
  1274.         $this->allowInherit = (bool)$allowInherit;
  1276.         return $this;
  1277.     }
  1279.     /**
  1280.      * @param bool $allowVariants
  1281.      *
  1282.      * @return $this
  1283.      */
  1284.     public function setAllowVariants($allowVariants)
  1285.     {
  1286.         $this->allowVariants = (bool)$allowVariants;
  1288.         return $this;
  1289.     }
  1291.     /**
  1292.      * @return string
  1293.      */
  1294.     public function getIcon()
  1295.     {
  1296.         return $this->icon;
  1297.     }
  1299.     /**
  1300.      * @param string $icon
  1301.      *
  1302.      * @return $this
  1303.      */
  1304.     public function setIcon($icon)
  1305.     {
  1306.         $this->icon = $icon;
  1308.         return $this;
  1309.     }
  1311.     /**
  1312.      * @return array
  1313.      */
  1314.     public function getPropertyVisibility()
  1315.     {
  1316.         return $this->propertyVisibility;
  1317.     }
  1319.     /**
  1320.      * @param array $propertyVisibility
  1321.      *
  1322.      * @return $this
  1323.      */
  1324.     public function setPropertyVisibility($propertyVisibility)
  1325.     {
  1326.         if (is_array($propertyVisibility)) {
  1327.             $this->propertyVisibility = $propertyVisibility;
  1328.         }
  1330.         return $this;
  1331.     }
  1333.     /**
  1334.      * @param string $previewUrl
  1335.      *
  1336.      * @return $this
  1337.      */
  1338.     public function setPreviewUrl($previewUrl)
  1339.     {
  1340.         $this->previewUrl = $previewUrl;
  1342.         return $this;
  1343.     }
  1345.     /**
  1346.      * @return string
  1347.      */
  1348.     public function getPreviewUrl()
  1349.     {
  1350.         return $this->previewUrl;
  1351.     }
  1353.     /**
  1354.      * @return string
  1355.      */
  1356.     public function getGroup()
  1357.     {
  1358.         return $this->group;
  1359.     }
  1361.     /**
  1362.      * @param string $group
  1363.      *
  1364.      * @return $this
  1365.      */
  1366.     public function setGroup($group)
  1367.     {
  1368.         $this->group = $group;
  1370.         return $this;
  1371.     }
  1373.     /**
  1374.      * @param string $description
  1375.      *
  1376.      * @return $this
  1377.      */
  1378.     public function setDescription($description)
  1379.     {
  1380.         $this->description = $description;
  1382.         return $this;
  1383.     }
  1385.     /**
  1386.      * @return string
  1387.      */
  1388.     public function getDescription()
  1389.     {
  1390.         return $this->description;
  1391.     }
  1393.     /**
  1394.      * @param bool $showVariants
  1395.      *
  1396.      * @return $this
  1397.      */
  1398.     public function setShowVariants($showVariants)
  1399.     {
  1400.         $this->showVariants = (bool)$showVariants;
  1402.         return $this;
  1403.     }
  1405.     /**
  1406.      * @return bool
  1407.      */
  1408.     public function getShowVariants()
  1409.     {
  1410.         return $this->showVariants;
  1411.     }
  1413.     /**
  1414.      * @return bool
  1415.      */
  1416.     public function getShowAppLoggerTab()
  1417.     {
  1418.         return $this->showAppLoggerTab;
  1419.     }
  1421.     /**
  1422.      * @param bool $showAppLoggerTab
  1423.      *
  1424.      * @return $this
  1425.      */
  1426.     public function setShowAppLoggerTab($showAppLoggerTab)
  1427.     {
  1428.         $this->showAppLoggerTab = (bool) $showAppLoggerTab;
  1430.         return $this;
  1431.     }
  1433.     /**
  1434.      * @return bool
  1435.      */
  1436.     public function getShowFieldLookup()
  1437.     {
  1438.         return $this->showFieldLookup;
  1439.     }
  1441.     /**
  1442.      * @param bool $showFieldLookup
  1443.      *
  1444.      * @return $this
  1445.      */
  1446.     public function setShowFieldLookup($showFieldLookup)
  1447.     {
  1448.         $this->showFieldLookup = (bool) $showFieldLookup;
  1450.         return $this;
  1451.     }
  1453.     /**
  1454.      * @return string
  1455.      */
  1456.     public function getLinkGeneratorReference()
  1457.     {
  1458.         return $this->linkGeneratorReference;
  1459.     }
  1461.     /**
  1462.      * @param string $linkGeneratorReference
  1463.      *
  1464.      * @return $this
  1465.      */
  1466.     public function setLinkGeneratorReference($linkGeneratorReference)
  1467.     {
  1468.         $this->linkGeneratorReference = $linkGeneratorReference;
  1470.         return $this;
  1471.     }
  1473.     /**
  1474.      * @return DataObject\ClassDefinition\LinkGeneratorInterface|null
  1475.      */
  1476.     public function getLinkGenerator()
  1477.     {
  1478.         return DataObject\ClassDefinition\Helper\LinkGeneratorResolver::resolveGenerator($this->getLinkGeneratorReference());
  1479.     }
  1481.     /**
  1482.      * @return string|null
  1483.      */
  1484.     public function getPreviewGeneratorReference(): ?string
  1485.     {
  1486.         return $this->previewGeneratorReference;
  1487.     }
  1489.     /**
  1490.      * @param string|null $previewGeneratorReference
  1491.      */
  1492.     public function setPreviewGeneratorReference(?string $previewGeneratorReference): void
  1493.     {
  1494.         $this->previewGeneratorReference = $previewGeneratorReference;
  1495.     }
  1497.     /**
  1498.      * @return DataObject\ClassDefinition\PreviewGeneratorInterface|null
  1499.      */
  1500.     public function getPreviewGenerator()
  1501.     {
  1502.         return DataObject\ClassDefinition\Helper\PreviewGeneratorResolver::resolveGenerator($this->getPreviewGeneratorReference());
  1503.     }
  1505.     /**
  1506.      * @return bool
  1507.      */
  1508.     public function isEnableGridLocking(): bool
  1509.     {
  1510.         return $this->enableGridLocking;
  1511.     }
  1513.     /**
  1514.      * @param bool $enableGridLocking
  1515.      */
  1516.     public function setEnableGridLocking(bool $enableGridLocking): void
  1517.     {
  1518.         $this->enableGridLocking = $enableGridLocking;
  1519.     }
  1521.     /**
  1522.      * @return string|null
  1523.      */
  1524.     public function getImplementsInterfaces(): ?string
  1525.     {
  1526.         return $this->implementsInterfaces;
  1527.     }
  1529.     /**
  1530.      * @param string|null $implementsInterfaces
  1531.      *
  1532.      * @return $this
  1533.      */
  1534.     public function setImplementsInterfaces(?string $implementsInterfaces)
  1535.     {
  1536.         $this->implementsInterfaces = $implementsInterfaces;
  1538.         return $this;
  1539.     }
  1541.     /**
  1542.      * @return array
  1543.      */
  1544.     public function getCompositeIndices(): array
  1545.     {
  1546.         return $this->compositeIndices;
  1547.     }
  1549.     /**
  1550.      * @param array|null $compositeIndices
  1551.      *
  1552.      * @return $this
  1553.      */
  1554.     public function setCompositeIndices($compositeIndices)
  1555.     {
  1556.         $this->compositeIndices = $compositeIndices ?? [];
  1558.         return $this;
  1559.     }
  1561.     /**
  1562.      * @return bool
  1563.      */
  1564.     public function getGenerateTypeDeclarations()
  1565.     {
  1566.         return (bool) $this->generateTypeDeclarations;
  1567.     }
  1569.     /**
  1570.      * @param bool $generateTypeDeclarations
  1571.      *
  1572.      * @return $this
  1573.      */
  1574.     public function setGenerateTypeDeclarations($generateTypeDeclarations)
  1575.     {
  1576.         $this->generateTypeDeclarations = (bool) $generateTypeDeclarations;
  1578.         return $this;
  1579.     }
  1580. }