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

Open in your IDE?
  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. class Template extends ConfigurationAnnotation
  21. {
  22.     /**
  23.      * The template.
  24.      *
  25.      * @var string
  26.      */
  27.     protected $template;
  29.     /**
  30.      * The associative array of template variables.
  31.      *
  32.      * @var array
  33.      */
  34.     private $vars = [];
  36.     /**
  37.      * Should the template be streamed?
  38.      *
  39.      * @var bool
  40.      */
  41.     private $streamable = false;
  43.     /**
  44.      * The controller (+action) this annotation is set to.
  45.      *
  46.      * @var array
  47.      */
  48.     private $owner = [];
  50.     /**
  51.      * Returns the array of templates variables.
  52.      *
  53.      * @return array
  54.      */
  55.     public function getVars()
  56.     {
  57.         return $this->vars;
  58.     }
  60.     /**
  61.      * @param bool $streamable
  62.      */
  63.     public function setIsStreamable($streamable)
  64.     {
  65.         $this->streamable = $streamable;
  66.     }
  68.     /**
  69.      * @return bool
  70.      */
  71.     public function isStreamable()
  72.     {
  73.         return (bool) $this->streamable;
  74.     }
  76.     /**
  77.      * Sets the template variables.
  78.      *
  79.      * @param array $vars The template variables
  80.      */
  81.     public function setVars($vars)
  82.     {
  83.         $this->vars = $vars;
  84.     }
  86.     /**
  87.      * Sets the template logic name.
  88.      *
  89.      * @param string $template The template logic name
  90.      */
  91.     public function setValue($template)
  92.     {
  93.         $this->setTemplate($template);
  94.     }
  96.     /**
  97.      * Returns the template.
  98.      *
  99.      * @return string
  100.      */
  101.     public function getTemplate()
  102.     {
  103.         return $this->template;
  104.     }
  106.     /**
  107.      * Sets the template.
  108.      *
  109.      * @param string $template The template
  110.      */
  111.     public function setTemplate($template)
  112.     {
  113.         $this->template = $template;
  114.     }
  116.     /**
  117.      * Returns the annotation alias name.
  118.      *
  119.      * @return string
  120.      *
  121.      * @see ConfigurationInterface
  122.      */
  123.     public function getAliasName()
  124.     {
  125.         return 'template';
  126.     }
  128.     /**
  129.      * Only one template directive is allowed.
  130.      *
  131.      * @return bool
  132.      *
  133.      * @see ConfigurationInterface
  134.      */
  135.     public function allowArray()
  136.     {
  137.         return false;
  138.     }
  140.     public function setOwner(array $owner)
  141.     {
  142.         $this->owner = $owner;
  143.     }
  145.     /**
  146.      * The controller (+action) this annotation is attached to.
  147.      *
  148.      * @return array
  149.      */
  150.     public function getOwner()
  151.     {
  152.         return $this->owner;
  153.     }
  154. }