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

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\ContentElement;
  12. use Contao\ContentModel;
  13. use Contao\Image\PictureConfiguration;
  14. use Contao\Input;
  15. use Contao\ModuleModel;
  16. use Contao\StringUtil;
  17. use Contao\System;
  18. use Contao\Validator;
  19. use MadeYourDay\RockSolidColumns\Element\ColumnsStart;
  20. use MadeYourDay\RockSolidCustomElements\Template\CustomTemplate;
  21. use MadeYourDay\RockSolidCustomElements\CustomElements;
  22. use Symfony\Component\HttpFoundation\Request;
  24. /**
  25.  * Custom content element and frontend module
  26.  *
  27.  * @author Martin Auswöger <martin@madeyourday.net>
  28.  */
  29. class CustomElement extends ContentElement
  30. {
  31.     /**
  32.      * @var string Template
  33.      */
  34.     protected $strTemplate = 'rsce_default';
  36.     /**
  37.      * Find the correct template and parse it
  38.      *
  39.      * @return string Parsed template
  40.      */
  41.     public function generate()
  42.     {
  43.         $this->strTemplate = $this->customTpl ?: $this->type;
  45.         // Return output for the backend if in BE mode
  46.         if (($output = $this->rsceGetBackendOutput()) !== null) {
  47.             return $output;
  48.         }
  50.         try {
  51.             return parent::generate();
  52.         }
  53.         catch (\Exception $exception) {
  55.             if (System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest(System::getContainer()->get('request_stack')->getCurrentRequest() ?? Request::create(''))) {
  57.                 $template = new CustomTemplate($this->strTemplate);
  58.                 $template->setData($this->Template->getData());
  59.                 $this->Template = $template;
  61.                 return $this->Template->parse();
  63.             }
  65.             throw $exception;
  66.         }
  67.     }
  69.     /**
  70.      * Generate backend output if TL_MODE is set to BE
  71.      *
  72.      * @return string|null Backend output or null
  73.      */
  74.     public function rsceGetBackendOutput()
  75.     {
  76.         if (!System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest(System::getContainer()->get('request_stack')->getCurrentRequest() ?? Request::create(''))) {
  77.             return null;
  78.         }
  80.         $config = CustomElements::getConfigByType($this->type) ?: array();
  82.         // Handle newsletter output the same way as the frontend
  83.         if (!empty($config['isNewsletter'])) {
  85.             if (Input::get('do') === 'newsletter') {
  86.                 return null;
  87.             }
  89.             foreach(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS) as $entry) {
  90.                 $method = $entry['class'] . '::' . $entry['function'];
  91.                 if (
  92.                     $entry['file'] === System::getContainer()->getParameter('kernel.project_dir') . '/system/modules/newsletter/classes/Newsletter.php'
  93.                     || $entry['file'] === System::getContainer()->getParameter('kernel.project_dir') . '/vendor/contao/newsletter-bundle/src/Resources/contao/classes/Newsletter.php'
  94.                     || $entry['file'] === System::getContainer()->getParameter('kernel.project_dir') . '/vendor/contao/newsletter-bundle/contao/classes/Newsletter.php'
  95.                     || $method === 'Contao\\Newsletter::send'
  96.                     || $method === 'tl_newsletter::listNewsletters'
  97.                 ) {
  98.                     return null;
  99.                 }
  100.             }
  102.         }
  104.         if (!empty($config['beTemplate'])) {
  106.             if (!isset($this->arrData['wildcard'])) {
  107.                 $label = CustomElements::getLabelTranslated($config['label']);
  108.                 $this->arrData['wildcard'] = '### ' . mb_strtoupper(is_array($label) ? $label[0] : $label) . ' ###';
  109.             }
  111.             if (!isset($this->arrData['title'])) {
  112.                 $this->arrData['title'] = $this->headline;
  113.             }
  115.             if (
  116.                 !isset($this->arrData['link'])
  117.                 && !isset($this->arrData['href'])
  118.                 && $this->objModel instanceof ModuleModel
  119.             ) {
  120.                 $this->arrData['link'] = $this->name;
  121.                 $this->arrData['href'] = StringUtil::specialcharsUrl(System::getContainer()->get('router')->generate('contao_backend', ['do' => 'themes', 'table' => 'tl_module', 'act' => 'edit', 'id' => $this->id]));
  122.             }
  124.             $this->strTemplate = $config['beTemplate'];
  126.             return null;
  127.         }
  129.         if (
  130.             in_array($this->type, $GLOBALS['TL_WRAPPERS']['start'])
  131.             || in_array($this->type, $GLOBALS['TL_WRAPPERS']['stop'])
  132.             || in_array($this->type, $GLOBALS['TL_WRAPPERS']['separator'])
  133.         ) {
  134.             return '';
  135.         }
  137.         return null;
  138.     }
  140.     /**
  141.      * Parse the json data and pass it to the template
  142.      *
  143.      * @return void
  144.      */
  145.     public function compile()
  146.     {
  147.         // Add an image
  148.         if ($this->addImage && trim($this->singleSRC)) {
  149.             $figure = System::getContainer()
  150.                 ->get('contao.image.studio')
  151.                 ->createFigureBuilder()
  152.                 ->from($this->singleSRC)
  153.                 ->setSize(StringUtil::deserialize($this->arrData['size'] ?? null) ?: null)
  154.                 ->enableLightbox((bool) ($this->arrData['fullsize'] ?? false))
  155.                 ->setLightboxSize(StringUtil::deserialize($this->arrData['lightboxSize'] ?? null) ?: null)
  156.                 ->setMetadata((new ContentModel())->setRow($this->arrData)->getOverwriteMetadata())
  157.                 ->buildIfResourceExists();
  159.             if ($figure) {
  160.                 $figure->applyLegacyTemplateData($this->Template, null, $this->arrData['floating'] ?? null);
  161.             }
  162.         }
  164.         $data = array();
  165.         if ($this->rsce_data && substr($this->rsce_data, 0, 1) === '{') {
  166.             $data = json_decode($this->rsce_data);
  167.         }
  169.         $data = $this->deserializeDataRecursive($data);
  171.         foreach ($data as $key => $value) {
  172.             $this->Template->$key = $value;
  173.         }
  175.         $self = $this;
  177.         $this->Template->getImageObject = function() use($self) {
  178.             return call_user_func_array(array($self, 'getImageObject'), func_get_args());
  179.         };
  180.         $this->Template->getColumnClassName = function() use($self) {
  181.             return call_user_func_array(array($self, 'getColumnClassName'), func_get_args());
  182.         };
  184.         $this->addFragmentControllerDefaults();
  185.     }
  187.     /**
  188.      * Deserialize all data recursively
  189.      *
  190.      * @param  array|object $data data array or object
  191.      * @return array|object       data passed in with deserialized values
  192.      */
  193.     protected function deserializeDataRecursive($data)
  194.     {
  195.         foreach ($data as $key => $value) {
  196.             if (is_string($value) && trim($value)) {
  197.                 if (is_object($data)) {
  198.                     $data->$key = StringUtil::deserialize($value);
  199.                 }
  200.                 else {
  201.                     $data[$key] = StringUtil::deserialize($value);
  202.                 }
  203.             }
  204.             else if (is_array($value) || is_object($value)) {
  205.                 if (is_object($data)) {
  206.                     $data->$key = $this->deserializeDataRecursive($value);
  207.                 }
  208.                 else {
  209.                     $data[$key] = $this->deserializeDataRecursive($value);
  210.                 }
  211.             }
  212.         }
  214.         if ($data instanceof \stdClass) {
  215.             $return = new class extends \stdClass{
  216.                 public function __get($name) {
  217.                     return null;
  218.                 }
  219.             };
  220.             foreach ($data as $key => $value) {
  221.                 $return->$key = $value;
  222.             }
  224.             $data = $return;
  225.         }
  227.         return $data;
  228.     }
  230.     /**
  231.      * Get an image object from id/uuid and an optional size configuration
  232.      *
  233.      * @param  int|string                        $id         ID, UUID string or binary
  234.      * @param  string|array|PictureConfiguration $size       [width, height, mode] optionally serialized or a config object
  235.      * @param  int                               $maxSize    Gets passed to addImageToTemplate as $intMaxWidth
  236.      * @param  string                            $lightboxId Gets passed to addImageToTemplate as $strLightboxId
  237.      * @param  array                             $item       Gets merged and passed to addImageToTemplate as $arrItem
  238.      * @return object                                        Image object (similar as addImageToTemplate)
  239.      */
  240.     public function getImageObject($id, $size = null, $deprecated = null, $lightboxId = null, $item = array())
  241.     {
  242.         if (!$id) {
  243.             return null;
  244.         }
  246.         $figure = System::getContainer()
  247.             ->get('contao.image.studio')
  248.             ->createFigureBuilder()
  249.             ->from($id)
  250.             ->setSize($size)
  251.             ->enableLightbox((bool) ($item['fullsize'] ?? false))
  252.             ->setLightboxGroupIdentifier($lightboxId)
  253.             ->setLightboxSize(StringUtil::deserialize($item['lightboxSize'] ?? null) ?: null)
  254.             ->setMetadata((new ContentModel())->setRow($item)->getOverwriteMetadata())
  255.             ->buildIfResourceExists();
  257.         if (null === $figure) {
  258.             return null;
  259.         }
  261.         return (object) array_merge($figure->getLegacyTemplateData(), ['figure' => $figure]);
  262.     }
  264.     /**
  265.      * Get the column class name for the specified index
  266.      *
  267.      * @param  int    $index Index of the column
  268.      * @return string        Class name(s)
  269.      */
  270.     public function getColumnClassName($index)
  271.     {
  272.         if (!class_exists(ColumnsStart::class)) {
  273.             return '';
  274.         }
  276.         $config = ColumnsStart::getColumnsConfiguration($this->arrData);
  278.         $classes = array('rs-column');
  279.         foreach ($config as $name => $media) {
  280.             $classes = array_merge($classes, $media[$index % count($media)]);
  281.             if ($index < count($media)) {
  282.                 $classes[] = '-' . $name . '-first-row';
  283.             }
  284.         }
  286.         return implode(' ', $classes);
  287.     }
  289.     private function addFragmentControllerDefaults()
  290.     {
  291.         $this->Template->template ??= $this->Template->getName();
  292.         $this->Template->as_editor_view ??= System::getContainer()->get('contao.routing.scope_matcher')->isBackendRequest(System::getContainer()->get('request_stack')->getCurrentRequest() ?? Request::create(''));
  293.         $this->Template->data ??= $this->objModel ? $this->objModel->row() : $this->arrData;
  294.         $this->Template->nested_fragments ??= [];
  295.         $this->Template->section ??= $this->strColumn;
  296.         $this->Template->properties ??= [];
  297.         $this->Template->element_html_id ??= $this->Template->cssID[0] ?? null;
  298.         $this->Template->element_css_classes ??= trim(($this->Template->cssID[1] ?? '') . ' ' . implode(' ', $this->objModel ? (array) $this->objModel->classes : []));
  300.         if (
  301.             (!\is_string($this->Template->headline) && $this->Template->headline !== null)
  302.             || (!\is_string($this->Template->hl) && $this->Template->hl !== null)
  303.         ) {
  304.             return;
  305.         }
  307.         // Legacy templates access the text using `$this->headline`, twig templates use `headline.text`
  308.         $this->Template->headline = new class($this->Template->headline, $this->Template->hl) implements \Stringable
  309.         {
  310.             public ?string $text;
  311.             public ?string $tag_name;
  313.             public function __construct(?string $text, ?string $tag_name)
  314.             {
  315.                 $this->text = $text;
  316.                 $this->tag_name = $tag_name;
  317.             }
  319.             public function __toString(): string
  320.             {
  321.                 return $this->text ?? '';
  322.             }
  324.             public function __invoke(): string
  325.             {
  326.                 return $this->text ?? '';
  327.             }
  328.         };
  330.         // The parent::generate() method overwrites the template headline with $this->headline
  331.         // so we need to set it to the same callable object here
  332.         $this->headline = $this->Template->getData()['headline'];
  333.     }
  334. }