vendor/friendsofsymfony/rest-bundle/Controller/Annotations/View.php line 22

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSRestBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.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 FOS\RestBundle\Controller\Annotations;
  14. use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
  16. /**
  17.  * View annotation class.
  18.  *
  19.  * @Annotation
  20.  * @Target({"METHOD","CLASS"})
  21.  */
  22. class View extends Template
  23. {
  24.     /**
  25.      * @var string
  26.      */
  27.     protected $templateVar;
  29.     /**
  30.      * @var int
  31.      */
  32.     protected $statusCode;
  34.     /**
  35.      * @var array
  36.      */
  37.     protected $serializerGroups;
  39.     /**
  40.      * @var bool
  41.      */
  42.     protected $populateDefaultVars = true;
  44.     /**
  45.      * @var bool
  46.      */
  47.     protected $serializerEnableMaxDepthChecks;
  49.     /**
  50.      * Sets the template var name to be used for templating formats.
  51.      *
  52.      * @param string $templateVar
  53.      */
  54.     public function setTemplateVar($templateVar)
  55.     {
  56.         $this->templateVar = $templateVar;
  57.     }
  59.     /**
  60.      * Returns the template var name to be used for templating formats.
  61.      *
  62.      * @return string
  63.      */
  64.     public function getTemplateVar()
  65.     {
  66.         return $this->templateVar;
  67.     }
  69.     /**
  70.      * @param int $statusCode
  71.      */
  72.     public function setStatusCode($statusCode)
  73.     {
  74.         $this->statusCode = $statusCode;
  75.     }
  77.     /**
  78.      * @return int
  79.      */
  80.     public function getStatusCode()
  81.     {
  82.         return $this->statusCode;
  83.     }
  85.     /**
  86.      * @param array $serializerGroups
  87.      */
  88.     public function setSerializerGroups($serializerGroups)
  89.     {
  90.         $this->serializerGroups = $serializerGroups;
  91.     }
  93.     /**
  94.      * @return array
  95.      */
  96.     public function getSerializerGroups()
  97.     {
  98.         return $this->serializerGroups;
  99.     }
  101.     /**
  102.      * @param bool $populateDefaultVars
  103.      */
  104.     public function setPopulateDefaultVars($populateDefaultVars)
  105.     {
  106.         $this->populateDefaultVars = (bool) $populateDefaultVars;
  107.     }
  109.     /**
  110.      * @return bool
  111.      */
  112.     public function isPopulateDefaultVars()
  113.     {
  114.         return $this->populateDefaultVars;
  115.     }
  117.     /**
  118.      * @param bool $serializerEnableMaxDepthChecks
  119.      */
  120.     public function setSerializerEnableMaxDepthChecks($serializerEnableMaxDepthChecks)
  121.     {
  122.         $this->serializerEnableMaxDepthChecks = $serializerEnableMaxDepthChecks;
  123.     }
  125.     /**
  126.      * @return bool
  127.      */
  128.     public function getSerializerEnableMaxDepthChecks()
  129.     {
  130.         return $this->serializerEnableMaxDepthChecks;
  131.     }
  132. }