Documentation

ArrayRangeOperators

Trait to represent array range operators.

Table of Contents

Methods

adj()  : PostgrestRequestBuilder
Adjacent operator.
cd()  : PostgrestRequestBuilder
Contained in operator.
cs()  : PostgrestRequestBuilder
Contains operator.
nxl()  : PostgrestRequestBuilder
Not extend to left of operator.
nxr()  : PostgrestRequestBuilder
Not extend to right of operator.
ov()  : PostgrestRequestBuilder
Overlap operator.
sl()  : PostgrestRequestBuilder
Strictly left of operator.
sr()  : PostgrestRequestBuilder
Strictly right of operator.
arrayHelper()  : PostgrestRequestBuilder
Array operator helper.
rangeHelper()  : PostgrestRequestBuilder
Range operator helper.

Methods

adj()

Adjacent operator.

public adj(string $columnName, int|float $start, int|float $end) : PostgrestRequestBuilder
Parameters
$columnName : string

The name of the column.

$start : int|float

The start value to use.

$end : int|float

The end value to use.

Tags
throws
NotUnifiedValuesException

If the start and end types are not unified.

link
https://postgrest.org/en/stable/references/api/tables_views.html#operators
Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

cd()

Contained in operator.

public cd(string $columnName, array<string|int, string>|array<string|int, int>|array<string|int, float> $value) : PostgrestRequestBuilder
Parameters
$columnName : string

The name of the column.

$value : array<string|int, string>|array<string|int, int>|array<string|int, float>

The value to use.

Tags
throws
NotUnifiedValuesException

If the value types are not unified.

link
https://postgrest.org/en/stable/references/api/tables_views.html#operators
Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

cs()

Contains operator.

public cs(string $columnName, array<string|int, string>|array<string|int, int>|array<string|int, float> $value) : PostgrestRequestBuilder
Parameters
$columnName : string

The name of the column.

$value : array<string|int, string>|array<string|int, int>|array<string|int, float>

The value to use.

Tags
throws
NotUnifiedValuesException

If the value types are not unified.

link
https://postgrest.org/en/stable/references/api/tables_views.html#operators
Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

nxl()

Not extend to left of operator.

public nxl(string $columnName, int|float $start, int|float $end) : PostgrestRequestBuilder
Parameters
$columnName : string

The name of the column.

$start : int|float

The start value to use.

$end : int|float

The end value to use.

Tags
throws
NotUnifiedValuesException

If the start and end types are not unified.

link
https://postgrest.org/en/stable/references/api/tables_views.html#operators
Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

nxr()

Not extend to right of operator.

public nxr(string $columnName, int|float $start, int|float $end) : PostgrestRequestBuilder
Parameters
$columnName : string

The name of the column.

$start : int|float

The start value to use.

$end : int|float

The end value to use.

Tags
throws
NotUnifiedValuesException

If the start and end types are not unified.

link
https://postgrest.org/en/stable/references/api/tables_views.html#operators
Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

ov()

Overlap operator.

public ov(string $columnName, OverlapType $overlapType, string|int|float ...$value) : PostgrestRequestBuilder
Parameters
$columnName : string

The name of the column.

$overlapType : OverlapType

The type of overlap to use

$value : string|int|float

Values for overlap operation

Tags
throws
NotUnifiedValuesException

If the value types are not unified.

link
https://postgrest.org/en/stable/references/api/tables_views.html#operators
Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

sl()

Strictly left of operator.

public sl(string $columnName, int|float $start, int|float $end) : PostgrestRequestBuilder
Parameters
$columnName : string

The name of the column.

$start : int|float

The start value to use.

$end : int|float

The end value to use.

Tags
throws
NotUnifiedValuesException

If the start and end types are not unified.

link
https://postgrest.org/en/stable/references/api/tables_views.html#operators
Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

sr()

Strictly right of operator.

public sr(string $columnName, int|float $start, int|float $end) : PostgrestRequestBuilder
Parameters
$columnName : string

The name of the column.

$start : int|float

The start value to use.

$end : int|float

The end value to use.

Tags
throws
NotUnifiedValuesException

If the start and end types are not unified.

link
https://postgrest.org/en/stable/references/api/tables_views.html#operators
Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

arrayHelper()

Array operator helper.

private arrayHelper(Operator $op, string $columnName, array<string|int, string>|array<string|int, int>|array<string|int, float> $value, array<string|int, string> $braces) : PostgrestRequestBuilder

Prevents code duplication.

Parameters
$op : Operator

The operator to use.

$columnName : string

The name of the column.

$value : array<string|int, string>|array<string|int, int>|array<string|int, float>

The value to use.

$braces : array<string|int, string>

The braces to use.

Tags
throws
NotUnifiedValuesException

If the value types are not unified.

Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.

rangeHelper()

Range operator helper.

private rangeHelper(Operator $op, string $columnName, int|float $start, int|float $end) : PostgrestRequestBuilder

Prevents code duplication.

Parameters
$op : Operator

The operator to use.

$columnName : string

The name of the column.

$start : int|float

The start value to use.

$end : int|float

The end value to use.

Tags
throws
NotUnifiedValuesException

If the start and end types are not unified.

Return values
PostgrestRequestBuilder

The PostgrestRequestBuilder instance.


        
On this page

Search results