Cycle\Database\Driver\SQLite\Query\Traits\WhereJsonTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Importance

Changes	5
Bugs	2	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	whereJson()	0	10	1
A	orWhereJsonDoesntContain()	0	7	1
A	orWhereJsonLength()	0	10	1
A	orWhereJsonContains()	0	7	1
A	whereJsonDoesntContainKey()	0	10	1
A	whereJsonDoesntContain()	0	7	1
A	whereJsonContainsKey()	0	10	1
A	orWhereJson()	0	10	1
A	whereJsonContains()	0	3	1
A	whereJsonLength()	0	10	1
A	orWhereJsonContainsKey()	0	10	1
A	orWhereJsonDoesntContainKey()	0	10	1

<?php

/**
 * This file is part of Cycle ORM package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Cycle\Database\Driver\SQLite\Query\Traits;

use Cycle\Database\Driver\SQLite\Injection\CompileJson;
use Cycle\Database\Driver\SQLite\Injection\CompileJsonContainsKey;
use Cycle\Database\Driver\SQLite\Injection\CompileJsonDoesntContainKey;
use Cycle\Database\Driver\SQLite\Injection\CompileJsonLength;
use Cycle\Database\Exception\DriverException;

/**
 * @internal
 *
 * @psalm-internal Cycle\Database\Driver\SQLite
 */
trait WhereJsonTrait
{
    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function whereJson(string $column, mixed $value): static
    {
        $this->registerToken(

It seems like registerToken() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            'AND',
            [new CompileJson($column), $value],
            $this->whereTokens,
            $this->whereWrapper()

It seems like whereWrapper() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        );

        return $this;
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function orWhereJson(string $column, mixed $value): static
    {
        $this->registerToken(
            'OR',
            [new CompileJson($column), $value],
            $this->whereTokens,
            $this->whereWrapper()
        );

        return $this;
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param bool $encode Encode the value into JSON.
     * @param bool $validate Check that $value is a valid JSON string if the $encode parameter is false.
     */
    public function whereJsonContains(string $column, mixed $value, bool $encode = true, bool $validate = true): static

The parameter $validate is not used and could be removed.

The parameter $column is not used and could be removed.

The parameter $value is not used and could be removed.

The parameter $encode is not used and could be removed.

    {
        throw new DriverException('This database engine does not support JSON contains operations.');
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param bool $encode Encode the value into JSON.
     * @param bool $validate Check that $value is a valid JSON string if the $encode parameter is false.
     */
    public function orWhereJsonContains(
        string $column,

The parameter $column is not used and could be removed.

        mixed $value,

The parameter $value is not used and could be removed.

        bool $encode = true,

The parameter $encode is not used and could be removed.

        bool $validate = true

The parameter $validate is not used and could be removed.

    ): static {
        throw new DriverException('This database engine does not support JSON contains operations.');
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param bool $encode Encode the value into JSON.
     * @param bool $validate Check that $value is a valid JSON string if the $encode parameter is false.
     */
    public function whereJsonDoesntContain(
        string $column,

The parameter $column is not used and could be removed.

        mixed $value,

The parameter $value is not used and could be removed.

        bool $encode = true,

The parameter $encode is not used and could be removed.

        bool $validate = true

The parameter $validate is not used and could be removed.

    ): static {
        throw new DriverException('This database engine does not support JSON contains operations.');
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param bool $encode Encode the value into JSON.
     * @param bool $validate Check that $value is a valid JSON string if the $encode parameter is false.
     */
    public function orWhereJsonDoesntContain(
        string $column,

The parameter $column is not used and could be removed.

        mixed $value,

The parameter $value is not used and could be removed.

        bool $encode = true,

The parameter $encode is not used and could be removed.

        bool $validate = true

The parameter $validate is not used and could be removed.

    ): static {
        throw new DriverException('This database engine does not support JSON contains operations.');
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function whereJsonContainsKey(string $column): static
    {
        $this->registerToken(
            'AND',
            [new CompileJsonContainsKey($column)],
            $this->whereTokens,
            $this->whereWrapper()
        );

        return $this;
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function orWhereJsonContainsKey(string $column): static
    {
        $this->registerToken(
            'OR',
            [new CompileJsonContainsKey($column)],
            $this->whereTokens,
            $this->whereWrapper()
        );

        return $this;
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function whereJsonDoesntContainKey(string $column): static
    {
        $this->registerToken(
            'AND',
            [new CompileJsonDoesntContainKey($column)],
            $this->whereTokens,
            $this->whereWrapper()
        );

        return $this;
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function orWhereJsonDoesntContainKey(string $column): static
    {
        $this->registerToken(
            'OR',
            [new CompileJsonDoesntContainKey($column)],
            $this->whereTokens,
            $this->whereWrapper()
        );

        return $this;
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param int<0, max> $length
     * @param non-empty-string $operator
     */
    public function whereJsonLength(string $column, int $length, string $operator = '='): static
    {
        $this->registerToken(
            'AND',
            [new CompileJsonLength($column, $length, $operator)],
            $this->whereTokens,
            $this->whereWrapper()
        );

        return $this;
    }

    /**
     * @param non-empty-string $column

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param int<0, max> $length
     * @param non-empty-string $operator
     */
    public function orWhereJsonLength(string $column, int $length, string $operator = '='): static
    {
        $this->registerToken(
            'OR',
            [new CompileJsonLength($column, $length, $operator)],
            $this->whereTokens,
            $this->whereWrapper()
        );

        return $this;
    }
}