Elgg  Version master
Public Member Functions | Protected Member Functions | List of all members
ElggUser Class Reference
Inheritance diagram for ElggUser:
ElggEntity ElggData Elgg\EntityIcon Elgg\Collections\CollectionItemInterface

Public Member Functions

 getType ()
 {} More...
 
 getLanguage (string $fallback=null)
 Get user language or default to site language. More...
 
 __set ($name, $value)
 {} More...
 
 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...
 
 delete (bool $recursive=true)
 
 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...
 
 __set ($name, $value)
 Set an attribute or metadata value for this 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...
 
 getMetadata (string $name)
 Return the value of a piece of metadata. More...
 
 getAllMetadata ()
 Get all entity metadata. More...
 
 setMetadata (string $name, $value, string $value_type= '', bool $multiple=false)
 Set metadata on this entity. More...
 
 deleteMetadata (string $name=null)
 Deletes all metadata on this object (metadata.entity_guid = $this->guid). 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...
 
 addRelationship (int $guid_two, string $relationship)
 Add a relationship between this an another entity. More...
 
 hasRelationship (int $guid_two, string $relationship)
 Check if this entity has a relationship with another entity. More...
 
 getRelationship (int $guid_two, string $relationship)
 Return the relationship if this entity has a relationship with another entity. More...
 
 getEntitiesFromRelationship (array $options=[])
 Gets an array of entities with a relationship to this entity. More...
 
 countEntitiesFromRelationship (string $relationship, bool $inverse_relationship=false)
 Gets the number of entities from a specific relationship type. More...
 
 removeRelationship (int $guid_two, string $relationship)
 Remove a relationship. More...
 
 removeAllRelationships (string $relationship=null, bool $inverse_relationship=false)
 Remove all relationships to or from this entity. More...
 
 removeAllRelatedRiverItems ()
 Removes all river items related to this entity. More...
 
 deleteAnnotations (string $name=null)
 Deletes all annotations on this object (annotations.entity_guid = $this->guid). More...
 
 deleteOwnedAnnotations (string $name=null)
 Deletes all annotations owned by this object (annotations.owner_guid = $this->guid). More...
 
 disableAnnotations (string $name=null)
 Disables annotations for this entity, optionally based on name. More...
 
 enableAnnotations (string $name=null)
 Enables annotations for this entity, optionally based on name. More...
 
 annotate ($name, $value, $access_id=ACCESS_PRIVATE, $owner_guid=0, $value_type="")
 Adds an annotation to an entity. More...
 
 getAnnotations (array $options=[])
 Gets an array of annotations. More...
 
 countAnnotations (string $name= '')
 Count annotations. More...
 
 getAnnotationsAvg (string $name)
 Get the average of an integer type annotation. More...
 
 getAnnotationsSum (string $name)
 Get the sum of integer type annotations of a given name. More...
 
 getAnnotationsMin (string $name)
 Get the minimum of integer type annotations of given name. More...
 
 getAnnotationsMax (string $name)
 Get the maximum of integer type annotations of a given name. More...
 
 countComments ()
 Count the number of comments attached to this entity. More...
 
 getOwnedAccessCollections (array $options=[])
 Returns the ACLs owned by the entity. More...
 
 getOwnedAccessCollection (string $subtype)
 Returns the first ACL owned by the entity with a given subtype. 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, bool $default=null)
 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...
 
 getOwnerGUID ()
 Get the guid of the entity's owner. More...
 
 getOwnerEntity ()
 Gets the 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...
 
 saveIconFromUploadedFile (string $input_name, string $type= 'icon', array $coords=[])
 Saves icons using an uploaded file as the source. More...
 
 saveIconFromLocalFile (string $filename, string $type= 'icon', array $coords=[])
 Saves icons using a local file as the source. More...
 
 saveIconFromElggFile (\ElggFile $file, string $type= 'icon', array $coords=[])
 Saves icons using a file located in the data store as the source. More...
 
 getIcon (string $size, string $type= 'icon')
 Returns entity icon as an ElggIcon object The icon file may or may not exist on filestore. More...
 
 deleteIcon (string $type= 'icon')
 Removes all icon files and metadata for the passed type of icon. More...
 
 getIconLastChange (string $size, string $type= 'icon')
 Returns the timestamp of when the icon was changed. More...
 
 hasIcon (string $size, string $type= 'icon')
 Returns if the entity has an icon of the passed type. More...
 
 getIconURL (string|array $params=[])
 Get the URL for this entity's icon. More...
 
 save ()
 
 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)
 Deletes the entity. 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. More...
 
 getObjectFromID (int $id)
 For a given ID, return the object associated with it. More...
 
 getTags ($tag_names=null)
 Returns tags for this entity. More...
 
 deleteAccessCollectionMemberships ()
 Remove the membership of all access collections for this entity (if the entity is a user) More...
 
 deleteOwnedAccessCollections ()
 Remove all access collections owned by this entity. More...
 
 updateLastAction (int $posted=null)
 Update the last_action 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 (bool $persist=true)
 Cache the entity in a session and persisted caches. More...
 
 invalidateCache ()
 Invalidate cache for entity. More...
 
 hasCapability (string $capability)
 Checks a specific capability is enabled for the entity type/subtype. 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...
 
 getURL ()
 Get a URL for this object. More...
 
 save ()
 Save this data to the appropriate database table. More...
 
 delete ()
 Delete this data. More...
 
 getTimeCreated ()
 Returns the UNIX epoch time that this entity was created. More...
 
 toObject (array $params=[])
 Get a plain old object copy for public consumption. More...
 
 rewind ()
 Iterator interface. More...
 
 current ()
 Iterator interface. More...
 
 key ()
 Iterator interface. More...
 
 next ()
 Iterator interface. More...
 
 valid ()
 Iterator interface. More...
 
 offsetSet ($key, $value)
 Array access interface. More...
 
 offsetGet ($key)
 Array access interface. More...
 
 offsetUnset ($key)
 Array access interface. More...
 
 offsetExists ($offset)
 Array access interface. More...
 
 getID ()
 {Get unique item identifier within a collection.
Returns
string|int
} More...
 
 getPriority ()
 {Get priority (weight) of the item within a collection.
Returns
int
} More...
 
 __serialize ()
 Called during serialization. More...
 
 __unserialize (array $data)
 Called during unserialization. More...
 
