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

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. if (class_exists(Template::class)) {
  17.     /**
  18.      * Compat class for applications where SensioFrameworkExtraBundle is installed, to be removed when compatibility with the bundle is no longer provided.
  19.      *
  20.      * @internal
  21.      */
  22.     abstract class CompatView extends Template
  23.     {
  24.     }
  25. } else {
  26.     /**
  27.      * Compat class for applications where SensioFrameworkExtraBundle is not installed.
  28.      *
  29.      * @internal
  30.      */
  31.     abstract class CompatView
  32.     {
  33.         /**
  34.          * The controller (+action) this annotation is set to.
  35.          *
  36.          * @var array
  37.          *
  38.          * @note This property is declared within this compat class to not conflict with the {@see Template::$owner}
  39.          *       property when SensioFrameworkExtraBundle is present.
  40.          */
  41.         protected $owner = [];
  43.         /**
  44.          * @note This method is declared within this compat class to not conflict with the {@see Template::setOwner}
  45.          *       method when SensioFrameworkExtraBundle is present.
  46.          */
  47.         public function setOwner(array $owner)
  48.         {
  49.             $this->owner = $owner;
  50.         }
  52.         /**
  53.          * The controller (+action) this annotation is attached to.
  54.          *
  55.          * @return array
  56.          *
  57.          * @note This method is declared within this compat class to not conflict with the {@see Template::getOwner}
  58.          *        method when SensioFrameworkExtraBundle is present.
  59.          */
  60.         public function getOwner()
  61.         {
  62.             return $this->owner;
  63.         }
  64.     }
  65. }
  67. /**
  68.  * View annotation class.
  69.  *
  70.  * @Annotation
  71.  * @Target({"METHOD","CLASS"})
  72.  */
  73. #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD)]
  74. class View extends CompatView
  75. {
  76.     /**
  77.      * @var int|null
  78.      */
  79.     protected $statusCode;
  81.     /**
  82.      * @var array
  83.      */
  84.     protected $serializerGroups;
  86.     /**
  87.      * @var bool
  88.      */
  89.     protected $serializerEnableMaxDepthChecks;
  91.     /**
  92.      * @param array|string $data
  93.      */
  94.     public function __construct(
  95.         $data = [],
  96.         array $vars = [],
  97.         bool $isStreamable = false,
  98.         array $owner = [],
  99.         ?int $statusCode = null,
  100.         array $serializerGroups = [],
  101.         bool $serializerEnableMaxDepthChecks = false
  102.     ) {
  103.         if ($this instanceof Template) {
  104.             trigger_deprecation('friendsofsymfony/rest-bundle', '3.7', 'Extending from "%s" in "%s" is deprecated, the $vars and $isStreamable constructor arguments will not be supported when "sensio/framework-extra-bundle" is not installed and will be removed completely in 4.0.', Template::class, static::class);
  106.             parent::__construct($data, $vars, $isStreamable, $owner);
  107.         } elseif ([] !== $vars) {
  108.             trigger_deprecation('friendsofsymfony/rest-bundle', '3.7', 'Extending from "%s" in "%s" is deprecated and "sensio/framework-extra-bundle" is not installed, the $vars and $isStreamable constructor arguments will be ignored and removed completely in 4.0.', Template::class, static::class);
  109.         }
  111.         $values = is_array($data) ? $data : [];
  112.         $this->statusCode = $values['statusCode'] ?? $statusCode;
  113.         $this->serializerGroups = $values['serializerGroups'] ?? $serializerGroups;
  114.         $this->serializerEnableMaxDepthChecks = $values['serializerEnableMaxDepthChecks'] ?? $serializerEnableMaxDepthChecks;
  116.         // Use the setter to initialize the owner; when extending the Template class, the property will be private
  117.         $this->setOwner($values['owner'] ?? $owner);
  118.     }
  120.     /**
  121.      * @param int $statusCode
  122.      */
  123.     public function setStatusCode($statusCode)
  124.     {
  125.         $this->statusCode = $statusCode;
  126.     }
  128.     /**
  129.      * @return int|null
  130.      */
  131.     public function getStatusCode()
  132.     {
  133.         return $this->statusCode;
  134.     }
  136.     /**
  137.      * @param array $serializerGroups
  138.      */
  139.     public function setSerializerGroups($serializerGroups)
  140.     {
  141.         $this->serializerGroups = $serializerGroups;
  142.     }
  144.     /**
  145.      * @return array
  146.      */
  147.     public function getSerializerGroups()
  148.     {
  149.         return $this->serializerGroups;
  150.     }
  152.     /**
  153.      * @param bool $serializerEnableMaxDepthChecks
  154.      */
  155.     public function setSerializerEnableMaxDepthChecks($serializerEnableMaxDepthChecks)
  156.     {
  157.         $this->serializerEnableMaxDepthChecks = $serializerEnableMaxDepthChecks;
  158.     }
  160.     /**
  161.      * @return bool
  162.      */
  163.     public function getSerializerEnableMaxDepthChecks()
  164.     {
  165.         return $this->serializerEnableMaxDepthChecks;
  166.     }
  167. }