Jump to main content Jump to doc navigation

What is hydration?

Hydration is the process in which fields and related objects represented by an xPDOObject are populated with values. By default, these fields are only accessible using the get(), getOne() and getMany() methods of xPDOObject, and must be defined with appropriate metadata in the map for the object. However, there are a number of options you can use to extend how xPDO hydrates fields and related objects.

The options are available by passing any of the following configuration options into the $config parameter of the xPDO constructor:

  • xPDO::OPT_HYDRATE_FIELDS - If true, fields will be hydrated as public member variables of the object.
  • xPDO::OPT_HYDRATE_RELATED_OBJECTS - If true, related objects will be hydrated as public member variables of the object.
  • xPDO::OPT_HYDRATE_ADHOC_FIELDS - If true, ad-hoc fields will be allowed and hydrated on the object (respects xPDO::OPT_HYDRATE_FIELDS setting as well).

Hydrating Fields

If the xPDO::OPT_HYDRATE_FIELDS option is set to true, in addition to accessing fields via the xPDOObject::get() method, all object fields will be made accessible for reading directly as public member variables of the object. An example of this is such:

echo $object->name;

This would output the 'name' field of the object, assuming that the 'name' field is defined in the object's schema.

These are "raw" values Please note that accessing fields of the object directly provides only the "raw" value as loaded from the database, ignoring the metadata that is defined for the field, and avoiding any logic applied by the get() method of your xPDOObject class (or any of it's parent classes). It is recommended that you always use the get() method to access object fields unless you need the raw value or to avoid the get() logic for a specific reason.

Hydrating Ad Hoc Fields

If the xPDO::OPT_HYDRATE_ADHOC_FIELDS option is set to true, field hydration will be enabled for arbitrary fields not defined in the class map. It takes one step further the idea of hydrating fields, and now hydrates all ad hoc fields; or rather, any field that is not defined in the schema. Say we want to set an arbitrary field called 'puns' to a Person object:

$object->set('name','Arthur Dent');
echo $object->get('name') .' has '. $object->get('puns') . ' puns.';

This would echo the appropriate value, even if the field 'puns' isn't defined in the schema.

The option respects the xPDO::OPT_HYDRATE_FIELDS option with respect to making the ad hoc fields available directly as public member variables of the object.

If the xPDO::OPT_HYDRATE_RELATED_OBJECTS option is set to true, all related objects will be made available as public member variables of the object. By default, related objects are only accessible via the getOne or getMany methods of xPDOObject, but this option (similar to xPDO::OPT_HYDRATE_FIELDS) makes any related objects already loaded by those methods accessible directly as variables. Example:

foreach ($fordPrefect->Beers as $beer) {
   echo $beer->get('name').'<br />';

This would echo a list of all the Beers associated to the $fordPrefect object loaded by the getMany method.

One vs. Many Objects loaded with getOne are available directly as an object of that class, while those with getMany are available as an array of objects of the class.

See Also