- Public Member Functions inherited from Elgg\EntityIcon
 getIconURL (array $params)
 Returns a URL of the icon. More...
 

Protected Member Functions

 initializeAttributes ()
 {} More...
 
 prepareObject (\Elgg\Export\Entity $object)
 {} More...
 
- Protected Member Functions inherited from ElggEntity
 initializeAttributes ()
 Initialize the attributes array. More...
 
 setTempMetadata (string $name, $value, bool $multiple=false)
 Set temp metadata on this entity. More...
 
 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...
 
 prepareObject (\Elgg\Export\Entity $object)
 Prepare an object copy for toObject() More...
 
- Protected Member Functions inherited from ElggData
 initializeAttributes ()
 Initialize the attributes array. More...
 
 getDatabase ()
 Provides a pointer to the database object. More...
 

Additional Inherited Members

- Public Attributes inherited from ElggEntity
const PRIMARY_ATTR_NAMES
 
- Protected Attributes inherited from ElggEntity
const INTEGER_ATTR_NAMES
 
 $temp_metadata = []
 
 $temp_annotations = []
 
 $volatile = []
 
 $orig_attributes = []
 
 $_is_cacheable = true
 
 $_cached_metadata
 
- Protected Attributes inherited from ElggData
 $attributes = []
 
 $valid = false
 

Detailed Description

Examples:
/root/Elgg/engine/lib/views.php.

Definition at line 29 of file ElggUser.php.

