class EntityLegalDocumentAcceptance in Entity Legal 7

Legal document user acceptance entity.

A user acceptance entity is linked directly with a legal document revision and is used to track which users have accepted which revision.

Hierarchy

• class \Entity implements EntityInterface
  • class \EntityLegalDocumentAcceptance

1 string reference to 'EntityLegalDocumentAcceptance'

entity_legal_entity_info in ./entity_legal.module

Implements hook_entity_info().

File

./entity_legal.entity.inc, line 436

Entity API main classes used by entity_legal module.

class EntityLegalDocumentAcceptance extends Entity {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $values = array(), $entity_type = NULL) {
    parent::__construct($values, ENTITY_LEGAL_DOCUMENT_ACCEPTANCE_ENTITY_NAME);
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return t('Accepted on @date', array(
      '@date' => format_date($this->acceptance_date),
    ));
  }

  /**
   * {@inheritdoc}
   */
  protected function defaultURI() {
    return NULL;
  }

  /**
   * Get the name of the document this acceptance belongs to.
   *
   * @return string
   *   The name of the document version this acceptance belongs to.
   */
  public function getDocumentVersionName() {
    return $this->document_version_name;
  }

  /**
   * Get the document version this acceptance belongs to.
   *
   * @return EntityLegalDocumentVersion
   *   The version of the document corresponding to this acceptance.
   */
  public function getDocumentVersion() {
    return entity_load_single(ENTITY_LEGAL_DOCUMENT_VERSION_ENTITY_NAME, $this
      ->getDocumentVersionName());
  }

  /**
   * Get the date a user created this acceptance.
   *
   * @return string
   *   The date this document was accepted.
   */
  public function getAcceptanceDate() {
    return $this->acceptance_date;
  }

}

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::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::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::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.
EntityLegalDocumentAcceptance::defaultURI	protected	function
EntityLegalDocumentAcceptance::getAcceptanceDate	public	function	Get the date a user created this acceptance.
EntityLegalDocumentAcceptance::getDocumentVersion	public	function	Get the document version this acceptance belongs to.
EntityLegalDocumentAcceptance::getDocumentVersionName	public	function	Get the name of the document this acceptance belongs to.
EntityLegalDocumentAcceptance::label	public	function	Returns the label of the entity. Overrides Entity::label
EntityLegalDocumentAcceptance::__construct	public	function	Overrides Entity::__construct