danielebarchiesi@4: <?php
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * @file
danielebarchiesi@4:  * Provides wrappers allowing easy usage of the entity metadata.
danielebarchiesi@4:  */
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * A common base class for all wrappers.
danielebarchiesi@4:  */
danielebarchiesi@4: abstract class EntityMetadataWrapper {
danielebarchiesi@4: 
danielebarchiesi@4:   protected $type;
danielebarchiesi@4:   protected $data;
danielebarchiesi@4:   protected $info;
danielebarchiesi@4:   protected $cache = array();
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Construct a new wrapper object.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $type
danielebarchiesi@4:    *   The type of the passed data.
danielebarchiesi@4:    * @param $data
danielebarchiesi@4:    *   Optional. The data to wrap.
danielebarchiesi@4:    * @param $info
danielebarchiesi@4:    *   Optional. Used internally to pass info about properties down the tree.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __construct($type, $data = NULL, $info = array()) {
danielebarchiesi@4:     $this->type = $type;
danielebarchiesi@4:     $this->info = $info + array(
danielebarchiesi@4:       'langcode' => NULL,
danielebarchiesi@4:     );
danielebarchiesi@4:     $this->info['type'] = $type;
danielebarchiesi@4:     if (isset($data)) {
danielebarchiesi@4:       $this->set($data);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Gets info about the wrapped data.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @return Array
danielebarchiesi@4:    *   Keys set are all keys as specified for a property in hook_entity_info()
danielebarchiesi@4:    *   as well as possible the following keys:
danielebarchiesi@4:    *    - name: If this wraps a property, the name of the property.
danielebarchiesi@4:    *    - parent: The parent wrapper, if any.
danielebarchiesi@4:    *    - langcode: The language code, if this data is language specific.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function info() {
danielebarchiesi@4:     return $this->info;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Gets the (entity)type of the wrapped data.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function type() {
danielebarchiesi@4:     return $this->type;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the wrapped data. If no options are given the data is returned as
danielebarchiesi@4:    * described in the info.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $options
danielebarchiesi@4:    *   (optional) A keyed array of options:
danielebarchiesi@4:    *   - sanitize: A boolean flag indicating that textual properties should be
danielebarchiesi@4:    *     sanitized for display to a web browser. Defaults to FALSE.
danielebarchiesi@4:    *   - decode: If set to TRUE and some textual data is already sanitized, it
danielebarchiesi@4:    *     strips HTML tags and decodes HTML entities. Defaults to FALSE.
danielebarchiesi@4:    *
danielebarchiesi@4:    *  @return
danielebarchiesi@4:    *    The value of the wrapped data. If the data property is not set, NULL
danielebarchiesi@4:    *    is returned.
danielebarchiesi@4:    *
danielebarchiesi@4:    *  @throws EntityMetadataWrapperException
danielebarchiesi@4:    *    In case there are no data values available to the wrapper, an exception
danielebarchiesi@4:    *    is thrown. E.g. if the value for an entity property is to be retrieved
danielebarchiesi@4:    *    and there is no entity available, the exception is thrown. However, if
danielebarchiesi@4:    *    an entity is available but the property is not set, NULL is returned.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function value(array $options = array()) {
danielebarchiesi@4:     if (!$this->dataAvailable() && isset($this->info['parent'])) {
danielebarchiesi@4:       throw new EntityMetadataWrapperException('Missing data values.');
danielebarchiesi@4:     }
danielebarchiesi@4:     if (!isset($this->data) && isset($this->info['name'])) {
danielebarchiesi@4:       $this->data = $this->info['parent']->getPropertyValue($this->info['name'], $this->info);
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this->data;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the raw, unprocessed data. Most times this is the same as returned
danielebarchiesi@4:    * by value(), however for already processed and sanitized textual data, this
danielebarchiesi@4:    * will return the unprocessed data in contrast to value().
danielebarchiesi@4:    */
danielebarchiesi@4:   public function raw() {
danielebarchiesi@4:     if (!$this->dataAvailable()) {
danielebarchiesi@4:       throw new EntityMetadataWrapperException('Missing data values.');
danielebarchiesi@4:     }
danielebarchiesi@4:     if (isset($this->info['name']) && isset($this->info['parent'])) {
danielebarchiesi@4:       return $this->info['parent']->getPropertyRaw($this->info['name'], $this->info);
danielebarchiesi@4:     }
danielebarchiesi@4:     // Else return the usual value, which should be raw in this case.
danielebarchiesi@4:     return $this->value();
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns whether data is available to work with.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @return
danielebarchiesi@4:    *   If we operate without any data FALSE, else TRUE.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function dataAvailable() {
danielebarchiesi@4:     return isset($this->data) || (isset($this->info['parent']) && $this->info['parent']->dataAvailable());
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Set a new data value.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function set($value) {
danielebarchiesi@4:     if (!$this->validate($value)) {
danielebarchiesi@4:       throw new EntityMetadataWrapperException('Invalid data value given. Be sure it matches the required data type and format.');
danielebarchiesi@4:     }
danielebarchiesi@4:     $this->clear();
danielebarchiesi@4:     $this->data = $value;
danielebarchiesi@4:     $this->updateParent($value);
danielebarchiesi@4:     return $this;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Updates the parent data structure of a data property with the latest data value.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function updateParent($value) {
danielebarchiesi@4:     if (isset($this->info['parent'])) {
danielebarchiesi@4:       $this->info['parent']->setProperty($this->info['name'], $value);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns whether $value is a valid value to set.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function validate($value) {
danielebarchiesi@4:     if (isset($value) && !entity_property_verify_data_type($value, $this->type)) {
danielebarchiesi@4:       return FALSE;
danielebarchiesi@4:     }
danielebarchiesi@4:     // Only proceed with further checks if this is not a list item. If this is
danielebarchiesi@4:     // a list item, the checks are performed on the list property level.
danielebarchiesi@4:     if (isset($this->info['parent']) && $this->info['parent'] instanceof EntityListWrapper) {
danielebarchiesi@4:       return TRUE;
danielebarchiesi@4:     }
danielebarchiesi@4:     if (!isset($value) && !empty($this->info['required'])) {
danielebarchiesi@4:       // Do not allow NULL values if the property is required.
danielebarchiesi@4:       return FALSE;
danielebarchiesi@4:     }
danielebarchiesi@4:     return !isset($this->info['validation callback']) || call_user_func($this->info['validation callback'], $value, $this->info);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function __toString() {
danielebarchiesi@4:     return isset($this->info) ? 'Property ' . $this->info['name'] : $this->type;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Clears the data value and the wrapper cache.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function clear() {
danielebarchiesi@4:     $this->data = NULL;
danielebarchiesi@4:     foreach ($this->cache as $wrapper) {
danielebarchiesi@4:       $wrapper->clear();
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the options list specifying possible values for the property, if
danielebarchiesi@4:    * defined.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $op
danielebarchiesi@4:    *   (optional) One of 'edit' or 'view'. In case the list of possible values
danielebarchiesi@4:    *   a user could set for a property differs from the list of values a
danielebarchiesi@4:    *   property could have, $op determines which options should be returned.
danielebarchiesi@4:    *   Defaults to 'edit'.
danielebarchiesi@4:    *   E.g. all possible roles a user could have include the anonymous and the
danielebarchiesi@4:    *   authenticated user roles, while those roles cannot be added to a user
danielebarchiesi@4:    *   account. So their options would be included for 'view', but for 'edit'
danielebarchiesi@4:    *   not.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @return
danielebarchiesi@4:    *   An array as used by hook_options_list() or FALSE.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function optionsList($op = 'edit') {
danielebarchiesi@4:     if (isset($this->info['options list']) && is_callable($this->info['options list'])) {
danielebarchiesi@4:       $name = isset($this->info['name']) ? $this->info['name'] : NULL;
danielebarchiesi@4:       return call_user_func($this->info['options list'], $name, $this->info, $op);
danielebarchiesi@4:     }
danielebarchiesi@4:     return FALSE;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the label for the currently set property value if there is one
danielebarchiesi@4:    * available, i.e. if an options list has been specified.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function label() {
danielebarchiesi@4:     if ($options = $this->optionsList('view')) {
danielebarchiesi@4:       $options = entity_property_options_flatten($options);
danielebarchiesi@4:       $value = $this->value();
danielebarchiesi@4:       if (is_scalar($value) && isset($options[$value])) {
danielebarchiesi@4:         return $options[$value];
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Determines whether the given user has access to view or edit this property.
danielebarchiesi@4:    * Apart from relying on access metadata of properties, this takes into
danielebarchiesi@4:    * account information about entity level access, if available:
danielebarchiesi@4:    *  - Referenced entities can only be viewed, when the user also has
danielebarchiesi@4:    *    permission to view the entity.
danielebarchiesi@4:    *  - A property may be only edited, if the user has permission to update the
danielebarchiesi@4:    *    entity containing the property.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $op
danielebarchiesi@4:    *   The operation being performed. One of 'view' or 'edit.
danielebarchiesi@4:    * @param $account
danielebarchiesi@4:    *   The user to check for. Leave it to NULL to check for the global user.
danielebarchiesi@4:    * @return boolean
danielebarchiesi@4:    *   Whether access to entity property is allowed for the given operation.
danielebarchiesi@4:    *   However if we wrap no data, it returns whether access is allowed to the
danielebarchiesi@4:    *   property of all entities of this type.
danielebarchiesi@4:    *   If there is no access information for this property, TRUE is returned.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function access($op, $account = NULL) {
danielebarchiesi@4:     if (empty($this->info['parent']) && $this instanceof EntityDrupalWrapper) {
danielebarchiesi@4:       // If there is no parent just incorporate entity based access.
danielebarchiesi@4:       return $this->entityAccess($op == 'edit' ? 'update' : 'view', $account);
danielebarchiesi@4:     }
danielebarchiesi@4:     return !empty($this->info['parent']) ? $this->info['parent']->propertyAccess($this->info['name'], $op, $account) : TRUE;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Prepare for serializiation.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __sleep() {
danielebarchiesi@4:     $vars = get_object_vars($this);
danielebarchiesi@4:     unset($vars['cache']);
danielebarchiesi@4:     return drupal_map_assoc(array_keys($vars));
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Wraps a single value.
danielebarchiesi@4:  */
danielebarchiesi@4: class EntityValueWrapper extends EntityMetadataWrapper {
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Overrides EntityMetadataWrapper#value().
danielebarchiesi@4:    * Sanitizes or decode textual data if necessary.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function value(array $options = array()) {
danielebarchiesi@4:     $data = parent::value();
danielebarchiesi@4:     if ($this->type == 'text' && isset($data)) {
danielebarchiesi@4:       $info = $this->info + array('sanitized' => FALSE, 'sanitize' => 'check_plain');
danielebarchiesi@4:       $options += array('sanitize' => FALSE, 'decode' => FALSE);
danielebarchiesi@4:       if ($options['sanitize'] && !$info['sanitized']) {
danielebarchiesi@4:         return call_user_func($info['sanitize'], $data);
danielebarchiesi@4:       }
danielebarchiesi@4:       elseif ($options['decode'] && $info['sanitized']) {
danielebarchiesi@4:         return decode_entities(strip_tags($data));
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     return $data;
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Provides a general wrapper for any data structure. For this to work the
danielebarchiesi@4:  * metadata has to be passed during construction.
danielebarchiesi@4:  */
danielebarchiesi@4: class EntityStructureWrapper extends EntityMetadataWrapper implements IteratorAggregate {
danielebarchiesi@4: 
danielebarchiesi@4:   protected $propertyInfo = array(), $propertyInfoAltered = FALSE;
danielebarchiesi@4:   protected $langcode = LANGUAGE_NONE;
danielebarchiesi@4: 
danielebarchiesi@4:   protected $propertyInfoDefaults = array(
danielebarchiesi@4:     'type' => 'text',
danielebarchiesi@4:     'getter callback' => 'entity_property_verbatim_get',
danielebarchiesi@4:     'clear' => array(),
danielebarchiesi@4:   );
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Construct a new EntityStructureWrapper object.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $type
danielebarchiesi@4:    *   The type of the passed data.
danielebarchiesi@4:    * @param $data
danielebarchiesi@4:    *   Optional. The data to wrap.
danielebarchiesi@4:    * @param $info
danielebarchiesi@4:    *   Used to for specifying metadata about the data and internally to pass
danielebarchiesi@4:    *   info about properties down the tree. For specifying metadata known keys
danielebarchiesi@4:    *   are:
danielebarchiesi@4:    *   - property info: An array of info about the properties of the wrapped
danielebarchiesi@4:    *     data structure. It has to contain an array of property info in the same
danielebarchiesi@4:    *     structure as used by hook_entity_property_info().
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __construct($type, $data = NULL, $info = array()) {
danielebarchiesi@4:     parent::__construct($type, $data, $info);
danielebarchiesi@4:     $this->info += array('property defaults' => array());
danielebarchiesi@4:     $info += array('property info' => array());
danielebarchiesi@4:     $this->propertyInfo['properties'] = $info['property info'];
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * May be used to lazy-load additional info about the data, depending on the
danielebarchiesi@4:    * concrete passed data.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function spotInfo() {
danielebarchiesi@4:     // Apply the callback if set, such that the caller may alter the info.
danielebarchiesi@4:     if (!empty($this->info['property info alter']) && !$this->propertyInfoAltered) {
danielebarchiesi@4:       $this->propertyInfo = call_user_func($this->info['property info alter'], $this, $this->propertyInfo);
danielebarchiesi@4:       $this->propertyInfoAltered = TRUE;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Gets the info about the given property.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $name
danielebarchiesi@4:    *   The name of the property. If not given, info about all properties will
danielebarchiesi@4:    *   be returned.
danielebarchiesi@4:    * @throws EntityMetadataWrapperException
danielebarchiesi@4:    *   If there is no such property.
danielebarchiesi@4:    * @return
danielebarchiesi@4:    *   An array of info about the property.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function getPropertyInfo($name = NULL) {
danielebarchiesi@4:     $this->spotInfo();
danielebarchiesi@4:     if (!isset($name)) {
danielebarchiesi@4:       return $this->propertyInfo['properties'];
danielebarchiesi@4:     }
danielebarchiesi@4:     if (!isset($this->propertyInfo['properties'][$name])) {
danielebarchiesi@4:       throw new EntityMetadataWrapperException('Unknown data property ' . check_plain($name) . '.');
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this->propertyInfo['properties'][$name] + $this->info['property defaults'] + $this->propertyInfoDefaults;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns a reference on the property info.
danielebarchiesi@4:    *
danielebarchiesi@4:    * If possible, use the property info alter callback for spotting metadata.
danielebarchiesi@4:    * The reference may be used to alter the property info for any remaining
danielebarchiesi@4:    * cases, e.g. if additional metadata has been asserted.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function &refPropertyInfo() {
danielebarchiesi@4:     return $this->propertyInfo;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Sets a new language to use for retrieving properties.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $langcode
danielebarchiesi@4:    *   The language code of the language to set.
danielebarchiesi@4:    * @return EntityWrapper
danielebarchiesi@4:    */
danielebarchiesi@4:   public function language($langcode = LANGUAGE_NONE) {
danielebarchiesi@4:     if ($langcode != $this->langcode) {
danielebarchiesi@4:       $this->langcode = $langcode;
danielebarchiesi@4:       $this->cache = array();
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Gets the language used for retrieving properties.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @return String
danielebarchiesi@4:    *   The language object of the language or NULL for the default language.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see EntityStructureWrapper::language()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function getPropertyLanguage() {
danielebarchiesi@4:     if ($this->langcode != LANGUAGE_NONE && $list = language_list()) {
danielebarchiesi@4:       if (isset($list[$this->langcode])) {
danielebarchiesi@4:         return $list[$this->langcode];
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     return NULL;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Get the wrapper for a property.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @return
danielebarchiesi@4:    *   An instance of EntityMetadataWrapper.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function get($name) {
danielebarchiesi@4:     // Look it up in the cache if possible.
danielebarchiesi@4:     if (!array_key_exists($name, $this->cache)) {
danielebarchiesi@4:       if ($info = $this->getPropertyInfo($name)) {
danielebarchiesi@4:         $info += array('parent' => $this, 'name' => $name, 'langcode' => $this->langcode, 'property defaults' => array());
danielebarchiesi@4:         $info['property defaults'] += $this->info['property defaults'];
danielebarchiesi@4:         $this->cache[$name] = entity_metadata_wrapper($info['type'], NULL, $info);
danielebarchiesi@4:       }
danielebarchiesi@4:       else {
danielebarchiesi@4:         throw new EntityMetadataWrapperException('There is no property ' . check_plain($name) . " for this entity.");
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this->cache[$name];
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Magic method: Get a wrapper for a property.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __get($name) {
danielebarchiesi@4:     if (strpos($name, 'krumo') === 0) {
danielebarchiesi@4:       // #914934 Ugly workaround to allow krumo to write its recursion property.
danielebarchiesi@4:       // This is necessary to make dpm() work without throwing exceptions.
danielebarchiesi@4:       return NULL;
danielebarchiesi@4:     }
danielebarchiesi@4:     $get = $this->get($name);
danielebarchiesi@4:     return $get;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Magic method: Set a property.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __set($name, $value) {
danielebarchiesi@4:     if (strpos($name, 'krumo') === 0) {
danielebarchiesi@4:       // #914934 Ugly workaround to allow krumo to write its recursion property.
danielebarchiesi@4:       // This is necessary to make dpm() work without throwing exceptions.
danielebarchiesi@4:       $this->$name = $value;
danielebarchiesi@4:     }
danielebarchiesi@4:     else {
danielebarchiesi@4:       $this->get($name)->set($value);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Gets the value of a property.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function getPropertyValue($name, &$info) {
danielebarchiesi@4:     $options = array('language' => $this->getPropertyLanguage(), 'absolute' => TRUE);
danielebarchiesi@4:     $data = $this->value();
danielebarchiesi@4:     if (!isset($data)) {
danielebarchiesi@4:       throw new EntityMetadataWrapperException('Unable to get the data property ' . check_plain($name) . ' as the parent data structure is not set.');
danielebarchiesi@4:     }
danielebarchiesi@4:     return $info['getter callback']($data, $options, $name, $this->type, $info);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Gets the raw value of a property.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function getPropertyRaw($name, &$info) {
danielebarchiesi@4:     if (!empty($info['raw getter callback'])) {
danielebarchiesi@4:       $options = array('language' => $this->getPropertyLanguage(), 'absolute' => TRUE);
danielebarchiesi@4:       $data = $this->value();
danielebarchiesi@4:       if (!isset($data)) {
danielebarchiesi@4:         throw new EntityMetadataWrapperException('Unable to get the data property ' . check_plain($name) . ' as the parent data structure is not set.');
danielebarchiesi@4:       }
danielebarchiesi@4:       return $info['raw getter callback']($data, $options, $name, $this->type, $info);
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this->getPropertyValue($name, $info);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Sets a property.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function setProperty($name, $value) {
danielebarchiesi@4:     $info = $this->getPropertyInfo($name);
danielebarchiesi@4:     if (!empty($info['setter callback'])) {
danielebarchiesi@4:       $data = $this->value();
danielebarchiesi@4: 
danielebarchiesi@4:       // In case the data structure is not set, support simple auto-creation
danielebarchiesi@4:       // for arrays. Else an exception is thrown.
danielebarchiesi@4:       if (!isset($data)) {
danielebarchiesi@4:         if (!empty($this->info['auto creation']) && !($this instanceof EntityDrupalWrapper)) {
danielebarchiesi@4:           $data = $this->info['auto creation']($name, $this->info);
danielebarchiesi@4:         }
danielebarchiesi@4:         else {
danielebarchiesi@4:           throw new EntityMetadataWrapperException('Unable to set the data property ' . check_plain($name) . ' as the parent data structure is not set.');
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4: 
danielebarchiesi@4:       // Invoke the setter callback for updating our data.
danielebarchiesi@4:       $info['setter callback']($data, $name, $value, $this->langcode, $this->type, $info);
danielebarchiesi@4: 
danielebarchiesi@4:       // If the setter has not thrown any exceptions, proceed and apply the
danielebarchiesi@4:       // update to the current and any parent wrappers as necessary.
danielebarchiesi@4:       $data = $this->info['type'] == 'entity' ? $this : $data;
danielebarchiesi@4:       $this->set($data);
danielebarchiesi@4: 
danielebarchiesi@4:       // Clear the cache of properties dependent on this value.
danielebarchiesi@4:       foreach ($info['clear'] as $name) {
danielebarchiesi@4:         if (isset($this->cache[$name])) {
danielebarchiesi@4:           $this->cache[$name]->clear();
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     else {
danielebarchiesi@4:       throw new EntityMetadataWrapperException('Entity property ' . check_plain($name) . " doesn't support writing.");
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   protected function propertyAccess($name, $op, $account = NULL) {
danielebarchiesi@4:     $info = $this->getPropertyInfo($name);
danielebarchiesi@4:     // If the property should be accessed and it's an entity, make sure the user
danielebarchiesi@4:     // is allowed to view that entity.
danielebarchiesi@4:     if ($op == 'view' && $this->$name instanceof EntityDrupalWrapper && !$this->$name->entityAccess($op, $account)) {
danielebarchiesi@4:       return FALSE;
danielebarchiesi@4:     }
danielebarchiesi@4:     // If a property should be edited and this is an entity, make sure the user
danielebarchiesi@4:     // has update access for this entity.
danielebarchiesi@4:     if ($op == 'edit') {
danielebarchiesi@4:       $entity = $this;
danielebarchiesi@4:       while (!($entity instanceof EntityDrupalWrapper) && isset($entity->info['parent'])) {
danielebarchiesi@4:         $entity = $entity->info['parent'];
danielebarchiesi@4:       }
danielebarchiesi@4:       if ($entity instanceof EntityDrupalWrapper && !$entity->entityAccess('update', $account)) {
danielebarchiesi@4:         return FALSE;
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     if (!empty($info['access callback'])) {
danielebarchiesi@4:       $data = $this->dataAvailable() ? $this->value() : NULL;
danielebarchiesi@4:       return call_user_func($info['access callback'], $op, $name, $data, $account, $this->type);
danielebarchiesi@4:     }
danielebarchiesi@4:     elseif ($op == 'edit' && isset($info['setter permission'])) {
danielebarchiesi@4:       return user_access($info['setter permission'], $account);
danielebarchiesi@4:     }
danielebarchiesi@4:     return TRUE;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Magic method: Can be used to check if a property is known.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __isset($name) {
danielebarchiesi@4:     $this->spotInfo();
danielebarchiesi@4:     return isset($this->propertyInfo['properties'][$name]);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function getIterator() {
danielebarchiesi@4:     $this->spotInfo();
danielebarchiesi@4:     return new EntityMetadataWrapperIterator($this, array_keys($this->propertyInfo['properties']));
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the identifier of the data structure. If there is none, NULL is
danielebarchiesi@4:    * returned.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function getIdentifier() {
danielebarchiesi@4:     return isset($this->id) && $this->dataAvailable() ? $this->id->value() : NULL;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Prepare for serializiation.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __sleep() {
danielebarchiesi@4:     $vars = parent::__sleep();
danielebarchiesi@4:     unset($vars['propertyInfoDefaults']);
danielebarchiesi@4:     return $vars;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function clear() {
danielebarchiesi@4:     $this->propertyInfoAltered = FALSE;
danielebarchiesi@4:     parent::clear();
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Provides a wrapper for entities registrered in hook_entity_info().
danielebarchiesi@4:  *
danielebarchiesi@4:  * The wrapper eases applying getter and setter callbacks of entity properties
danielebarchiesi@4:  * specified in hook_entity_property_info().
danielebarchiesi@4:  */
danielebarchiesi@4: class EntityDrupalWrapper extends EntityStructureWrapper {
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Contains the entity id.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected $id = FALSE;
danielebarchiesi@4:   protected $bundle;
danielebarchiesi@4:   protected $entityInfo;
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Construct a new EntityDrupalWrapper object.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $type
danielebarchiesi@4:    *   The type of the passed data.
danielebarchiesi@4:    * @param $data
danielebarchiesi@4:    *   Optional. The entity to wrap or its identifier.
danielebarchiesi@4:    * @param $info
danielebarchiesi@4:    *   Optional. Used internally to pass info about properties down the tree.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __construct($type, $data = NULL, $info = array()) {
danielebarchiesi@4:     parent::__construct($type, $data, $info);
danielebarchiesi@4:     $this->setUp();
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   protected function setUp() {
danielebarchiesi@4:     $this->propertyInfo = entity_get_property_info($this->type) + array('properties' => array());
danielebarchiesi@4:     $info = $this->info + array('property info' => array(), 'bundle' => NULL);
danielebarchiesi@4:     $this->propertyInfo['properties'] += $info['property info'];
danielebarchiesi@4:     $this->bundle = $info['bundle'];
danielebarchiesi@4:     $this->entityInfo = entity_get_info($this->type);
danielebarchiesi@4:     if (isset($this->bundle)) {
danielebarchiesi@4:       $this->spotBundleInfo(FALSE);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Sets the entity internally accepting both the entity id and object.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function setEntity($data) {
danielebarchiesi@4:     // For entities we allow getter callbacks to return FALSE, which we
danielebarchiesi@4:     // interpret like NULL values as unset properties.
danielebarchiesi@4:     if (isset($data) && $data !== FALSE && !is_object($data)) {
danielebarchiesi@4:       $this->id = $data;
danielebarchiesi@4:       $this->data = FALSE;
danielebarchiesi@4:     }
danielebarchiesi@4:     elseif (is_object($data) && $data instanceof EntityDrupalWrapper) {
danielebarchiesi@4:       // We got a wrapped entity passed, so take over its values.
danielebarchiesi@4:       $this->id = $data->id;
danielebarchiesi@4:       $this->data = $data->data;
danielebarchiesi@4:       // For generic entity references, also update the entity type accordingly.
danielebarchiesi@4:       if ($this->info['type'] == 'entity') {
danielebarchiesi@4:         $this->type = $data->type;
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     elseif (is_object($data)) {
danielebarchiesi@4:       // We got the entity object passed.
danielebarchiesi@4:       $this->data = $data;
danielebarchiesi@4:       $id = entity_id($this->type, $data);
danielebarchiesi@4:       $this->id = isset($id) ? $id : FALSE;
danielebarchiesi@4:     }
danielebarchiesi@4:     else {
danielebarchiesi@4:       $this->id = FALSE;
danielebarchiesi@4:       $this->data = NULL;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Used to lazy-load bundle info. So the wrapper can be loaded e.g. just
danielebarchiesi@4:    * for setting without the data being loaded.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function spotInfo() {
danielebarchiesi@4:     if (!$this->propertyInfoAltered) {
danielebarchiesi@4:       if ($this->info['type'] == 'entity' && $this->dataAvailable() && $this->value()) {
danielebarchiesi@4:         // Add in entity-type specific details.
danielebarchiesi@4:         $this->setUp();
danielebarchiesi@4:       }
danielebarchiesi@4:       $this->spotBundleInfo(TRUE);
danielebarchiesi@4:       parent::spotInfo();
danielebarchiesi@4:       $this->propertyInfoAltered = TRUE;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Tries to determine the bundle and adds in the according property info.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $load
danielebarchiesi@4:    *   Whether the entity should be loaded to spot the info if necessary.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected function spotBundleInfo($load = TRUE) {
danielebarchiesi@4:     // Like entity_extract_ids() assume the entity type if no key is given.
danielebarchiesi@4:     if (empty($this->entityInfo['entity keys']['bundle']) && $this->type != 'entity') {
danielebarchiesi@4:       $this->bundle = $this->type;
danielebarchiesi@4:     }
danielebarchiesi@4:     // Detect the bundle if not set yet and add in properties from the bundle.
danielebarchiesi@4:     elseif (!$this->bundle && $load && $this->dataAvailable()) {
danielebarchiesi@4:       try {
danielebarchiesi@4:         if ($entity = $this->value()) {
danielebarchiesi@4:           list($id, $vid, $bundle) = entity_extract_ids($this->type, $entity);
danielebarchiesi@4:           $this->bundle = $bundle;
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:       catch (EntityMetadataWrapperException $e) {
danielebarchiesi@4:         // Loading data failed, so we cannot derive the used bundle.
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4: 
danielebarchiesi@4:     if ($this->bundle && isset($this->propertyInfo['bundles'][$this->bundle])) {
danielebarchiesi@4:       $bundle_info = (array) $this->propertyInfo['bundles'][$this->bundle] + array('properties' => array());
danielebarchiesi@4:       // Allow bundles to re-define existing properties, such that the bundle
danielebarchiesi@4:       // can add in more bundle-specific details like the bundle of a referenced
danielebarchiesi@4:       // entity.
danielebarchiesi@4:       $this->propertyInfo['properties'] = $bundle_info['properties'] + $this->propertyInfo['properties'];
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the identifier of the wrapped entity.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see entity_id()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function getIdentifier() {
danielebarchiesi@4:     return $this->dataAvailable() ? $this->value(array('identifier' => TRUE)) : NULL;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the bundle of an entity, or FALSE if it has no bundles.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function getBundle() {
danielebarchiesi@4:     if ($this->dataAvailable()) {
danielebarchiesi@4:       $this->spotInfo();
danielebarchiesi@4:       return $this->bundle;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Overridden.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $options
danielebarchiesi@4:    *   An array of options. Known keys:
danielebarchiesi@4:    *   - identifier: If set to TRUE, the entity identifier is returned.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function value(array $options = array()) {
danielebarchiesi@4:     // Try loading the data via the getter callback if there is none yet.
danielebarchiesi@4:     if (!isset($this->data)) {
danielebarchiesi@4:       $this->setEntity(parent::value());
danielebarchiesi@4:     }
danielebarchiesi@4:     if (!empty($options['identifier'])) {
danielebarchiesi@4:       return $this->id;
danielebarchiesi@4:     }
danielebarchiesi@4:     elseif (!$this->data && !empty($this->id)) {
danielebarchiesi@4:       // Lazy load the entity if necessary.
danielebarchiesi@4:       $return = entity_load($this->type, array($this->id));
danielebarchiesi@4:       // In case the entity cannot be loaded, we return NULL just as for empty
danielebarchiesi@4:       // properties.
danielebarchiesi@4:       $this->data = $return ? reset($return) : NULL;
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this->data;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the entity prepared for rendering.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see entity_view()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function view($view_mode = 'full', $langcode = NULL, $page = NULL) {
danielebarchiesi@4:     return entity_view($this->type(), array($this->value()), $view_mode, $langcode, $page);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Overridden to support setting the entity by either the object or the id.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function set($value) {
danielebarchiesi@4:     if (!$this->validate($value)) {
danielebarchiesi@4:       throw new EntityMetadataWrapperException('Invalid data value given. Be sure it matches the required data type and format.');
danielebarchiesi@4:     }
danielebarchiesi@4:     if ($this->info['type'] == 'entity' && $value === $this) {
danielebarchiesi@4:       // Nothing to do.
danielebarchiesi@4:       return $this;
danielebarchiesi@4:     }
danielebarchiesi@4:     $previous_id = $this->id;
danielebarchiesi@4:     $previous_type = $this->type;
danielebarchiesi@4:     // Set value, so we get the identifier and pass it to the normal setter.
danielebarchiesi@4:     $this->clear();
danielebarchiesi@4:     $this->setEntity($value);
danielebarchiesi@4:     // Generally, we have to update the parent only if the entity reference
danielebarchiesi@4:     // has changed. In case of a generic entity reference, we pass the entity
danielebarchiesi@4:     // wrapped. Else we just pass the id of the entity to the setter callback.
danielebarchiesi@4:     if ($this->info['type'] == 'entity' && ($previous_id != $this->id || $previous_type != $this->type)) {
danielebarchiesi@4:       // We need to clone the wrapper we pass through as value, so it does not
danielebarchiesi@4:       // get cleared when the current wrapper instance gets cleared.
danielebarchiesi@4:       $this->updateParent(clone $this);
danielebarchiesi@4:     }
danielebarchiesi@4:     // In case the entity has been unset, we cannot properly detect changes as
danielebarchiesi@4:     // the previous id defaults to FALSE for unloaded entities too. So in that
danielebarchiesi@4:     // case we just always update the parent.
danielebarchiesi@4:     elseif ($this->id === FALSE && !$this->data) {
danielebarchiesi@4:       $this->updateParent(NULL);
danielebarchiesi@4:     }
danielebarchiesi@4:     elseif ($previous_id != $this->id) {
danielebarchiesi@4:       $this->updateParent($this->id);
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Overridden.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function clear() {
danielebarchiesi@4:     $this->id = NULL;
danielebarchiesi@4:     $this->bundle = isset($this->info['bundle']) ? $this->info['bundle'] : NULL;
danielebarchiesi@4:     if ($this->type != $this->info['type']) {
danielebarchiesi@4:       // Reset entity info / property info based upon the info provided during
danielebarchiesi@4:       // the creation of the wrapper.
danielebarchiesi@4:       $this->type = $this->info['type'];
danielebarchiesi@4:       $this->setUp();
danielebarchiesi@4:     }
danielebarchiesi@4:     parent::clear();
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Overridden.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function type() {
danielebarchiesi@4:     // In case of a generic entity wrapper, load the data first to determine
danielebarchiesi@4:     // the type of the concrete entity.
danielebarchiesi@4:     if ($this->dataAvailable() && $this->info['type'] == 'entity') {
danielebarchiesi@4:       try {
danielebarchiesi@4:         $this->value(array('identifier' => TRUE));
danielebarchiesi@4:       }
danielebarchiesi@4:       catch (EntityMetadataWrapperException $e) {
danielebarchiesi@4:         // If loading data fails, we cannot determine the concrete entity type.
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this->type;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Checks whether the operation $op is allowed on the entity.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see entity_access()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function entityAccess($op, $account = NULL) {
danielebarchiesi@4:     $entity = $this->dataAvailable() ? $this->value() : NULL;
danielebarchiesi@4:     return entity_access($op, $this->type, $entity, $account);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Permanently save the wrapped entity.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @throws EntityMetadataWrapperException
danielebarchiesi@4:    *   If the entity type does not support saving.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @return EntityDrupalWrapper
danielebarchiesi@4:    */
danielebarchiesi@4:   public function save() {
danielebarchiesi@4:     if ($this->data) {
danielebarchiesi@4:       if (!entity_type_supports($this->type, 'save')) {
danielebarchiesi@4:         throw new EntityMetadataWrapperException("There is no information about how to save entities of type " . check_plain($this->type) . '.');
danielebarchiesi@4:       }
danielebarchiesi@4:       entity_save($this->type, $this->data);
danielebarchiesi@4:       // On insert, update the identifier afterwards.
danielebarchiesi@4:       if (!$this->id) {
danielebarchiesi@4:         list($this->id, , ) = entity_extract_ids($this->type, $this->data);
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     // If the entity hasn't been loaded yet, don't bother saving it.
danielebarchiesi@4:     return $this;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Permanently delete the wrapped entity.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @return EntityDrupalWrapper
danielebarchiesi@4:    */
danielebarchiesi@4:   public function delete() {
danielebarchiesi@4:     if ($this->dataAvailable() && $this->value()) {
danielebarchiesi@4:       $return = entity_delete($this->type, $this->id);
danielebarchiesi@4:       if ($return === FALSE) {
danielebarchiesi@4:         throw new EntityMetadataWrapperException("There is no information about how to delete entities of type " . check_plain($this->type) . '.');
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Gets the info about the wrapped entity.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function entityInfo() {
danielebarchiesi@4:     return $this->entityInfo;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the name of the key used by the entity for given entity key.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $name
danielebarchiesi@4:    *   One of 'id', 'name', 'bundle' or 'revision'.
danielebarchiesi@4:    * @return
danielebarchiesi@4:    *   The name of the key used by the entity.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function entityKey($name) {
danielebarchiesi@4:     return isset($this->entityInfo['entity keys'][$name]) ? $this->entityInfo['entity keys'][$name] : FALSE;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the entity label.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see entity_label()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function label() {
danielebarchiesi@4:     if ($entity = $this->value()) {
danielebarchiesi@4:       return entity_label($this->type, $entity);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Prepare for serializiation.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __sleep() {
danielebarchiesi@4:     $vars = parent::__sleep();
danielebarchiesi@4:     // Don't serialize the loaded entity and its property info.
danielebarchiesi@4:     unset($vars['data'], $vars['propertyInfo'], $vars['propertyInfoAltered'], $vars['entityInfo']);
danielebarchiesi@4:     // In case the entity is not saved yet, serialize the unsaved data.
danielebarchiesi@4:     if ($this->dataAvailable() && $this->id === FALSE) {
danielebarchiesi@4:       $vars['data'] = 'data';
danielebarchiesi@4:     }
danielebarchiesi@4:     return $vars;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function __wakeup() {
danielebarchiesi@4:     $this->setUp();
danielebarchiesi@4:     if ($this->id !== FALSE) {
danielebarchiesi@4:       // Make sure data is set, so the entity will be loaded when needed.
danielebarchiesi@4:       $this->data = FALSE;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Wraps a list of values.
danielebarchiesi@4:  *
danielebarchiesi@4:  * If the wrapped data is a list of data, its numerical indexes may be used to
danielebarchiesi@4:  * retrieve wrappers for the list items. For that this wrapper implements
danielebarchiesi@4:  * ArrayAccess so it may be used like a usual numerically indexed array.
danielebarchiesi@4:  */
danielebarchiesi@4: class EntityListWrapper extends EntityMetadataWrapper implements IteratorAggregate, ArrayAccess, Countable {
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * The type of contained items.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected $itemType;
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Whether this is a list of entities with a known entity type, i.e. for
danielebarchiesi@4:    * generic list of entities (list<entity>) this is FALSE.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected $isEntityList;
danielebarchiesi@4: 
danielebarchiesi@4: 
danielebarchiesi@4:   public function __construct($type, $data = NULL, $info = array()) {
danielebarchiesi@4:     parent::__construct($type, NULL, $info);
danielebarchiesi@4: 
danielebarchiesi@4:     $this->itemType = entity_property_list_extract_type($this->type);
danielebarchiesi@4:     if (!$this->itemType) {
danielebarchiesi@4:       $this->itemType = 'unknown';
danielebarchiesi@4:     }
danielebarchiesi@4:     $this->isEntityList = (bool) entity_get_info($this->itemType);
danielebarchiesi@4: 
danielebarchiesi@4:     if (isset($data)) {
danielebarchiesi@4:       $this->set($data);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Get the wrapper for a single item.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @return
danielebarchiesi@4:    *   An instance of EntityMetadataWrapper.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function get($delta) {
danielebarchiesi@4:     // Look it up in the cache if possible.
danielebarchiesi@4:     if (!array_key_exists($delta, $this->cache)) {
danielebarchiesi@4:       if (!isset($delta)) {
danielebarchiesi@4:         // The [] operator has been used so point at a new entry.
danielebarchiesi@4:         $values = parent::value();
danielebarchiesi@4:         $delta = $values ? max(array_keys($values)) + 1 : 0;
danielebarchiesi@4:       }
danielebarchiesi@4:       if (is_numeric($delta)) {
danielebarchiesi@4:         $info = array('parent' => $this, 'name' => $delta) + $this->info;
danielebarchiesi@4:         $this->cache[$delta] = entity_metadata_wrapper($this->itemType, NULL, $info);
danielebarchiesi@4:       }
danielebarchiesi@4:       else {
danielebarchiesi@4:         throw new EntityMetadataWrapperException('There can be only numerical keyed items in a list.');
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     return $this->cache[$delta];
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   protected function getPropertyValue($delta) {
danielebarchiesi@4:     // Make use parent::value() to easily by-pass any entity-loading.
danielebarchiesi@4:     $data = parent::value();
danielebarchiesi@4:     if (isset($data[$delta])) {
danielebarchiesi@4:       return $data[$delta];
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   protected function getPropertyRaw($delta) {
danielebarchiesi@4:     return $this->getPropertyValue($delta);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   protected function setProperty($delta, $value) {
danielebarchiesi@4:     $data = parent::value();
danielebarchiesi@4:     if (is_numeric($delta)) {
danielebarchiesi@4:       $data[$delta] = $value;
danielebarchiesi@4:       $this->set($data);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   protected function propertyAccess($delta, $op, $account = NULL) {
danielebarchiesi@4:     return $this->access($op, $account);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the list as numerically indexed array.
danielebarchiesi@4:    *
danielebarchiesi@4:    * Note that a list of entities might contain stale entity references. In
danielebarchiesi@4:    * that case the wrapper and the identifier of a stale reference would be
danielebarchiesi@4:    * still accessible, however the entity object value would be NULL. That way,
danielebarchiesi@4:    * there may be NULL values in lists of entity objects due to stale entity
danielebarchiesi@4:    * references.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $options
danielebarchiesi@4:    *   An array of options. Known keys:
danielebarchiesi@4:    *   - identifier: If set to TRUE for a list of entities, it won't be returned
danielebarchiesi@4:    *     as list of fully loaded entity objects, but as a list of entity ids.
danielebarchiesi@4:    *     Note that this list may contain ids of stale entity references.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function value(array $options = array()) {
danielebarchiesi@4:     // For lists of entities fetch full entity objects before returning.
danielebarchiesi@4:     // Generic entity-wrappers need to be handled separately though.
danielebarchiesi@4:     if ($this->isEntityList && empty($options['identifier']) && $this->dataAvailable()) {
danielebarchiesi@4:       $list = parent::value();
danielebarchiesi@4:       $entities = $list ? entity_load($this->get(0)->type, $list) : array();
danielebarchiesi@4:       // Make sure to keep the array keys as present in the list.
danielebarchiesi@4:       foreach ($list as $key => $id) {
danielebarchiesi@4:         // In case the entity cannot be loaded, we return NULL just as for empty
danielebarchiesi@4:         // properties.
danielebarchiesi@4:         $list[$key] = isset($entities[$id]) ? $entities[$id] : NULL;
danielebarchiesi@4:       }
danielebarchiesi@4:       return $list;
danielebarchiesi@4:     }
danielebarchiesi@4:     return parent::value();
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function set($values) {
danielebarchiesi@4:     // Support setting lists of fully loaded entities.
danielebarchiesi@4:     if ($this->isEntityList && $values && is_object(reset($values))) {
danielebarchiesi@4:       foreach ($values as $key => $value) {
danielebarchiesi@4:         list($id, $vid, $bundle) = entity_extract_ids($this->itemType, $value);
danielebarchiesi@4:         $values[$key] = $id;
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     return parent::set($values);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * If we wrap a list, we return an iterator over the data list.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function getIterator() {
danielebarchiesi@4:     // In case there is no data available, just iterate over the first item.
danielebarchiesi@4:     return new EntityMetadataWrapperIterator($this, $this->dataAvailable() ? array_keys(parent::value()) : array(0));
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Implements the ArrayAccess interface.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function offsetGet($delta) {
danielebarchiesi@4:     return $this->get($delta);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function offsetExists($delta) {
danielebarchiesi@4:     return $this->dataAvailable() && ($data = $this->value()) && array_key_exists($delta, $data);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function offsetSet($delta, $value) {
danielebarchiesi@4:     $this->get($delta)->set($value);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function offsetUnset($delta) {
danielebarchiesi@4:     if ($this->offsetExists($delta)) {
danielebarchiesi@4:       unset($this->data[$delta]);
danielebarchiesi@4:       $this->set($this->data);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function count() {
danielebarchiesi@4:     return $this->dataAvailable() ? count($this->value()) : 0;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Overridden.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function validate($value) {
danielebarchiesi@4:     // Required lists may not be empty or unset.
danielebarchiesi@4:     if (!empty($this->info['required']) && empty($value)) {
danielebarchiesi@4:       return FALSE;
danielebarchiesi@4:     }
danielebarchiesi@4:     return parent::validate($value);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Returns the label for the list of set values if available.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function label() {
danielebarchiesi@4:     if ($options = $this->optionsList('view')) {
danielebarchiesi@4:       $options = entity_property_options_flatten($options);
danielebarchiesi@4:       $labels = array_intersect_key($options, array_flip((array) parent::value()));
danielebarchiesi@4:     }
danielebarchiesi@4:     else {
danielebarchiesi@4:       // Get each label on its own, e.g. to support getting labels of a list
danielebarchiesi@4:       // of entities.
danielebarchiesi@4:       $labels = array();
danielebarchiesi@4:       foreach ($this as $key => $property) {
danielebarchiesi@4:         $label = $property->label();
danielebarchiesi@4:         if (!$label) {
danielebarchiesi@4:           return NULL;
danielebarchiesi@4:         }
danielebarchiesi@4:         $labels[] = $label;
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     return isset($labels) ? implode(', ', $labels) : NULL;
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Provide a separate Exception so it can be caught separately.
danielebarchiesi@4:  */
danielebarchiesi@4: class EntityMetadataWrapperException extends Exception { }
danielebarchiesi@4: 
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Allows to easily iterate over existing child wrappers.
danielebarchiesi@4:  */
danielebarchiesi@4: class EntityMetadataWrapperIterator implements RecursiveIterator {
danielebarchiesi@4: 
danielebarchiesi@4:   protected $position = 0;
danielebarchiesi@4:   protected $wrapper, $keys;
danielebarchiesi@4: 
danielebarchiesi@4:   public function __construct(EntityMetadataWrapper $wrapper, array $keys) {
danielebarchiesi@4:     $this->wrapper = $wrapper;
danielebarchiesi@4:     $this->keys = $keys;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   function rewind() {
danielebarchiesi@4:     $this->position = 0;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   function current() {
danielebarchiesi@4:     return $this->wrapper->get($this->keys[$this->position]);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   function key() {
danielebarchiesi@4:     return $this->keys[$this->position];
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   function next() {
danielebarchiesi@4:     $this->position++;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   function valid() {
danielebarchiesi@4:     return isset($this->keys[$this->position]);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function hasChildren() {
danielebarchiesi@4:     return $this->current() instanceof IteratorAggregate;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function getChildren() {
danielebarchiesi@4:     return $this->current()->getIterator();
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * An array object implementation keeping the reference on the given array so
danielebarchiesi@4:  * changes to the object are reflected in the passed array.
danielebarchiesi@4:  */
danielebarchiesi@4: class EntityMetadataArrayObject implements ArrayAccess, Countable, IteratorAggregate {
danielebarchiesi@4: 
danielebarchiesi@4:   protected $data;
danielebarchiesi@4: 
danielebarchiesi@4:   public function __construct(&$array) {
danielebarchiesi@4:     $this->data =& $array;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function &getArray() {
danielebarchiesi@4:     return $this->data;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Implements the ArrayAccess interface.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function offsetGet($delta) {
danielebarchiesi@4:     return $this->data[$delta];
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function offsetExists($delta) {
danielebarchiesi@4:     return array_key_exists($delta, $this->data);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function offsetSet($delta, $value) {
danielebarchiesi@4:     $this->data[$delta] = $value;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function offsetUnset($delta) {
danielebarchiesi@4:     unset($this->data[$delta]);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function count() {
danielebarchiesi@4:     return count($this->data);
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function getIterator() {
danielebarchiesi@4:     return new ArrayIterator($this->data);
danielebarchiesi@4:   }
danielebarchiesi@4: }