oms-Dashboard/Models/DashboardBoard.php

<?php
/**
 * Orange Management
 *
 * PHP Version 7.4
 *
 * @package   Modules\Dashboard\Models
 * @copyright Dennis Eichhorn
 * @license   OMS License 1.0
 * @version   1.0.0
 * @link      https://orange-management.org
 */
declare(strict_types=1);

namespace Modules\Dashboard\Models;

use phpOMS\Stdlib\Base\Exception\InvalidEnumValue;

/**
 * DashboardBoard class.
 *
 * @package Modules\Dashboard\Models
 * @license OMS License 1.0
 * @link    https://orange-management.org
 * @since   1.0.0
 */
class DashboardBoard implements \JsonSerializable
{
    /**
     * ID.
     *
     * @var   int
     * @since 1.0.0
     */
    protected int $id = 0;

    /**
     * Title.
     *
     * @var   string
     * @since 1.0.0
     */
    protected string $title = '';

    /**
     * Account.
     *
     * @var   null|int
     * @since 1.0.0
     */
    protected $account = null;

    /**
     * Status.
     *
     * @var   int
     * @since 1.0.0
     */
    protected int $status = DashboardBoardStatus::ACTIVE;

    /**
     * Dashboard component.
     *
     * @var   DashboardComponent[]
     * @since 1.0.0
     */
    protected array $components = [];

    /**
     * Get id
     *
     * @return int
     *
     * @since 1.0.0
     */
    public function getId() : int
    {
        return $this->id;
    }

    /**
     * Get account
     *
     * @return null|int
     *
     * @since 1.0.0
     */
    public function getAccount()
    {
        return $this->account;
    }

    /**
     * Set account
     *
     * @param mixed $id Account
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setAccount($id) : void
    {
        $this->account = $id;
    }

    /**
     * Get title
     *
     * @return string
     *
     * @since 1.0.0
     */
    public function getTitle() : string
    {
        return $this->title;
    }

    /**
     * Set title
     *
     * @param string $title Title
     *
     * @return void
     *
     * @since 1.0.0
     */
    public function setTitle(string $title) : void
    {
        $this->title = $title;
    }

    /**
     * Get status
     *
     * @return int
     *
     * @since 1.0.0
     */
    public function getStatus() : int
    {
        return $this->status;
    }

    /**
     * Set status
     *
     * @param int $status Task status
     *
     * @return void
     *
     * @throws InvalidEnumValue
     *
     * @since 1.0.0
     */
    public function setStatus(int $status) : void
    {
        if (!DashboardBoardStatus::isValidValue($status)) {
            throw new InvalidEnumValue((string) $status);
        }

        $this->status = $status;
    }

    /**
     * Adding board component.
     *
     * @param DashboardComponent $element Task element
     *
     * @return int
     *
     * @since 1.0.0
     */
    public function addComponent(DashboardComponent $element) : int
    {
        $this->components[] = $element;

        \end($this->components);
        $key = (int) \key($this->components);
        \reset($this->components);

        return $key;
    }

    /**
     * Remove component from list.
     *
     * @param int $id Board component
     *
     * @return bool
     *
     * @since 1.0.0
     */
    public function removeComponent($id) : bool
    {
        if (isset($this->components[$id])) {
            unset($this->components[$id]);

            return true;
        }

        return false;
    }

    /**
     * Get board components.
     *
     * @return DashboardComponent[]
     *
     * @since 1.0.0
     */
    public function getComponents() : array
    {
        return $this->components;
    }

    /**
     * Get board component.
     *
     * @param int $id Component id
     *
     * @return DashboardComponent
     *
     * @since 1.0.0
     */
    public function getComponent(int $id) : DashboardComponent
    {
        return $this->components[$id] ?? new NullDashboardComponent();
    }

    /**
     * {@inheritdoc}
     */
    public function toArray() : array
    {
        return [
            'id'         => $this->id,
            'account'    => $this->account,
            'title'      => $this->title,
            'status'     => $this->status,
            'components' => $this->components,
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }
}