WebServCo\Framework\Traits\DatabaseTrait

Complexity

Total Complexity

10

Size/Duplication

Total Lines	116
Duplicated Lines	0 %

Importance

Changes	9
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	valueExists()	0	9	1
A	insertIgnore()	0	3	1
A	insert()	0	3	1
A	add()	0	19	4
A	replace()	0	3	1
A	tableExists()	0	9	2

<?php

declare(strict_types=1);

namespace WebServCo\Framework\Traits;

use WebServCo\Framework\Database\QueryType;

trait DatabaseTrait
{
    abstract public function escapeIdentifier(string $string): string;

    abstract public function escapeTableName(string $string): string;

    /**
    * @param array<int,float|int|string> $params
    * @return bool|int|string|null
    */
    abstract public function getColumn(string $query, array $params = [], int $columnNumber = 0);

    /**
    * @param array<int,float|int|string|null> $params
    */
    abstract public function query(string $query, array $params = []): \PDOStatement;

    /**
    * @param array<int,array<int,mixed>> $queries
    */
    abstract public function transaction(array $queries): int;

    /**
    * @param array<string,float|int|string|null> $addData
    * @param array<string,float|int|string|null> $updateData
    */
    abstract protected function generateAddQuery(
        string $queryType,
        string $tableName,
        array $addData = [],
        array $updateData = []
    ): string;

    /**
    * @param array<mixed> $addData
    * @param array<mixed> $updateData
    *
    * Returns lastInsertId
    */
    final public function insert(string $tableName, array $addData = [], array $updateData = []): int
    {
        return $this->add(QueryType::INSERT, $tableName, $addData, $updateData);
    }

    /**
    * @param array<mixed> $data
    *
    * Returns lastInsertId
    */
    final public function insertIgnore(string $tableName, array $data = []): int
    {
        return $this->add(QueryType::INSERT_IGNORE, $tableName, $data);
    }

    /**
    * @param array<mixed> $data
    *
    * Returns lastInsertId
    */
    final public function replace(string $tableName, array $data = []): int
    {
        return $this->add(QueryType::REPLACE, $tableName, $data);
    }

    /**
    * @param float|int|string $value
    */
    final public function valueExists(string $table, string $field, $value): bool
    {
        return (bool) $this->getColumn(
            \sprintf(
                "SELECT 1 FROM %s WHERE %s = ? LIMIT 1",
                $this->escapeTableName($table),
                $this->escapeIdentifier($field),
            ),
            [$value],
        );
    }

    final public function tableExists(string $table): bool
    {
        $name = $this->escapeTableName($table);

        try {
            $this->query(\sprintf('SELECT 1 FROM %s LIMIT 1', $name));
            return true;
        } catch (\WebServCo\Framework\Exceptions\DatabaseException $e) {
            return false;
        }
    }

    /**
    * @param array<mixed> $addData
    * @param array<mixed> $updateData
    *
    * Returns lastInsertId
    */
    final protected function add(string $queryType, string $tableName, array $addData = [], array $updateData = []): int
    {
        if (!$tableName) {
            throw new \WebServCo\Framework\Exceptions\ApplicationException('No data specified.');
        }

        $query = $this->generateAddQuery($queryType, $tableName, $addData, $updateData);

        $queryData = [];
        foreach ($addData as $item) {
            $queryData[] = $item;
        }
        foreach ($updateData as $item) {
            $queryData[] = $item;
        }

        return $this->transaction(
            [
                [$query, $queryData], // item
            ], // array
        );
    }
}