ellisgl / GeekLab-GLPDO2

src/Bindings/Bindings.php

<?php

namespace GeekLab\GLPDO2\Bindings;

use PDO;
use Exception;
use JsonException;

class Bindings
{
    protected DateTimeBindingInterface $dateTime;
    protected LogicBindingInterface $logic;
    protected NumericBindingInterface $numeric;
    protected RawBindingInterface $raw;
    protected StringBindingInterface $string;

    public function __construct(
        DateTimeBindingInterface $dateTime,
        LogicBindingInterface $logic,
        NumericBindingInterface $numeric,
        RawBindingInterface $raw,
        StringBindingInterface $string
    ) {
        $this->dateTime = $dateTime;
        $this->logic = $logic;
        $this->numeric = $numeric;
        $this->raw = $raw;
        $this->string = $string;
    }

    /**
     * Bind a boolean value as bool, with NULL option.
     *
     * @param bool | int | null $value
     * @param bool              $null
     *
     * @return array{?bool, int}

The doc comment array{?bool, int} at position 2 could not be parsed: Expected ':' at position 2, but found '?bool'.

     * @throws Exception
     */
    public function bBool(bool | int | null $value = null, bool $null = false): array
    {
        return $this->logic->bBool($value, $null);
    }

    /**
     * Bind a boolean value as int, with NULL option.
     *
     * @param bool | int | null $value
     * @param bool              $null
     *
     * @return array{?int, int}

The doc comment array{?int, int} at position 2 could not be parsed: Expected ':' at position 2, but found '?int'.

     * @throws Exception
     */
    public function bBoolInt(bool | int | null $value = null, bool $null = false): array
    {
        return $this->logic->bBoolInt($value, $null);
    }

    /**
     * Bind a date value as date or optional NULL.
     * YYYY-MM-DD is the proper date format.
     *
     * @param string | null $value
     * @param bool          $null
     *
     * @return array{?string, int}

The doc comment array{?string, int} at position 2 could not be parsed: Expected ':' at position 2, but found '?string'.

     * @throws Exception
     */
    public function bDate(?string $value, bool $null = false): array
    {
        return $this->dateTime->bDate($value, $null);
    }

    /**
     * Bind a date value as date time or optional NULL.
     * YYYY-MM-DD HH:MM:SS is the proper date format.
     *
     * @param string | null $value
     * @param bool          $null
     *
     * @return array{?string, int}

The doc comment array{?string, int} at position 2 could not be parsed: Expected ':' at position 2, but found '?string'.

     * @throws Exception
     */
    public function bDateTime(?string $value = null, bool $null = false): array
    {
        return $this->dateTime->bDateTime($value, $null);
    }

    /**
     * Bind a float.
     *
     * @param float | int | string | null $value
     * @param int                         $decimals
     * @param bool                        $null
     *
     * @return array{?string}

The doc comment array{?string} at position 2 could not be parsed: Expected ':' at position 2, but found '?string'.

     * @throws Exception
     */
    public function bFloat(float | int | string | null $value = null, int $decimals = 3, bool $null = false): array
    {
        return $this->numeric->bFloat($value, $decimals, $null);
    }

    /**
     * Bind an integer with optional NULL.
     *
     * @param float | bool | int | string | null $value
     * @param bool                               $null
     *
     * @return array{?int, int}

The doc comment array{?int, int} at position 2 could not be parsed: Expected ':' at position 2, but found '?int'.

     * @throws Exception
     */
    public function bInt(float | bool | int | string | null $value = null, bool $null = false): array
    {
        return $this->numeric->bInt($value, $null);
    }

    /**
     * Convert array of integers to comma separated values. Uses %%
     * Great for IN() statements.
     *
     * @param array{} | array{mixed} $data

The doc comment array{} | array{mixed} at position 6 could not be parsed: Expected ':' at position 6, but found 'mixed'.

     *
     * @return array{int | string}

The doc comment array{int | string} at position 2 could not be parsed: Expected ':' at position 2, but found 'int'.

     * @throws Exception
     */
    public function bIntArray(array $data): array
    {
        return $this->numeric->bIntArray($data);
    }

    /**
     * Bind an object or JSON string to a string
     *
     * @param mixed $value
     * @param bool  $null
     *
     * @return array{string, int}

The doc comment array{string, int} at position 2 could not be parsed: Expected ':' at position 2, but found 'string'.

     * @throws JsonException
     */
    public function bJSON(mixed $value, bool $null = false): array
    {
        return $this->string->bJSON($value, $null);
    }

    /**
     * Create and bind string for LIKE() statements.
     *
     * @param string $value
     * @param bool   $ends   Ends with?
     * @param bool   $starts Starts with?
     *
     * @return array{string}

The doc comment array{string} at position 2 could not be parsed: Expected ':' at position 2, but found 'string'.

     */
    public function bLike(string $value, bool $ends = false, bool $starts = false): array
    {
        return $this->string->bLike($value, $ends, $starts);
    }

    /**
     * !!!DANGER!!!
     * Bind a raw value.
     *
     * @param float | bool | int | string $value
     *
     * @return array{float | bool | int | string}

The doc comment array{float | bool | int | string} at position 2 could not be parsed: Expected ':' at position 2, but found 'float'.

     */
    public function bRaw(float | bool | int | string $value): array
    {
        return $this->raw->bRaw($value);
    }

    /**
     * Bind a string value.
     *
     * @param float | bool | int | string | null $value
     * @param bool                               $null
     * @param int                                $type
     *
     * @return array{string, int}

The doc comment array{string, int} at position 2 could not be parsed: Expected ':' at position 2, but found 'string'.

     * @throws Exception
     */
    public function bStr(
        float | bool | int | string | null $value,
        bool $null = false,
        int $type = PDO::PARAM_STR
    ): array {
        return $this->string->bStr($value, $null, $type);
    }

    /**
     * Convert an array into a string and bind it.
     * Great for IN() statements.
     *
     * @param array{} | array{mixed}      $values

The doc comment array{} | array{mixed} at position 6 could not be parsed: Expected ':' at position 6, but found 'mixed'.

     * @param float | bool | int | string $default
     *
     * @return array{float | bool | int | string}

The doc comment array{float | bool | int | string} at position 2 could not be parsed: Expected ':' at position 2, but found 'float'.

     */
    public function bStrArr(array $values, float | bool | int | string $default = ''): array
    {
        return $this->string->bStrArr($values, $default);
    }
}