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

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\Tool\Serialize;
  23. /**
  24.  * @method \Pimcore\Model\Document\Editable\Dao getDao()
  25.  */
  26. class Image extends Model\Document\Editable implements IdRewriterInterface, EditmodeDataInterface
  27. {
  28.     /**
  29.      * ID of the referenced image
  30.      *
  31.      * @internal
  32.      *
  33.      * @var int
  34.      */
  35.     protected $id;
  37.     /**
  38.      * The ALT text of the image
  39.      *
  40.      * @internal
  41.      *
  42.      * @var string
  43.      */
  44.     protected $alt;
  46.     /**
  47.      * Contains the imageobject itself
  48.      *
  49.      * @internal
  50.      *
  51.      * @var Asset\Image|null
  52.      */
  53.     protected $image;
  55.     /**
  56.      * @internal
  57.      *
  58.      * @var bool
  59.      */
  60.     protected $cropPercent = false;
  62.     /**
  63.      * @internal
  64.      *
  65.      * @var float
  66.      */
  67.     protected $cropWidth;
  69.     /**
  70.      * @internal
  71.      *
  72.      * @var float
  73.      */
  74.     protected $cropHeight;
  76.     /**
  77.      * @internal
  78.      *
  79.      * @var float
  80.      */
  81.     protected $cropTop;
  83.     /**
  84.      * @internal
  85.      *
  86.      * @var float
  87.      */
  88.     protected $cropLeft;
  90.     /**
  91.      * @internal
  92.      *
  93.      * @var array
  94.      */
  95.     protected $hotspots = [];
  97.     /**
  98.      * @internal
  99.      *
  100.      * @var array
  101.      */
  102.     protected $marker = [];
  104.     /**
  105.      * The Thumbnail config of the image
  106.      *
  107.      * @internal
  108.      *
  109.      * @var string
  110.      */
  111.     protected $thumbnail;
  113.     /**
  114.      * {@inheritdoc}
  115.      */
  116.     public function getType()
  117.     {
  118.         return 'image';
  119.     }
  121.     /**
  122.      * {@inheritdoc}
  123.      */
  124.     public function getData()
  125.     {
  126.         return [
  127.             'id' => $this->id,
  128.             'alt' => $this->alt,
  129.             'cropPercent' => $this->cropPercent,
  130.             'cropWidth' => $this->cropWidth,
  131.             'cropHeight' => $this->cropHeight,
  132.             'cropTop' => $this->cropTop,
  133.             'cropLeft' => $this->cropLeft,
  134.             'hotspots' => $this->hotspots,
  135.             'marker' => $this->marker,
  136.             'thumbnail' => $this->thumbnail,
  137.         ];
  138.     }
  140.     /**
  141.      * {@inheritdoc}
  142.      */
  143.     public function getDataForResource()
  144.     {
  145.         return [
  146.             'id' => $this->id,
  147.             'alt' => $this->alt,
  148.             'cropPercent' => $this->cropPercent,
  149.             'cropWidth' => $this->cropWidth,
  150.             'cropHeight' => $this->cropHeight,
  151.             'cropTop' => $this->cropTop,
  152.             'cropLeft' => $this->cropLeft,
  153.             'hotspots' => $this->hotspots,
  154.             'marker' => $this->marker,
  155.             'thumbnail' => $this->thumbnail,
  156.         ];
  157.     }
  159.     /**
  160.      * {@inheritdoc}
  161.      */
  162.     public function getDataEditmode() /** : mixed */
  163.     {
  164.         $image = $this->getImage();
  166.         if ($image instanceof Asset\Image) {
  167.             $rewritePath = function ($data) {
  168.                 if (!is_array($data)) {
  169.                     return [];
  170.                 }
  172.                 foreach ($data as &$element) {
  173.                     if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  174.                         foreach ($element['data'] as &$metaData) {
  175.                             if ($metaData instanceof Element\Data\MarkerHotspotItem) {
  176.                                 $metaData = get_object_vars($metaData);
  177.                             }
  179.                             if (in_array($metaData['type'], ['object', 'asset', 'document'])
  180.                             && $el = Element\Service::getElementById($metaData['type'], $metaData['value'])) {
  181.                                 $metaData['value'] = $el;
  182.                             }
  184.                             if ($metaData['value'] instanceof Element\ElementInterface) {
  185.                                 $metaData['value'] = $metaData['value']->getRealFullPath();
  186.                             }
  187.                         }
  188.                     }
  189.                 }
  191.                 return $data;
  192.             };
  194.             $marker = $rewritePath($this->marker);
  195.             $hotspots = $rewritePath($this->hotspots);
  197.             return [
  198.                 'id' => $this->id,
  199.                 'path' => $image->getRealFullPath(),
  200.                 'alt' => $this->alt,
  201.                 'cropPercent' => $this->cropPercent,
  202.                 'cropWidth' => $this->cropWidth,
  203.                 'cropHeight' => $this->cropHeight,
  204.                 'cropTop' => $this->cropTop,
  205.                 'cropLeft' => $this->cropLeft,
  206.                 'hotspots' => $hotspots,
  207.                 'marker' => $marker,
  208.                 'thumbnail' => $this->thumbnail,
  209.                 'predefinedDataTemplates' => $this->getConfig()['predefinedDataTemplates'] ?? null,
  210.             ];
  211.         }
  213.         return null;
  214.     }
  216.     /**
  217.      * {@inheritdoc}
  218.      */
  219.     public function getConfig()
  220.     {
  221.         $config = parent::getConfig();
  222.         if (isset($config['thumbnail']) && !isset($config['focal_point_context_menu_item'])) {
  223.             $thumbConfig = Asset\Image\Thumbnail\Config::getByAutoDetect($config['thumbnail']);
  224.             if ($thumbConfig) {
  225.                 foreach ($thumbConfig->getItems() as $item) {
  226.                     if ($item['method'] == 'cover') {
  227.                         $config['focal_point_context_menu_item'] = true;
  228.                         $this->config['focal_point_context_menu_item'] = true;
  230.                         break;
  231.                     }
  232.                 }
  233.             }
  234.         }
  236.         return $config;
  237.     }
  239.     /**
  240.      * {@inheritdoc}
  241.      */
  242.     public function frontend()
  243.     {
  244.         if (!is_array($this->config)) {
  245.             $this->config = [];
  246.         }
  248.         $image = $this->getImage();
  250.         if ($image instanceof Asset) {
  251.             $thumbnailName = $this->config['thumbnail'] ?? null;
  252.             if ($thumbnailName || $this->cropPercent) {
  253.                 // create a thumbnail first
  254.                 $autoName = false;
  256.                 $thumbConfig = $image->getThumbnailConfig($thumbnailName);
  257.                 if (!$thumbConfig && $this->cropPercent) {
  258.                     $thumbConfig = new Asset\Image\Thumbnail\Config();
  259.                 }
  261.                 if ($this->cropPercent) {
  262.                     $this->applyCustomCropping($thumbConfig);
  263.                     $autoName = true;
  264.                 }
  266.                 if (isset($this->config['highResolution']) && $this->config['highResolution'] > 1) {
  267.                     $thumbConfig->setHighResolution($this->config['highResolution']);
  268.                 }
  270.                 // autogenerate a name for the thumbnail because it's different from the original
  271.                 if ($autoName) {
  272.                     $hash = md5(Serialize::serialize($thumbConfig->getItems()));
  273.                     $thumbConfig->setName($thumbConfig->getName() . '_auto_' . $hash);
  274.                 }
  276.                 $deferred = true;
  277.                 if (isset($this->config['deferred'])) {
  278.                     $deferred = $this->config['deferred'];
  279.                 }
  281.                 $thumbnail = $image->getThumbnail($thumbConfig, $deferred);
  282.             } else {
  283.                 // we're using the thumbnail class only to generate the HTML
  284.                 $thumbnail = $image->getThumbnail();
  285.             }
  287.             $attributes = array_merge($this->config, [
  288.                 'alt' => $this->alt,
  289.                 'title' => $this->alt,
  290.             ]);
  292.             $removeAttributes = [];
  293.             if (isset($this->config['removeAttributes']) && is_array($this->config['removeAttributes'])) {
  294.                 $removeAttributes = $this->config['removeAttributes'];
  295.             }
  297.             // thumbnail's HTML is always generated by the thumbnail itself
  298.             return $thumbnail->getHtml($attributes);
  299.         }
  301.         return '';
  302.     }
  304.     /**
  305.      * {@inheritdoc}
  306.      */
  307.     public function setDataFromResource($data)
  308.     {
  309.         if (strlen($data) > 2) {
  310.             $data = Serialize::unserialize($data);
  311.         }
  313.         $rewritePath = function ($data) {
  314.             if (!is_array($data)) {
  315.                 return [];
  316.             }
  318.             foreach ($data as &$element) {
  319.                 if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  320.                     foreach ($element['data'] as &$metaData) {
  321.                         // this is for backward compatibility (Array vs. MarkerHotspotItem)
  322.                         if (is_array($metaData)) {
  323.                             $metaData = new Element\Data\MarkerHotspotItem($metaData);
  324.                         }
  325.                     }
  326.                 }
  327.             }
  329.             return $data;
  330.         };
  332.         if (array_key_exists('marker', $data) && is_array($data['marker']) && count($data['marker']) > 0) {
  333.             $data['marker'] = $rewritePath($data['marker']);
  334.         }
  336.         if (array_key_exists('hotspots', $data) && is_array($data['hotspots']) && count($data['hotspots']) > 0) {
  337.             $data['hotspots'] = $rewritePath($data['hotspots']);
  338.         }
  340.         $this->id = $data['id'] ?? null;
  341.         $this->alt = $data['alt'] ?? null;
  342.         $this->cropPercent = $data['cropPercent'] ?? null;
  343.         $this->cropWidth = $data['cropWidth'] ?? null;
  344.         $this->cropHeight = $data['cropHeight'] ?? null;
  345.         $this->cropTop = $data['cropTop'] ?? null;
  346.         $this->cropLeft = $data['cropLeft'] ?? null;
  347.         $this->marker = $data['marker'] ?? null;
  348.         $this->hotspots = $data['hotspots'] ?? null;
  349.         $this->thumbnail = $data['thumbnail'] ?? null;
  351.         return $this;
  352.     }
  354.     /**
  355.      * {@inheritdoc}
  356.      */
  357.     public function setDataFromEditmode($data)
  358.     {
  359.         $rewritePath = function ($data) {
  360.             if (!is_array($data)) {
  361.                 return [];
  362.             }
  364.             foreach ($data as &$element) {
  365.                 if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  366.                     foreach ($element['data'] as &$metaData) {
  367.                         $metaData = new Element\Data\MarkerHotspotItem($metaData);
  368.                         if (in_array($metaData['type'], ['object', 'asset', 'document'])) {
  369.                             $el = Element\Service::getElementByPath($metaData['type'], $metaData->getValue());
  370.                             $metaData['value'] = $el;
  371.                         }
  372.                     }
  373.                 }
  374.             }
  376.             return $data;
  377.         };
  379.         if (is_array($data)) {
  380.             if (array_key_exists('marker', $data) && is_array($data['marker']) && count($data['marker']) > 0) {
  381.                 $data['marker'] = $rewritePath($data['marker']);
  382.             }
  384.             if (array_key_exists('hotspots', $data) && is_array($data['hotspots']) && count($data['hotspots']) > 0) {
  385.                 $data['hotspots'] = $rewritePath($data['hotspots']);
  386.             }
  388.             $this->id = $data['id'] ?? null;
  389.             $this->alt = $data['alt'] ?? null;
  390.             $this->cropPercent = $data['cropPercent'] ?? null;
  391.             $this->cropWidth = $data['cropWidth'] ?? null;
  392.             $this->cropHeight = $data['cropHeight'] ?? null;
  393.             $this->cropTop = $data['cropTop'] ?? null;
  394.             $this->cropLeft = $data['cropLeft'] ?? null;
  395.             $this->marker = $data['marker'] ?? null;
  396.             $this->hotspots = $data['hotspots'] ?? null;
  397.             $this->thumbnail = $data['thumbnail'] ?? null;
  398.         }
  400.         return $this;
  401.     }
  403.     /**
  404.      * @return string
  405.      */
  406.     public function getText()
  407.     {
  408.         return $this->alt;
  409.     }
  411.     /**
  412.      * @param string $text
  413.      */
  414.     public function setText($text)
  415.     {
  416.         $this->alt = $text;
  417.     }
  419.     /**
  420.      * @return string
  421.      */
  422.     public function getAlt()
  423.     {
  424.         return $this->getText();
  425.     }
  427.     /**
  428.      * @return string|null
  429.      */
  430.     public function getThumbnailConfig()
  431.     {
  432.         return $this->thumbnail;
  433.     }
  435.     /**
  436.      * @return string
  437.      */
  438.     public function getSrc()
  439.     {
  440.         $image = $this->getImage();
  441.         if ($image instanceof Asset) {
  442.             return $image->getFullPath();
  443.         }
  445.         return '';
  446.     }
  448.     /**
  449.      * @return Asset\Image|null
  450.      */
  451.     public function getImage()
  452.     {
  453.         if (!$this->image) {
  454.             $this->image = Asset\Image::getById($this->getId());
  455.         }
  457.         return $this->image;
  458.     }
  460.     /**
  461.      * @param Asset\Image|null $image
  462.      *
  463.      * @return Model\Document\Editable\Image
  464.      */
  465.     public function setImage($image)
  466.     {
  467.         $this->image = $image;
  469.         if ($image instanceof Asset) {
  470.             $this->setId($image->getId());
  471.         }
  473.         return $this;
  474.     }
  476.     /**
  477.      * @param int $id
  478.      *
  479.      * @return Model\Document\Editable\Image
  480.      */
  481.     public function setId($id)
  482.     {
  483.         $this->id = $id;
  485.         return $this;
  486.     }
  488.     /**
  489.      * @return int
  490.      */
  491.     public function getId()
  492.     {
  493.         return (int) $this->id;
  494.     }
  496.     /**
  497.      * @param string|array|Asset\Image\Thumbnail\Config $conf
  498.      * @param bool $deferred
  499.      *
  500.      * @return Asset\Image\Thumbnail|string
  501.      */
  502.     public function getThumbnail($conf, $deferred = true)
  503.     {
  504.         $image = $this->getImage();
  505.         if ($image instanceof Asset) {
  506.             $thumbConfig = $image->getThumbnailConfig($conf);
  507.             if ($thumbConfig && $this->cropPercent) {
  508.                 $this->applyCustomCropping($thumbConfig);
  509.                 $hash = md5(Serialize::serialize($thumbConfig->getItems()));
  510.                 $thumbConfig->setName($thumbConfig->getName() . '_auto_' . $hash);
  511.             }
  513.             return $image->getThumbnail($thumbConfig, $deferred);
  514.         }
  516.         return '';
  517.     }
  519.     /**
  520.      * @param Asset\Image\Thumbnail\Config $thumbConfig
  521.      */
  522.     private function applyCustomCropping($thumbConfig)
  523.     {
  524.         $cropConfig = [
  525.             'width' => $this->cropWidth,
  526.             'height' => $this->cropHeight,
  527.             'y' => $this->cropTop,
  528.             'x' => $this->cropLeft,
  529.         ];
  531.         $thumbConfig->addItemAt(0, 'cropPercent', $cropConfig);
  533.         // also crop media query specific configs
  534.         if ($thumbConfig->hasMedias()) {
  535.             foreach ($thumbConfig->getMedias() as $mediaName => $mediaItems) {
  536.                 $thumbConfig->addItemAt(0, 'cropPercent', $cropConfig, $mediaName);
  537.             }
  538.         }
  539.     }
  541.     /**
  542.      * {@inheritdoc}
  543.      */
  544.     public function isEmpty()
  545.     {
  546.         $image = $this->getImage();
  547.         if ($image instanceof Asset\Image) {
  548.             return false;
  549.         }
  551.         return true;
  552.     }
  554.     /**
  555.      * {@inheritdoc}
  556.      */
  557.     public function getCacheTags(Model\Document\PageSnippet $ownerDocument, array $tags = []): array
  558.     {
  559.         $image = $this->getImage();
  561.         if ($image instanceof Asset) {
  562.             if (!array_key_exists($image->getCacheTag(), $tags)) {
  563.                 $tags = $image->getCacheTags($tags);
  564.             }
  565.         }
  567.         $getMetaDataCacheTags = function ($data, $tags) {
  568.             if (!is_array($data)) {
  569.                 return $tags;
  570.             }
  572.             foreach ($data as $element) {
  573.                 if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  574.                     foreach ($element['data'] as $metaData) {
  575.                         if ($metaData instanceof Element\Data\MarkerHotspotItem) {
  576.                             $metaData = get_object_vars($metaData);
  577.                         }
  579.                         if ($metaData['value'] instanceof Element\ElementInterface) {
  580.                             if (!array_key_exists($metaData['value']->getCacheTag(), $tags)) {
  581.                                 $tags = $metaData['value']->getCacheTags($tags);
  582.                             }
  583.                         }
  584.                     }
  585.                 }
  586.             }
  588.             return $tags;
  589.         };
  591.         $tags = $getMetaDataCacheTags($this->marker, $tags);
  592.         $tags = $getMetaDataCacheTags($this->hotspots, $tags);
  594.         return $tags;
  595.     }
  597.     /**
  598.      * {@inheritdoc}
  599.      */
  600.     public function resolveDependencies()
  601.     {
  602.         $dependencies = [];
  603.         $image = $this->getImage();
  605.         if ($image instanceof Asset\Image) {
  606.             $key = 'asset_' . $image->getId();
  608.             $dependencies[$key] = [
  609.                 'id' => $image->getId(),
  610.                 'type' => 'asset',
  611.             ];
  612.         }
  614.         $getMetaDataDependencies = function ($data, $dependencies) {
  615.             if (!is_array($data)) {
  616.                 return $dependencies;
  617.             }
  619.             foreach ($data as $element) {
  620.                 if (array_key_exists('data', $element) && is_array($element['data']) && count($element['data']) > 0) {
  621.                     foreach ($element['data'] as $metaData) {
  622.                         if ($metaData instanceof Element\Data\MarkerHotspotItem) {
  623.                             $metaData = get_object_vars($metaData);
  624.                         }
  626.                         if ($metaData['value'] instanceof Element\ElementInterface) {
  627.                             $dependencies[$metaData['type'] . '_' . $metaData['value']->getId()] = [
  628.                                 'id' => $metaData['value']->getId(),
  629.                                 'type' => $metaData['type'],
  630.                             ];
  631.                         }
  632.                     }
  633.                 }
  634.             }
  636.             return $dependencies;
  637.         };
  639.         $dependencies = $getMetaDataDependencies($this->marker, $dependencies);
  640.         $dependencies = $getMetaDataDependencies($this->hotspots, $dependencies);
  642.         return $dependencies;
  643.     }
  645.     /**
  646.      * @param float $cropHeight
  647.      *
  648.      * @return $this
  649.      */
  650.     public function setCropHeight($cropHeight)
  651.     {
  652.         $this->cropHeight = $cropHeight;
  654.         return $this;
  655.     }
  657.     /**
  658.      * @return float
  659.      */
  660.     public function getCropHeight()
  661.     {
  662.         return $this->cropHeight;
  663.     }
  665.     /**
  666.      * @param float $cropLeft
  667.      *
  668.      * @return $this
  669.      */
  670.     public function setCropLeft($cropLeft)
  671.     {
  672.         $this->cropLeft = $cropLeft;
  674.         return $this;
  675.     }
  677.     /**
  678.      * @return float
  679.      */
  680.     public function getCropLeft()
  681.     {
  682.         return $this->cropLeft;
  683.     }
  685.     /**
  686.      * @param bool $cropPercent
  687.      *
  688.      * @return $this
  689.      */
  690.     public function setCropPercent($cropPercent)
  691.     {
  692.         $this->cropPercent = $cropPercent;
  694.         return $this;
  695.     }
  697.     /**
  698.      * @return bool
  699.      */
  700.     public function getCropPercent()
  701.     {
  702.         return $this->cropPercent;
  703.     }
  705.     /**
  706.      * @param float $cropTop
  707.      *
  708.      * @return $this
  709.      */
  710.     public function setCropTop($cropTop)
  711.     {
  712.         $this->cropTop = $cropTop;
  714.         return $this;
  715.     }
  717.     /**
  718.      * @return float
  719.      */
  720.     public function getCropTop()
  721.     {
  722.         return $this->cropTop;
  723.     }
  725.     /**
  726.      * @param float $cropWidth
  727.      *
  728.      * @return $this
  729.      */
  730.     public function setCropWidth($cropWidth)
  731.     {
  732.         $this->cropWidth = $cropWidth;
  734.         return $this;
  735.     }
  737.     /**
  738.      * @return float
  739.      */
  740.     public function getCropWidth()
  741.     {
  742.         return $this->cropWidth;
  743.     }
  745.     /**
  746.      * @param array $hotspots
  747.      */
  748.     public function setHotspots($hotspots)
  749.     {
  750.         $this->hotspots = $hotspots;
  751.     }
  753.     /**
  754.      * @return array
  755.      */
  756.     public function getHotspots()
  757.     {
  758.         return $this->hotspots;
  759.     }
  761.     /**
  762.      * @param array $marker
  763.      */
  764.     public function setMarker($marker)
  765.     {
  766.         $this->marker = $marker;
  767.     }
  769.     /**
  770.      * @return array
  771.      */
  772.     public function getMarker()
  773.     {
  774.         return $this->marker;
  775.     }
  777.     /**
  778.      * { @inheritdoc }
  779.      */
  780.     public function rewriteIds($idMapping) /** : void */
  781.     {
  782.         if (array_key_exists('asset', $idMapping) && array_key_exists($this->getId(), $idMapping['asset'])) {
  783.             $this->setId($idMapping['asset'][$this->getId()]);
  785.             // reset marker & hotspot information
  786.             $this->setHotspots([]);
  787.             $this->setMarker([]);
  788.             $this->setCropPercent(false);
  789.             $this->setImage(null);
  790.         }
  791.     }
  793.     public function __sleep()
  794.     {
  795.         $finalVars = [];
  796.         $parentVars = parent::__sleep();
  798.         $blockedVars = ['image'];
  800.         foreach ($parentVars as $key) {
  801.             if (!in_array($key, $blockedVars)) {
  802.                 $finalVars[] = $key;
  803.             }
  804.         }
  806.         return $finalVars;
  807.     }
  808. }