vendor/gollumsf/rest-doc-bundle/src/Annotation/ApiDescribe.php line 11

Open in your IDE?
  1. <?php
  3. namespace GollumSF\RestDocBundle\Annotation;
  5. use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationAnnotation;
  7. /**
  8.  * @Annotation
  9.  * @Target({"CLASS", "METHOD"})
  10.  */
  11. class ApiDescribe extends ConfigurationAnnotation {
  12.     
  13.     const ALIAS_NAME = 'gsf_api_describe';
  14.     
  15.     /** @var string */
  16.     private $entity;
  18.     /** @var bool */
  19.     private $collection = false;
  21.     /** @var string[] */
  22.     private $serializeGroups = [];
  24.     /** @var string[] */
  25.     private $unserializeGroups = [];
  27.     /** @var array */
  28.     private $request = [];
  30.     /** @var array */
  31.     private $response = [];
  33.     private $summary = null;
  34.     
  35.     /////////////
  36.     // Getters //
  37.     /////////////
  39.     public function getEntity(): ?string {
  40.         return $this->entity;
  41.     }
  43.     public function isCollection(): bool {
  44.         return $this->collection;
  45.     }
  47.     public function getSerializeGroups(): array {
  48.         return $this->serializeGroups;
  49.     }
  51.     public function getUnserializeGroups(): array {
  52.         return $this->unserializeGroups;
  53.     }
  55.     public function getRequest(): array {
  56.         return $this->request;
  57.     }
  59.     public function getResponse(): array {
  60.         return $this->response;
  61.     }
  63.     public function getSummary(): ?string {
  64.         return $this->summary;
  65.     }
  67.     public function getAliasName() {
  68.         return self::ALIAS_NAME;
  69.     }
  71.     public function allowArray() {
  72.         return true;
  73.     }
  75.     /////////////
  76.     // Setters //
  77.     /////////////
  79.     public function setEntity(?string $entity): self {
  80.         $this->entity = $entity;
  81.         return $this;
  82.     }
  84.     public function setCollection(bool $collection): self {
  85.         $this->collection = $collection;
  86.         return $this;
  87.     }
  89.     public function setSerializeGroups($serializeGroups): self {
  90.         if (!is_array($serializeGroups)) {
  91.             $serializeGroups = [$serializeGroups];
  92.         }
  93.         $this->serializeGroups = $serializeGroups;
  94.         return $this;
  95.     }
  97.     public function setUnserializeGroups($unserializeGroups): self {
  98.         if (!is_array($unserializeGroups)) {
  99.             $unserializeGroups = [$unserializeGroups];
  100.         }
  101.         $this->unserializeGroups = $unserializeGroups;
  102.         return $this;
  103.     }
  105.     public function setRequest(array $request): self {
  106.         $this->request = $request;
  107.         return $this;
  108.     }
  110.     public function setResponse(array $response): self {
  111.         $this->response = $response;
  112.         return $this;
  113.     }
  115.     public function setSummary(?string $summary): self {
  116.         $this->summary = $summary;
  117.         return $this;
  118.     }
  120.     public function setValue(?string $entity): self {
  121.         $this->entity = $entity;
  122.         return $this;
  123.     }
  124. }