src/App/Model/Mobile/Shortcut.php line 11

Open in your IDE?
  1. <?php
  3. namespace App\Model\Mobile;
  5. use JsonSerializable;
  6. use Serializable;
  8. /**
  9.  *
  10.  */
  11. final class Shortcut implements Serializable, JsonSerializable
  12. {
  13.     const ICONS = [
  14.         'covid' => 'COVID-19',
  15.         'health' => 'Health and Safety',
  16.         'directory' => 'Directory',
  17.         'bell' => 'Bell Schedule',
  18.         'budget' => 'Budgets',
  19.         'lunch' => 'Lunch Menu',
  20.         'agenda' => 'Agenda and Minutes',
  21.         'principal' => 'Principal and Minutes',
  22.         'board' => 'Board of Education',
  23.         'pto' => 'PTO',
  24.         'helpdesk' => 'Helpdesk',
  25.         'title-ix' => 'Title IX',
  26.         'links' => 'Links',
  27.         'calendar' => 'Calendar',
  28.         'bus' => 'Bus Routes',
  29.         'backpack' => 'Virtual Backpack',
  30.         'handbook' => 'Handbook',
  31.         'forms' => 'Forms',
  32.         'documents' => 'Documents',
  33.         'grades' => 'Check Grades',
  34.         'pay-lunch' => 'Pay Lunch Fees',
  35.         'photo-gallery' => 'Photo Gallery',
  36.         'uniform' => 'Spirit Wear',
  37.     ];
  39.     /**
  40.      * @var bool
  41.      */
  42.     protected bool $promoted = false;
  44.     /**
  45.      * @var string|null
  46.      */
  47.     protected ?string $icon = null;
  49.     /**
  50.      * @var string|null
  51.      */
  52.     protected ?string $name = null;
  54.     /**
  55.      * @var string|null
  56.      */
  57.     protected ?string $link = null;
  59.     /**
  60.      * @return bool
  61.      */
  62.     public function isBlank(): bool
  63.     {
  64.         return empty($this->getName()) || empty($this->getLink());
  65.     }
  67.     /**
  68.      * @return bool
  69.      */
  70.     public function isPromoted(): bool
  71.     {
  72.         return $this->promoted;
  73.     }
  75.     /**
  76.      * @param bool $promoted
  77.      * @return $this
  78.      */
  79.     public function setPromoted(bool $promoted): self
  80.     {
  81.         $this->promoted = $promoted;
  82.         return $this;
  83.     }
  85.     /**
  86.      * @return string|null
  87.      */
  88.     public function getIcon(): ?string
  89.     {
  90.         return $this->icon;
  91.     }
  93.     /**
  94.      * @param string|null $icon
  95.      * @return $this
  96.      */
  97.     public function setIcon(?string $icon): self
  98.     {
  99.         if ( ! array_key_exists($icon, self::ICONS)) {
  100.             $icon = null;
  101.         }
  102.         $this->icon = $icon;
  103.         return $this;
  104.     }
  106.     /**
  107.      * @return string|null
  108.      */
  109.     public function getName(): ?string
  110.     {
  111.         return $this->name;
  112.     }
  114.     /**
  115.      * @param string|null $name
  116.      * @return $this
  117.      */
  118.     public function setName(?string $name): self
  119.     {
  120.         $this->name = $name;
  121.         return $this;
  122.     }
  124.     /**
  125.      * @return string|null
  126.      */
  127.     public function getLink(): ?string
  128.     {
  129.         return $this->link;
  130.     }
  132.     /**
  133.      * @param string|null $link
  134.      * @return $this
  135.      */
  136.     public function setLink(?string $link): self
  137.     {
  138.         $this->link = $link;
  139.         return $this;
  140.     }
  142.     /**
  143.      * @return array
  144.      */
  145.     public function toArray(): array
  146.     {
  147.         return [
  148.             'name' => $this->getName(),
  149.             'icon' => $this->getIcon(),
  150.             'link' => $this->getLink(),
  151.             'promoted' => $this->isPromoted(),
  152.         ];
  153.     }
  155.     /**
  156.      * {@inheritDoc}
  157.      */
  158.     public function jsonSerialize(): array
  159.     {
  160.         return $this->toArray();
  161.     }
  163.     /**
  164.      * {@inheritDoc}
  165.      */
  166.     public function serialize(): string
  167.     {
  168.         return json_encode($this);
  169.     }
  171.     /**
  172.      * {@inheritDoc}
  173.      */
  174.     public function unserialize($data): void
  175.     {
  176.         $this->fromArray(
  177.             json_decode($data, true)
  178.         );
  179.     }
  181.     /**
  182.      * @param array $data
  183.      * @return $this
  184.      */
  185.     public function fromArray(array $data): self
  186.     {
  187.         return $this
  188.             ->setPromoted($data['promoted'] ?: false)
  189.             ->setIcon($data['icon'] ?: null)
  190.             ->setName($data['name'] ?: null)
  191.             ->setLink($data['link'] ?: null)
  192.         ;
  193.     }
  195.     /**
  196.      * @param array $data
  197.      * @return Shortcut
  198.      */
  199.     static public function build(array $data): Shortcut
  200.     {
  201.         return (new Shortcut())->fromArray($data);
  202.     }
  203. }