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.      */
  404.     public function save($saveDefinitionFile = true)
  405.     {
  406.         if ($saveDefinitionFile && !$this->isWritable()) {
  407.             throw new \Exception(sprintf('Definitions in %s folder cannot be overwritten', PIMCORE_CUSTOM_CONFIGURATION_DIRECTORY));
  408.         }
  410.         $fieldDefinitions = $this->getFieldDefinitions();
  411.         foreach ($fieldDefinitions as $fd) {
  412.             if ($fd->isForbiddenName()) {
  413.                 throw new \Exception(sprintf('Forbidden name used for field definition: %s', $fd->getName()));
  414.             }
  416.             if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  417.                 $fd->preSave($this);
  418.             }
  419.         }
  421.         if (!$this->getId()) {
  422.             $db = Db::get();
  423.             $maxId = $db->fetchOne('SELECT MAX(CAST(id AS SIGNED)) FROM classes;');
  424.             $this->setId($maxId ? $maxId + 1 : 1);
  425.         }
  427.         if (!preg_match('/[a-zA-Z][a-zA-Z0-9_]+/', $this->getName())) {
  428.             throw new \Exception(sprintf('Invalid name for class definition: %s', $this->getName()));
  429.         }
  431.         if (!preg_match('/[a-zA-Z0-9]([a-zA-Z0-9_]+)?/', $this->getId())) {
  432.             throw new \Exception(sprintf('Invalid ID `%s` for class definition %s', $this->getId(), $this->getName()));
  433.         }
  435.         foreach (['parentClass', 'listingParentClass', 'useTraits', 'listingUseTraits'] as $propertyName) {
  436.             $propertyValue = $this->{'get'.ucfirst($propertyName)}();
  437.             if ($propertyValue && !preg_match('/^[a-zA-Z_\x7f-\xff\\\][a-zA-Z0-9_\x7f-\xff\\\ ,]*$/', $propertyValue)) {
  438.                 throw new \Exception(sprintf('Invalid %s value for class definition: %s', $propertyName,
  439.                     $this->getParentClass()));
  440.             }
  441.         }
  443.         $isUpdate = $this->exists();
  445.         if (!$isUpdate) {
  446.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_ADD);
  447.         } else {
  448.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_UPDATE);
  449.         }
  451.         $this->setModificationDate(time());
  453.         $this->getDao()->save($isUpdate);
  455.         $this->generateClassFiles($saveDefinitionFile);
  457.         // empty object cache
  458.         try {
  459.             Cache::clearTag('class_'.$this->getId());
  460.         } catch (\Exception $e) {
  461.         }
  463.         foreach ($fieldDefinitions as $fd) {
  464.             if ($fd instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface) {
  465.                 $fd->postSave($this);
  466.             }
  467.         }
  469.         if ($isUpdate) {
  470.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_UPDATE);
  471.         } else {
  472.             \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_ADD);
  473.         }
  474.     }
  476.     /**
  477.      * @param bool $generateDefinitionFile
  478.      *
  479.      * @throws \Exception
  480.      *
  481.      * @internal
  482.      */
  483.     public function generateClassFiles($generateDefinitionFile = true)
  484.     {
  485.         $infoDocBlock = $this->getInfoDocBlock();
  487.         // create class for object
  488.         $extendClass = 'Concrete';
  489.         if ($this->getParentClass()) {
  490.             $extendClass = $this->getParentClass();
  491.             $extendClass = '\\'.ltrim($extendClass, '\\');
  492.         }
  494.         $cd = '<?php';
  495.         $cd .= "\n\n";
  496.         $cd .= $infoDocBlock;
  497.         $cd .= "\n\n";
  498.         $cd .= 'namespace Pimcore\\Model\\DataObject;';
  499.         $cd .= "\n\n";
  500.         $cd .= 'use Pimcore\Model\DataObject\Exception\InheritanceParentNotFoundException;';
  501.         $cd .= "\n";
  502.         $cd .= 'use Pimcore\Model\DataObject\PreGetValueHookInterface;';
  503.         $cd .= "\n\n";
  504.         $cd .= "/**\n";
  505.         $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst($this->getName()).'\Listing getList(array $config = [])'."\n";
  506.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  507.             foreach ($this->getFieldDefinitions() as $key => $def) {
  508.                 if ($def instanceof DataObject\ClassDefinition\Data\Localizedfields) {
  509.                     $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  510.                             $this->getName()
  511.                         ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  512.                             $this->getName()
  513.                         ).'|null getBy'.ucfirst(
  514.                             $def->getName()
  515.                         ).'($field, $value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  517.                     foreach ($def->getFieldDefinitions() as $localizedFieldDefinition) {
  518.                         $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  519.                                 $this->getName()
  520.                             ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  521.                                 $this->getName()
  522.                             ).'|null getBy'.ucfirst(
  523.                                 $localizedFieldDefinition->getName()
  524.                             ).'($value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  525.                     }
  526.                 } elseif ($def->isFilterable()) {
  527.                     $cd .= '* @method static \\Pimcore\\Model\\DataObject\\'.ucfirst(
  528.                             $this->getName()
  529.                         ).'\Listing|\\Pimcore\\Model\\DataObject\\'.ucfirst(
  530.                             $this->getName()
  531.                         ).'|null getBy'.ucfirst($def->getName()).'($value, $limit = 0, $offset = 0, $objectTypes = null)'."\n";
  532.                 }
  533.             }
  534.         }
  535.         $cd .= "*/\n\n";
  537.         $implementsParts = [];
  539.         $implements = DataObject\ClassDefinition\Service::buildImplementsInterfacesCode($implementsParts, $this->getImplementsInterfaces());
  541.         $cd .= 'class '.ucfirst($this->getName()).' extends '.$extendClass. $implements . "\n";
  542.         $cd .= '{' . "\n";
  544.         $useParts = [];
  546.         $cd .= DataObject\ClassDefinition\Service::buildUseTraitsCode($useParts, $this->getUseTraits());
  548.         $cd .= 'protected $o_classId = "' . $this->getId(). "\";\n";
  549.         $cd .= 'protected $o_className = "'.$this->getName().'"'.";\n";
  551.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  552.             foreach ($this->getFieldDefinitions() as $key => $def) {
  553.                 if (!$def instanceof DataObject\ClassDefinition\Data\ReverseObjectRelation && !$def instanceof DataObject\ClassDefinition\Data\CalculatedValue
  554.                 ) {
  555.                     $cd .= 'protected $'.$key.";\n";
  556.                 }
  557.             }
  558.         }
  560.         $cd .= "\n\n";
  562.         $cd .= '/**'."\n";
  563.         $cd .= '* @param array $values'."\n";
  564.         $cd .= '* @return \\Pimcore\\Model\\DataObject\\'.ucfirst($this->getName())."\n";
  565.         $cd .= '*/'."\n";
  566.         $cd .= 'public static function create($values = array()) {';
  567.         $cd .= "\n";
  568.         $cd .= "\t".'$object = new static();'."\n";
  569.         $cd .= "\t".'$object->setValues($values);'."\n";
  570.         $cd .= "\t".'return $object;'."\n";
  571.         $cd .= '}';
  573.         $cd .= "\n\n";
  575.         if (is_array($this->getFieldDefinitions()) && count($this->getFieldDefinitions())) {
  576.             foreach ($this->getFieldDefinitions() as $key => $def) {
  577.                 if ($def instanceof DataObject\ClassDefinition\Data\ReverseObjectRelation) {
  578.                     continue;
  579.                 }
  581.                 // get setter and getter code
  582.                 $cd .= $def->getGetterCode($this);
  583.                 $cd .= $def->getSetterCode($this);
  585.                 // 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
  586.                 //TODO Pimcore 11 remove method_exists call
  587.                 if (!$def instanceof DataObject\ClassDefinition\Data\DataContainerAwareInterface && method_exists($def, 'classSaved')) {
  588.                     $def->classSaved($this);
  589.                 }
  590.             }
  591.         }
  593.         $cd .= "}\n";
  594.         $cd .= "\n";
  596.         if (File::put($this->getPhpClassFile(), $cd) === false) {
  597.             throw new \Exception(sprintf('Cannot write class file in %s please check the rights on this directory', $this->getPhpClassFile()));
  598.         }
  600.         // create class for object list
  601.         $extendListingClass = 'DataObject\\Listing\\Concrete';
  602.         if ($this->getListingParentClass()) {
  603.             $extendListingClass = $this->getListingParentClass();
  604.             $extendListingClass = '\\'.ltrim($extendListingClass, '\\');
  605.         }
  607.         // create list class
  608.         $cd = '<?php';
  610.         $cd .= "\n\n";
  611.         $cd .= 'namespace Pimcore\\Model\\DataObject\\'.ucfirst($this->getName()).';';
  612.         $cd .= "\n\n";
  613.         $cd .= 'use Pimcore\\Model\\DataObject;';
  614.         $cd .= "\n\n";
  615.         $cd .= "/**\n";
  616.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."|false current()\n";
  617.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."[] load()\n";
  618.         $cd .= ' * @method DataObject\\'.ucfirst($this->getName())."[] getData()\n";
  619.         $cd .= ' */';
  620.         $cd .= "\n\n";
  621.         $cd .= 'class Listing extends '.$extendListingClass . "\n";
  622.         $cd .= '{' . "\n";
  624.         $cd .= DataObject\ClassDefinition\Service::buildUseTraitsCode([], $this->getListingUseTraits());
  626.         $cd .= 'protected $classId = "'. $this->getId()."\";\n";
  627.         $cd .= 'protected $className = "'.$this->getName().'"'.";\n";
  629.         $cd .= "\n\n";
  631.         if (\is_array($this->getFieldDefinitions())) {
  632.             foreach ($this->getFieldDefinitions() as $key => $def) {
  633.                 if ($def instanceof DataObject\ClassDefinition\Data\Localizedfields) {
  634.                     foreach ($def->getFieldDefinitions() as $localizedFieldDefinition) {
  635.                         $cd .= $localizedFieldDefinition->getFilterCode();
  636.                     }
  637.                 } elseif ($def->isFilterable()) {
  638.                     $cd .= $def->getFilterCode();
  639.                 }
  640.             }
  641.         }
  643.         $cd .= "\n\n";
  644.         $cd .= "}\n";
  646.         if (File::put($this->getPhpListingClassFile(), $cd) === false) {
  647.             throw new \Exception(
  648.                 sprintf('Cannot write class file in %s please check the rights on this directory', $this->getPhpListingClassFile())
  649.             );
  650.         }
  652.         if ($generateDefinitionFile) {
  653.             // save definition as a php file
  654.             $definitionFile = $this->getDefinitionFile();
  655.             if (!is_writable(dirname($definitionFile)) || (is_file($definitionFile) && !is_writable($definitionFile))) {
  656.                 throw new \Exception(
  657.                     'Cannot write definition file in: '.$definitionFile.' please check write permission on this directory.'
  658.                 );
  659.             }
  660.             /** @var self $clone */
  661.             $clone = DataObject\Service::cloneDefinition($this);
  662.             $clone->setDao(null);
  663.             $clone->fieldDefinitions = [];
  665.             self::cleanupForExport($clone->layoutDefinitions);
  667.             $exportedClass = var_export($clone, true);
  669.             $data = '<?php';
  670.             $data .= "\n\n";
  671.             $data .= $infoDocBlock;
  672.             $data .= "\n\n";
  674.             $data .= "\nreturn ".$exportedClass.";\n";
  676.             \Pimcore\File::putPhpFile($definitionFile, $data);
  677.         }
  678.     }
  680.     /**
  681.      * @return string
  682.      *
  683.      * @internal
  684.      */
  685.     protected function getInfoDocBlock()
  686.     {
  687.         $cd = '/**' . "\n";
  688.         $cd .= '* Inheritance: '.($this->getAllowInherit() ? 'yes' : 'no')."\n";
  689.         $cd .= '* Variants: '.($this->getAllowVariants() ? 'yes' : 'no')."\n";
  691.         if ($this->getDescription()) {
  692.             $description = str_replace(['/**', '*/', '//'], '', $this->getDescription());
  693.             $description = str_replace("\n", "\n* ", $description);
  695.             $cd .= '* '.$description."\n";
  696.         }
  698.         $cd .= "\n\n";
  699.         $cd .= "Fields Summary:\n";
  701.         $cd = $this->getInfoDocBlockForFields($this, $cd, 1);
  703.         $cd .= '*/';
  705.         return $cd;
  706.     }
  708.     /**
  709.      * @internal
  710.      *
  711.      * @param ClassDefinition|ClassDefinition\Data $definition
  712.      * @param string $text
  713.      * @param int $level
  714.      *
  715.      * @return string
  716.      */
  717.     protected function getInfoDocBlockForFields($definition, $text, $level)
  718.     {
  719.         foreach ($definition->getFieldDefinitions() as $fd) {
  720.             $text .= str_pad('', $level, '-').' '.$fd->getName().' ['.$fd->getFieldtype()."]\n";
  721.             if (method_exists($fd, 'getFieldDefinitions')) {
  722.                 $text = $this->getInfoDocBlockForFields($fd, $text, $level + 1);
  723.             }
  724.         }
  726.         return $text;
  727.     }
  729.     public function delete()
  730.     {
  731.         \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::PRE_DELETE);
  733.         // delete all objects using this class
  734.         $list = new Listing();
  735.         $list->setCondition('o_classId = ?', $this->getId());
  736.         $list->load();
  738.         foreach ($list->getObjects() as $o) {
  739.             $o->delete();
  740.         }
  742.         $this->deletePhpClasses();
  744.         // empty object cache
  745.         try {
  746.             Cache::clearTag('class_'.$this->getId());
  747.         } catch (\Exception $e) {
  748.         }
  750.         // empty output cache
  751.         try {
  752.             Cache::clearTag('output');
  753.         } catch (\Exception $e) {
  754.         }
  756.         $customLayouts = new ClassDefinition\CustomLayout\Listing();
  757.         $customLayouts->setCondition('classId = ?', $this->getId());
  758.         $customLayouts = $customLayouts->load();
  760.         foreach ($customLayouts as $customLayout) {
  761.             $customLayout->delete();
  762.         }
  764.         $brickListing = new DataObject\Objectbrick\Definition\Listing();
  765.         $brickListing = $brickListing->load();
  766.         foreach ($brickListing as $brickDefinition) {
  767.             $modified = false;
  769.             $classDefinitions = $brickDefinition->getClassDefinitions();
  770.             if (is_array($classDefinitions)) {
  771.                 foreach ($classDefinitions as $key => $classDefinition) {
  772.                     if ($classDefinition['classname'] == $this->getId()) {
  773.                         unset($classDefinitions[$key]);
  774.                         $modified = true;
  775.                     }
  776.                 }
  777.             }
  778.             if ($modified) {
  779.                 $brickDefinition->setClassDefinitions($classDefinitions);
  780.                 $brickDefinition->save();
  781.             }
  782.         }
  784.         $this->getDao()->delete();
  786.         \Pimcore::getEventDispatcher()->dispatch(new ClassDefinitionEvent($this), DataObjectClassDefinitionEvents::POST_DELETE);
  787.     }
  789.     private function deletePhpClasses()
  790.     {
  791.         // delete the class files
  792.         @unlink($this->getPhpClassFile());
  793.         @unlink($this->getPhpListingClassFile());
  794.         @rmdir(dirname($this->getPhpListingClassFile()));
  795.         @unlink($this->getDefinitionFile());
  796.     }
  798.     /**
  799.      * @internal
  800.      *
  801.      * @return bool
  802.      */
  803.     public function isWritable(): bool
  804.     {
  805.         if ($_SERVER['PIMCORE_CLASS_DEFINITION_WRITABLE'] ?? false) {
  806.             return true;
  807.         }
  809.         return !str_starts_with($this->getDefinitionFile(), PIMCORE_CUSTOM_CONFIGURATION_DIRECTORY);
  810.     }
  812.     /**
  813.      * @internal
  814.      *
  815.      * @param string|null $name
  816.      *
  817.      * @return string
  818.      */
  819.     public function getDefinitionFile($name = null)
  820.     {
  821.         return $this->locateFile($name ?? $this->getName(), 'definition_%s.php');
  822.     }
  824.     private function getPhpClassFile(): string
  825.     {
  826.         return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s.php');
  827.     }
  829.     private function getPhpListingClassFile(): string
  830.     {
  831.         return $this->locateFile(ucfirst($this->getName()), 'DataObject/%s/Listing.php');
  832.     }
  834.     /**
  835.      * @return string|null
  836.      */
  837.     public function getId()
  838.     {
  839.         return $this->id;
  840.     }
  842.     /**
  843.      * @return string|null
  844.      */
  845.     public function getName()
  846.     {
  847.         return $this->name;
  848.     }
  850.     /**
  851.      * @return int|null
  852.      */
  853.     public function getCreationDate()
  854.     {
  855.         return $this->creationDate;
  856.     }
  858.     /**
  859.      * @return int|null
  860.      */
  861.     public function getModificationDate()
  862.     {
  863.         return $this->modificationDate;
  864.     }
  866.     /**
  867.      * @return int|null
  868.      */
  869.     public function getUserOwner()
  870.     {
  871.         return $this->userOwner;
  872.     }
  874.     /**
  875.      * @return int|null
  876.      */
  877.     public function getUserModification()
  878.     {
  879.         return $this->userModification;
  880.     }
  882.     /**
  883.      * @param string $id
  884.      *
  885.      * @return $this
  886.      */
  887.     public function setId($id)
  888.     {
  889.         $this->id = $id;
  891.         return $this;
  892.     }
  894.     /**
  895.      * @param string $name
  896.      *
  897.      * @return $this
  898.      */
  899.     public function setName($name)
  900.     {
  901.         $this->name = $name;
  903.         return $this;
  904.     }
  906.     /**
  907.      * @param int $creationDate
  908.      *
  909.      * @return $this
  910.      */
  911.     public function setCreationDate($creationDate)
  912.     {
  913.         $this->creationDate = (int)$creationDate;
  915.         return $this;
  916.     }
  918.     /**
  919.      * @param int $modificationDate
  920.      *
  921.      * @return $this
  922.      */
  923.     public function setModificationDate($modificationDate)
  924.     {
  925.         $this->modificationDate = (int)$modificationDate;
  927.         return $this;
  928.     }
  930.     /**
  931.      * @param int $userOwner
  932.      *
  933.      * @return $this
  934.      */
  935.     public function setUserOwner($userOwner)
  936.     {
  937.         $this->userOwner = (int)$userOwner;
  939.         return $this;
  940.     }
  942.     /**
  943.      * @param int $userModification
  944.      *
  945.      * @return $this
  946.      */
  947.     public function setUserModification($userModification)
  948.     {
  949.         $this->userModification = (int)$userModification;
  951.         return $this;
  952.     }
  954.     /**
  955.      * @param array $context
  956.      *
  957.      * @return DataObject\ClassDefinition\Data[]
  958.      */
  959.     public function getFieldDefinitions($context = [])
  960.     {
  961.         if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  962.             return $this->fieldDefinitions;
  963.         }
  965.         $enrichedFieldDefinitions = [];
  966.         foreach ($this->fieldDefinitions as $key => $fieldDefinition) {
  967.             $fieldDefinition = $this->doEnrichFieldDefinition($fieldDefinition, $context);
  968.             $enrichedFieldDefinitions[$key] = $fieldDefinition;
  969.         }
  971.         return $enrichedFieldDefinitions;
  972.     }
  974.     /**
  975.      * @internal
  976.      */
  977.     protected function doEnrichFieldDefinition($fieldDefinition, $context = [])
  978.     {
  979.         //TODO Pimcore 11: remove method_exists BC layer
  980.         if ($fieldDefinition instanceof FieldDefinitionEnrichmentInterface || method_exists($fieldDefinition, 'enrichFieldDefinition')) {
  981.             if (!$fieldDefinition instanceof FieldDefinitionEnrichmentInterface) {
  982.                 trigger_deprecation('pimcore/pimcore', '10.1',
  983.                     sprintf('Usage of method_exists is deprecated since version 10.1 and will be removed in Pimcore 11.' .
  984.                     'Implement the %s interface instead.', FieldDefinitionEnrichmentInterface::class));
  985.             }
  986.             $context['class'] = $this;
  987.             $fieldDefinition = $fieldDefinition->enrichFieldDefinition($context);
  988.         }
  990.         return $fieldDefinition;
  991.     }
  993.     /**
  994.      * @return DataObject\ClassDefinition\Layout|null
  995.      */
  996.     public function getLayoutDefinitions()
  997.     {
  998.         return $this->layoutDefinitions;
  999.     }
  1001.     /**
  1002.      * @param DataObject\ClassDefinition\Data[] $fieldDefinitions
  1003.      *
  1004.      * @return $this
  1005.      */
  1006.     public function setFieldDefinitions(array $fieldDefinitions)
  1007.     {
  1008.         $this->fieldDefinitions = $fieldDefinitions;
  1010.         return $this;
  1011.     }
  1013.     /**
  1014.      * @param string $key
  1015.      * @param DataObject\ClassDefinition\Data $data
  1016.      *
  1017.      * @return $this
  1018.      */
  1019.     public function addFieldDefinition($key, $data)
  1020.     {
  1021.         $this->fieldDefinitions[$key] = $data;
  1023.         return $this;
  1024.     }
  1026.     /**
  1027.      * @param string $key
  1028.      * @param array $context
  1029.      *
  1030.      * @return DataObject\ClassDefinition\Data|null
  1031.      */
  1032.     public function getFieldDefinition($key, $context = [])
  1033.     {
  1034.         if (array_key_exists($key, $this->fieldDefinitions)) {
  1035.             if (!\Pimcore::inAdmin() || (isset($context['suppressEnrichment']) && $context['suppressEnrichment'])) {
  1036.                 return $this->fieldDefinitions[$key];
  1037.             }
  1038.             $fieldDefinition = $this->doEnrichFieldDefinition($this->fieldDefinitions[$key], $context);
  1040.             return $fieldDefinition;
  1041.         }
  1043.         return null;
  1044.     }
  1046.     /**
  1047.      * @param DataObject\ClassDefinition\Layout|null $layoutDefinitions
  1048.      *
  1049.      * @return $this
  1050.      */
  1051.     public function setLayoutDefinitions($layoutDefinitions)
  1052.     {
  1053.         $this->layoutDefinitions = $layoutDefinitions;
  1055.         $this->fieldDefinitions = [];
  1056.         $this->extractDataDefinitions($this->layoutDefinitions);
  1058.         return $this;
  1059.     }
  1061.     /**
  1062.      * @param DataObject\ClassDefinition\Layout|DataObject\ClassDefinition\Data $def
  1063.      */
  1064.     private function extractDataDefinitions($def)
  1065.     {
  1066.         if ($def instanceof DataObject\ClassDefinition\Layout) {
  1067.             if ($def->hasChildren()) {
  1068.                 foreach ($def->getChildren() as $child) {
  1069.                     $this->extractDataDefinitions($child);
  1070.                 }
  1071.             }
  1072.         }
  1074.         if ($def instanceof DataObject\ClassDefinition\Data) {
  1075.             $existing = $this->getFieldDefinition($def->getName());
  1077.             if (!$existing && method_exists($def, 'addReferencedField') && method_exists($def, 'setReferencedFields')) {
  1078.                 $def->setReferencedFields([]);
  1079.             }
  1081.             if ($existing && method_exists($existing, 'addReferencedField')) {
  1082.                 // this is especially for localized fields which get aggregated here into one field definition
  1083.                 // in the case that there are more than one localized fields in the class definition
  1084.                 // see also pimcore.object.edit.addToDataFields();
  1085.                 $existing->addReferencedField($def);
  1086.             } else {
  1087.                 $this->addFieldDefinition($def->getName(), $def);
  1088.             }
  1089.         }
  1090.     }
  1092.     /**
  1093.      * @return string
  1094.      */
  1095.     public function getParentClass()
  1096.     {
  1097.         return $this->parentClass;
  1098.     }
  1100.     /**
  1101.      * @return string
  1102.      */
  1103.     public function getListingParentClass()
  1104.     {
  1105.         return $this->listingParentClass;
  1106.     }
  1108.     /**
  1109.      * @return string
  1110.      */
  1111.     public function getUseTraits()
  1112.     {
  1113.         return $this->useTraits;
  1114.     }
  1116.     /**
  1117.      * @param string $useTraits
  1118.      *
  1119.      * @return ClassDefinition
  1120.      */
  1121.     public function setUseTraits($useTraits)
  1122.     {
  1123.         $this->useTraits = (string) $useTraits;
  1125.         return $this;
  1126.     }
  1128.     /**
  1129.      * @return string
  1130.      */
  1131.     public function getListingUseTraits()
  1132.     {
  1133.         return $this->listingUseTraits;
  1134.     }
  1136.     /**
  1137.      * @param string $listingUseTraits
  1138.      *
  1139.      * @return ClassDefinition
  1140.      */
  1141.     public function setListingUseTraits($listingUseTraits)
  1142.     {
  1143.         $this->listingUseTraits = (string) $listingUseTraits;
  1145.         return $this;
  1146.     }
  1148.     /**
  1149.      * @return bool
  1150.      */
  1151.     public function getAllowInherit()
  1152.     {
  1153.         return $this->allowInherit;
  1154.     }
  1156.     /**
  1157.      * @return bool
  1158.      */
  1159.     public function getAllowVariants()
  1160.     {
  1161.         return $this->allowVariants;
  1162.     }
  1164.     /**
  1165.      * @param string $parentClass
  1166.      *
  1167.      * @return $this
  1168.      */
  1169.     public function setParentClass($parentClass)
  1170.     {
  1171.         $this->parentClass = $parentClass;
  1173.         return $this;
  1174.     }
  1176.     /**
  1177.      * @param string $listingParentClass
  1178.      *
  1179.      * @return $this
  1180.      */
  1181.     public function setListingParentClass($listingParentClass)
  1182.     {
  1183.         $this->listingParentClass = (string) $listingParentClass;
  1185.         return $this;
  1186.     }
  1188.     /**
  1189.      * @return bool
  1190.      */
  1191.     public function getEncryption(): bool
  1192.     {
  1193.         return $this->encryption;
  1194.     }
  1196.     /**
  1197.      * @param bool $encryption
  1198.      *
  1199.      * @return $this
  1200.      */
  1201.     public function setEncryption(bool $encryption)
  1202.     {
  1203.         $this->encryption = $encryption;
  1205.         return $this;
  1206.     }
  1208.     /**
  1209.      * @internal
  1210.      *
  1211.      * @param array $tables
  1212.      */
  1213.     public function addEncryptedTables(array $tables)
  1214.     {
  1215.         $this->encryptedTables = array_unique(array_merge($this->encryptedTables, $tables));
  1216.     }
  1218.     /**
  1219.      * @internal
  1220.      *
  1221.      * @param array $tables
  1222.      */
  1223.     public function removeEncryptedTables(array $tables)
  1224.     {
  1225.         foreach ($tables as $table) {
  1226.             if (($key = array_search($table, $this->encryptedTables)) !== false) {
  1227.                 unset($this->encryptedTables[$key]);
  1228.             }
  1229.         }
  1230.     }
  1232.     /**
  1233.      * @internal
  1234.      *
  1235.      * @param string $table
  1236.      *
  1237.      * @return bool
  1238.      */
  1239.     public function isEncryptedTable(string $table): bool
  1240.     {
  1241.         return (array_search($table, $this->encryptedTables) === false) ? false : true;
  1242.     }
  1244.     /**
  1245.      * @return bool
  1246.      */
  1247.     public function hasEncryptedTables(): bool
  1248.     {
  1249.         return (bool) count($this->encryptedTables);
  1250.     }
  1252.     /**
  1253.      * @internal
  1254.      *
  1255.      * @param array $encryptedTables
  1256.      *
  1257.      * @return $this
  1258.      */
  1259.     public function setEncryptedTables(array $encryptedTables)
  1260.     {
  1261.         $this->encryptedTables = $encryptedTables;
  1263.         return $this;
  1264.     }
  1266.     /**
  1267.      * @param bool $allowInherit
  1268.      *
  1269.      * @return $this
  1270.      */
  1271.     public function setAllowInherit($allowInherit)
  1272.     {
  1273.         $this->allowInherit = (bool)$allowInherit;
  1275.         return $this;
  1276.     }
  1278.     /**
  1279.      * @param bool $allowVariants
  1280.      *
  1281.      * @return $this
  1282.      */
  1283.     public function setAllowVariants($allowVariants)
  1284.     {
  1285.         $this->allowVariants = (bool)$allowVariants;
  1287.         return $this;
  1288.     }
  1290.     /**
  1291.      * @return string
  1292.      */
  1293.     public function getIcon()
  1294.     {
  1295.         return $this->icon;
  1296.     }
  1298.     /**
  1299.      * @param string $icon
  1300.      *
  1301.      * @return $this
  1302.      */
  1303.     public function setIcon($icon)
  1304.     {
  1305.         $this->icon = $icon;
  1307.         return $this;
  1308.     }
  1310.     /**
  1311.      * @return array
  1312.      */
  1313.     public function getPropertyVisibility()
  1314.     {
  1315.         return $this->propertyVisibility;
  1316.     }
  1318.     /**
  1319.      * @param array $propertyVisibility
  1320.      *
  1321.      * @return $this
  1322.      */
  1323.     public function setPropertyVisibility($propertyVisibility)
  1324.     {
  1325.         if (is_array($propertyVisibility)) {
  1326.             $this->propertyVisibility = $propertyVisibility;
  1327.         }
  1329.         return $this;
  1330.     }
  1332.     /**
  1333.      * @param string $previewUrl
  1334.      *
  1335.      * @return $this
  1336.      */
  1337.     public function setPreviewUrl($previewUrl)
  1338.     {
  1339.         $this->previewUrl = $previewUrl;
  1341.         return $this;
  1342.     }
  1344.     /**
  1345.      * @return string
  1346.      */
  1347.     public function getPreviewUrl()
  1348.     {
  1349.         return $this->previewUrl;
  1350.     }
  1352.     /**
  1353.      * @return string
  1354.      */
  1355.     public function getGroup()
  1356.     {
  1357.         return $this->group;
  1358.     }
  1360.     /**
  1361.      * @param string $group
  1362.      *
  1363.      * @return $this
  1364.      */
  1365.     public function setGroup($group)
  1366.     {
  1367.         $this->group = $group;
  1369.         return $this;
  1370.     }
  1372.     /**
  1373.      * @param string $description
  1374.      *
  1375.      * @return $this
  1376.      */
  1377.     public function setDescription($description)
  1378.     {
  1379.         $this->description = $description;
  1381.         return $this;
  1382.     }
  1384.     /**
  1385.      * @return string
  1386.      */
  1387.     public function getDescription()
  1388.     {
  1389.         return $this->description;
  1390.     }
  1392.     /**
  1393.      * @param bool $showVariants
  1394.      *
  1395.      * @return $this
  1396.      */
  1397.     public function setShowVariants($showVariants)
  1398.     {
  1399.         $this->showVariants = (bool)$showVariants;
  1401.         return $this;
  1402.     }
  1404.     /**
  1405.      * @return bool
  1406.      */
  1407.     public function getShowVariants()
  1408.     {
  1409.         return $this->showVariants;
  1410.     }
  1412.     /**
  1413.      * @return bool
  1414.      */
  1415.     public function getShowAppLoggerTab()
  1416.     {
  1417.         return $this->showAppLoggerTab;
  1418.     }
  1420.     /**
  1421.      * @param bool $showAppLoggerTab
  1422.      *
  1423.      * @return $this
  1424.      */
  1425.     public function setShowAppLoggerTab($showAppLoggerTab)
  1426.     {
  1427.         $this->showAppLoggerTab = (bool) $showAppLoggerTab;
  1429.         return $this;
  1430.     }
  1432.     /**
  1433.      * @return bool
  1434.      */
  1435.     public function getShowFieldLookup()
  1436.     {
  1437.         return $this->showFieldLookup;
  1438.     }
  1440.     /**
  1441.      * @param bool $showFieldLookup
  1442.      *
  1443.      * @return $this
  1444.      */
  1445.     public function setShowFieldLookup($showFieldLookup)
  1446.     {
  1447.         $this->showFieldLookup = (bool) $showFieldLookup;
  1449.         return $this;
  1450.     }
  1452.     /**
  1453.      * @return string
  1454.      */
  1455.     public function getLinkGeneratorReference()
  1456.     {
  1457.         return $this->linkGeneratorReference;
  1458.     }
  1460.     /**
  1461.      * @param string $linkGeneratorReference
  1462.      *
  1463.      * @return $this
  1464.      */
  1465.     public function setLinkGeneratorReference($linkGeneratorReference)
  1466.     {
  1467.         $this->linkGeneratorReference = $linkGeneratorReference;
  1469.         return $this;
  1470.     }
  1472.     /**
  1473.      * @return DataObject\ClassDefinition\LinkGeneratorInterface|null
  1474.      */
  1475.     public function getLinkGenerator()
  1476.     {
  1477.         return DataObject\ClassDefinition\Helper\LinkGeneratorResolver::resolveGenerator($this->getLinkGeneratorReference());
  1478.     }
  1480.     /**
  1481.      * @return string|null
  1482.      */
  1483.     public function getPreviewGeneratorReference(): ?string
  1484.     {
  1485.         return $this->previewGeneratorReference;
  1486.     }
  1488.     /**
  1489.      * @param string|null $previewGeneratorReference
  1490.      */
  1491.     public function setPreviewGeneratorReference(?string $previewGeneratorReference): void
  1492.     {
  1493.         $this->previewGeneratorReference = $previewGeneratorReference;
  1494.     }
  1496.     /**
  1497.      * @return DataObject\ClassDefinition\PreviewGeneratorInterface|null
  1498.      */
  1499.     public function getPreviewGenerator()
  1500.     {
  1501.         return DataObject\ClassDefinition\Helper\PreviewGeneratorResolver::resolveGenerator($this->getPreviewGeneratorReference());
  1502.     }
  1504.     /**
  1505.      * @return bool
  1506.      */
  1507.     public function isEnableGridLocking(): bool
  1508.     {
  1509.         return $this->enableGridLocking;
  1510.     }
  1512.     /**
  1513.      * @param bool $enableGridLocking
  1514.      */
  1515.     public function setEnableGridLocking(bool $enableGridLocking): void
  1516.     {
  1517.         $this->enableGridLocking = $enableGridLocking;
  1518.     }
  1520.     /**
  1521.      * @return string|null
  1522.      */
  1523.     public function getImplementsInterfaces(): ?string
  1524.     {
  1525.         return $this->implementsInterfaces;
  1526.     }
  1528.     /**
  1529.      * @param string|null $implementsInterfaces
  1530.      *
  1531.      * @return $this
  1532.      */
  1533.     public function setImplementsInterfaces(?string $implementsInterfaces)
  1534.     {
  1535.         $this->implementsInterfaces = $implementsInterfaces;
  1537.         return $this;
  1538.     }
  1540.     /**
  1541.      * @return array
  1542.      */
  1543.     public function getCompositeIndices(): array
  1544.     {
  1545.         return $this->compositeIndices;
  1546.     }
  1548.     /**
  1549.      * @param array $compositeIndices
  1550.      *
  1551.      * @return $this
  1552.      */
  1553.     public function setCompositeIndices($compositeIndices)
  1554.     {
  1555.         $this->compositeIndices = $compositeIndices ?? [];
  1557.         return $this;
  1558.     }
  1560.     /**
  1561.      * @return bool
  1562.      */
  1563.     public function getGenerateTypeDeclarations()
  1564.     {
  1565.         return (bool) $this->generateTypeDeclarations;
  1566.     }
  1568.     /**
  1569.      * @param bool $generateTypeDeclarations
  1570.      *
  1571.      * @return $this
  1572.      */
  1573.     public function setGenerateTypeDeclarations($generateTypeDeclarations)
  1574.     {
  1575.         $this->generateTypeDeclarations = (bool) $generateTypeDeclarations;
  1577.         return $this;
  1578.     }
  1579. }