interface EntityReference_BehaviorHandler in Entity reference 7

Additional behaviors for a Entity Reference field.

Implementations that wish to provide an implementation of this should register it using CTools' plugin system.

Hierarchy

• interface \EntityReference_BehaviorHandler

File

plugins/behavior/abstract.inc, line 9

interface EntityReference_BehaviorHandler {

  /**
   * Constructor for the behavior.
   *
   * @param $behavior
   *   The name of the behavior plugin.
   */
  public function __construct($behavior);

  /**
   * Alter the field schema.
   *
   * @see hook_field_schema()
   */
  public function schema_alter(&$schema, $field);

  /**
   * Alter the properties information of a field instance.
   *
   * @see entity_hook_field_info()
   */
  public function property_info_alter(&$info, $entity_type, $field, $instance, $field_type);

  /**
   * Alter the views data of a field.
   *
   * @see entityreference_field_views_data()
   */
  public function views_data_alter(&$data, $field);

  /**
   * Act on loading entity reference fields of entities.
   *
   * @see hook_field_load()
   */
  public function load($entity_type, $entities, $field, $instances, $langcode, &$items);

  /**
   * Alter the empty status of a field item.
   *
   * @see hook_field_is_empty()
   */
  public function is_empty_alter(&$empty, $item, $field);

  /**
   * Act on validating an entity reference field.
   *
   * @see hook_field_validate()
   */
  public function validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors);

  /**
   * Act on presaving an entity reference field.
   *
   * @see hook_field_presave()
   */
  public function presave($entity_type, $entity, $field, $instance, $langcode, &$items);

  /**
   * Act before inserting an entity reference field.
   *
   * @see hook_field_insert()
   */
  public function insert($entity_type, $entity, $field, $instance, $langcode, &$items);

  /**
   * Act after inserting an entity reference field.
   *
   * @see hook_field_attach_insert()
   */
  public function postInsert($entity_type, $entity, $field, $instance);

  /**
   * Act before updating an entity reference field.
   *
   * @see hook_field_update()
   */
  public function update($entity_type, $entity, $field, $instance, $langcode, &$items);

  /**
   * Act after updating an entity reference field.
   *
   * @see hook_field_attach_update()
   */
  public function postUpdate($entity_type, $entity, $field, $instance);

  /**
   * Act before deleting an entity with an entity reference field.
   *
   * @see hook_field_delete()
   */
  public function delete($entity_type, $entity, $field, $instance, $langcode, &$items);

  /**
   * Act after deleting an entity with an entity reference field.
   *
   * @see hook_field_attach_delete()
   */
  public function postDelete($entity_type, $entity, $field, $instance);

  /**
   * Act after inserting an entity.
   *
   * @see hook_entity_insert()
   */
  public function entityPostInsert($entity_type, $entity, $field, $instance);

  /**
   * Act after updating an entity.
   *
   * @see hook_entity_update()
   */
  public function entityPostUpdate($entity_type, $entity, $field, $instance);

  /**
   * Act after deleting an entity.
   *
   * @see hook_entity_delete()
   */
  public function entityPostDelete($entity_type, $entity, $field, $instance);

  /**
   * Generate a settings form for this handler.
   */
  public function settingsForm($field, $instance);

  /**
   * Determine if handler should appear.
   */
  public function access($field, $instance);

}

Members

Name	Modifiers	Type	Description	Overrides
EntityReference_BehaviorHandler::access	public	function	Determine if handler should appear.	1
EntityReference_BehaviorHandler::delete	public	function	Act before deleting an entity with an entity reference field.	1
EntityReference_BehaviorHandler::entityPostDelete	public	function	Act after deleting an entity.	1
EntityReference_BehaviorHandler::entityPostInsert	public	function	Act after inserting an entity.	1
EntityReference_BehaviorHandler::entityPostUpdate	public	function	Act after updating an entity.	1
EntityReference_BehaviorHandler::insert	public	function	Act before inserting an entity reference field.	1
EntityReference_BehaviorHandler::is_empty_alter	public	function	Alter the empty status of a field item.	1
EntityReference_BehaviorHandler::load	public	function	Act on loading entity reference fields of entities.	1
EntityReference_BehaviorHandler::postDelete	public	function	Act after deleting an entity with an entity reference field.	1
EntityReference_BehaviorHandler::postInsert	public	function	Act after inserting an entity reference field.	1
EntityReference_BehaviorHandler::postUpdate	public	function	Act after updating an entity reference field.	1
EntityReference_BehaviorHandler::presave	public	function	Act on presaving an entity reference field.	1
EntityReference_BehaviorHandler::property_info_alter	public	function	Alter the properties information of a field instance.	1
EntityReference_BehaviorHandler::schema_alter	public	function	Alter the field schema.	1
EntityReference_BehaviorHandler::settingsForm	public	function	Generate a settings form for this handler.	1
EntityReference_BehaviorHandler::update	public	function	Act before updating an entity reference field.	1
EntityReference_BehaviorHandler::validate	public	function	Act on validating an entity reference field.	1
EntityReference_BehaviorHandler::views_data_alter	public	function	Alter the views data of a field.	1
EntityReference_BehaviorHandler::__construct	public	function	Constructor for the behavior.	1