com\setasign\Konquadrat\Object

Selector Class Selector

File: /Konquadrat/src/Object/Selector.php

Class hierarchy

Summary

Constants

COMPARE_BITWISE_AND

public const Selector::COMPARE_BITWISE_AND = '&'

COMPARE_EQUAL

public const Selector::COMPARE_EQUAL = '='

COMPARE_GREATER

public const Selector::COMPARE_GREATER = '>'

COMPARE_GREATER_EQUAL

public const Selector::COMPARE_GREATER_EQUAL = '>='

COMPARE_IN

public const Selector::COMPARE_IN = 'IN'

COMPARE_LIKE

public const Selector::COMPARE_LIKE = 'LIKE'

COMPARE_LOWER

public const Selector::COMPARE_LOWER = '<'

COMPARE_LOWER_EQUAL

public const Selector::COMPARE_LOWER_EQUAL = '<='

COMPARE_NOT_IN

public const Selector::COMPARE_NOT_IN = 'NOT IN'

COMPARE_NOT_LIKE

public const Selector::COMPARE_NOT_LIKE = 'NOT LIKE'

COMPARE_UNEQUAL

public const Selector::COMPARE_UNEQUAL = '!='

CONDITION_AND

public const Selector::CONDITION_AND = 'AND'

CONDITION_AND_PARENTHESE_OPEN

public const Selector::CONDITION_AND_PARENTHESE_OPEN = 'AND ('

CONDITION_OR

public const Selector::CONDITION_OR = 'OR'

CONDITION_OR_PARENTHESE_OPEN

public const Selector::CONDITION_OR_PARENTHESE_OPEN = 'OR ('

CONDITION_PARENTHESE_CLOSE

ORDER_ASCENDING

public const Selector::ORDER_ASCENDING = 'ASC'

ORDER_DESCENDING

public const Selector::ORDER_DESCENDING = 'DESC'

Properties

$filter

protected array Selector::$filter = array()

$ignoreShowDeletedFlag

protected bool Selector::$ignoreShowDeletedFlag = false

$limit

protected ?array{limit: int, offset?: int} Selector::$limit

$order

protected array Selector::$order = array()

$type

protected Selector::$type

Methods

__construct()

public Selector::__construct (
class-string<T> $type
)
Parameters
$type : class-string<T>
 

checkAndResolveField()

protected Selector::checkAndResolveField (
ObjectConfig $objectConfig,
\com\setasign\Konquadrat\LanguageManager $languageManager,
string $fieldName
): string

Checks whether the field exists and resolves multiLang fields.

Parameters
$objectConfig : ObjectConfig
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$fieldName : string
 

checkComparatorAndValue()

protected Selector::checkComparatorAndValue (
string $comparator,
mixed $value
): void
Parameters
$comparator : string
 
$value : mixed
 

getFilter()

public Selector::getFilter (
ObjectConfig $objectConfig,
\com\setasign\Konquadrat\LanguageManager $languageManager
): array
Parameters
$objectConfig : ObjectConfig
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 

getIgnoreShowDeletedFlag()

public Selector::getIgnoreShowDeletedFlag (
void
): bool

getLimit()

public Selector::getLimit (
void
): ?array

getOrder()

public Selector::getOrder (
ObjectConfig $objectConfig,
\com\setasign\Konquadrat\LanguageManager $languageManager
): array
Parameters
$objectConfig : ObjectConfig
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 

getSelectorData()

public Selector::getSelectorData (
ObjectConfig $objectConfig,
\com\setasign\Konquadrat\LanguageManager $languageManager
): array
Parameters
$objectConfig : ObjectConfig
 
$languageManager : \com\setasign\Konquadrat\LanguageManager
 

getType()

public Selector::getType (
ObjectConfig $objectConfig
): string
Parameters
$objectConfig : ObjectConfig
 

hasOrder()

public Selector::hasOrder (
void
): bool

limit()

public Selector::limit (
int $limit,
?int $offset = null
): self
Parameters
$limit : int
 
$offset : ?int
 

orderBy()

public Selector::orderBy (
string $fieldName,
string $direction = 'ASC'
): self
Parameters
$fieldName : string
 
$direction : string
 

resetLimit()

public Selector::resetLimit (
void
): self

resolveField()

protected Selector::resolveField (
\com\setasign\Konquadrat\LanguageManager $languageManager,
array $fields,
string $fieldName
): string
Parameters
$languageManager : \com\setasign\Konquadrat\LanguageManager
 
$fields : array
 
$fieldName : string
 

setIgnoreShowDeletedFlag()

public Selector::setIgnoreShowDeletedFlag (
bool $ignoreShowDeletedFlag = true
): self

Set this on true to always filter deleted objects no matter whether the showDeletedFlag is set.

Parameters
$ignoreShowDeletedFlag : bool
 

where()

public Selector::where (
string $fieldName,
string $comparator,
$value
): self
Parameters
$fieldName : string
 
$comparator : string
 
$value
 

whereOr()

public Selector::whereOr (
string $fieldName,
string $comparator,
$value
): self
Parameters
$fieldName : string
 
$comparator : string
 
$value
 

whereOrParentheseOpen()

whereParentheseClose()

whereParentheseOpen()