vendor/api-platform/core/src/Metadata/Link.php line 17

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.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. declare(strict_types=1);
  14. namespace ApiPlatform\Metadata;
  16. use ApiPlatform\OpenApi;
  18. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::TARGET_PARAMETER)]
  19. final class Link extends Parameter
  20. {
  21.     public function __construct(
  22.         private ?string $parameterName = null,
  23.         private ?string $fromProperty = null,
  24.         private ?string $toProperty = null,
  25.         private ?string $fromClass = null,
  26.         private ?string $toClass = null,
  27.         private ?array $identifiers = null,
  28.         private ?bool $compositeIdentifier = null,
  29.         private ?string $expandedValue = null,
  30.         ?string $security = null,
  31.         ?string $securityMessage = null,
  32.         private ?string $securityObjectName = null,
  34.         ?string $key = null,
  35.         ?array $schema = null,
  36.         ?OpenApi\Model\Parameter $openApi = null,
  37.         mixed $provider = null,
  38.         mixed $filter = null,
  39.         ?string $property = null,
  40.         ?string $description = null,
  41.         ?bool $required = null,
  42.         array $extraProperties = [],
  43.     ) {
  44.         // For the inverse property shortcut
  45.         if ($this->parameterName && class_exists($this->parameterName)) {
  46.             $this->fromClass = $this->parameterName;
  47.         }
  49.         parent::__construct(
  50.             key: $key,
  51.             schema: $schema,
  52.             openApi: $openApi,
  53.             provider: $provider,
  54.             filter: $filter,
  55.             property: $property,
  56.             description: $description,
  57.             required: $required,
  58.             security: $security,
  59.             securityMessage: $securityMessage,
  60.             extraProperties: $extraProperties
  61.         );
  62.     }
  64.     public function getParameterName(): ?string
  65.     {
  66.         return $this->parameterName;
  67.     }
  69.     public function withParameterName(string $parameterName): self
  70.     {
  71.         $self = clone $this;
  72.         $self->parameterName = $parameterName;
  74.         return $self;
  75.     }
  77.     public function getFromClass(): ?string
  78.     {
  79.         return $this->fromClass;
  80.     }
  82.     public function withFromClass(string $fromClass): self
  83.     {
  84.         $self = clone $this;
  85.         $self->fromClass = $fromClass;
  87.         return $self;
  88.     }
  90.     public function getToClass(): ?string
  91.     {
  92.         return $this->toClass;
  93.     }
  95.     public function withToClass(string $toClass): self
  96.     {
  97.         $self = clone $this;
  98.         $self->toClass = $toClass;
  100.         return $self;
  101.     }
  103.     public function getFromProperty(): ?string
  104.     {
  105.         return $this->fromProperty;
  106.     }
  108.     public function withFromProperty(string $fromProperty): self
  109.     {
  110.         $self = $this;
  111.         $self->fromProperty = $fromProperty;
  113.         return $self;
  114.     }
  116.     public function getToProperty(): ?string
  117.     {
  118.         return $this->toProperty;
  119.     }
  121.     public function withToProperty(string $toProperty): self
  122.     {
  123.         $self = clone $this;
  124.         $self->toProperty = $toProperty;
  126.         return $self;
  127.     }
  129.     public function getIdentifiers(): ?array
  130.     {
  131.         return $this->identifiers;
  132.     }
  134.     public function withIdentifiers(array $identifiers): self
  135.     {
  136.         $self = clone $this;
  137.         $self->identifiers = $identifiers;
  139.         return $self;
  140.     }
  142.     public function getCompositeIdentifier(): ?bool
  143.     {
  144.         return $this->compositeIdentifier;
  145.     }
  147.     public function withCompositeIdentifier(bool $compositeIdentifier): self
  148.     {
  149.         $self = clone $this;
  150.         $self->compositeIdentifier = $compositeIdentifier;
  152.         return $self;
  153.     }
  155.     public function getExpandedValue(): ?string
  156.     {
  157.         return $this->expandedValue;
  158.     }
  160.     public function withExpandedValue(string $expandedValue): self
  161.     {
  162.         $self = clone $this;
  163.         $self->expandedValue = $expandedValue;
  165.         return $self;
  166.     }
  168.     public function getSecurity(): ?string
  169.     {
  170.         return $this->security;
  171.     }
  173.     public function getSecurityObjectName(): ?string
  174.     {
  175.         return $this->securityObjectName;
  176.     }
  178.     public function withSecurityObjectName(?string $securityObjectName): self
  179.     {
  180.         $self = clone $this;
  181.         $self->securityObjectName = $securityObjectName;
  183.         return $self;
  184.     }
  186.     public function withLink(self $link): self
  187.     {
  188.         $self = clone $this;
  190.         if (!$self->getToProperty() && ($toProperty = $link->getToProperty())) {
  191.             $self->toProperty = $toProperty;
  192.         }
  194.         if (!$self->getCompositeIdentifier() && ($compositeIdentifier = $link->getCompositeIdentifier())) {
  195.             $self->compositeIdentifier = $compositeIdentifier;
  196.         }
  198.         if (!$self->getFromClass() && ($fromClass = $link->getFromClass())) {
  199.             $self->fromClass = $fromClass;
  200.         }
  202.         if (!$self->getToClass() && ($toClass = $link->getToClass())) {
  203.             $self->toClass = $toClass;
  204.         }
  206.         if (!$self->getIdentifiers() && ($identifiers = $link->getIdentifiers())) {
  207.             $self->identifiers = $identifiers;
  208.         }
  210.         if (!$self->getFromProperty() && ($fromProperty = $link->getFromProperty())) {
  211.             $self->fromProperty = $fromProperty;
  212.         }
  214.         if (!$self->getParameterName() && ($parameterName = $link->getParameterName())) {
  215.             $self->parameterName = $parameterName;
  216.         }
  218.         if (!$self->getExpandedValue() && ($expandedValue = $link->getExpandedValue())) {
  219.             $self->expandedValue = $expandedValue;
  220.         }
  222.         if (!$self->getSecurity() && ($security = $link->getSecurity())) {
  223.             $self->security = $security;
  224.         }
  226.         if (!$self->getSecurityMessage() && ($securityMessage = $link->getSecurityMessage())) {
  227.             $self->securityMessage = $securityMessage;
  228.         }
  230.         if (!$self->getSecurityObjectName() && ($securityObjectName = $link->getSecurityObjectName())) {
  231.             $self->securityObjectName = $securityObjectName;
  232.         }
  234.         return $self;
  235.     }
  236. }