Inheritance diagram for ElggUser:
Public Member Functions | |||||||||
| getLanguage (string $fallback=null) | |||||||||
| Get user language or default to site language. More... | |||||||||
| __set ($name, $value) | |||||||||
{Set an attribute or metadata value for this entity.Anything that is not an attribute is saved as metadata.Be advised that metadata values are cast to integer or string. You can save booleans, but they will be stored and returned as integers.
| |||||||||
| ban (string $reason='') | |||||||||
| Ban this user. More... | |||||||||
| unban () | |||||||||
| Unban this user. More... | |||||||||
| isBanned () | |||||||||
| Is this user banned or not? More... | |||||||||
| isAdmin () | |||||||||
| Is this user admin? More... | |||||||||
| makeAdmin () | |||||||||
| Make the user an admin. More... | |||||||||
| removeAdmin () | |||||||||
| Remove the admin flag for user. More... | |||||||||
| setLastLogin () | |||||||||
| Sets the last logon time of the user to right now. More... | |||||||||
| setLastAction () | |||||||||
| Sets the last action time of the given user to right now. More... | |||||||||
| isValidated () | |||||||||
| Gets the validation status of a user. More... | |||||||||
| setValidationStatus (bool $status, string $method='') | |||||||||
| Set the validation status for a user. More... | |||||||||
| getGroups (array $options=[]) | |||||||||
| Gets the user's groups. More... | |||||||||
| getObjects (array $options=[]) | |||||||||
| {} More... | |||||||||
| getOwnerGUID () | |||||||||
| Get a user's owner GUID. More... | |||||||||
| setPassword (string $password) | |||||||||
| Set the necessary metadata to store a hash of the user's password. More... | |||||||||
| setNotificationSetting (string $method, bool $enabled=true, string $purpose='default') | |||||||||
| Enable or disable a notification delivery method. More... | |||||||||
| getNotificationSettings (string $purpose='default') | |||||||||
Returns users's notification settings [ 'email' => true, // enabled 'ajax' => false, // disabled ] More... | |||||||||
| persistentDelete (bool $recursive=true) | |||||||||
{Permanently delete the entity from the database.
| |||||||||
| getPluginSetting (string $plugin_id, string $name, $default=null) | |||||||||
| Get a plugin setting. More... | |||||||||
 Public Member Functions inherited from ElggEntity | |||||||||
| __construct (?\stdClass $row=null) | |||||||||
| Create a new entity. More... | |||||||||
| __clone () | |||||||||
| Clone an entity. More... | |||||||||
| getOriginalAttributes () | |||||||||
| Get the original values of attribute(s) that have been modified since the entity was persisted. More... | |||||||||
| __get ($name) | |||||||||
| Get an attribute or metadata value. More... | |||||||||
| getDisplayName () | |||||||||
| Get the entity's display name. More... | |||||||||
| setDisplayName (string $display_name) | |||||||||
| Sets the title or name of this entity. More... | |||||||||
| getVolatileData (string $name) | |||||||||
| Get a piece of volatile (non-persisted) data on this entity. More... | |||||||||
| setVolatileData (string $name, $value) | |||||||||
| Set a piece of volatile (non-persisted) data on this entity. More... | |||||||||
| removeAllRelatedRiverItems () | |||||||||
| Removes all river items related to this entity. More... | |||||||||
| countComments () | |||||||||
| Count the number of comments attached to this entity. More... | |||||||||
| hasAccess (int $user_guid=0) | |||||||||
| Check if the given user has access to this entity. More... | |||||||||
| canEdit (int $user_guid=0) | |||||||||
| Can a user edit this entity? More... | |||||||||
| canDelete (int $user_guid=0) | |||||||||
| Can a user delete this entity? More... | |||||||||
| canWriteToContainer (int $user_guid=0, string $type='', string $subtype='') | |||||||||
| Can a user add an entity to this container. More... | |||||||||
| canComment (int $user_guid=0) | |||||||||
| Can a user comment on an entity? More... | |||||||||
| canAnnotate (int $user_guid=0, string $annotation_name='') | |||||||||
| Can a user annotate an entity? More... | |||||||||
| getGUID () | |||||||||
| Returns the guid. More... | |||||||||
| getType () | |||||||||
| Returns the entity type. More... | |||||||||
| setSubtype (string $subtype) | |||||||||
| Set the subtype of the entity. More... | |||||||||
| getSubtype () | |||||||||
| Get the entity subtype. More... | |||||||||
| getOwnerEntity () | |||||||||
| Gets the \ElggEntity that owns this entity. More... | |||||||||
| setContainerGUID (int $container_guid) | |||||||||
| Set the container for this object. More... | |||||||||
| getContainerGUID () | |||||||||
| Gets the container GUID for this entity. More... | |||||||||
| getContainerEntity () | |||||||||
| Get the container entity for this object. More... | |||||||||
| getTimeUpdated () | |||||||||
| Returns the UNIX epoch time that this entity was last updated. More... | |||||||||
| getURL () | |||||||||
| Gets the URL for this entity. More... | |||||||||
| save () | |||||||||
Save this data to the appropriate database table.
| |||||||||
| disable (string $reason='', bool $recursive=true) | |||||||||
| Disable this entity. More... | |||||||||
| enable (bool $recursive=true) | |||||||||
| Enable the entity. More... | |||||||||
| isEnabled () | |||||||||
| Is this entity enabled? More... | |||||||||
| delete (bool $recursive=true, ?bool $persistent=null) | |||||||||
| Deletes the entity. More... | |||||||||
| restore (bool $recursive=true) | |||||||||
| Restore the entity. More... | |||||||||
| isDeleted () | |||||||||
| Is the entity marked as deleted. More... | |||||||||
| toObject (array $params=[]) | |||||||||
| Export an entity. More... | |||||||||
| setLatLong (float $lat, float $long) | |||||||||
| Set latitude and longitude metadata tags for a given entity. More... | |||||||||
| getLatitude () | |||||||||
| Return the entity's latitude. More... | |||||||||
| getLongitude () | |||||||||
| Return the entity's longitude. More... | |||||||||
| getSystemLogID () | |||||||||
{Return an identification for the object for storage in the system log.This id must be an integer. Unsaved implementations should return 0.
| |||||||||
| getObjectFromID (int $id) | |||||||||
| For a given ID, return the object associated with it. More... | |||||||||
| updateLastAction (?int $posted=null) | |||||||||
| Update the last_action column in the entities table. More... | |||||||||
| updateTimeDeleted (?int $deleted=null) | |||||||||
| Update the time_deleted column in the entities table. More... | |||||||||
| disableCaching () | |||||||||
| Disable runtime caching for entity. More... | |||||||||
| enableCaching () | |||||||||
| Enable runtime caching for entity. More... | |||||||||
| isCacheable () | |||||||||
| Is entity cacheable in the runtime cache. More... | |||||||||
| cache () | |||||||||
| Cache the entity in a session cache. More... | |||||||||
| invalidateCache () | |||||||||
| Invalidate cache for entity. More... | |||||||||
| hasCapability (string $capability) | |||||||||
| Checks a specific capability is enabled for the entity type/subtype. More... | |||||||||
| getFields () | |||||||||
| Helper function to easily retrieve form fields for this entity. More... | |||||||||
| Public Member Functions inherited from ElggData | |||||||||
| __isset ($name) | |||||||||
| Test if property is set either as an attribute or metadata. More... | |||||||||
| __unset ($name) | |||||||||
| Unset a property from metadata or attribute. More... | |||||||||
| delete () | |||||||||
| Delete this data. More... | |||||||||
| getTimeCreated () | |||||||||
| Returns the UNIX epoch time that this entity was created. More... | |||||||||
| rewind () | |||||||||
| Iterator interface. More... | |||||||||
| current () | |||||||||
| Iterator interface. More... | |||||||||
| key () | |||||||||
| Iterator interface. More... | |||||||||
| next () | |||||||||
| Iterator interface. More... | |||||||||
| valid () | |||||||||
| Iterator interface. More... | |||||||||
| offsetSet ($offset, $value) | |||||||||
| Array access interface. More... | |||||||||
| offsetGet ($offset) | |||||||||
| Array access interface. More... | |||||||||
| offsetUnset ($offset) | |||||||||
| Array access interface. More... | |||||||||
| offsetExists ($offset) | |||||||||
| Array access interface. More... | |||||||||
| getID () | |||||||||
{Get unique item identifier within a collection.
| |||||||||
| getPriority () | |||||||||
{Get priority (weight) of the item within a collection.
| |||||||||
| __serialize () | |||||||||
| Called during serialization. More... | |||||||||
| __unserialize (array $data) | |||||||||
| Called during unserialization. More... | |||||||||
Protected Member Functions | ||||
| initializeAttributes () | ||||
{Initialize the attributes array.This is vital to distinguish between metadata and base parameters.
| ||||
| prepareObject (\Elgg\Export\Entity $object) | ||||
{Prepare an object copy for toObject()
| ||||
| Protected Member Functions inherited from ElggEntity | ||||
| create () | ||||
| Create a new entry in the entities table. More... | ||||
| update () | ||||
| Update the entity in the database. More... | ||||
| load (stdClass $row) | ||||
| Loads attributes from the entities table into the object. More... | ||||
| trash (bool $recursive=true) | ||||
| Move the entity to the trash. More... | ||||
| Protected Member Functions inherited from ElggData | ||||
| getDatabase () | ||||
| Provides a pointer to the database object. More... | ||||
Additional Inherited Members | |
| Static Public Member Functions inherited from ElggEntity | |
| static | getDefaultFields () |
| Returns a default set of fields to be used for forms related to this entity. More... | |
| Public Attributes inherited from ElggEntity | |
| const | PRIMARY_ATTR_NAMES |
| Protected Attributes inherited from ElggEntity | |
| const | INTEGER_ATTR_NAMES |
| $volatile = [] | |
| $orig_attributes = [] | |
| $_is_cacheable = true | |
| Protected Attributes inherited from ElggData | |
| $attributes = [] | |
| $valid = false | |
Detailed Description
- Examples
- /root/Elgg/engine/lib/views.php.
Definition at line 28 of file ElggUser.php.
Member Function Documentation
◆ __set()
| ElggUser::__set | ( | $name, | |
| $value | |||
| ) |
{Set an attribute or metadata value for this entity.Anything that is not an attribute is saved as metadata.Be advised that metadata values are cast to integer or string. You can save booleans, but they will be stored and returned as integers.
- Parameters
-
string $name Name of the attribute or metadata mixed $value The value to be set
- Returns
- void
- Exceptions
-
- Exceptions
-
Reimplemented from ElggEntity.
Definition at line 83 of file ElggUser.php.
◆ ban()
| ElggUser::ban | ( | string | $reason = '' | ) |
Ban this user.
- Parameters
-
string $reason Optional reason
- Returns
- bool
Definition at line 127 of file ElggUser.php.
◆ getGroups()
| ElggUser::getGroups | ( | array | $options = [] | ) |
Gets the user's groups.
- Parameters
-
array $options Options array.
- Returns
- \ElggGroup[]|int|mixed
Definition at line 329 of file ElggUser.php.
◆ getLanguage()
| ElggUser::getLanguage | ( | string | $fallback = null | ) |
Get user language or default to site language.
- Parameters
-
string $fallback If this is provided, it will be returned if the user doesn't have a language set. If null, the site language will be returned.
- Returns
- string
Definition at line 66 of file ElggUser.php.
◆ getNotificationSettings()
| ElggUser::getNotificationSettings | ( | string | $purpose = 'default' | ) |
Returns users's notification settings [ 'email' => true, // enabled 'ajax' => false, // disabled ]
- Parameters
-
string $purpose For what purpose to get the notification settings (default: 'default')
- Returns
- array
- Exceptions
-
Definition at line 425 of file ElggUser.php.
◆ getObjects()
| ElggUser::getObjects | ( | array | $options = [] | ) |
{}
Definition at line 340 of file ElggUser.php.
◆ getOwnerGUID()
| ElggUser::getOwnerGUID | ( | ) |
Get a user's owner GUID.
Returns its own GUID if the user is not owned.
- Returns
- int
Reimplemented from ElggEntity.
Definition at line 354 of file ElggUser.php.
◆ getPluginSetting()
| ElggUser::getPluginSetting | ( | string | $plugin_id, |
| string | $name, | ||
$default = null |
|||
| ) |
Get a plugin setting.
Will return $default if the plugin isn't active
- Parameters
-
string $plugin_id plugin ID string $name setting name mixed $default default setting value
- Returns
- mixed
- See also
- \Elgg\Traits\Entity\PluginSettings::getPluginSetting()
Definition at line 469 of file ElggUser.php.
◆ initializeAttributes()
|
protected |
{Initialize the attributes array.This is vital to distinguish between metadata and base parameters.
- Returns
- void
Reimplemented from ElggEntity.
Definition at line 39 of file ElggUser.php.
◆ isAdmin()
| ElggUser::isAdmin | ( | ) |
◆ isBanned()
| ElggUser::isBanned | ( | ) |
◆ isValidated()
| ElggUser::isValidated | ( | ) |
Gets the validation status of a user.
- Returns
- bool|null Null means status was not set for this user.
Definition at line 279 of file ElggUser.php.
◆ makeAdmin()
| ElggUser::makeAdmin | ( | ) |
◆ persistentDelete()
| ElggUser::persistentDelete | ( | bool | $recursive = true | ) |
{Permanently delete the entity from the database.
- Parameters
-
bool $recursive If true (default) then all entities which are owned or contained by $this will also be deleted.
- Returns
- bool
- Since
- 6.0
Reimplemented from ElggEntity.
Definition at line 448 of file ElggUser.php.
◆ prepareObject()
|
protected |
{Prepare an object copy for toObject()
- Parameters
-
\Elgg\Export\Entity $object Object representation of the entity
- Returns
- \Elgg\Export\Entity
Reimplemented from ElggEntity.
Definition at line 366 of file ElggUser.php.
◆ removeAdmin()
| ElggUser::removeAdmin | ( | ) |
◆ setLastAction()
| ElggUser::setLastAction | ( | ) |
Sets the last action time of the given user to right now.
- Returns
- void
Definition at line 255 of file ElggUser.php.
◆ setLastLogin()
| ElggUser::setLastLogin | ( | ) |
Sets the last logon time of the user to right now.
- Returns
- void
Definition at line 235 of file ElggUser.php.
◆ setNotificationSetting()
| ElggUser::setNotificationSetting | ( | string | $method, |
| bool | $enabled = true, |
||
| string | $purpose = 'default' |
||
| ) |
Enable or disable a notification delivery method.
- Parameters
-
string $method Method name bool $enabled Enabled or disabled (default: true) string $purpose For what purpose is the notification setting used (default: 'default')
- Returns
- bool
- Exceptions
-
Definition at line 402 of file ElggUser.php.
◆ setPassword()
| ElggUser::setPassword | ( | string | $password | ) |
Set the necessary metadata to store a hash of the user's password.
- Parameters
-
string $password The password to be hashed
- Returns
- void
- Since
- 1.10.0
Definition at line 383 of file ElggUser.php.
◆ setValidationStatus()
| ElggUser::setValidationStatus | ( | bool | $status, |
| string | $method = '' |
||
| ) |
Set the validation status for a user.
- Parameters
-
bool $status Validated (true) or unvalidated (false) string $method Optional method to say how a user was validated
- Returns
- void
Definition at line 295 of file ElggUser.php.
◆ unban()
| ElggUser::unban | ( | ) |
The documentation for this class was generated from the following file:
- engine/classes/ElggUser.php
