XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
CriteriaElement Class Reference
Inheritance diagram for CriteriaElement:
Criteria CriteriaCompo

Public Member Functions

 __construct ()
 
 render ()
 
 hasChildElements ()
 
 getCountChildElements ()
 
 getChildElement ($idx)
 
 getCondition ($idx)
 
 getName ()
 
 getValue ()
 
 getOperator ()
 
 setSort ($sort, $order=null)
 
 addSort ($sort, $order='ASC')
 
 getSort ()
 
 getSorts ()
 
 setOrder ($order)
 
 getOrder ()
 
 setLimit ($limit=0)
 
 getLimit ()
 
 setStart ($start=0)
 
 getStart ()
 
 setGroupby ($group)
 
 getGroupby ()
 

Data Fields

 $order = []
 
 $sort = []
 
 $limit = 0
 
 $start = 0
 
 $groupby = ''
 

Detailed Description

Definition at line 23 of file criteria.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Constructor

Definition at line 56 of file criteria.php.

Member Function Documentation

◆ addSort()

addSort ( $sort,
$order = 'ASC' )

Add sort and order condition to this object.

Parameters
$sort
string$order

Definition at line 145 of file criteria.php.

◆ getChildElement()

getChildElement ( $idx)

Return child element.

Parameters
$idx
Returns
null

Reimplemented in CriteriaCompo.

Definition at line 86 of file criteria.php.

◆ getCondition()

getCondition ( $idx)

Return condition string.

Parameters
$idx
Returns
null

Reimplemented in CriteriaCompo.

Definition at line 96 of file criteria.php.

◆ getCountChildElements()

getCountChildElements ( )

Definition at line 76 of file criteria.php.

◆ getGroupby()

getGroupby ( )
Returns
string
Deprecated

Definition at line 255 of file criteria.php.

◆ getLimit()

getLimit ( )
Returns
int

Definition at line 221 of file criteria.php.

◆ getName()

getName ( )

Definition at line 101 of file criteria.php.

◆ getOperator()

getOperator ( )

Definition at line 111 of file criteria.php.

◆ getOrder()

getOrder ( )
Returns
string

Definition at line 201 of file criteria.php.

◆ getSort()

getSort ( )
Returns
string

Definition at line 158 of file criteria.php.

◆ getSorts()

getSorts ( )

Return sort and order condition as hashmap array.

Returns
array 'sort' ... sort string/key'order' order string.

Definition at line 172 of file criteria.php.

◆ getStart()

getStart ( )
Returns
int

Definition at line 237 of file criteria.php.

◆ getValue()

getValue ( )

Definition at line 106 of file criteria.php.

◆ hasChildElements()

hasChildElements ( )

Return true if this object has child elements.

Reimplemented in CriteriaCompo.

Definition at line 71 of file criteria.php.

◆ render()

render ( )

Render the criteria element

Deprecated

Reimplemented in Criteria, and CriteriaCompo.

Definition at line 64 of file criteria.php.

◆ setGroupby()

setGroupby ( $group)
Parameters
string$group
Deprecated

Definition at line 246 of file criteria.php.

◆ setLimit()

setLimit ( $limit = 0)
Parameters
int$limit

Definition at line 213 of file criteria.php.

◆ setOrder()

setOrder ( $order)
Parameters
string$order
Deprecated

Definition at line 189 of file criteria.php.

◆ setSort()

setSort ( $sort,
$order = null )

#+ Accessor

Parameters
string$sort
string$order

Definition at line 123 of file criteria.php.

◆ setStart()

setStart ( $start = 0)
Parameters
int$start

Definition at line 229 of file criteria.php.

Field Documentation

◆ $groupby

$groupby = ''

Definition at line 51 of file criteria.php.

◆ $limit

$limit = 0

Definition at line 40 of file criteria.php.

◆ $order

$order = []

Definition at line 29 of file criteria.php.

◆ $sort

$sort = []

Definition at line 34 of file criteria.php.

◆ $start

$start = 0

Definition at line 46 of file criteria.php.


The documentation for this class was generated from the following file: