SnapSearchRequest Class Reference
[Utility Classes]
INSERT BRIEF DESCRIPTION HERE.
More...
Public Member Functions | |
| addDirectoryConstraint ($field, $op, $value) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| addFileConstraint ($field, $op, $value) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| addOrdering ($field, $dir=self::ORDER_ASCENDING) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| addResourceConstraint ($field, $op, $value) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| addType ($type) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| addVersionConstraint ($field, $op, $value) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getConjunction () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getConstraints ($type) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getDirConstraints () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getDomain () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getFileConstraints () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getLimit () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getOffset () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getOrdering () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getResConstraints () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getTypes () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| getVersConstraints () | |
| INSERT BRIEF DESCRIPTION HERE. | |
| removeType ($type) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| setConjunction ($conj) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| setDomain ($path) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| setLimit ($limit) | |
| INSERT BRIEF DESCRIPTION HERE. | |
| setOffset ($off) | |
| INSERT BRIEF DESCRIPTION HERE. | |
Detailed Description
INSERT BRIEF DESCRIPTION HERE.INSERT FULL DESCRIPTION HERE
Member Function Documentation
| SnapSearchRequest::addDirectoryConstraint | ( | $ | field, | |
| $ | op, | |||
| $ | value | |||
| ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$field [TYPE]: DESCRIPTION $op [TYPE]: DESCRIPTION $value [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::addFileConstraint | ( | $ | field, | |
| $ | op, | |||
| $ | value | |||
| ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$field [TYPE]: DESCRIPTION $op [TYPE]: DESCRIPTION $value [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::addOrdering | ( | $ | field, | |
| $ | dir = self::ORDER_ASCENDING | |||
| ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$field [TYPE]: DESCRIPTION $dir [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::addResourceConstraint | ( | $ | field, | |
| $ | op, | |||
| $ | value | |||
| ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$field [TYPE]: DESCRIPTION $op [TYPE]: DESCRIPTION $value [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::addType | ( | $ | type | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$type [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::addVersionConstraint | ( | $ | field, | |
| $ | op, | |||
| $ | value | |||
| ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$field [TYPE]: DESCRIPTION $op [TYPE]: DESCRIPTION $value [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getConjunction | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getConstraints | ( | $ | type | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$type [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getDirConstraints | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getDomain | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getFileConstraints | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getLimit | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getOffset | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getOrdering | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getResConstraints | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getTypes | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::getVersConstraints | ( | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::removeType | ( | $ | type | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$type [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::setConjunction | ( | $ | conj | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$conj [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::setDomain | ( | $ | path | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$path [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::setLimit | ( | $ | limit | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$limit [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
| SnapSearchRequest::setOffset | ( | $ | off | ) |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$off [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
The documentation for this class was generated from the following file:
- snap2/util/SnapSearchRequest.php5
