class GProfile in Group 7

Main class for group member profiles.

Hierarchy

• class \Entity implements EntityInterface
  • class \GProfile

1 string reference to 'GProfile'

gprofile_entity_info in modules/gprofile/gprofile.entity.inc

Implements hook_entity_info().

File

modules/gprofile/classes/gprofile.inc, line 10

Defines the Entity API class for group member profiles.

class GProfile extends Entity {

  /**
   * Defines the entity label if the 'entity_class_label' callback is used.
   */
  protected function defaultLabel() {
    $group_membership = $this
      ->getMember();
    $message = '%profile profile for %member in %group';
    $replace = array(
      '%profile' => gprofile_type_load($this->type)
        ->label(),
      '%member' => format_username(user_load($group_membership->uid)),
      '%group' => group_load($group_membership->gid)
        ->label(),
    );
    return t($message, $replace);
  }

  /**
   * Specifies the default uri, which is picked up by uri() by default.
   */
  protected function defaultURI() {
    return $this
      ->getMember()
      ->defaultURI();
  }

  /**
   * Get the member this profile belongs to.
   *
   * @return GroupMembership
   *   The GroupMembership entity of the member.
   */
  public function getMember() {
    $group_memberships = group_membership_load_multiple(array(
      $this->mid,
    ));
    return reset($group_memberships);
  }

}

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::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::__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.
GProfile::defaultLabel	protected	function	Defines the entity label if the 'entity_class_label' callback is used. Overrides Entity::defaultLabel
GProfile::defaultURI	protected	function	Specifies the default uri, which is picked up by uri() by default.
GProfile::getMember	public	function	Get the member this profile belongs to.