class CommerceFileLicenseLogEntity in Commerce File 7

A Commerce File License Log entity class.

It's suggested, but not required, to extend this class and to override __construct() in order to specify a fixed entity type.

For providing an entity label and URI it is suggested to override the defaultLabel() and defaultUri() methods, and to specify the entity_class_label() and entity_class_uri() as respective callbacks in hook_entity_info(). That way modules are able to override your defaults by altering the hook_entity_info() callbacks, while $entity->label() and $entity->uri() reflect this changes as well.

Hierarchy

• class \Entity implements EntityInterface
  • class \CommerceFileLicenseLogEntity

1 string reference to 'CommerceFileLicenseLogEntity'

commerce_file_entity_info in ./commerce_file.module

Implements hook_entity_info().

File

includes/commerce_file_license_log.entity.inc, line 21

Provides a base class for CommreceFileLicenseLogEntity.

class CommerceFileLicenseLogEntity extends Entity {

  /**
   * Overridden __construct()
   *  - set fixed entity type
   *  - merge in defaults
   */
  public function __construct(array $values = array(), $entityType = NULL) {
    parent::__construct($values, COMMERCE_FILE_LICENSE_LOG_ENTITY_NAME);
  }

  // -----------------------------------------------------------------------
  // Base Class overridden functions

  /**
   * Overridden buildContent()
   *  - add custom fields to the output.
   */
  public function buildContent($view_mode = 'full', $langcode = NULL) {
    return $this
      ->get_controller()
      ->buildContent($this, $view_mode, $langcode, $content);
  }

  /**
   * Specifies the default label, which is picked up by label() by default.
   */
  protected function defaultLabel() {
    if (!empty($this->entityInfo['entity keys']['label']) && isset($this->{$this->entityInfo['entity keys']['label']})) {
      return $this->{$this->entityInfo['entity keys']['label']};
    }
    return FALSE;
  }

  /**
   * Specifies the default uri, which is picked up by uri() by default.
   */
  protected function defaultURI() {
    return array(
      'path' => $this->entityType . 's/' . $this
        ->identifier(),
    );
  }

  // -----------------------------------------------------------------------
  // Custom functions

  /**
   * Return entity controller
   */
  public function get_controller() {
    return entity_get_controller($this->entityType);
  }

  /**
   * Access callback
   */
  public function access($op = 'view', $account = NULL) {
    return entity_access($op, $this->entityType, $this, $account);
  }

  /**
   * Invoke hook
   */
  public function invoke($hook) {
    return $this
      ->get_controller()
      ->invoke($hook, $this);
  }

  /**
   * License
   */
  public function license() {
    if (isset($this->license_id)) {
      return commerce_file_license_load($this->license_id);
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommerceFileLicenseLogEntity::access	public	function	Access callback
CommerceFileLicenseLogEntity::buildContent	public	function	Overridden buildContent() Overrides Entity::buildContent
CommerceFileLicenseLogEntity::defaultLabel	protected	function	Specifies the default label, which is picked up by label() by default. Overrides Entity::defaultLabel
CommerceFileLicenseLogEntity::defaultURI	protected	function	Specifies the default uri, which is picked up by uri() by default.
CommerceFileLicenseLogEntity::get_controller	public	function	Return entity controller
CommerceFileLicenseLogEntity::invoke	public	function	Invoke hook
CommerceFileLicenseLogEntity::license	public	function	License
CommerceFileLicenseLogEntity::__construct	public	function	Overridden __construct() Overrides Entity::__construct
Entity::$defaultLabel	protected	property		1
Entity::$entityInfo	protected	property
Entity::$entityType	protected	property
Entity::$idKey	protected	property
Entity::$wrapper	protected	property
Entity::bundle	public	function	Returns the bundle of the entity. Overrides EntityInterface::bundle
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::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::__sleep	public	function	Magic method to only serialize what's necessary.
Entity::__wakeup	public	function	Magic method to invoke setUp() on unserialization.