WebHemi\Data\Storage\ApplicationStorage

Complexity

Total Complexity

7

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	populateEntity()	0	12	1
A	getEntityData()	0	17	3
A	getApplicationById()	0	7	1
A	getApplicationByName()	0	7	1
A	getApplications()	0	7	1

<?php
/**
 * WebHemi.
 *
 * PHP version 7.1
 *
 * @copyright 2012 - 2017 Gixx-web (http://www.gixx-web.com)
 * @license   https://opensource.org/licenses/MIT The MIT License (MIT)
 *
 * @link      http://www.gixx-web.com
 */
declare(strict_types = 1);

namespace WebHemi\Data\Storage;

use WebHemi\DateTime;
use WebHemi\Data\EntityInterface;
use WebHemi\Data\Entity\ApplicationEntity;

/**
 * Class ApplicationStorage.
 */
class ApplicationStorage extends AbstractStorage
{
    /** @var string */
    protected $dataGroup = 'webhemi_application';
    /** @var string */
    protected $idKey = 'id_application';
    /** @var string */
    private $name = 'name';
    /** @var string */
    private $title = 'title';
    /** @var string */
    private $description = 'description';
    /** @var string */
    private $isReadOnly = 'is_read_only';
    /** @var string */
    private $isEnabled = 'is_enabled';
    /** @var string */
    private $dateCreated = 'date_created';
    /** @var string */
    private $dateModified = 'date_modified';

    /**
     * Populates an entity with storage data.
     *
     * @param EntityInterface $dataEntity
     * @param array           $data
     * @return void
     */
    protected function populateEntity(EntityInterface&$dataEntity, array $data) : void
    {
        /* @var ApplicationEntity $dataEntity */
        $dataEntity->setApplicationId((int) $data[$this->idKey])
            ->setName($data[$this->name])
            ->setTitle($data[$this->title])
            ->setDescription($data[$this->description])
            ->setReadOnly((bool) $data[$this->isReadOnly])
            ->setEnabled((bool) $data[$this->isEnabled])
            ->setDateCreated(new DateTime($data[$this->dateCreated] ?? 'now'))
            ->setDateModified(new DateTime($data[$this->dateModified] ?? 'now'));
    }

    /**
     * Get data from an entity.
     *
     * @param EntityInterface $dataEntity
     * @return array
     */
    protected function getEntityData(EntityInterface $dataEntity) : array
    {
        /** @var ApplicationEntity $dataEntity */
        $dateCreated = $dataEntity->getDateCreated();
        $dateModified = $dataEntity->getDateModified();

        return [
            $this->idKey => $dataEntity->getKeyData(),
            $this->name => $dataEntity->getName(),
            $this->title => $dataEntity->getTitle(),
            $this->description => $dataEntity->getDescription(),
            $this->isReadOnly => (int) $dataEntity->getReadOnly(),
            $this->isEnabled => (int) $dataEntity->getEnabled(),
            $this->dateCreated => $dateCreated instanceof DateTime ? $dateCreated->format('Y-m-d H:i:s') : null,
            $this->dateModified => $dateModified instanceof DateTime ? $dateModified->format('Y-m-d H:i:s') : null
        ];
    }

    /**
     * Returns every Application entity.
     *
     * @return array|ApplicationEntity[]
     */
    public function getApplications()
    {
        /** @var ApplicationEntity[] $entityList */
        $entityList = $this->getDataEntitySet([]);

        return $entityList;
    }

    /**
     * Returns a Application entity identified by (unique) ID.
     *
     * @param int $identifier
     * @return null|ApplicationEntity
     */
    public function getApplicationById($identifier) : ? ApplicationEntity
    {
        /** @var null|ApplicationEntity $dataEntity */
        $dataEntity = $this->getDataEntity([$this->idKey => $identifier]);

        return $dataEntity;
    }

    /**
     * Returns an Application entity by name.
     *
     * @param string $name
     * @return null|ApplicationEntity
     */
    public function getApplicationByName($name) : ? ApplicationEntity
    {
        /** @var null|ApplicationEntity $dataEntity */
        $dataEntity = $this->getDataEntity([$this->name => $name]);

        return $dataEntity;
    }
}