You are here

class CivicrmEntity in CiviCRM Entity 7

Same name and namespace in other branches
  1. 7.2 civicrm_entity.inc \CivicrmEntity

@TODO Document this class.

Hierarchy

Expanded class hierarchy of CivicrmEntity

File

./civicrm_entity.inc, line 5

View source
class CivicrmEntity extends Entity {

  /**
   * Creates a new entity.
   *
   * @see entity_create()
   */
  public function __construct(array $values = array(), $entityType = NULL) {
    if (empty($entityType)) {
      throw new Exception('Cannot create an instance of Entity without a specified entity type.');
    }
    $this->entityType = $entityType;
    $this
      ->setUp();

    // Set initial values.
    foreach ($values as $key => $value) {

      // this is a bit of a hack around the fact we are casting to this to construct it
      if (stristr($key, "\0")) {
        continue;
      }
      $this->{$key} = $value;
    }
  }

  /**
   * Please document this function.
   */
  protected function defaultLabel() {
    return $this->title;
  }

  /**
   * Please document this function.
   */
  protected function defaultUri() {
    return array(
      'path' => 'task/' . $this
        ->identifier(),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CivicrmEntity::defaultLabel protected function Please document this function. Overrides Entity::defaultLabel
CivicrmEntity::defaultUri protected function Please document this function. Overrides Entity::defaultUri
CivicrmEntity::__construct public function Creates a new entity. 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::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::__sleep public function Magic method to only serialize what's necessary.
Entity::__wakeup public function Magic method to invoke setUp() on unserialization.