dmBridge PHP API
DMInput Class Reference

Takes in user input via the URI query string and makes it available via convenient accessors. More...

Public Member Functions


Detailed Description

Takes in user input via the URI query string and makes it available via convenient accessors.

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

Definition at line 17 of file DMInput.php.


Constructor & Destructor Documentation

DMInput::__construct ( DMURI uri)
Parameters:
DMURIuri URI containing a query

Definition at line 45 of file DMInput.php.


Member Function Documentation

DMInput::getBeginDate ( )
Returns:
DMDateTime
Since:
0.1

Definition at line 184 of file DMInput.php.

Referenced by getTerms(), and validate().

DMInput::getCollections ( )
Returns:
Array of DMCollection objects
Since:
0.1

Definition at line 196 of file DMInput.php.

DMInput::getDateQualifier ( )
Returns:
string
Since:
0.1

Definition at line 204 of file DMInput.php.

DMInput::getEndDate ( )
Returns:
DMDateTime
Since:
0.1

Definition at line 223 of file DMInput.php.

Referenced by getTerms(), and validate().

DMInput::getOnDate ( )
Returns:
DMDateTime
Since:
0.1

Definition at line 235 of file DMInput.php.

Referenced by getTerms(), and validate().

DMInput::getPredicate ( index)
Parameters:
intindex
Returns:
DMQueryPredicate
Since:
0.3

Definition at line 259 of file DMInput.php.

DMInput::getProximity ( )
Returns:
int

Definition at line 246 of file DMInput.php.

Referenced by getTerms(), and validate().

DMInput::getTerms ( )
Returns:
array Array of DMQueryPredicate objects
Since:
0.1

Definition at line 272 of file DMInput.php.

Referenced by getPredicate(), and validate().

DMInput::isPresent ( )
Returns:
Boolean

Definition at line 176 of file DMInput.php.

DMInput::validate ( )
Returns:
Boolean
Exceptions:
DMIllegalArgumentException
Since:
0.1

Definition at line 342 of file DMInput.php.


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