Member Function Documentation

ElggUser::__set (   $name,
  $value 
)

{}

Definition at line 85 of file ElggUser.php.

ElggUser::ban ( string  $reason = '')

Ban this user.

Parameters
string$reasonOptional reason
Returns
bool

Definition at line 128 of file ElggUser.php.

ElggUser::delete ( bool  $recursive = true)

Definition at line 440 of file ElggUser.php.

ElggUser::getGroups ( array  $options = [])

Gets the user's groups.

Parameters
array$optionsOptions array.
Returns
[]|int|mixed

Definition at line 327 of file ElggUser.php.

ElggUser::getLanguage ( string  $fallback = null)

Get user language or default to site language.

Parameters
string$fallbackIf 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 72 of file ElggUser.php.

ElggUser::getNotificationSettings ( string  $purpose = 'default')

Returns users's notification settings [ 'email' => true, // enabled 'ajax' => false, // disabled ]

Parameters
string$purposeFor what purpose to get the notification settings (default: 'default')
Returns
array
Exceptions

Definition at line 416 of file ElggUser.php.

ElggUser::getObjects ( array  $options = [])

{}

Definition at line 338 of file ElggUser.php.

ElggUser::getOwnerGUID ( )

Get a user's owner GUID.

Returns it's own GUID if the user is not owned.

Returns
int

Definition at line 352 of file ElggUser.php.

ElggUser::getPluginSetting ( string  $plugin_id,
string  $name,
  $default = null 
)

Get a plugin setting.

Parameters
string$plugin_idplugin ID
string$namesetting name
mixed$defaultdefault setting value
Returns
mixed
See also
::getPluginSetting()

Definition at line 460 of file ElggUser.php.

ElggUser::getType ( )

{}

Definition at line 60 of file ElggUser.php.

ElggUser::initializeAttributes ( )
protected

{}

Definition at line 40 of file ElggUser.php.

ElggUser::isAdmin ( )

Is this user admin?

Returns
bool

Definition at line 183 of file ElggUser.php.

ElggUser::isBanned ( )

Is this user banned or not?

Returns
bool

Definition at line 174 of file ElggUser.php.

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.

ElggUser::makeAdmin ( )

Make the user an admin.

Returns
bool

Definition at line 192 of file ElggUser.php.

ElggUser::prepareObject ( \Elgg\Export\Entity  $object)
protected

{}

Definition at line 363 of file ElggUser.php.

ElggUser::removeAdmin ( )

Remove the admin flag for user.

Returns
bool

Definition at line 214 of file ElggUser.php.

ElggUser::setLastAction ( )

Sets the last action time of the given user to right now.

Returns
void

Definition at line 255 of file ElggUser.php.

ElggUser::setLastLogin ( )

Sets the last logon time of the user to right now.

Returns
void

Definition at line 236 of file ElggUser.php.

ElggUser::setNotificationSetting ( string  $method,
bool  $enabled = true,
string  $purpose = 'default' 
)

Enable or disable a notification delivery method.

Parameters
string$methodMethod name
bool$enabledEnabled or disabled (default: true)
string$purposeFor what purpose is the notification setting used (default: 'default')
Returns
bool
Exceptions

Definition at line 393 of file ElggUser.php.

ElggUser::setPassword ( string  $password)

Set the necessary metadata to store a hash of the user's password.

Parameters
string$passwordThe password to be hashed
Returns
void
Since
1.10.0

Definition at line 379 of file ElggUser.php.

ElggUser::setValidationStatus ( bool  $status,
string  $method = '' 
)

Set the validation status for a user.

Parameters
bool$statusValidated (true) or unvalidated (false)
string$methodOptional method to say how a user was validated
Returns
void

Definition at line 293 of file ElggUser.php.

ElggUser::unban ( )

Unban this user.

Returns
bool

Definition at line 151 of file ElggUser.php.


The documentation for this class was generated from the following file: