what is doctrine hydration?
Data Hydrators
Doctrine has a concept of data hydrators for transforming your :php:class:`Doctrine_Query` instances to a set of PHP data for the user to take advantage of. The most obvious way to hydrate the data is to put it into your object graph and return models/class instances. Sometimes though you want to hydrate the data to an array, use no hydration or return a single scalar value. This chapter aims to document and demonstrate the different hydration types and even how to write your own new hydration types.
Hydration is a method used to return query results. For example:
HYDRATE_ARRAY
- This will return you an array of records that are represented by another array:$q = Doctrine_Query::create() ->from('Post p') ->setHydrationMode(Doctrine::HYDRATE_ARRAY); $resultSet = $q->execute(); // $resultSet is an array foreach ($resultSet as $post) { // $post is an array echo $post['title']; }
HYDRATE_RECORD
- This will return you an collection (Doctrine_Collection) of objects:$q = Doctrine_Query::create() ->from('Post p') ->setHydrationMode(Doctrine::HYDRATE_RECORD); // Unnecessary, HYDATE_RECORD is default method $resultSet = $q->execute(); // $resultSet is an Doctrine_Collection object foreach ($resultSet as $post) { // $post is an Post object echo $post->getTitle(); echo $post['title']; // Each Doctrine's Model object implements ArrayAccess interface so this is possible echo $post->myCustomMethod(); }
HYDRATE_SINGULAR_SCALAR
- Will return the value of first column of query's result:$q = Doctrine_Query::create() ->select('p.created_at') ->from('Post p') ->where('p.id = ?', 321) ->setHydrationMode(Doctrine::HYDRATE_SINGULAR_SCALAR); $createdAt = $q->execute(); // $createdAt has value of first column from first record from result set (eg.: 2008-04-06 21:22:35)
There is a few more methods , you can read about each in documentation.