vendor/netgen/layouts-core/lib/API/Values/Layout/Layout.php line 27

  1. <?php
  3. declare(strict_types=1);
  5. namespace Netgen\Layouts\API\Values\Layout;
  7. use ArrayAccess;
  8. use Countable;
  9. use DateTimeInterface;
  10. use Doctrine\Common\Collections\Collection;
  11. use IteratorAggregate;
  12. use Netgen\Layouts\API\Values\Value;
  13. use Netgen\Layouts\API\Values\ValueStatusTrait;
  14. use Netgen\Layouts\Exception\API\LayoutException;
  15. use Netgen\Layouts\Exception\RuntimeException;
  16. use Netgen\Layouts\Layout\Type\LayoutTypeInterface;
  17. use Netgen\Layouts\Utils\HydratorTrait;
  18. use Ramsey\Uuid\UuidInterface;
  19. use Traversable;
  21. use function in_array;
  23. /**
  24.  * @implements \IteratorAggregate<string, \Netgen\Layouts\API\Values\Layout\Zone>
  25.  * @implements \ArrayAccess<string, \Netgen\Layouts\API\Values\Layout\Zone>
  26.  */
  27. final class Layout implements Value, ArrayAccess, IteratorAggregate, Countable
  28. {
  29.     use HydratorTrait;
  30.     use ValueStatusTrait;
  32.     private UuidInterface $id;
  34.     private LayoutTypeInterface $layoutType;
  36.     private string $name;
  38.     private string $description;
  40.     private DateTimeInterface $created;
  42.     private DateTimeInterface $modified;
  44.     private bool $shared;
  46.     private string $mainLocale;
  48.     /**
  49.      * @var string[]
  50.      */
  51.     private array $availableLocales;
  53.     /**
  54.      * @var \Doctrine\Common\Collections\Collection<string, \Netgen\Layouts\API\Values\Layout\Zone>
  55.      */
  56.     private Collection $zones;
  58.     public function getId(): UuidInterface
  59.     {
  60.         return $this->id;
  61.     }
  63.     /**
  64.      * Returns the layout type.
  65.      */
  66.     public function getLayoutType(): LayoutTypeInterface
  67.     {
  68.         return $this->layoutType;
  69.     }
  71.     /**
  72.      * Returns human readable name of the layout.
  73.      */
  74.     public function getName(): string
  75.     {
  76.         return $this->name;
  77.     }
  79.     /**
  80.      * Return human readable description of the layout.
  81.      */
  82.     public function getDescription(): string
  83.     {
  84.         return $this->description;
  85.     }
  87.     /**
  88.      * Returns when was the layout first created.
  89.      */
  90.     public function getCreated(): DateTimeInterface
  91.     {
  92.         return $this->created;
  93.     }
  95.     /**
  96.      * Returns when was the layout last updated.
  97.      */
  98.     public function getModified(): DateTimeInterface
  99.     {
  100.         return $this->modified;
  101.     }
  103.     /**
  104.      * Returns if the layout is shared.
  105.      */
  106.     public function isShared(): bool
  107.     {
  108.         return $this->shared;
  109.     }
  111.     /**
  112.      * Returns the main locale of the layout.
  113.      */
  114.     public function getMainLocale(): string
  115.     {
  116.         return $this->mainLocale;
  117.     }
  119.     /**
  120.      * Returns the list of all available locales in the layout.
  121.      *
  122.      * @return string[]
  123.      */
  124.     public function getAvailableLocales(): array
  125.     {
  126.         return $this->availableLocales;
  127.     }
  129.     /**
  130.      * Returns if the layout has the provided locale.
  131.      */
  132.     public function hasLocale(string $locale): bool
  133.     {
  134.         return in_array($locale, $this->availableLocales, true);
  135.     }
  137.     /**
  138.      * Returns all zones from the layout.
  139.      */
  140.     public function getZones(): ZoneList
  141.     {
  142.         return new ZoneList($this->zones->toArray());
  143.     }
  145.     /**
  146.      * Returns the specified zone.
  147.      *
  148.      * @throws \Netgen\Layouts\Exception\API\LayoutException If the zone does not exist
  149.      */
  150.     public function getZone(string $zoneIdentifier): Zone
  151.     {
  152.         $zone = $this->zones->get($zoneIdentifier);
  153.         if ($zone === null) {
  154.             throw LayoutException::noZone($zoneIdentifier);
  155.         }
  157.         return $zone;
  158.     }
  160.     /**
  161.      * Returns if layout has a specified zone.
  162.      */
  163.     public function hasZone(string $zoneIdentifier): bool
  164.     {
  165.         return $this->zones->containsKey($zoneIdentifier);
  166.     }
  168.     public function getIterator(): Traversable
  169.     {
  170.         return $this->zones->getIterator();
  171.     }
  173.     public function count(): int
  174.     {
  175.         return $this->zones->count();
  176.     }
  178.     /**
  179.      * @param mixed $offset
  180.      */
  181.     public function offsetExists($offset): bool
  182.     {
  183.         return $this->zones->offsetExists($offset);
  184.     }
  186.     /**
  187.      * @param mixed $offset
  188.      */
  189.     public function offsetGet($offset): ?Zone
  190.     {
  191.         return $this->zones->offsetGet($offset);
  192.     }
  194.     /**
  195.      * @param mixed $offset
  196.      * @param mixed $value
  197.      */
  198.     public function offsetSet($offset, $value): void
  199.     {
  200.         throw new RuntimeException('Method call not supported.');
  201.     }
  203.     /**
  204.      * @param mixed $offset
  205.      */
  206.     public function offsetUnset($offset): void
  207.     {
  208.         throw new RuntimeException('Method call not supported.');
  209.     }
  210. }