class EntityExampleBasic

EntityExampleBasic extends Entity.

A subclass of Entity is a requirement for creating a custom entity. It is also a minimum requirement to define the methods included here, even as empty functions.

Hierarchy

class Entity extends \stdClass implements EntityInterface
- class EntityExampleBasic

Expanded class hierarchy of EntityExampleBasic

1 string reference to 'EntityExampleBasic'

entity_example_entity_info in modules/examples/entity_example/entity_example.module: Implements hook_entity_info().

File

modules/examples/entity_example/entity_example.inc, line 11

View source

class EntityExampleBasic extends Entity {

  /**
   * The basic ID.
   *
   * @var integer
   */
  public $basic_id;

  /**
   * Item description.
   */
  public $item_description;

  /**
   * The bundle type.
   *
   * @var string
   */
  public $bundle_type;

  /**
   * Implements EntityInterface::id().
   */
  public function id() {
    return isset($this->basic_id) ? $this->basic_id : NULL;
  }

  /**
   * Implements EntityInterface::entityType().
   */
  public function entityType() {
    return 'entity_example_basic';
  }

  /**
   * Implements EntityInterface::bundle().
   */
  public function bundle() {
    return $this->bundle_type;
  }

  /**
   * Implements EntityInterface::label().
   */
  public function label() {
    return $this->item_description;
  }

  /**
   * Implements EntityInterface::uri().
   */
  public function uri() {
    return array(
      'path' => 'examples/entity_example/basic/' . $this->basic_id,
      'options' => array(),
    );
  }
}

Members

Name	Modifiers	Type	Description
Entity::$is_active_revision	public	property	Indicates whether this is the active revision.
Entity::access	public	function	Implements EntityInterface::access(). Overrides EntityInterface::access
Entity::buildContent	public	function	Implements EntityInterface::buildContent(). Overrides EntityInterface::buildContent
Entity::createAccess	public static	function	Implements EntityInterface::createAccess(). Overrides EntityInterface::createAccess
Entity::createDuplicate	public	function	Implements EntityInterface::createDuplicate(). Overrides EntityInterface::createDuplicate
Entity::delete	public	function	Implements EntityInterface::delete(). Overrides EntityInterface::delete
Entity::getFieldValue	public	function	Implements EntityInterface::getFieldValue(). Overrides EntityInterface::getFieldValue
Entity::getFieldValues	public	function	Implements EntityInterface::getFieldValues(). Overrides EntityInterface::getFieldValues
Entity::getRevisionId	public	function	Implements Backdrop\entity\EntityInterface::getRevisionId(). Overrides EntityInterface::getRevisionId
Entity::isActiveRevision	public	function	Implements Backdrop\entity\EntityInterface::isActiveRevision(). Overrides EntityInterface::isActiveRevision
Entity::isNew	public	function	Implements EntityInterface::isNew(). Overrides EntityInterface::isNew
Entity::save	public	function	Implements EntityInterface::save(). Overrides EntityInterface::save
Entity::setIsActiveRevision	public	function	Implements Backdrop\entity\EntityInterface::setActiveRevision(). Overrides EntityInterface::setIsActiveRevision
Entity::view	public	function	Implements EntityInterface::view(). Overrides EntityInterface::view
Entity::__construct	public	function	Constructs a new entity object. Overrides EntityInterface::__construct
EntityExampleBasic::$basic_id	public	property	The basic ID.
EntityExampleBasic::$bundle_type	public	property	The bundle type.
EntityExampleBasic::$item_description	public	property	Item description.
EntityExampleBasic::bundle	public	function	Implements EntityInterface::bundle(). Overrides Entity::bundle
EntityExampleBasic::entityType	public	function	Implements EntityInterface::entityType(). Overrides EntityInterface::entityType
EntityExampleBasic::id	public	function	Implements EntityInterface::id(). Overrides EntityInterface::id
EntityExampleBasic::label	public	function	Implements EntityInterface::label(). Overrides EntityInterface::label
EntityExampleBasic::uri	public	function	Implements EntityInterface::uri(). Overrides EntityInterface::uri