interface CerHandlerInterface in Corresponding Entity References 7.2

Hierarchy

• interface \CerHandlerInterface

File

./handler.inc, line 15

Contains base code for CER handlers, which are objects responsible for creating, updating and deleting corresponding references between entities.

interface CerHandlerInterface {

  /**
   * @constructor
   *
   * @param string $preset
   *  The CER preset string, in the format:
   *  entity_a*bundle_a*field_a*entity_b*bundle_b*field_b.
   *
   * @param $entity.
   *  The local (home) entity to be wrapped by this instance.
   */
  public function __construct($preset, $entity);

  /**
   * Create reciprocal references on referenced entities after the
   * local entity has been created.
   */
  public function insert();

  /**
   * Delete reciprocal references on entities the local entity is no
   * longer referencing, and create new reciprocal references, after
   * the local entity has been updated.
   */
  public function update();

  /**
   * Delete all reciprocal references after the local entity is deleted.
   */
  public function delete();

  /**
   * Check if $entity is referenced by the local entity.
   *
   * @param object $entity
   *  The remote entity.
   *
   * @return boolean
   */
  public function references($entity);

  /**
   * Check if the local entity is referenced by $entity.
   *
   * @param object $entity
   *  The remote entiy.
   *
   * @return boolean
   */
  public function referencedBy($entity);

  /**
   * Check if the remote entity can reference the local entity, and vice-versa.
   *
   * @param object $entity
   *  The remote entity.
   *
   * @return boolean
   */
  public function referenceable($entity);

  /**
   * Create a reference to the local entity on the remote entity, and vice-versa
   * if needed. Should throw CerException if the reference(s) can't be created
   * for any reason.
   *
   * @param object $entity
   */
  public function reference($entity);

  /**
   * Delete all references to the remote entity from the local entity,
   * and delete reciprocal references from the remote entity.
   *
   * @param object $entity.
   */
  public function dereference($entity);

}

Members

Name	Modifiers	Type	Description	Overrides
CerHandlerInterface::delete	public	function	Delete all reciprocal references after the local entity is deleted.	1
CerHandlerInterface::dereference	public	function	Delete all references to the remote entity from the local entity, and delete reciprocal references from the remote entity.	1
CerHandlerInterface::insert	public	function	Create reciprocal references on referenced entities after the local entity has been created.	1
CerHandlerInterface::reference	public	function	Create a reference to the local entity on the remote entity, and vice-versa if needed. Should throw CerException if the reference(s) can't be created for any reason.	1
CerHandlerInterface::referenceable	public	function	Check if the remote entity can reference the local entity, and vice-versa.	1
CerHandlerInterface::referencedBy	public	function	Check if the local entity is referenced by $entity.	1
CerHandlerInterface::references	public	function	Check if $entity is referenced by the local entity.	1
CerHandlerInterface::update	public	function	Delete reciprocal references on entities the local entity is no longer referencing, and create new reciprocal references, after the local entity has been updated.	1
CerHandlerInterface::__construct	public	function	@constructor