AbterPhp\Files\Orm\DataMappers\FileSqlDataMapper

Complexity

Total Complexity

17

Size/Duplication

Total Lines	314
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getPage()	0	23	4
A	getById()	0	10	1
A	getPublicByFilesystemName()	0	12	1
A	withUserGroup()	0	16	1
A	loadEntity()	0	20	1
A	update()	0	27	1
A	delete()	0	15	1
A	getPublicByCategoryIdentifiers()	0	15	2
A	getByUserId()	0	12	1
A	getByFilesystemName()	0	10	1
A	add()	0	24	1
A	getAll()	0	7	1
A	getBaseQuery()	0	25	1

<?php

declare(strict_types=1);

namespace AbterPhp\Files\Orm\DataMappers;

use AbterPhp\Files\Domain\Entities\File as Entity;
use AbterPhp\Files\Domain\Entities\FileCategory;
use Opulence\Orm\DataMappers\SqlDataMapper;
use Opulence\QueryBuilders\Conditions\ConditionFactory;
use Opulence\QueryBuilders\Expression;
use Opulence\QueryBuilders\MySql\QueryBuilder;
use Opulence\QueryBuilders\MySql\SelectQuery;

/** @phan-file-suppress PhanTypeMismatchArgument */
class FileSqlDataMapper extends SqlDataMapper implements IFileDataMapper
{
    /**
     * @param Entity $entity
     */
    public function add($entity)
    {
        assert($entity instanceof Entity, new \InvalidArgumentException());

        $query = (new QueryBuilder())
            ->insert(
                'files',
                [
                    'id'               => [$entity->getId(), \PDO::PARAM_STR],
                    'filesystem_name'  => [$entity->getFilesystemName(), \PDO::PARAM_STR],
                    'public_name'      => [$entity->getPublicName(), \PDO::PARAM_STR],
                    'mime'             => [$entity->getMime(), \PDO::PARAM_STR],
                    'description'      => [$entity->getDescription(), \PDO::PARAM_STR],
                    'file_category_id' => [$entity->getCategory()->getId(), \PDO::PARAM_STR],
                    'uploaded_at'      => [$entity->getUploadedAt()->format(Entity::DATE_FORMAT), \PDO::PARAM_STR],
                ]
            );

        $sql    = $query->getSql();
        $params = $query->getParameters();

        $statement = $this->writeConnection->prepare($sql);
        $statement->bindValues($params);
        $statement->execute();
    }

    /**
     * @param Entity $entity
     *
     * @throws \Opulence\QueryBuilders\InvalidQueryException
     */
    public function delete($entity)
    {
        assert($entity instanceof Entity, new \InvalidArgumentException());

        $query = (new QueryBuilder())
            ->update('files', 'files', ['deleted_at' => new Expression('NOW()')])
            ->where('id = ?')
            ->addUnnamedPlaceholderValue($entity->getId(), \PDO::PARAM_STR);

        $sql    = $query->getSql();
        $params = $query->getParameters();

        $statement = $this->writeConnection->prepare($sql);
        $statement->bindValues($params);
        $statement->execute();
    }

