vendor/netgen/layouts-core/lib/API/Values/LayoutResolver/Rule.php line 15

  1. <?php
  3. declare(strict_types=1);
  5. namespace Netgen\Layouts\API\Values\LayoutResolver;
  7. use Doctrine\Common\Collections\Collection;
  8. use Netgen\Layouts\API\Values\Layout\Layout;
  9. use Netgen\Layouts\API\Values\LazyPropertyTrait;
  10. use Netgen\Layouts\API\Values\Value;
  11. use Netgen\Layouts\API\Values\ValueStatusTrait;
  12. use Netgen\Layouts\Utils\HydratorTrait;
  13. use Ramsey\Uuid\UuidInterface;
  15. final class Rule implements Value
  16. {
  17.     use HydratorTrait;
  18.     use LazyPropertyTrait;
  19.     use ValueStatusTrait;
  21.     private UuidInterface $id;
  23.     private UuidInterface $ruleGroupId;
  25.     /**
  26.      * @var \Netgen\Layouts\API\Values\Layout\Layout|\Closure|null
  27.      */
  28.     private $layout;
  30.     private bool $enabled;
  32.     private int $priority;
  34.     private string $description;
  36.     /**
  37.      * @var \Doctrine\Common\Collections\Collection<int, \Netgen\Layouts\API\Values\LayoutResolver\Target>
  38.      */
  39.     private Collection $targets;
  41.     /**
  42.      * @var \Doctrine\Common\Collections\Collection<int, \Netgen\Layouts\API\Values\LayoutResolver\Condition>
  43.      */
  44.     private Collection $conditions;
  46.     public function getId(): UuidInterface
  47.     {
  48.         return $this->id;
  49.     }
  51.     /**
  52.      * Returns the UUID of the rule group where this rule belongs.
  53.      */
  54.     public function getRuleGroupId(): UuidInterface
  55.     {
  56.         return $this->ruleGroupId;
  57.     }
  59.     /**
  60.      * Returns the layout mapped to this rule.
  61.      */
  62.     public function getLayout(): ?Layout
  63.     {
  64.         return $this->getLazyProperty($this->layout);
  65.     }
  67.     /**
  68.      * Returns if the rule is enabled.
  69.      */
  70.     public function isEnabled(): bool
  71.     {
  72.         return $this->enabled;
  73.     }
  75.     /**
  76.      * Returns the rule priority.
  77.      */
  78.     public function getPriority(): int
  79.     {
  80.         return $this->priority;
  81.     }
  83.     /**
  84.      * Returns the rule comment.
  85.      *
  86.      * @deprecated use self::getDescription
  87.      */
  88.     public function getComment(): string
  89.     {
  90.         return $this->description;
  91.     }
  93.     /**
  94.      * Returns the rule description.
  95.      */
  96.     public function getDescription(): string
  97.     {
  98.         return $this->description;
  99.     }
  101.     /**
  102.      * Returns all the targets in the rule.
  103.      */
  104.     public function getTargets(): TargetList
  105.     {
  106.         return new TargetList($this->targets->toArray());
  107.     }
  109.     /**
  110.      * Returns all conditions in the rule.
  111.      */
  112.     public function getConditions(): ConditionList
  113.     {
  114.         return new ConditionList($this->conditions->toArray());
  115.     }
  116. }