vendor/madeyourday/contao-rocksolid-custom-elements/src/Element/CustomElement.php line 163

Open in your IDE?
  1. <?php
  2. /*
  3.  * Copyright MADE/YOUR/DAY OG <mail@madeyourday.net>
  4.  *
  5.  * For the full copyright and license information, please view the LICENSE
  6.  * file that was distributed with this source code.
  7.  */
  9. namespace MadeYourDay\RockSolidCustomElements\Element;
  11. use Contao\Image\PictureConfiguration;
  12. use Contao\Image\PictureConfigurationInterface;
  13. use Contao\ModuleModel;
  14. use MadeYourDay\RockSolidColumns\Element\ColumnsStart;
  15. use MadeYourDay\RockSolidCustomElements\Template\CustomTemplate;
  16. use MadeYourDay\RockSolidCustomElements\CustomElements;
  18. /**
  19.  * Custom content element and frontend module
  20.  *
  21.  * @author Martin Auswöger <martin@madeyourday.net>
  22.  */
  23. class CustomElement extends \ContentElement
  24. {
  25.     /**
  26.      * @var string Template
  27.      */
  28.     protected $strTemplate = 'rsce_default';
  30.     /**
  31.      * Find the correct template and parse it
  32.      *
  33.      * @return string Parsed template
  34.      */
  35.     public function generate()
  36.     {
  37.         $this->strTemplate = $this->customTpl ?: $this->type;
  39.         // Return output for the backend if in BE mode
  40.         if (($output = $this->rsceGetBackendOutput()) !== null) {
  41.             return $output;
  42.         }
  44.         try {
  45.             return parent::generate();
  46.         }
  47.         catch (\Exception $exception) {
  49.             if (TL_MODE === 'BE') {
  51.                 $template = new CustomTemplate($this->strTemplate);
  52.                 $template->setData($this->Template->getData());
  53.                 $this->Template = $template;
  55.                 return $this->Template->parse();
  57.             }
  59.             throw $exception;
  60.         }
  61.     }
  63.     /**
  64.      * Generate backend output if TL_MODE is set to BE
  65.      *
  66.      * @return string|null Backend output or null
  67.      */
  68.     public function rsceGetBackendOutput()
  69.     {
  70.         if (TL_MODE !== 'BE') {
  71.             return null;
  72.         }
  74.         $config = CustomElements::getConfigByType($this->type) ?: array();
  76.         // Handle newsletter output the same way as the frontend
  77.         if (!empty($config['isNewsletter'])) {
  79.             if (\Input::get('do') === 'newsletter') {
  80.                 return null;
  81.             }
  83.             foreach(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS) as $entry) {
  84.                 $method = $entry['class'] . '::' . $entry['function'];
  85.                 if (
  86.                     $entry['file'] === TL_ROOT . '/system/modules/newsletter/classes/Newsletter.php'
  87.                     || $entry['file'] === TL_ROOT . '/vendor/contao/newsletter-bundle/src/Resources/contao/classes/Newsletter.php'
  88.                     || $method === 'Contao\\Newsletter::send'
  89.                     || $method === 'tl_newsletter::listNewsletters'
  90.                 ) {
  91.                     return null;
  92.                 }
  93.             }
  95.         }
  97.         if (!empty($config['beTemplate'])) {
  99.             if (!isset($this->arrData['wildcard'])) {
  100.                 $label = CustomElements::getLabelTranslated($config['label']);
  101.                 $this->arrData['wildcard'] = '### ' . mb_strtoupper(is_array($label) ? $label[0] : $label) . ' ###';
  102.             }
  104.             if (!isset($this->arrData['title'])) {
  105.                 $this->arrData['title'] = $this->headline;
  106.             }
  108.             if (
  109.                 !isset($this->arrData['link'])
  110.                 && !isset($this->arrData['href'])
  111.                 && $this->objModel instanceof ModuleModel
  112.             ) {
  113.                 $this->arrData['link'] = $this->name;
  114.                 $this->arrData['href'] = 'contao/main.php?do=themes&amp;table=tl_module&amp;act=edit&amp;id=' . $this->id;
  115.             }
  117.             $this->strTemplate = $config['beTemplate'];
  119.             return null;
  120.         }
  122.         if (
  123.             in_array($this->type, $GLOBALS['TL_WRAPPERS']['start'])
  124.             || in_array($this->type, $GLOBALS['TL_WRAPPERS']['stop'])
  125.             || in_array($this->type, $GLOBALS['TL_WRAPPERS']['separator'])
  126.         ) {
  127.             return '';
  128.         }
  130.         return null;
  131.     }
  133.     /**
  134.      * Parse the json data and pass it to the template
  135.      *
  136.      * @return void
  137.      */
  138.     public function compile()
  139.     {
  140.         // Add an image
  141.         if ($this->addImage && trim($this->singleSRC)) {
  142.             $fileModel = \FilesModel::findByUuid($this->singleSRC);
  143.             if ($fileModel !== null && is_file(TL_ROOT . '/' . $fileModel->path)) {
  144.                 $this->singleSRC = $fileModel->path;
  145.                 $this->addImageToTemplate($this->Template, $this->arrData, null, null, $fileModel);
  146.             }
  147.         }
  149.         $data = array();
  150.         if ($this->rsce_data && substr($this->rsce_data, 0, 1) === '{') {
  151.             $data = json_decode($this->rsce_data);
  152.         }
  154.         $data = $this->deserializeDataRecursive($data);
  156.         foreach ($data as $key => $value) {
  157.             $this->Template->$key = $value;
  158.         }
  160.         $self = $this;
  162.         $this->Template->getImageObject = function() use($self) {
  163.             return call_user_func_array(array($self, 'getImageObject'), func_get_args());
  164.         };
  165.         $this->Template->getColumnClassName = function() use($self) {
  166.             return call_user_func_array(array($self, 'getColumnClassName'), func_get_args());
  167.         };
  168.     }
  170.     /**
  171.      * Deserialize all data recursively
  172.      *
  173.      * @param  array|object $data data array or object
  174.      * @return array|object       data passed in with deserialized values
  175.      */
  176.     protected function deserializeDataRecursive($data)
  177.     {
  178.         foreach ($data as $key => $value) {
  179.             if (is_string($value) && trim($value)) {
  180.                 if (is_object($data)) {
  181.                     $data->$key = \StringUtil::deserialize($value);
  182.                 }
  183.                 else {
  184.                     $data[$key] = \StringUtil::deserialize($value);
  185.                 }
  186.             }
  187.             else if (is_array($value) || is_object($value)) {
  188.                 if (is_object($data)) {
  189.                     $data->$key = $this->deserializeDataRecursive($value);
  190.                 }
  191.                 else {
  192.                     $data[$key] = $this->deserializeDataRecursive($value);
  193.                 }
  194.             }
  195.         }
  197.         if ($data instanceof \stdClass) {
  198.             $return = new class extends \stdClass{
  199.                 public function __get($name) {
  200.                     return null;
  201.                 }
  202.             };
  203.             foreach ($data as $key => $value) {
  204.                 $return->$key = $value;
  205.             }
  207.             $data = $return;
  208.         }
  210.         return $data;
  211.     }
  213.     /**
  214.      * Get an image object from id/uuid and an optional size configuration
  215.      *
  216.      * @param  int|string                        $id         ID, UUID string or binary
  217.      * @param  string|array|PictureConfiguration $size       [width, height, mode] optionally serialized or a config object
  218.      * @param  int                               $maxSize    Gets passed to addImageToTemplate as $intMaxWidth
  219.      * @param  string                            $lightboxId Gets passed to addImageToTemplate as $strLightboxId
  220.      * @param  array                             $item       Gets merged and passed to addImageToTemplate as $arrItem
  221.      * @return object                                        Image object (similar as addImageToTemplate)
  222.      */
  223.     public function getImageObject($id, $size = null, $maxSize = null, $lightboxId = null, $item = array())
  224.     {
  225.         if (!$id) {
  226.             return null;
  227.         }
  229.         if (\Validator::isUuid($id)) {
  230.             $image = \FilesModel::findByUuid($id);
  231.         }
  232.         elseif (is_numeric($id)) {
  233.             $image = \FilesModel::findByPk($id);
  234.         }
  235.         else {
  236.             $image = \FilesModel::findByPath($id);
  237.         }
  238.         if (!$image) {
  239.             return null;
  240.         }
  242.         try {
  243.             $file = new \File($image->path, true);
  244.             if (!$file->exists()) {
  245.                 return null;
  246.             }
  247.         }
  248.         catch (\Exception $e) {
  249.             return null;
  250.         }
  252.         if (!$size instanceof PictureConfiguration && !$size instanceof PictureConfigurationInterface) {
  253.             if (is_string($size) && trim($size)) {
  254.                 $size = \StringUtil::deserialize($size);
  255.             }
  256.             if (!is_array($size)) {
  257.                 $size = array();
  258.             }
  259.             $size[0] = isset($size[0]) ? $size[0] : 0;
  260.             $size[1] = isset($size[1]) ? $size[1] : 0;
  261.             $size[2] = isset($size[2]) ? $size[2] : 'crop';
  262.         }
  264.         $imageItem = array(
  265.             'id' => $image->id,
  266.             'uuid' => isset($image->uuid) ? $image->uuid : null,
  267.             'name' => $file->basename,
  268.             'singleSRC' => $image->path,
  269.             'size' => $size,
  270.         );
  272.         $imageItem = array_merge($imageItem, $item);
  274.         $imageObject = new \FrontendTemplate('rsce_image_object');
  275.         $this->addImageToTemplate($imageObject, $imageItem, $maxSize, $lightboxId, $image);
  276.         $imageObject = (object)$imageObject->getData();
  278.         if (empty($imageObject->src)) {
  279.             $imageObject->src = $imageObject->singleSRC;
  280.         }
  282.         $imageObject->id = $image->id;
  283.         $imageObject->uuid = isset($image->uuid) ? \StringUtil::binToUuid($image->uuid) : null;
  285.         return $imageObject;
  286.     }
  288.     /**
  289.      * Get the column class name for the specified index
  290.      *
  291.      * @param  int    $index Index of the column
  292.      * @return string        Class name(s)
  293.      */
  294.     public function getColumnClassName($index)
  295.     {
  296.         if (!class_exists(ColumnsStart::class)) {
  297.             return '';
  298.         }
  300.         $config = ColumnsStart::getColumnsConfiguration($this->arrData);
  302.         $classes = array('rs-column');
  303.         foreach ($config as $name => $media) {
  304.             $classes = array_merge($classes, $media[$index % count($media)]);
  305.             if ($index < count($media)) {
  306.                 $classes[] = '-' . $name . '-first-row';
  307.             }
  308.         }
  310.         return implode(' ', $classes);
  311.     }
  312. }