phpDocumentor

SearchConditionSettings
in package
implements SearchConditionSettingsInterface Uses SearchConditionStrategyTrait

Class SearchConditionSettings

Interfaces, Classes and Traits

SearchConditionSettingsInterface
Interface SearchConditionSettingsInterface

Table of Contents

$allowedColumns  : array<string|int, mixed>
$allowedTables  : array<string|int, mixed>
$strategies  : array<string|int, mixed>
__construct()  : mixed
SearchConditionSettings constructor.
allowedColumns()  : array<string|int, mixed>
Returns the allowed columns as an array.
allowedTables()  : array<string|int, mixed>
Returns the tables as an array.
create()  : self
Return a new object of this class.
strategies()  : array<string|int, mixed>
Returns the strategies as an array.
getAttribute()  : string
Determines the sql attribute and returns it.
getValue()  : string
Determines the sql value and returns it.

Properties

Methods

__construct()

SearchConditionSettings constructor.

public __construct(array<string|int, mixed> $strategies, array<string|int, mixed> $allowedColumns, array<string|int, mixed> $allowedTables) : mixed
Parameters
$strategies : array<string|int, mixed>
$allowedColumns : array<string|int, mixed>
$allowedTables : array<string|int, mixed>
Return values
mixed

allowedColumns()

Returns the allowed columns as an array.

public allowedColumns() : array<string|int, mixed>
Return values
array<string|int, mixed>

allowedTables()

Returns the tables as an array.

public allowedTables() : array<string|int, mixed>
Return values
array<string|int, mixed>

create()

Return a new object of this class.

public static create([array<string|int, mixed>|null $allowedColumns = null ][, array<string|int, mixed>|null $allowedTables = null ][, array<string|int, mixed>|null $strategies = null ]) : self
Parameters
$allowedColumns : array<string|int, mixed>|null = null
$allowedTables : array<string|int, mixed>|null = null
$strategies : array<string|int, mixed>|null = null
Return values
self

strategies()

Returns the strategies as an array.

public strategies() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAttribute()

Determines the sql attribute and returns it.

protected getAttribute(array<string|int, mixed> $params, array<string|int, mixed> $allowedColumns, array<string|int, mixed> $allowedTables) : string
Parameters
$params : array<string|int, mixed>
$allowedColumns : array<string|int, mixed>
$allowedTables : array<string|int, mixed>
Tags
throws
InvalidSearchConditionException

If given column or table is not allowed.

Return values
string

getValue()

Determines the sql value and returns it.

protected getValue(array<string|int, mixed> $params) : string

Notice: RangeStrategy and InStrategy have their own implementation.

Parameters
$params : array<string|int, mixed>
Return values
string

Search results