vendor/sensio/framework-extra-bundle/src/Configuration/Template.php line 21

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Sensio\Bundle\FrameworkExtraBundle\Configuration;
  14. /**
  15.  * The Template class handles the Template annotation parts.
  16.  *
  17.  * @author Fabien Potencier <fabien@symfony.com>
  18.  * @Annotation
  19.  */
  20. #[\Attribute(\Attribute::TARGET_METHOD)]
  21. class Template extends ConfigurationAnnotation
  22. {
  23.     /**
  24.      * The template.
  25.      *
  26.      * @var string
  27.      */
  28.     protected $template;
  30.     /**
  31.      * The associative array of template variables.
  32.      *
  33.      * @var array
  34.      */
  35.     private $vars = [];
  37.     /**
  38.      * Should the template be streamed?
  39.      *
  40.      * @var bool
  41.      */
  42.     private $streamable = false;
  44.     /**
  45.      * The controller (+action) this annotation is set to.
  46.      *
  47.      * @var array
  48.      */
  49.     private $owner = [];
  51.     /**
  52.      * @param array|string $data
  53.      */
  54.     public function __construct(
  55.         $data = [],
  56.         array $vars = [],
  57.         bool $isStreamable = false,
  58.         array $owner = []
  59.     ) {
  60.         $values = [];
  61.         if (\is_string($data)) {
  62.             $values['template'] = $data;
  63.         } else {
  64.             $values = $data;
  65.         }
  67.         $values['isStreamable'] = $values['isStreamable'] ?? $isStreamable;
  68.         $values['vars'] = $values['vars'] ?? $vars;
  69.         $values['owner'] = $values['owner'] ?? $owner;
  71.         parent::__construct($values);
  72.     }
  74.     /**
  75.      * Returns the array of templates variables.
  76.      *
  77.      * @return array
  78.      */
  79.     public function getVars()
  80.     {
  81.         return $this->vars;
  82.     }
  84.     /**
  85.      * @param bool $streamable
  86.      */
  87.     public function setIsStreamable($streamable)
  88.     {
  89.         $this->streamable = $streamable;
  90.     }
  92.     /**
  93.      * @return bool
  94.      */
  95.     public function isStreamable()
  96.     {
  97.         return (bool) $this->streamable;
  98.     }
  100.     /**
  101.      * Sets the template variables.
  102.      *
  103.      * @param array $vars The template variables
  104.      */
  105.     public function setVars($vars)
  106.     {
  107.         $this->vars = $vars;
  108.     }
  110.     /**
  111.      * Sets the template logic name.
  112.      *
  113.      * @param string $template The template logic name
  114.      */
  115.     public function setValue($template)
  116.     {
  117.         $this->setTemplate($template);
  118.     }
  120.     /**
  121.      * Returns the template.
  122.      *
  123.      * @return string
  124.      */
  125.     public function getTemplate()
  126.     {
  127.         return $this->template;
  128.     }
  130.     /**
  131.      * Sets the template.
  132.      *
  133.      * @param string $template The template
  134.      */
  135.     public function setTemplate($template)
  136.     {
  137.         $this->template = $template;
  138.     }
  140.     /**
  141.      * Returns the annotation alias name.
  142.      *
  143.      * @return string
  144.      *
  145.      * @see ConfigurationInterface
  146.      */
  147.     public function getAliasName()
  148.     {
  149.         return 'template';
  150.     }
  152.     /**
  153.      * Only one template directive is allowed.
  154.      *
  155.      * @return bool
  156.      *
  157.      * @see ConfigurationInterface
  158.      */
  159.     public function allowArray()
  160.     {
  161.         return false;
  162.     }
  164.     public function setOwner(array $owner)
  165.     {
  166.         $this->owner = $owner;
  167.     }
  169.     /**
  170.      * The controller (+action) this annotation is attached to.
  171.      *
  172.      * @return array
  173.      */
  174.     public function getOwner()
  175.     {
  176.         return $this->owner;
  177.     }
  178. }