class ProfileType in Profile 2 7.2
Same name and namespace in other branches
- 7 profile2.module \ProfileType
Use a separate class for profile types so we can specify some defaults modules may alter.
Hierarchy
- class \Entity implements EntityInterface
- class \ProfileType
Expanded class hierarchy of ProfileType
1 string reference to 'ProfileType'
- profile2_entity_info in ./
profile2.module - Implements hook_entity_info().
File
- ./
profile2.module, line 1310 - Support for configurable user profiles.
View source
class ProfileType extends Entity {
/**
* Whether the profile type appears in the user categories.
*/
public $userCategory = TRUE;
/**
* Whether the profile is displayed on the user account page.
*/
public $userView = TRUE;
public $type;
public $label;
public $weight = 0;
public function __construct($values = array()) {
parent::__construct($values, 'profile2_type');
}
/**
* Returns whether the profile type is locked, thus may not be deleted or renamed.
*
* Profile types provided in code are automatically treated as locked, as well
* as any fixed profile type.
*/
public function isLocked() {
return isset($this->status) && empty($this->is_new) && ($this->status & ENTITY_IN_CODE || $this->status & ENTITY_FIXED);
}
/**
* Overridden, to introduce the method for old entity API versions (BC).
*
* @todo Remove once we bump the required entity API version.
*/
public function getTranslation($property, $langcode = NULL) {
if (module_exists('profile2_i18n')) {
return parent::getTranslation($property, $langcode);
}
return $this->{$property};
}
/**
* Overrides Entity::save().
*/
public function save() {
parent::save();
// Clear field info caches such that any changes to extra fields get
// reflected.
field_info_cache_clear();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Entity:: |
protected | property | 1 | |
Entity:: |
protected | property | ||
Entity:: |
protected | property | ||
Entity:: |
protected | property | ||
Entity:: |
protected | property | ||
Entity:: |
public | function |
Builds a structured array representing the entity's content. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Returns the bundle of the entity. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Defines the entity label if the 'entity_class_label' callback is used. | 1 |
Entity:: |
protected | function | Override this in order to implement a custom default URI and specify 'entity_class_uri' as 'uri callback' hook_entity_info(). | |
Entity:: |
public | function |
Permanently deletes the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns the info of the type of the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns the type of the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Exports the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Checks if the entity has a certain exportable status. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns the entity identifier, i.e. the entities name or numeric id. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns the internal, numeric identifier. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Checks whether the entity is the default revision. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns the label of the entity. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Set up the object instance on construction or unserializiation. | |
Entity:: |
public | function |
Returns the uri of the entity just as entity_uri(). Overrides EntityInterface:: |
|
Entity:: |
public | function |
Generate an array for rendering the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Returns the EntityMetadataWrapper of the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function | Magic method to only serialize what's necessary. | |
Entity:: |
public | function | Magic method to invoke setUp() on unserialization. | |
ProfileType:: |
public | property | ||
ProfileType:: |
public | property | ||
ProfileType:: |
public | property | Whether the profile type appears in the user categories. | |
ProfileType:: |
public | property | Whether the profile is displayed on the user account page. | |
ProfileType:: |
public | property | ||
ProfileType:: |
public | function |
Overridden, to introduce the method for old entity API versions (BC). Overrides Entity:: |
|
ProfileType:: |
public | function | Returns whether the profile type is locked, thus may not be deleted or renamed. | |
ProfileType:: |
public | function |
Overrides Entity::save(). Overrides Entity:: |
|
ProfileType:: |
public | function |
Overrides Entity:: |