danielebarchiesi@4: <?php
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Additional behaviors for a Entity Reference field.
danielebarchiesi@4:  *
danielebarchiesi@4:  * Implementations that wish to provide an implementation of this should
danielebarchiesi@4:  * register it using CTools' plugin system.
danielebarchiesi@4:  */
danielebarchiesi@4: interface EntityReference_BehaviorHandler {
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Constructor for the behavior.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @param $behavior
danielebarchiesi@4:    *   The name of the behavior plugin.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function __construct($behavior);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Alter the field schema.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_schema()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function schema_alter(&$schema, $field);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Alter the properties information of a field instance.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see entity_hook_field_info()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function property_info_alter(&$info, $entity_type, $field, $instance, $field_type);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Alter the views data of a field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see entityreference_field_views_data()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function views_data_alter(&$data, $field);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act on loading entity reference fields of entities.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_load()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function load($entity_type, $entities, $field, $instances, $langcode, &$items);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Alter the empty status of a field item.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_is_empty()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function is_empty_alter(&$empty, $item, $field);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act on validating an entity reference field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_validate()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act on presaving an entity reference field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_presave()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function presave($entity_type, $entity, $field, $instance, $langcode, &$items);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act before inserting an entity reference field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_insert()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function insert($entity_type, $entity, $field, $instance, $langcode, &$items);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act after inserting an entity reference field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_attach_insert()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function postInsert($entity_type, $entity, $field, $instance);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act before updating an entity reference field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_update()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function update($entity_type, $entity, $field, $instance, $langcode, &$items);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act after updating an entity reference field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_attach_update()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function postUpdate($entity_type, $entity, $field, $instance);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act before deleting an entity with an entity reference field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_delete()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function delete($entity_type, $entity, $field, $instance, $langcode, &$items);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act after deleting an entity with an entity reference field.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_field_attach_delete()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function postDelete($entity_type, $entity, $field, $instance);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act after inserting an entity.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_entity_insert()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function entityPostInsert($entity_type, $entity, $field, $instance);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act after updating an entity.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_entity_update()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function entityPostUpdate($entity_type, $entity, $field, $instance);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Act after deleting an entity.
danielebarchiesi@4:    *
danielebarchiesi@4:    * @see hook_entity_delete()
danielebarchiesi@4:    */
danielebarchiesi@4:   public function entityPostDelete($entity_type, $entity, $field, $instance);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Generate a settings form for this handler.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function settingsForm($field, $instance);
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * Determine if handler should appear.
danielebarchiesi@4:    */
danielebarchiesi@4:   public function access($field, $instance);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * An abstract implementation of EntityReference_BehaviorHandler.
danielebarchiesi@4:  */
danielebarchiesi@4: abstract class EntityReference_BehaviorHandler_Abstract implements EntityReference_BehaviorHandler {
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * The name of the behavior plugin.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected $behavior;
danielebarchiesi@4: 
danielebarchiesi@4:   /**
danielebarchiesi@4:    * The plugin definition.
danielebarchiesi@4:    */
danielebarchiesi@4:   protected $plugin;
danielebarchiesi@4: 
danielebarchiesi@4:   public function __construct($behavior) {
danielebarchiesi@4:     $this->behavior = $behavior;
danielebarchiesi@4: 
danielebarchiesi@4:     ctools_include('plugins');
danielebarchiesi@4:     $plugin = ctools_get_plugins('entityreference', 'behavior', $behavior);
danielebarchiesi@4:     $this->plugin = $plugin;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   public function schema_alter(&$schema, $field) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function property_info_alter(&$info, $entity_type, $field, $instance, $field_type) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function views_data_alter(&$data, $field) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function load($entity_type, $entities, $field, $instances, $langcode, &$items) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function is_empty_alter(&$empty, $item, $field) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function presave($entity_type, $entity, $field, $instance, $langcode, &$items) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function insert($entity_type, $entity, $field, $instance, $langcode, &$items) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function postInsert($entity_type, $entity, $field, $instance) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function update($entity_type, $entity, $field, $instance, $langcode, &$items) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function postUpdate($entity_type, $entity, $field, $instance) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function delete($entity_type, $entity, $field, $instance, $langcode, &$items) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function postDelete($entity_type, $entity, $field, $instance) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function entityPostInsert($entity_type, $entity, $field, $instance) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function entityPostUpdate($entity_type, $entity, $field, $instance) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function entityPostDelete($entity_type, $entity, $field, $instance) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function settingsForm($field, $instance) {}
danielebarchiesi@4: 
danielebarchiesi@4:   public function access($field, $instance) {
danielebarchiesi@4:     return TRUE;
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * A broken implementation of EntityReference_BehaviorHandler.
danielebarchiesi@4:  */
danielebarchiesi@4: class EntityReference_BehaviorHandler_Broken extends EntityReference_BehaviorHandler_Abstract {
danielebarchiesi@4:   public function settingsForm($field, $instance) {
danielebarchiesi@4:     $form['behavior_handler'] = array(
danielebarchiesi@4:       '#markup' => t('The selected behavior handler is broken.'),
danielebarchiesi@4:     );
danielebarchiesi@4:     return $form;
danielebarchiesi@4:   }
danielebarchiesi@4: }