Heratio Framework API Reference

Criteria
in package

Table of Contents

Constants

ASC  = 'ASC'
DESC  = 'DESC'
EQUAL  = '='
GREATER_EQUAL  = '>='
GREATER_THAN  = '>'
IN  = 'IN'
ISNOTNULL  = 'IS NOT NULL'
ISNULL  = 'IS NULL'
LESS_EQUAL  = '<='
LESS_THAN  = '<'
LIKE  = 'LIKE'
NOT_EQUAL  = '!='
NOT_IN  = 'NOT IN'
NOT_LIKE  = 'NOT LIKE'

Methods

add()  : self
Add a WHERE condition.
addAscendingOrderByColumn()  : self
Add ascending order by column.
addCriterion()  : self
Add a criterion (from getNewCriterion) to this Criteria.
addDescendingOrderByColumn()  : self
Add descending order by column.
addJoin()  : self
Add a JOIN clause.
addOr()  : self
Add an OR criterion group.
addSelectColumn()  : self
Add select columns (Propel pattern).
clearSelectColumns()  : self
Clear select columns.
getBaseTable()  : string
Get the base table name (inferred from conditions/joins).
getLimit()  : int|null
Get the limit.
getNewCriterion()  : CriterionStub
Create a new CriterionStub for OR grouping.
getOffset()  : int|null
Get the offset.
resolveColumn()  : array<string|int, mixed>
Resolve a Propel column constant (e.g. 'actor_i18n.authorized_form_of_name') into [table, column].
setLimit()  : self
Set the maximum number of rows to return.
setOffset()  : self
Set the offset.
toQueryBuilder()  : Builder
Build a Laravel Query Builder from accumulated state.

Constants

GREATER_EQUAL

public mixed GREATER_EQUAL = '>='

GREATER_THAN

public mixed GREATER_THAN = '>'

ISNOTNULL

public mixed ISNOTNULL = 'IS NOT NULL'

LESS_EQUAL

public mixed LESS_EQUAL = '<='

NOT_LIKE

public mixed NOT_LIKE = 'NOT LIKE'

Methods

add()

Add a WHERE condition.

public add(string $column[, mixed $value = null ][, string $operator = self::EQUAL ]) : self
Parameters
$column : string

Propel column constant (e.g. 'actor_i18n.authorized_form_of_name')

$value : mixed = null

Value to compare against

$operator : string = self::EQUAL

Comparison operator

Return values
self

addAscendingOrderByColumn()

Add ascending order by column.

public addAscendingOrderByColumn(string $column) : self
Parameters
$column : string

Propel column constant

Return values
self

addCriterion()

Add a criterion (from getNewCriterion) to this Criteria.

public addCriterion(CriterionStub $criterion) : self

Adds it as a WHERE condition, respecting any OR chain.

Parameters
$criterion : CriterionStub
Return values
self

addDescendingOrderByColumn()

Add descending order by column.

public addDescendingOrderByColumn(string $column) : self
Parameters
$column : string

Propel column constant

Return values
self

addJoin()

Add a JOIN clause.

public addJoin(string $leftCol, string $rightCol) : self
Parameters
$leftCol : string

Left column (e.g. 'actor.id')

$rightCol : string

Right column (e.g. 'actor_i18n.id')

Return values
self

addSelectColumn()

Add select columns (Propel pattern).

public addSelectColumn(string $column) : self
Parameters
$column : string

Propel column constant

Return values
self

clearSelectColumns()

Clear select columns.

public clearSelectColumns() : self
Return values
self

getBaseTable()

Get the base table name (inferred from conditions/joins).

public getBaseTable() : string
Return values
string

getLimit()

Get the limit.

public getLimit() : int|null
Return values
int|null

getNewCriterion()

Create a new CriterionStub for OR grouping.

public getNewCriterion(string $column, mixed $value[, string $operator = self::EQUAL ]) : CriterionStub
Parameters
$column : string

Propel column constant

$value : mixed

Value

$operator : string = self::EQUAL

Comparison operator

Return values
CriterionStub

getOffset()

Get the offset.

public getOffset() : int|null
Return values
int|null

resolveColumn()

Resolve a Propel column constant (e.g. 'actor_i18n.authorized_form_of_name') into [table, column].

public static resolveColumn(string $propelColumn) : array<string|int, mixed>
Parameters
$propelColumn : string
Return values
array<string|int, mixed> —

[table, column]

setLimit()

Set the maximum number of rows to return.

public setLimit(int $limit) : self
Parameters
$limit : int
Return values
self

setOffset()

Set the offset.

public setOffset(int $offset) : self
Parameters
$offset : int
Return values
self

toQueryBuilder()

Build a Laravel Query Builder from accumulated state.

public toQueryBuilder() : Builder

The base table is determined by: (1) the left side of the first join, or (2) the first add() column's table if no joins exist.

Return values
Builder 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results