abterphp / admin

src/Orm/DataMappers/TokenSqlDataMapper.php

<?php

declare(strict_types=1);

namespace AbterPhp\Admin\Orm\DataMappers;

use AbterPhp\Admin\Domain\Entities\Token as Entity;
use AbterPhp\Framework\Domain\Entities\IStringerEntity;
use DateTimeImmutable;
use Exception;
use Opulence\Orm\DataMappers\SqlDataMapper;
use Opulence\Orm\OrmException;
use Opulence\QueryBuilders\Expression;
use Opulence\QueryBuilders\InvalidQueryException;
use Opulence\QueryBuilders\MySql\QueryBuilder;
use Opulence\QueryBuilders\SelectQuery;

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

        $revokedAtTye = $entity->getRevokedAt() === null ? \PDO::PARAM_NULL : \PDO::PARAM_STR;

        $query = (new QueryBuilder())
            ->insert(
                'tokens',
                [
                    'id'            => [$entity->getId(), \PDO::PARAM_STR],
                    'api_client_id' => [$entity->getApiClientId(), \PDO::PARAM_STR],
                    'expires_at'    => [$entity->getExpiresAt(), \PDO::PARAM_STR],
                    'revoked_at'    => [$entity->getRevokedAt(), $revokedAtTye],
                ]
            );

        $statement = $this->writeConnection->prepare($query->getSql());
        $statement->bindValues($query->getParameters());
        $statement->execute();
    }

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

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

        $statement = $this->writeConnection->prepare($query->getSql());
        $statement->bindValues($query->getParameters());
        $statement->execute();
    }

    /**
     * @return Entity[]
     * @throws 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|string $id
     *
     * @return Entity|null
     * @throws OrmException
     */
    public function getById($id): ?Entity
    {
        $query = $this->getBaseQuery()->andWhere('tokens.id = :token_id');

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

        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 which is incompatible with the type-hinted return AbterPhp\Admin\Domain\Entities\Token|null. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param string $clientId
     *
     * @return Entity|null
     * @throws OrmException
     */
    public function getByClientId(string $clientId): ?Entity
    {
        $query = $this->getBaseQuery()->andWhere('tokens.api_client_id = :api_client_id');

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

        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 which is incompatible with the type-hinted return AbterPhp\Admin\Domain\Entities\Token|null. Consider adding an additional type-check to rule them out.

    }

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

        $revokedAtTye = $entity->getRevokedAt() === null ? \PDO::PARAM_NULL : \PDO::PARAM_STR;

        $query = (new QueryBuilder())
            ->update(
                'tokens',
                'tokens',
                [
                    'api_client_id' => [$entity->getApiClientId(), \PDO::PARAM_STR],
                    'expires_at'    => [$entity->getExpiresAt(), \PDO::PARAM_STR],
                    'revoked_at'    => [$entity->getRevokedAt(), $revokedAtTye],
                ]
            )
            ->where('id = ?')
            ->addUnnamedPlaceholderValue($entity->getId(), \PDO::PARAM_STR);

        $statement = $this->writeConnection->prepare($query->getSql());
        $statement->bindValues($query->getParameters());
        $statement->execute();
    }

    /**
     * @param array $data
     *
     * @return Entity
     * @throws Exception
     */
    protected function loadEntity(array $data): Entity
    {
        $expiresAt = new DateTimeImmutable($data['expires_at']);
        $revokedAt = null;
        if (null !== $data['revoked_at']) {
            $revokedAt = new DateTimeImmutable($data['revoked_at']);
        }

        return new Entity(
            $data['id'],
            $data['api_client_id'],
            $expiresAt,
            $revokedAt
        );
    }

    /**
     * @return SelectQuery
     */
    private function getBaseQuery(): SelectQuery
    {
        return (new QueryBuilder())
            ->select(
                'tokens.id',
                'tokens.api_client_id',
                'tokens.expires_at',
                'tokens.revoked_at'
            )
            ->from('tokens')
            ->where('tokens.deleted_at IS NULL');
    }
}