class CerPreset in Corresponding Entity References 7.3

@file Contains the entity class for CER presets.

Hierarchy

• class \Entity implements EntityInterface
  • class \CerPreset

1 string reference to 'CerPreset'

cer_entity_info in ./cer.module

Implements hook_entity_info().

File

includes/CerPreset.inc, line 8

Contains the entity class for CER presets.

class CerPreset extends Entity {

  /**
   * @var integer
   * The preset's numeric ID in the database.
   */
  public $pid = 0;

  /**
   * @var string
   * The export identifier, in the format $this->cer_left*$this->cer_right.
   */
  public $identifier;

  /**
   * @var EntityMetadataWrapper
   * A metadata wrapper around this preset, for convenience.
   */
  public $wrapper;

  /**
   * @var integer
   * The exportable status of this preset.
   */
  public $status = 0x1;

  // ENTITY_CUSTOM

  /**
   * @var string
   * The module exporting this preset.
   */
  public $module = 'cer';

  /**
   * Overrides Entity::__construct().
   */
  public function __construct(array $values = array()) {
    parent::__construct($values, 'cer');
    $this->wrapper = new EntityDrupalWrapper('cer', $this);
  }

  /**
   * Overrides Entity::label().
   */
  public function label() {
    return isset($this->label_variables) ? t('@left !operator @right', $this->label_variables) : $this
      ->defaultLabel();
  }

  /**
   * Overrides Entity::save().
   */
  public function save() {

    // Generate the export identifier automagically before saving.
    $this->identifier = $this->wrapper->cer_left
      ->value() . '*' . $this->wrapper->cer_right
      ->value();
    parent::save();
  }
  public function invert() {
    $init = get_object_vars($this);
    unset($init['pid'], $init['wrapper'], $init['identifier'], $init['status']);
    $buf = $init['cer_left'];
    $init['cer_left'] = $init['cer_right'];
    $init['cer_right'] = $buf;
    return entity_create('cer', $init);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CerPreset::$identifier	public	property	The export identifier, in the format $this->cer_left*$this->cer_right.
CerPreset::$module	public	property	The module exporting this preset.
CerPreset::$pid	public	property	The preset's numeric ID in the database.
CerPreset::$status	public	property	The exportable status of this preset.
CerPreset::$wrapper	public	property	A metadata wrapper around this preset, for convenience. Overrides Entity::$wrapper
CerPreset::invert	public	function
CerPreset::label	public	function	Overrides Entity::label(). Overrides Entity::label
CerPreset::save	public	function	Overrides Entity::save(). Overrides Entity::save
CerPreset::__construct	public	function	Overrides Entity::__construct(). Overrides Entity::__construct
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::buildContent	public	function	Builds a structured array representing the entity's content. Overrides EntityInterface::buildContent	1
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
Entity::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used.	1
Entity::defaultUri	protected	function	Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info().
Entity::delete	public	function	Permanently deletes the entity. Overrides EntityInterface::delete
Entity::entityInfo	public	function	Returns the info of the type of the entity. Overrides EntityInterface::entityInfo
Entity::entityType	public	function	Returns the type of the entity. Overrides EntityInterface::entityType
Entity::export	public	function	Exports the entity. Overrides EntityInterface::export
Entity::getTranslation	public	function	Gets the raw, translated value of a property or field. Overrides EntityInterface::getTranslation
Entity::hasStatus	public	function	Checks if the entity has a certain exportable status. Overrides EntityInterface::hasStatus
Entity::identifier	public	function	Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface::identifier
Entity::internalIdentifier	public	function	Returns the internal, numeric identifier. Overrides EntityInterface::internalIdentifier
Entity::isDefaultRevision	public	function	Checks whether the entity is the default revision. Overrides EntityInterface::isDefaultRevision
Entity::setUp	protected	function	Set up the object instance on construction or unserializiation.
Entity::uri	public	function	Returns the uri of the entity just as entity_uri(). Overrides EntityInterface::uri
Entity::view	public	function	Generate an array for rendering the entity. Overrides EntityInterface::view
Entity::wrapper	public	function	Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface::wrapper
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.