dmBridge PHP API
DMQueryPredicate Class Reference

An object encapsulation of the dmQuery() $searchstring parameter (see the CONTENTdm(R) API documentation). More...

Public Member Functions

Static Public Member Functions


Detailed Description

An object encapsulation of the dmQuery() $searchstring parameter (see the CONTENTdm(R) API documentation).

Author:
Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 16 of file DMQueryPredicate.php.


Member Function Documentation

DMQueryPredicate::__toString ( )
Returns:
string

Definition at line 42 of file DMQueryPredicate.php.

DMQueryPredicate::getField ( ) [final]
Returns:
DMDCElement

Definition at line 77 of file DMQueryPredicate.php.

Referenced by isBrowse(), and isValid().

DMQueryPredicate::getMode ( ) [final]
Returns:
string

Definition at line 91 of file DMQueryPredicate.php.

Referenced by isBrowse(), and isValid().

DMQueryPredicate::getString ( ) [final]
Returns:
string
Since:
0.1

Definition at line 129 of file DMQueryPredicate.php.

Referenced by __toString(), isBrowse(), and isValid().

static DMQueryPredicate::getValidModes ( ) [static, final]
Returns:
array of valid modes, as strings

Definition at line 35 of file DMQueryPredicate.php.

DMQueryPredicate::isBrowse ( ) [final]
Returns:
Boolean
Since:
0.1

Definition at line 50 of file DMQueryPredicate.php.

DMQueryPredicate::isDate ( ) [final]
Returns:
Boolean
Since:
0.3

Definition at line 62 of file DMQueryPredicate.php.

DMQueryPredicate::isProximity ( ) [final]
Returns:
Boolean
Since:
0.3

Definition at line 113 of file DMQueryPredicate.php.

DMQueryPredicate::isValid ( ) [final]
Returns:
Boolean
Since:
0.1

Definition at line 145 of file DMQueryPredicate.php.

DMQueryPredicate::setDate ( bool) [final]
Parameters:
Booleanbool
Since:
0.3

Definition at line 70 of file DMQueryPredicate.php.

DMQueryPredicate::setField ( DMDCElement field) [final]
Parameters:
stringfield

Definition at line 84 of file DMQueryPredicate.php.

DMQueryPredicate::setMode ( mode) [final]
Parameters:
stringmode
Exceptions:
DMIllegalArgumentException
Since:
0.1

Definition at line 100 of file DMQueryPredicate.php.

DMQueryPredicate::setProximity ( bool) [final]
Parameters:
Booleanbool
Since:
0.3

Definition at line 121 of file DMQueryPredicate.php.

DMQueryPredicate::setString ( string) [final]
Parameters:
stringstring
Since:
0.1

Definition at line 137 of file DMQueryPredicate.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables