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

Public Member Functions

 __construct ($ele=null, $condition='AND')
 
 hasChildElements ()
 
 getCountChildElements ()
 
 getChildElement ($idx)
 
 getCondition ($idx)
 
add ($criteriaElement, $condition='AND')
 
 render ()
 
 renderWhere ()
 
 renderLdap ()
 
- Public Member Functions inherited from CriteriaElement
 __construct ()
 
 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

 $criteriaElements = []
 
 $conditions = []
 
- Data Fields inherited from CriteriaElement
 $order = []
 
 $sort = []
 
 $limit = 0
 
 $start = 0
 
 $groupby = ''
 

Detailed Description

Collection of multiple CriteriaElements

Definition at line 266 of file criteria.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $ele = null,
$condition = 'AND' )

Constructor

Parameters
object$ele
string$condition

Definition at line 287 of file criteria.php.

Member Function Documentation

◆ add()

& add ( $criteriaElement,
$condition = 'AND' )

Add an element

Parameters
object&$criteriaElement
string$condition
Returns
object reference to this collection

Definition at line 322 of file criteria.php.

◆ getChildElement()

getChildElement ( $idx)

Return child element.

Parameters
$idx
Returns
null

Reimplemented from CriteriaElement.

Definition at line 304 of file criteria.php.

◆ getCondition()

getCondition ( $idx)

Return condition string.

Parameters
$idx
Returns
null

Reimplemented from CriteriaElement.

Definition at line 309 of file criteria.php.

◆ getCountChildElements()

getCountChildElements ( )

Reimplemented from CriteriaElement.

Definition at line 299 of file criteria.php.

◆ hasChildElements()

hasChildElements ( )

Return true if this object has child elements.

Reimplemented from CriteriaElement.

Definition at line 294 of file criteria.php.

◆ render()

render ( )

Make the criteria into a query string

Returns
string
Deprecated
XoopsObjectGenericHandler\_makeCriteriaElement4sql()

Reimplemented from CriteriaElement.

Definition at line 335 of file criteria.php.

◆ renderLdap()

renderLdap ( )

Generate an LDAP filter from criteria

Returns
string
Author
Nathan Dial ndial.nosp@m.@tri.nosp@m.llion.nosp@m.21.c.nosp@m.om
Deprecated

Definition at line 371 of file criteria.php.

◆ renderWhere()

renderWhere ( )

Make the criteria into a SQL "WHERE" clause

Returns
string
Deprecated

Definition at line 357 of file criteria.php.

Field Documentation

◆ $conditions

$conditions = []

Definition at line 279 of file criteria.php.

◆ $criteriaElements

$criteriaElements = []

Definition at line 273 of file criteria.php.


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