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.      * @deprecated since 2.8
  53.      *
  54.      * @param string $templateVar
  55.      */
  56.     public function setTemplateVar($templateVar)
  57.     {
  58.         if (1 === func_num_args() || func_get_arg(1)) {
  59.             @trigger_error(sprintf('The %s() method is deprecated since FOSRestBundle 2.8.', __METHOD__), E_USER_DEPRECATED);
  60.         }
  62.         $this->templateVar = $templateVar;
  63.     }
  65.     /**
  66.      * Returns the template var name to be used for templating formats.
  67.      *
  68.      * @deprecated since 2.8
  69.      *
  70.      * @return string
  71.      */
  72.     public function getTemplateVar()
  73.     {
  74.         if (0 === func_num_args() || func_get_arg(0)) {
  75.             @trigger_error(sprintf('The %s() method is deprecated since FOSRestBundle 2.8.', __METHOD__), E_USER_DEPRECATED);
  76.         }
  78.         return $this->templateVar;
  79.     }
  81.     /**
  82.      * @param int $statusCode
  83.      */
  84.     public function setStatusCode($statusCode)
  85.     {
  86.         $this->statusCode = $statusCode;
  87.     }
  89.     /**
  90.      * @return int
  91.      */
  92.     public function getStatusCode()
  93.     {
  94.         return $this->statusCode;
  95.     }
  97.     /**
  98.      * @param array $serializerGroups
  99.      */
  100.     public function setSerializerGroups($serializerGroups)
  101.     {
  102.         $this->serializerGroups = $serializerGroups;
  103.     }
  105.     /**
  106.      * @return array
  107.      */
  108.     public function getSerializerGroups()
  109.     {
  110.         return $this->serializerGroups;
  111.     }
  113.     /**
  114.      * @deprecated since 2.8
  115.      *
  116.      * @param bool $populateDefaultVars
  117.      */
  118.     public function setPopulateDefaultVars($populateDefaultVars)
  119.     {
  120.         if (1 === func_num_args() || func_get_arg(1)) {
  121.             @trigger_error(sprintf('The %s() method is deprecated since FOSRestBundle 2.8.', __METHOD__), E_USER_DEPRECATED);
  122.         }
  124.         $this->populateDefaultVars = (bool) $populateDefaultVars;
  125.     }
  127.     /**
  128.      * @deprecated since 2.8
  129.      *
  130.      * @return bool
  131.      */
  132.     public function isPopulateDefaultVars()
  133.     {
  134.         if (0 === func_num_args() || func_get_arg(0)) {
  135.             @trigger_error(sprintf('The %s() method is deprecated since FOSRestBundle 2.8.', __METHOD__), E_USER_DEPRECATED);
  136.         }
  138.         return $this->populateDefaultVars;
  139.     }
  141.     /**
  142.      * @param bool $serializerEnableMaxDepthChecks
  143.      */
  144.     public function setSerializerEnableMaxDepthChecks($serializerEnableMaxDepthChecks)
  145.     {
  146.         $this->serializerEnableMaxDepthChecks = $serializerEnableMaxDepthChecks;
  147.     }
  149.     /**
  150.      * @return bool
  151.      */
  152.     public function getSerializerEnableMaxDepthChecks()
  153.     {
  154.         return $this->serializerEnableMaxDepthChecks;
  155.     }
  156. }