API - XOOPS 2.5.11 Beta 2
By monxoops.fr
Criteria Class Reference
Inheritance diagram for Criteria:
Collaboration diagram for Criteria:

Public Member Functions

 __construct ($column, $value='', $operator='=', $prefix='', $function='')
 
 render ()
 
 renderLdap ()
 
 renderWhere ()
 
- Public Member Functions inherited from CriteriaElement
 __construct ()
 
 render ()
 
 setSort ($sort)
 
 getSort ()
 
 setOrder ($order)
 
 getOrder ()
 
 setLimit ($limit=0)
 
 getLimit ()
 
 setStart ($start=0)
 
 getStart ()
 
 setGroupBy ($group)
 
 getGroupby ()
 

Data Fields

 $prefix
 
 $function
 
 $column
 
 $operator
 
 $value
 
- Data Fields inherited from CriteriaElement
 $order = 'ASC'
 
 $sort = ''
 
 $limit = 0
 
 $start = 0
 
 $groupby = ''
 

Detailed Description

A single criteria

Constructor & Destructor Documentation

◆ __construct()

__construct (   $column,
  $value = '',
  $operator = '=',
  $prefix = '',
  $function = '' 
)

Constructor

Parameters
string$column
string$value
string$operator
string$prefix
string$function

A common custom in some older programs was to use "new Criteria(1, '1')" to create an always true clause, WHERE 1 = "1"

This is no longer needed and now no longer works. Instead use "new Criteria('')" or "new CriteriaCompo()", either of which will produce no WHERE clause.

The following is a temporary workaround for the old technique

Member Function Documentation

◆ render()

render ( )

Make a sql condition string

Returns
string

Reimplemented from CriteriaElement.

Here is the caller graph for this function:

◆ 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, improved by Pierre-Eric MENUET pemen.nosp@m.@sou.nosp@m.rcefo.nosp@m.rge..nosp@m.net

◆ renderWhere()

renderWhere ( )

Make a SQL "WHERE" clause

Returns
string
Here is the call graph for this function:

Field Documentation

◆ $column

$column

◆ $function

$function

◆ $operator

$operator

◆ $prefix

$prefix

◆ $value

$value

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