    /**
     * @return Entity[]
     * @throws \Opulence\Orm\OrmException
     */
    public function getAll(): array
    {
        $query = $this->getBaseQuery();

        $sql = $query->getSql();

        return $this->read($sql, [], self::VALUE_TYPE_ARRAY);

The expression return $this->read($sql, array(), self::VALUE_TYPE_ARRAY) could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param int      $limitFrom
     * @param int      $pageSize
     * @param string[] $orders
     * @param array    $conditions
     * @param array    $params
     *
     * @return Entity[]
     * @throws \Opulence\Orm\OrmException
     */
    public function getPage(int $limitFrom, int $pageSize, array $orders, array $conditions, array $params): array
    {
        $query = $this->getBaseQuery()
            ->limit($pageSize)
            ->offset($limitFrom);

        if (!$orders) {

The expression $orders of type string[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            $query->orderBy('files.public_name ASC');
        }
        foreach ($orders as $order) {
            $query->addOrderBy($order);
        }

        foreach ($conditions as $condition) {
            $query->andWhere($condition);
        }

        $replaceCount = 1;

        $sql = $query->getSql();
        $sql = str_replace('SELECT', 'SELECT SQL_CALC_FOUND_ROWS', $sql, $replaceCount);

        return $this->read($sql, $params, self::VALUE_TYPE_ARRAY);

The expression return $this->read($sql, $params, self::VALUE_TYPE_ARRAY) could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param int|string $id
     *
     * @return Entity
     * @throws \Opulence\Orm\OrmException
     */
    public function getById($id)
    {
        $query = $this->getBaseQuery()->andWhere('files.id = :file_id');

        $params = [
            'file_id' => [$id, \PDO::PARAM_STR],
        ];
        $sql    = $query->getSql();

        return $this->read($sql, $params, self::VALUE_TYPE_ENTITY, true);

The expression return $this->read($sql, $params, self::VALUE_TYPE_ENTITY, true) also could return the type array which is incompatible with the documented return type AbterPhp\Files\Domain\Entities\File.

    }

    /**
     * @param string $filesystemName
     *
     * @return Entity
     * @throws \Opulence\Orm\OrmException
     */
    public function getByFilesystemName(string $filesystemName): Entity
    {
        $query = $this->getBaseQuery()->andWhere('files.filesystem_name = :filesystem_name');

        $params = [
            'filesystem_name' => [$filesystemName, \PDO::PARAM_STR],
        ];
        $sql    = $query->getSql();

        return $this->read($sql, $params, self::VALUE_TYPE_ENTITY, true);

The expression return $this->read($sql, $params, self::VALUE_TYPE_ENTITY, true) could return the type array|null which is incompatible with the type-hinted return AbterPhp\Files\Domain\Entities\File. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param string $filesystemName
     *
     * @return Entity
     * @throws \Opulence\Orm\OrmException
     */
    public function getPublicByFilesystemName(string $filesystemName): Entity
    {
        $query = $this->getBaseQuery()
            ->andWhere('files.filesystem_name = :filesystem_name')
            ->andWhere('file_categories.is_public = 1');

        $params = [
            'filesystem_name' => [$filesystemName, \PDO::PARAM_STR],
        ];
        $sql    = $query->getSql();

        return $this->read($sql, $params, self::VALUE_TYPE_ENTITY, true);

The expression return $this->read($sql, $params, self::VALUE_TYPE_ENTITY, true) could return the type array|null which is incompatible with the type-hinted return AbterPhp\Files\Domain\Entities\File. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param string[] $identifiers
     *
     * @return Entity[]
     * @throws \Opulence\Orm\OrmException
     */
    public function getPublicByCategoryIdentifiers(array $identifiers): array
    {
        if (count($identifiers) === 0) {
            return [];
        }

        $conditions = new ConditionFactory();
        $query      = $this
            ->withUserGroup($this->getBaseQuery())
            ->andWhere($conditions->in('file_categories.identifier', $identifiers));

        $sql    = $query->getSql();
        $params = $query->getParameters();

        return $this->read($sql, $params, self::VALUE_TYPE_ARRAY);

The expression return $this->read($sql, $params, self::VALUE_TYPE_ARRAY) could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param string $userId
     *
     * @return Entity[]
     * @throws \Opulence\Orm\OrmException
     */
    public function getByUserId(string $userId): array
    {
        $query = $this
            ->withUserGroup($this->getBaseQuery())
            ->andWhere('user_groups.user_id = :user_id');

        $sql    = $query->getSql();
        $params = [
            'user_id' => [$userId, \PDO::PARAM_STR],
        ];

        return $this->read($sql, $params, self::VALUE_TYPE_ARRAY);

The expression return $this->read($sql, $params, self::VALUE_TYPE_ARRAY) could return the type null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param Entity $entity
     *
     * @throws \Opulence\QueryBuilders\InvalidQueryException
     */
    public function update($entity)
    {
        assert($entity instanceof Entity, new \InvalidArgumentException());

        $query = (new QueryBuilder())
            ->update(
                'files',
                'files',
                [
                    'filesystem_name'  => [$entity->getFilesystemName(), \PDO::PARAM_STR],
                    'public_name'      => [$entity->getPublicName(), \PDO::PARAM_STR],
                    'mime'             => [$entity->getMime(), \PDO::PARAM_STR],
                    'description'      => [$entity->getDescription(), \PDO::PARAM_STR],
                    'uploaded_at'      => [$entity->getUploadedAt()->format(Entity::DATE_FORMAT), \PDO::PARAM_STR],
                    'file_category_id' => [$entity->getCategory()->getId(), \PDO::PARAM_STR],
                ]
            )
            ->where('id = ?')
            ->andWhere('deleted_at IS NULL')
            ->addUnnamedPlaceholderValue($entity->getId(), \PDO::PARAM_STR);

        $sql    = $query->getSql();
        $params = $query->getParameters();

        $statement = $this->writeConnection->prepare($sql);
        $statement->bindValues($params);
        $statement->execute();
    }

    /**
     * @param array $hash
     *
     * @return Entity|object
     * @throws \Exception
     */
    protected function loadEntity(array $hash)
    {
        $category = new FileCategory(
            $hash['file_category_id'],
            (string)$hash['file_category_identifier'],
            (string)$hash['file_category_name'],
            (bool)$hash['file_category_name']
        );

        $uploadedAt = new \DateTime((string)$hash['uploaded_at']);

        return new Entity(
            $hash['id'],
            $hash['filesystem_name'],
            $hash['public_name'],
            $hash['mime'],
            $hash['description'],
            $category,
            $uploadedAt,
            true
        );
    }

    /**
     * @return SelectQuery
     */
    private function getBaseQuery()
    {
        /** @var SelectQuery $query */
        $query = (new QueryBuilder())
            ->select(
                'files.id',
                'files.filesystem_name',
                'files.public_name',
                'files.mime',
                'files.file_category_id',
                'files.description',
                'files.uploaded_at',
                'file_categories.name AS file_category_name',
                'file_categories.identifier AS file_category_identifier'
            )
            ->from('files')
            ->innerJoin(
                'file_categories',
                'file_categories',
                'file_categories.id = files.file_category_id AND file_categories.deleted_at IS NULL'
            )
            ->where('files.deleted_at IS NULL')
            ->groupBy('files.id');

        return $query;
    }

    /**
     * @param SelectQuery $selectQuery
     *
     * @return SelectQuery
     */
    private function withUserGroup(SelectQuery $selectQuery): SelectQuery
    {
        /** @var SelectQuery $query */
        $selectQuery
            ->innerJoin(
                'user_groups_file_categories',
                'ugfc',
                'file_categories.id = ugfc.file_category_id AND file_categories.deleted_at IS NULL'
            )
            ->innerJoin(
                'user_groups',
                'user_groups',
                'user_groups.id = ugfc.user_group_id AND user_groups.deleted_at IS NULL'
            );

        return $selectQuery;
    }
}