vendor/netzmacht/contao-toolkit/src/Component/ContentElement/AbstractContentElement.php line 58

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Netzmacht\Contao\Toolkit\Component\ContentElement;
  7. use Contao\Database\Result;
  8. use Contao\Model;
  9. use Contao\Model\Collection;
  10. use InvalidArgumentException;
  11. use Netzmacht\Contao\Toolkit\Component\AbstractComponent;
  12. use Netzmacht\Contao\Toolkit\Routing\RequestScopeMatcher;
  13. use Symfony\Component\Templating\EngineInterface as TemplateEngine;
  15. use function defined;
  16. use function time;
  17. use function trigger_error;
  18. use function trim;
  20. use const BE_USER_LOGGED_IN;
  21. use const E_USER_DEPRECATED;
  23. /**
  24.  * @deprecated Since 3.5.0 and get removed in 4.0.0
  25.  *
  26.  * @psalm-suppress DeprecatedClass
  27.  * @psalm-suppress DeprecatedInterface
  28.  */
  29. abstract class AbstractContentElement extends AbstractComponent implements ContentElement
  30. {
  31.     /**
  32.      * State if the request is called in the preview mode.
  33.      *
  34.      * @var bool|null
  35.      */
  36.     private $isPreviewMode;
  38.     /**
  39.      * @param Model|Collection|Result  $model               Object model or result.
  40.      * @param TemplateEngine           $templateEngine      Template engine.
  41.      * @param string                   $column              Column.
  42.      * @param RequestScopeMatcher|null $requestScopeMatcher Request scope matcher.
  43.      * @param bool|null                $isPreviewMode       State if the request is called in the preview mode.
  44.      *
  45.      * @throws InvalidArgumentException When model does not have a row method.
  46.      */
  47.     public function __construct(
  48.         $model,
  49.         TemplateEngine $templateEngine,
  50.         $column = 'main',
  51.         ?RequestScopeMatcher $requestScopeMatcher = null,
  52.         ?bool $isPreviewMode = null
  53.     ) {
  54.         parent::__construct($model, $templateEngine, $column, $requestScopeMatcher);
  56.         if ($isPreviewMode === null) {
  57.             // @codingStandardsIgnoreStart
  58.             @trigger_error(
  59.                 'isPreviewMode not passed as fifth argument. isPreviewMode will be required in version 4.0.0',
  60.                 E_USER_DEPRECATED
  61.             );
  62.             // @codingStandardsIgnoreEnd
  64.             $isPreviewMode = defined('BE_USER_LOGGED_IN') && BE_USER_LOGGED_IN;
  65.         }
  67.         $this->isPreviewMode = $isPreviewMode;
  68.     }
  70.     /** @psalm-suppress DeprecatedClass */
  71.     public function generate(): string
  72.     {
  73.         if (! $this->isVisible()) {
  74.             return '';
  75.         }
  77.         return parent::generate();
  78.     }
  80.     /**
  81.      * Check if content element is visible.
  82.      */
  83.     protected function isVisible(): bool
  84.     {
  85.         if ($this->isPreviewMode || ! $this->isFrontendRequest()) {
  86.             return true;
  87.         }
  89.         if ($this->get('invisible')) {
  90.             return false;
  91.         }
  93.         $now   = time();
  94.         $start = $this->get('start');
  95.         $stop  = $this->get('stop');
  97.         // phpcs:disable SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedEqualOperator
  98.         return ($start == '' || $start <= $now) && ($stop == '' || $stop >= $now);
  99.         // phpcs:enable SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedEqualOperator
  100.     }
  102.     /** @psalm-suppress DeprecatedClass */
  103.     protected function compileCssClass(): string
  104.     {
  105.         return trim('ce_' . $this->get('type') . ' ' . parent::compileCssClass());
  106.     }
  107. }