Cycle\Database\Driver\MySQL\Query\Traits\WhereJsonTrait

Complexity

Total Complexity

18

Size/Duplication

Total Lines	258
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	andWhereJson()	0	3	1
A	whereJsonContains()	0	10	1
A	orWhereJsonContains()	0	10	1
A	orWhereJsonDoesntContainKey()	0	10	1
A	whereJsonDoesntContainKey()	0	10	1
A	whereJson()	0	10	1
A	orWhereJson()	0	10	1
A	andWhereJsonLength()	0	3	1
A	andWhereJsonDoesntContainKey()	0	3	1
A	orWhereJsonDoesntContain()	0	14	1
A	orWhereJsonContainsKey()	0	10	1
A	andWhereJsonContainsKey()	0	3	1
A	andWhereJsonContains()	0	3	1
A	whereJsonContainsKey()	0	10	1
A	orWhereJsonLength()	0	10	1
A	whereJsonLength()	0	10	1
A	andWhereJsonDoesntContain()	0	7	1
A	whereJsonDoesntContain()	0	14	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\MySQL\Query\Traits;

use Cycle\Database\Driver\Jsoner;
use Cycle\Database\Driver\MySQL\Injection\CompileJson;
use Cycle\Database\Driver\MySQL\Injection\CompileJsonContains;
use Cycle\Database\Driver\MySQL\Injection\CompileJsonContainsKey;
use Cycle\Database\Driver\MySQL\Injection\CompileJsonDoesntContain;
use Cycle\Database\Driver\MySQL\Injection\CompileJsonDoesntContainKey;
use Cycle\Database\Driver\MySQL\Injection\CompileJsonLength;

/**
 * @internal
 *
 * @psalm-internal Cycle\Database\Driver\MySQL
 */
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): self
    {
        $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 andWhereJson(string $column, mixed $value): self
    {
        return $this->whereJson($column, $value);
    }

    /**
     * @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): self
    {
        $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 Checking the value that it is valid JSON.
     */
    public function whereJsonContains(string $column, mixed $value, bool $encode = true, bool $validate = true): self
    {
        $this->registerToken(
            'AND',
            [new CompileJsonContains($column, Jsoner::toJson($value, $encode, $validate))],
            $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 Checking the value that it is valid JSON.
     */
    public function andWhereJsonContains(string $column, mixed $value, bool $encode = true, bool $validate = true): self
    {
        return $this->whereJsonContains($column, $value, $encode, $validate);
    }

    /**
     * @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 Checking the value that it is valid JSON.
     */
    public function orWhereJsonContains(string $column, mixed $value, bool $encode = true, bool $validate = true): self
    {
        $this->registerToken(
            'OR',
            [new CompileJsonContains($column, Jsoner::toJson($value, $encode, $validate))],
            $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 Checking the value that it is valid JSON.
     */
    public function whereJsonDoesntContain(
        string $column,
        mixed $value,
        bool $encode = true,
        bool $validate = true
    ): self {
        $this->registerToken(
            'AND',
            [new CompileJsonDoesntContain($column, Jsoner::toJson($value, $encode, $validate))],
            $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 Checking the value that it is valid JSON.
     */
    public function andWhereJsonDoesntContain(
        string $column,
        mixed $value,
        bool $encode = true,
        bool $validate = true
    ): self {
        return $this->whereJsonDoesntContain($column, $value, $encode, $validate);
    }

    /**
     * @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 Checking the value that it is valid JSON.
     */
    public function orWhereJsonDoesntContain(
        string $column,
        mixed $value,
        bool $encode = true,
        bool $validate = true
    ): self {
        $this->registerToken(
            'OR',
            [new CompileJsonDoesntContain($column, Jsoner::toJson($value, $encode, $validate))],
            $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 whereJsonContainsKey(string $column): self
    {
        $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 andWhereJsonContainsKey(string $column): self
    {
        return $this->whereJsonContainsKey($column);
    }

    /**
     * @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): self
    {
        $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): self
    {
        $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 andWhereJsonDoesntContainKey(string $column): self
    {
        return $this->whereJsonDoesntContainKey($column);
    }

    /**
     * @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): self
    {
        $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 = '='): self
    {
        $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 andWhereJsonLength(string $column, int $length, string $operator = '='): self
    {
        return $this->whereJsonLength($column, $length, $operator);
    }

    /**
     * @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 = '='): self
    {
        $this->registerToken(
            'OR',
            [new CompileJsonLength($column, $length, $operator)],
            $this->whereTokens,
            $this->whereWrapper()
        );

        return $this;
    }
}