vendor/pimcore/pimcore/models/Document/Editable/Image.php line 27

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\Document\Editable;
  18. use Pimcore\Model;
  19. use Pimcore\Model\Asset;
  20. use Pimcore\Model\Element;
  21. use Pimcore\Model\Element\ElementDescriptor;
  22. use Pimcore\Model\Element\ElementInterface;
  23. use Pimcore\Tool\Serialize;
  25. /**
  26.  * @method \Pimcore\Model\Document\Editable\Dao getDao()
  27.  */
  28. class Image extends Model\Document\Editable implements IdRewriterInterface, EditmodeDataInterface
  29. {
  30.     /**
  31.      * ID of the referenced image
  32.      *
  33.      * @internal
  34.      *
  35.      * @var int|null
  36.      */
  37.     protected $id;
  39.     /**
  40.      * The ALT text of the image
  41.      *
  42.      * @internal
  43.      *
  44.      * @var string|null
  45.      */
  46.     protected $alt;
  48.     /**
  49.      * Contains the imageobject itself
  50.      *
  51.      * @internal
  52.      *
  53.      * @var Asset\Image|ElementDescriptor|ElementInterface|null
  54.      */
  55.     protected $image;
  57.     /**
  58.      * @internal
  59.      *
  60.      * @var bool
  61.      */
  62.     protected $cropPercent = false;
  64.     /**
  65.      * @internal
  66.      *
  67.      * @var float
  68.      */
  69.     protected $cropWidth;
  71.     /**
  72.      * @internal
  73.      *
  74.      * @var float
  75.      */
  76.     protected $cropHeight;
  78.     /**
  79.      * @internal
  80.      *
  81.      * @var float
  82.      */
  83.     protected $cropTop;
  85.     /**
  86.      * @internal
  87.      *
  88.      * @var float
  89.      */
  90.     protected $cropLeft;
  92.     /**
  93.      * @internal
  94.      *
  95.      * @var array
  96.      */
  97.     protected $hotspots = [];
  99.     /**
  100.      * @internal
  101.      *
  102.      * @var array
  103.      */
  104.     protected $marker = [];
  106.     /**
  107.      * The Thumbnail config of the image
  108.      *
  109.      * @internal
  110.      *
  111.      * @var string|null
  112.      */
  113.     protected $thumbnail;
  115.     /**
  116.      * {@inheritdoc}
  117.      */
  118.     public function getType()
  119.     {
  120.         return 'image';
  121.     }
  123.     /**
  124.      * {@inheritdoc}
  125.      *
  126.      * @return mixed
  127.      */
  128.     public function getData()
  129.     {
  130.         return [
  131.             'id' => $this->id,
  132.             'alt' => $this->alt,
  133.             'cropPercent' => $this->cropPercent,
  134.             'cropWidth' => $this->cropWidth,
  135.             'cropHeight' => $this->cropHeight,
  136.             'cropTop' => $this->cropTop,
  137.             'cropLeft' => $this->cropLeft,
  138.             'hotspots' => $this->hotspots,
  139.             'marker' => $this->marker,
  140.             'thumbnail' => $this->thumbnail,
  141.         ];
  142.     }
  144.     /**
  145.      * {@inheritdoc}
  146.      *
  147.      * @return array
  148.      */
  149.     public function getDataForResource()
  150.     {
  151.         return [
  152.             'id' => $this->id,
  153.             'alt' => $this->alt,
  154.             'cropPercent' => $this->cropPercent,
  155.             'cropWidth' => $this->cropWidth,
  156.             'cropHeight' => $this->cropHeight,
  157.             'cropTop' => $this->cropTop,
  158.             'cropLeft' => $this->cropLeft,
  159.             'hotspots' => $this->hotspots,
  160.             'marker' => $this->marker,
  161.             'thumbnail' => $this->thumbnail,
  162.         ];
  163.     }
  165.     /**
  166.      * {@inheritdoc}
  167.      */
  168.     public function getDataEditmode() /** : mixed */
  169.     {
  170.         $image = $this->getImage();
  172.         if ($image instanceof Asset\Image) {
  173.             $rewritePath = function ($data) {
  174.                 if (!is_array($data)) {
  175.                     return [];
  176.                 }
  178.                 foreach ($data as &$element) {
  179.                     if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  180.                         foreach ($element['data'] as &$metaData) {
  181.                             if ($metaData instanceof Element\Data\MarkerHotspotItem) {
  182.                                 $metaData = get_object_vars($metaData);
  183.                             }
  185.                             if (in_array($metaData['type'], ['object', 'asset', 'document'])
  186.                             && $el = Element\Service::getElementById($metaData['type'], $metaData['value'])) {
  187.                                 $metaData['value'] = $el;
  188.                             }
  190.                             if ($metaData['value'] instanceof Element\ElementInterface) {
  191.                                 $metaData['value'] = $metaData['value']->getRealFullPath();
  192.                             }
  193.                         }
  194.                     }
  195.                 }
  197.                 return $data;
  198.             };
  200.             $marker = $rewritePath($this->marker);
  201.             $hotspots = $rewritePath($this->hotspots);
  203.             return [
  204.                 'id' => $this->id,
  205.                 'path' => $image->getRealFullPath(),
  206.                 'alt' => $this->alt,
  207.                 'cropPercent' => $this->cropPercent,
  208.                 'cropWidth' => $this->cropWidth,
  209.                 'cropHeight' => $this->cropHeight,
  210.                 'cropTop' => $this->cropTop,
  211.                 'cropLeft' => $this->cropLeft,
  212.                 'hotspots' => $hotspots,
  213.                 'marker' => $marker,
  214.                 'thumbnail' => $this->thumbnail,
  215.                 'predefinedDataTemplates' => $this->getConfig()['predefinedDataTemplates'] ?? null,
  216.             ];
  217.         }
  219.         return null;
  220.     }
  222.     /**
  223.      * @return array
  224.      */
  225.     public function getConfig()
  226.     {
  227.         $config = parent::getConfig();
  228.         if (isset($config['thumbnail']) && !isset($config['focal_point_context_menu_item'])) {
  229.             $thumbConfig = Asset\Image\Thumbnail\Config::getByAutoDetect($config['thumbnail']);
  230.             if ($thumbConfig) {
  231.                 foreach ($thumbConfig->getItems() as $item) {
  232.                     if ($item['method'] == 'cover') {
  233.                         $config['focal_point_context_menu_item'] = true;
  234.                         $this->config['focal_point_context_menu_item'] = true;
  236.                         break;
  237.                     }
  238.                 }
  239.             }
  240.         }
  242.         return $config;
  243.     }
  245.     /**
  246.      * {@inheritdoc}
  247.      */
  248.     public function frontend()
  249.     {
  250.         if (!is_array($this->config)) {
  251.             $this->config = [];
  252.         }
  254.         $image = $this->getImage();
  256.         if ($image instanceof Asset\Image) {
  257.             $thumbnailName = $this->config['thumbnail'] ?? null;
  258.             if ($thumbnailName || $this->cropPercent) {
  259.                 // create a thumbnail first
  260.                 $autoName = false;
  262.                 $thumbConfig = $image->getThumbnailConfig($thumbnailName);
  263.                 if (!$thumbConfig && $this->cropPercent) {
  264.                     $thumbConfig = new Asset\Image\Thumbnail\Config();
  265.                 }
  267.                 if ($this->cropPercent) {
  268.                     $this->applyCustomCropping($thumbConfig);
  269.                     $autoName = true;
  270.                 }
  272.                 if (isset($this->config['highResolution']) && $this->config['highResolution'] > 1) {
  273.                     $thumbConfig->setHighResolution($this->config['highResolution']);
  274.                 }
  276.                 // autogenerate a name for the thumbnail because it's different from the original
  277.                 if ($autoName) {
  278.                     $thumbConfig->generateAutoName();
  279.                 }
  281.                 $deferred = true;
  282.                 if (isset($this->config['deferred'])) {
  283.                     $deferred = $this->config['deferred'];
  284.                 }
  286.                 $thumbnail = $image->getThumbnail($thumbConfig, $deferred);
  287.             } else {
  288.                 // we're using the thumbnail class only to generate the HTML
  289.                 $thumbnail = $image->getThumbnail();
  290.             }
  292.             $attributes = array_merge($this->config, [
  293.                 'alt' => $this->alt,
  294.                 'title' => $this->alt,
  295.             ]);
  297.             $removeAttributes = [];
  298.             if (isset($this->config['removeAttributes']) && is_array($this->config['removeAttributes'])) {
  299.                 $removeAttributes = $this->config['removeAttributes'];
  300.             }
  302.             // thumbnail's HTML is always generated by the thumbnail itself
  303.             return $thumbnail->getHtml($attributes);
  304.         }
  306.         return '';
  307.     }
  309.     /**
  310.      * {@inheritdoc}
  311.      */
  312.     public function setDataFromResource($data)
  313.     {
  314.         if (strlen($data) > 2) {
  315.             $data = Serialize::unserialize($data);
  316.         }
  318.         $rewritePath = function ($data) {
  319.             if (!is_array($data)) {
  320.                 return [];
  321.             }
  323.             foreach ($data as &$element) {
  324.                 if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  325.                     foreach ($element['data'] as &$metaData) {
  326.                         // this is for backward compatibility (Array vs. MarkerHotspotItem)
  327.                         if (is_array($metaData)) {
  328.                             $metaData = new Element\Data\MarkerHotspotItem($metaData);
  329.                         }
  330.                     }
  331.                 }
  332.             }
  334.             return $data;
  335.         };
  337.         if (array_key_exists('marker', $data) && is_array($data['marker']) && count($data['marker']) > 0) {
  338.             $data['marker'] = $rewritePath($data['marker']);
  339.         }
  341.         if (array_key_exists('hotspots', $data) && is_array($data['hotspots']) && count($data['hotspots']) > 0) {
  342.             $data['hotspots'] = $rewritePath($data['hotspots']);
  343.         }
  345.         $this->id = $data['id'] ?? null;
  346.         $this->alt = $data['alt'] ?? null;
  347.         $this->cropPercent = $data['cropPercent'] ?? null;
  348.         $this->cropWidth = $data['cropWidth'] ?? null;
  349.         $this->cropHeight = $data['cropHeight'] ?? null;
  350.         $this->cropTop = $data['cropTop'] ?? null;
  351.         $this->cropLeft = $data['cropLeft'] ?? null;
  352.         $this->marker = $data['marker'] ?? null;
  353.         $this->hotspots = $data['hotspots'] ?? null;
  354.         $this->thumbnail = $data['thumbnail'] ?? null;
  356.         return $this;
  357.     }
  359.     /**
  360.      * {@inheritdoc}
  361.      */
  362.     public function setDataFromEditmode($data)
  363.     {
  364.         $rewritePath = function ($data) {
  365.             if (!is_array($data)) {
  366.                 return [];
  367.             }
  369.             foreach ($data as &$element) {
  370.                 if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  371.                     foreach ($element['data'] as &$metaData) {
  372.                         $metaData = new Element\Data\MarkerHotspotItem($metaData);
  373.                         if (in_array($metaData['type'], ['object', 'asset', 'document'])) {
  374.                             $el = Element\Service::getElementByPath($metaData['type'], $metaData->getValue());
  375.                             $metaData['value'] = $el;
  376.                         }
  377.                     }
  378.                 }
  379.             }
  381.             return $data;
  382.         };
  384.         if (is_array($data)) {
  385.             if (array_key_exists('marker', $data) && is_array($data['marker']) && count($data['marker']) > 0) {
  386.                 $data['marker'] = $rewritePath($data['marker']);
  387.             }
  389.             if (array_key_exists('hotspots', $data) && is_array($data['hotspots']) && count($data['hotspots']) > 0) {
  390.                 $data['hotspots'] = $rewritePath($data['hotspots']);
  391.             }
  393.             $this->id = $data['id'] ?? null;
  394.             $this->alt = $data['alt'] ?? null;
  395.             $this->cropPercent = $data['cropPercent'] ?? null;
  396.             $this->cropWidth = $data['cropWidth'] ?? null;
  397.             $this->cropHeight = $data['cropHeight'] ?? null;
  398.             $this->cropTop = $data['cropTop'] ?? null;
  399.             $this->cropLeft = $data['cropLeft'] ?? null;
  400.             $this->marker = $data['marker'] ?? null;
  401.             $this->hotspots = $data['hotspots'] ?? null;
  402.             $this->thumbnail = $data['thumbnail'] ?? null;
  403.         }
  405.         return $this;
  406.     }
  408.     /**
  409.      * @return string
  410.      */
  411.     public function getText()
  412.     {
  413.         return $this->alt;
  414.     }
  416.     /**
  417.      * @param string $text
  418.      */
  419.     public function setText($text)
  420.     {
  421.         $this->alt = $text;
  422.     }
  424.     /**
  425.      * @return string
  426.      */
  427.     public function getAlt()
  428.     {
  429.         return $this->getText();
  430.     }
  432.     /**
  433.      * @return string|null
  434.      */
  435.     public function getThumbnailConfig()
  436.     {
  437.         return $this->thumbnail;
  438.     }
  440.     /**
  441.      * @return string
  442.      */
  443.     public function getSrc()
  444.     {
  445.         $image = $this->getImage();
  446.         if ($image instanceof Asset) {
  447.             return $image->getFullPath();
  448.         }
  450.         return '';
  451.     }
  453.     /**
  454.      * @return Asset\Image|ElementDescriptor|ElementInterface|null
  455.      */
  456.     public function getImage()
  457.     {
  458.         if (!$this->image) {
  459.             $this->image = Asset\Image::getById($this->getId());
  460.         }
  462.         return $this->image;
  463.     }
  465.     /**
  466.      * @param Asset\Image|ElementDescriptor|ElementInterface|null $image
  467.      *
  468.      * @return $this
  469.      */
  470.     public function setImage($image)
  471.     {
  472.         $this->image = $image;
  474.         if ($image instanceof Asset) {
  475.             $this->setId($image->getId());
  476.         }
  478.         return $this;
  479.     }
  481.     /**
  482.      * @param int $id
  483.      *
  484.      * @return $this
  485.      */
  486.     public function setId($id)
  487.     {
  488.         $this->id = $id;
  490.         return $this;
  491.     }
  493.     /**
  494.      * @return int
  495.      */
  496.     public function getId()
  497.     {
  498.         return (int) $this->id;
  499.     }
  501.     /**
  502.      * @param array|string|Asset\Image\Thumbnail\Config $conf
  503.      * @param bool $deferred
  504.      *
  505.      * @return Asset\Image\Thumbnail|string
  506.      */
  507.     public function getThumbnail($conf, $deferred = true)
  508.     {
  509.         $image = $this->getImage();
  510.         if ($image instanceof Asset\Image) {
  511.             $thumbConfig = $image->getThumbnailConfig($conf);
  512.             if ($thumbConfig && $this->cropPercent) {
  513.                 $this->applyCustomCropping($thumbConfig);
  514.                 $thumbConfig->generateAutoName();
  515.             }
  517.             return $image->getThumbnail($thumbConfig, $deferred);
  518.         }
  520.         return '';
  521.     }
  523.     /**
  524.      * @param Asset\Image\Thumbnail\Config $thumbConfig
  525.      *
  526.      * @return void
  527.      */
  528.     private function applyCustomCropping($thumbConfig)
  529.     {
  530.         $cropConfig = [
  531.             'width' => $this->cropWidth,
  532.             'height' => $this->cropHeight,
  533.             'y' => $this->cropTop,
  534.             'x' => $this->cropLeft,
  535.         ];
  537.         $thumbConfig->addItemAt(0, 'cropPercent', $cropConfig);
  539.         // also crop media query specific configs
  540.         if ($thumbConfig->hasMedias()) {
  541.             foreach ($thumbConfig->getMedias() as $mediaName => $mediaItems) {
  542.                 $thumbConfig->addItemAt(0, 'cropPercent', $cropConfig, $mediaName);
  543.             }
  544.         }
  545.     }
  547.     /**
  548.      * {@inheritdoc}
  549.      */
  550.     public function isEmpty()
  551.     {
  552.         $image = $this->getImage();
  553.         if ($image instanceof Asset\Image) {
  554.             return false;
  555.         }
  557.         return true;
  558.     }
  560.     /**
  561.      * {@inheritdoc}
  562.      */
  563.     public function getCacheTags(Model\Document\PageSnippet $ownerDocument, array $tags = []): array
  564.     {
  565.         $image = $this->getImage();
  567.         if ($image instanceof Asset) {
  568.             if (!array_key_exists($image->getCacheTag(), $tags)) {
  569.                 $tags = $image->getCacheTags($tags);
  570.             }
  571.         }
  573.         $getMetaDataCacheTags = function ($data, $tags) {
  574.             if (!is_array($data)) {
  575.                 return $tags;
  576.             }
  578.             foreach ($data as $element) {
  579.                 if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  580.                     foreach ($element['data'] as $metaData) {
  581.                         if ($metaData instanceof Element\Data\MarkerHotspotItem) {
  582.                             $metaData = get_object_vars($metaData);
  583.                         }
  585.                         if ($metaData['value'] instanceof Element\ElementInterface) {
  586.                             if (!array_key_exists($metaData['value']->getCacheTag(), $tags)) {
  587.                                 $tags = $metaData['value']->getCacheTags($tags);
  588.                             }
  589.                         }
  590.                     }
  591.                 }
  592.             }
  594.             return $tags;
  595.         };
  597.         $tags = $getMetaDataCacheTags($this->marker, $tags);
  598.         $tags = $getMetaDataCacheTags($this->hotspots, $tags);
  600.         return $tags;
  601.     }
  603.     /**
  604.      * @return array
  605.      */
  606.     public function resolveDependencies()
  607.     {
  608.         $dependencies = [];
  609.         $image = $this->getImage();
  611.         if ($image instanceof Asset\Image) {
  612.             $key = 'asset_' . $image->getId();
  614.             $dependencies[$key] = [
  615.                 'id' => $image->getId(),
  616.                 'type' => 'asset',
  617.             ];
  618.         }
  620.         $getMetaDataDependencies = function ($data, $dependencies) {
  621.             if (!is_array($data)) {
  622.                 return $dependencies;
  623.             }
  625.             foreach ($data as $element) {
  626.                 if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  627.                     foreach ($element['data'] as $metaData) {
  628.                         if ($metaData instanceof Element\Data\MarkerHotspotItem) {
  629.                             $metaData = get_object_vars($metaData);
  630.                         }
  632.                         if ($metaData['value'] instanceof Element\ElementInterface) {
  633.                             $dependencies[$metaData['type'] . '_' . $metaData['value']->getId()] = [
  634.                                 'id' => $metaData['value']->getId(),
  635.                                 'type' => $metaData['type'],
  636.                             ];
  637.                         }
  638.                     }
  639.                 }
  640.             }
  642.             return $dependencies;
  643.         };
  645.         $dependencies = $getMetaDataDependencies($this->marker, $dependencies);
  646.         $dependencies = $getMetaDataDependencies($this->hotspots, $dependencies);
  648.         return $dependencies;
  649.     }
  651.     /**
  652.      * @param float $cropHeight
  653.      *
  654.      * @return $this
  655.      */
  656.     public function setCropHeight($cropHeight)
  657.     {
  658.         $this->cropHeight = $cropHeight;
  660.         return $this;
  661.     }
  663.     /**
  664.      * @return float
  665.      */
  666.     public function getCropHeight()
  667.     {
  668.         return $this->cropHeight;
  669.     }
  671.     /**
  672.      * @param float $cropLeft
  673.      *
  674.      * @return $this
  675.      */
  676.     public function setCropLeft($cropLeft)
  677.     {
  678.         $this->cropLeft = $cropLeft;
  680.         return $this;
  681.     }
  683.     /**
  684.      * @return float
  685.      */
  686.     public function getCropLeft()
  687.     {
  688.         return $this->cropLeft;
  689.     }
  691.     /**
  692.      * @param bool $cropPercent
  693.      *
  694.      * @return $this
  695.      */
  696.     public function setCropPercent($cropPercent)
  697.     {
  698.         $this->cropPercent = $cropPercent;
  700.         return $this;
  701.     }
  703.     /**
  704.      * @return bool
  705.      */
  706.     public function getCropPercent()
  707.     {
  708.         return $this->cropPercent;
  709.     }
  711.     /**
  712.      * @param float $cropTop
  713.      *
  714.      * @return $this
  715.      */
  716.     public function setCropTop($cropTop)
  717.     {
  718.         $this->cropTop = $cropTop;
  720.         return $this;
  721.     }
  723.     /**
  724.      * @return float
  725.      */
  726.     public function getCropTop()
  727.     {
  728.         return $this->cropTop;
  729.     }
  731.     /**
  732.      * @param float $cropWidth
  733.      *
  734.      * @return $this
  735.      */
  736.     public function setCropWidth($cropWidth)
  737.     {
  738.         $this->cropWidth = $cropWidth;
  740.         return $this;
  741.     }
  743.     /**
  744.      * @return float
  745.      */
  746.     public function getCropWidth()
  747.     {
  748.         return $this->cropWidth;
  749.     }
  751.     /**
  752.      * @param array $hotspots
  753.      */
  754.     public function setHotspots($hotspots)
  755.     {
  756.         $this->hotspots = $hotspots;
  757.     }
  759.     /**
  760.      * @return array
  761.      */
  762.     public function getHotspots()
  763.     {
  764.         return $this->hotspots;
  765.     }
  767.     /**
  768.      * @param array $marker
  769.      */
  770.     public function setMarker($marker)
  771.     {
  772.         $this->marker = $marker;
  773.     }
  775.     /**
  776.      * @return array
  777.      */
  778.     public function getMarker()
  779.     {
  780.         return $this->marker;
  781.     }
  783.     /**
  784.      * {@inheritdoc}
  785.      */
  786.     public function rewriteIds($idMapping) /** : void */
  787.     {
  788.         if (array_key_exists('asset', $idMapping) && array_key_exists($this->getId(), $idMapping['asset'])) {
  789.             $this->setId($idMapping['asset'][$this->getId()]);
  791.             // reset marker & hotspot information
  792.             $this->setHotspots([]);
  793.             $this->setMarker([]);
  794.             $this->setCropPercent(false);
  795.             $this->setImage(null);
  796.         }
  797.     }
  799.     /**
  800.      * @return array
  801.      */
  802.     public function __sleep()
  803.     {
  804.         $finalVars = [];
  805.         $parentVars = parent::__sleep();
  807.         $blockedVars = ['image'];
  809.         foreach ($parentVars as $key) {
  810.             if (!in_array($key, $blockedVars)) {
  811.                 $finalVars[] = $key;
  812.             }
  813.         }
  815.         return $finalVars;
  816.     }
  817. }