class FormAssemblyEntity in FormAssembly 7

@file An Entity class for the FormAssembly entity

Longer file description goes here Author: Shawn P. Duncan Date: 7/23/14 Time: 1:14 PM

Hierarchy

• class \Entity implements EntityInterface
  • class \FormAssemblyEntity

1 string reference to 'FormAssemblyEntity'

formassembly_entity_info in ./formassembly.module

Implements hook_entity_info().

File

includes/FormAssemblyEntity.php, line 12

An Entity class for the FormAssembly entity

class FormAssemblyEntity extends Entity {

  /**
   * Overrides the parent method to implement a custom default label.
   *
   * @return string
   *   Returns the name property of the fa_form
   */
  protected function defaultLabel() {
    return $this->name;
  }

  /**
   * Overrides the parent method to implement a custom default URI.
   *
   * @return array
   *   Drupal path specification
   */
  protected function defaultUri() {
    return array(
      'path' => 'formassembly/' . $this
        ->identifier(),
    );
  }

  /**
   * Get the value on the fa_form->modified field.
   *
   * @return string
   *   Unix timestamp as Drupal date
   */
  public function getModified() {
    return $this->modified;
  }

  /**
   * Fully update the entity with new data obtained from FormAssembly.
   *
   * The Form Assembly ID (faid) is persistent.
   *
   * @param array $data
   *   An array of values to set
   */
  public function updateData($data) {
    $this->modified = $data['modified'];
    $this->name = $data['name'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	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::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::label	public	function	Returns the label of the entity. Overrides EntityInterface::label
Entity::save	public	function	Permanently saves the entity. Overrides EntityInterface::save
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::__construct	public	function		1
Entity::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
FormAssemblyEntity::defaultLabel	protected	function	Overrides the parent method to implement a custom default label. Overrides Entity::defaultLabel
FormAssemblyEntity::defaultUri	protected	function	Overrides the parent method to implement a custom default URI. Overrides Entity::defaultUri
FormAssemblyEntity::getModified	public	function	Get the value on the fa_form->modified field.
FormAssemblyEntity::updateData	public	function	Fully update the entity with new data obtained from FormAssembly.