Class: Doctrine_Hook
Source Location: /Doctrine/Hook.phpClass Doctrine_Hook
Class Overview
|
Doctrine_Hook Located in /Doctrine/Hook.php [line 33] Author(s):
|
[ Top ]
Property Summary
Method Summary
| Doctrine_Hook | __construct() | |
| Doctrine_Query | getQuery() | getQuery |
| void | hookLimit() | |
| void | hookOffset() | |
| boolean | hookOrderby() | hookOrderBy builds DQL query orderby part from given parameter array |
| boolean | hookWhere() | hookWhere builds DQL query where part from given parameter array |
| void | setFieldParser() | setFieldParser |
| void | setTypeParser() | setTypeParser |
[ Top ]
Properties
array
$hooks
= array(
'where',
'orderby',
'limit',
'offset'
) [line 46]
API Tags:'where',
'orderby',
'limit',
'offset'
) [line 46]
| Access: | protected |
[ Top ]
array
$typeParsers
= array(
'char' => 'Doctrine_Hook_WordLike',
'string' => 'Doctrine_Hook_WordLike',
'varchar' => 'Doctrine_Hook_WordLike',
'integer' => 'Doctrine_Hook_Integer',
'enum' => 'Doctrine_Hook_Integer',
'time' => 'Doctrine_Hook_Time',
'date' => 'Doctrine_Hook_Date',
) [line 63]
API Tags:'char' => 'Doctrine_Hook_WordLike',
'string' => 'Doctrine_Hook_WordLike',
'varchar' => 'Doctrine_Hook_WordLike',
'integer' => 'Doctrine_Hook_Integer',
'enum' => 'Doctrine_Hook_Integer',
'time' => 'Doctrine_Hook_Time',
'date' => 'Doctrine_Hook_Date',
) [line 63]
| Access: | protected |
[ Top ]
Methods
Constructor __construct [line 76]
|
| Doctrine_Query | $query: | the base query |
API Tags:
| Access: | public |
[ Top ]
getQuery [line 94]
|
getQuery
API Tags:
| Return: | returns the query object associated with this hook |
| Access: | public |
[ Top ]
hookLimit [line 204]
|
| integer | $limit: |
API Tags:
| Access: | public |
[ Top ]
hookOffset [line 211]
|
| integer | $offset: |
API Tags:
| Access: | public |
[ Top ]
hookOrderby [line 172]
|
hookOrderBy builds DQL query orderby part from given parameter array
Parameters:| array | $params: | an array containing all fields which the built query should be ordered by |
API Tags:
| Return: | whether or not the hooking was successful |
| Access: | public |
[ Top ]
hookWhere [line 126]
|
hookWhere builds DQL query where part from given parameter array
Parameters:| array | $params: | an associative array containing field names and their values |
API Tags:
| Return: | whether or not the hooking was |
| Access: | public |
[ Top ]
setFieldParser [line 114]
|
setFieldParser
Parameters:| string | $field: | field name |
| string|object | $parser: | parser name or custom parser object |
API Tags:
| Access: | public |
[ Top ]