AbterPhp\Files\Orm\DataMappers\FileDownloadSqlDataMapper

Complexity

Total Complexity

13

Size/Duplication

Total Lines	239
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getBaseQuery()	0	28	1
A	getByUserId()	0	8	1
A	getAll()	0	5	1
A	getPage()	0	23	4
A	getByFileId()	0	9	1
A	delete()	0	19	1
A	add()	0	21	1
A	getById()	0	9	1
A	loadEntity()	0	19	1
A	update()	0	23	1

<?php

declare(strict_types=1);

namespace AbterPhp\Files\Orm\DataMappers;

use AbterPhp\Admin\Domain\Entities\User;
use AbterPhp\Admin\Domain\Entities\UserLanguage;
use AbterPhp\Files\Domain\Entities\File;
use AbterPhp\Files\Domain\Entities\FileDownload as Entity;
use Opulence\Orm\DataMappers\SqlDataMapper;
use Opulence\QueryBuilders\Expression;
use Opulence\QueryBuilders\MySql\QueryBuilder;
use Opulence\QueryBuilders\MySql\SelectQuery;

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

        $query = (new QueryBuilder())
            ->insert(
                'file_downloads',
                [
                    'id'            => [$entity->getId(), \PDO::PARAM_STR],
                    'file_id'       => [$entity->getFile()->getId(), \PDO::PARAM_STR],
                    'user_id'       => [$entity->getUser()->getId(), \PDO::PARAM_STR],
                    'downloaded_at' => [$entity->getDownloadedAt()->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(
                'file_downloads',
                'file_downloads',
                ['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();

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

The expression return $this->read($query->getSql(), 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('downloaded_at DESC');
        }
        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('file_downloads.id = :file_download_id');

        $parameters = [
            'file_download_id' => [$id, \PDO::PARAM_STR],
        ];

        return $this->read($query->getSql(), $parameters, self::VALUE_TYPE_ENTITY, true);

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

    }

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

        return $this->read($query->getSql(), $parameters, self::VALUE_TYPE_ARRAY);

The expression return $this->read($query->getSql(), $parameters, 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 $fileId
     *
     * @return Entity[]
     * @throws \Opulence\Orm\OrmException
     */
    public function getByFileId(string $fileId): array
    {
        $query = $this->getBaseQuery()->andWhere('file_id = :file_id');

        $parameters = [
            'file_id' => [$fileId, \PDO::PARAM_STR],
        ];

        return $this->read($query->getSql(), $parameters, self::VALUE_TYPE_ARRAY);

The expression return $this->read($query->getSql(), $parameters, 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 object $entity
     *
     * @throws \Opulence\QueryBuilders\InvalidQueryException
     */
    public function update($entity)
    {
        assert($entity instanceof Entity, new \InvalidArgumentException());

        $query = (new QueryBuilder())
            ->update(
                'file_downloads',
                'file_downloads',
                [
                    'file_id'       => [$entity->getFile()->getId(), \PDO::PARAM_STR],
                    'user_id'       => [$entity->getUser()->getId(), \PDO::PARAM_STR],
                    'downloaded_at' => [$entity->getDownloadedAt()->format(Entity::DATE_FORMAT), \PDO::PARAM_STR],
                ]
            )
            ->where('id = ?')
            ->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
     * @throws \Exception
     */
    protected function loadEntity(array $hash)
    {
        $file         = new File($hash['file_id'], $hash['filesystem_name'], $hash['public_name'], $hash['mime'], '');
        $userLanguage = new UserLanguage('', '', '');
        $user         = new User(
            $hash['user_id'],
            $hash['username'],
            '',
            '',
            true,
            true,
            $userLanguage
        );

        return new Entity(
            $hash['id'],
            $file,
            $user,
            new \DateTime($hash['downloaded_at'])
        );
    }

    /**
     * @return SelectQuery
     */
    private function getBaseQuery()
    {
        /** @var SelectQuery $query */
        $query = (new QueryBuilder())
            ->select(
                'file_downloads.id',
                'file_downloads.file_id',
                'file_downloads.user_id',
                'file_downloads.downloaded_at',
                'files.filesystem_name AS filesystem_name',
                'files.public_name AS public_name',
                'files.mime AS mime',
                'users.username AS username'
            )
            ->from('file_downloads')
            ->innerJoin(
                'files',
                'files',
                'files.id=file_downloads.file_id'
            )
            ->innerJoin(
                'users',
                'users',
                'users.id=file_downloads.user_id'
            )
            ->where('file_downloads.deleted_at IS NULL');

        return $query;
    }
}