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

Public Member Functions

 getType ()
 {} More...
 
 getLanguage ($fallback=null)
 Get user language or default to site language. More...
 
 __set ($name, $value)
 {} More...
 
 getURL ()
 {} More...
 
 ban ($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 ($status, $method= '')
 Set the validation status for a user. More...
 
 addFriend ($friend_guid, $create_river_item=false)
 Adds a user as a friend. More...
 
 removeFriend ($friend_guid)
 Removes a user as a friend. More...
 
 isFriend ()
 Determines whether or not this user is a friend of the currently logged in user. More...
 
 isFriendsWith ($user_guid)
 Determines whether this user is friends with another user. More...
 
 isFriendOf ($user_guid)
 Determines whether or not this user is another user's friend. More...
 
 getFriends (array $options=[])
 {Gets this entity's friends.
Parameters
array$optionsOptions array. See elgg_get_entities() for a list of options. 'relationship_guid' is set to this entity, relationship name to 'friend' and type to 'user'.
Returns
[]|int|mixed
} More...
 
 getFriendsOf (array $options=[])
 {Gets users who have made this entity a friend.
Parameters
array$optionsOptions array. See elgg_get_entities() for a list of options. 'relationship_guid' is set to this entity, relationship name to 'friend', type to 'user' and inverse_relationship to true.
Returns
[]|int|mixed
} More...
 
 getGroups (array $options=[])
 Gets the user's groups. More...
 
 getObjects (array $options=[])
 {Get an array of owned by this entity.
Parameters
array$optionsOptions array. See elgg_get_entities() for a list of options. 'type' is set to object and owner_guid to this entity.
Returns
[]|int|mixed
} More...
 
 getFriendsObjects (array $options=[])
 {Get an array of owned by this entity's friends.
Parameters
array$optionsOptions array. See elgg_get_entities() for a list of options. 'relationship_guid' is set to this entity, type to 'object', relationship name to 'friend' and relationship_join_on to 'container_guid'.
Returns
[]|int|mixed
} More...
 
 getOwnerGUID ()
 Get a user's owner GUID. More...
 
 canComment ($user_guid=0, $default=null)
 Can a user comment on this user? More...
 
 setPassword ($password)
 Set the necessary metadata to store a hash of the user's password. More...
 
 setNotificationSetting ($method, $enabled=true)
 Enable or disable a notification delivery method. More...
 
 getNotificationSettings ()
 Returns users's notification settings [ 'email' => true, // enabled 'ajax' => false, // disabled ] More...
 
 cache ($persist=true)
 Cache the entity in a session and persisted caches. More...
 
 invalidateCache ()
 Invalidate cache for entity. More...
 
 delete ($recursive=true)
 
- 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 ($display_name)
 Sets the title or name of this entity. More...
 
 getMetadata ($name)
 Return the value of a piece of metadata. More...
 
 getAllMetadata ()
 Get all entity metadata. More...
 
 setMetadata ($name, $value, $value_type= '', $multiple=false)
 Set metadata on this entity. More...
 
 deleteMetadata ($name=null)
 Deletes all metadata on this object (metadata.entity_guid = $this->guid). More...
 
 getVolatileData ($name)
 Get a piece of volatile (non-persisted) data on this entity. More...
 
 setVolatileData ($name, $value)
 Set a piece of volatile (non-persisted) data on this entity. More...
 
 deleteRelationships ($relationship=null)
 Remove all relationships to and from this entity. More...
 
 addRelationship ($guid_two, $relationship)
 Add a relationship between this an another entity. More...
 
 removeRelationship ($guid_two, $relationship)
 Remove a relationship. More...
 
 setPrivateSetting ($name, $value)
 Adds a private setting to this entity. More...
 
 getPrivateSetting ($name)
 Returns a private setting value. More...
 
 getAllPrivateSettings ()
 Returns all private settings. More...
 
 removePrivateSetting ($name)
 Removes private setting. More...
 
 removeAllPrivateSettings ()
 Removes all private settings. More...
 
 removeAllRelatedRiverItems ()
 Removes all river items related to this entity. More...
 
 deleteAnnotations ($name=null)
 Deletes all annotations on this object (annotations.entity_guid = $this->guid). More...
 
 deleteOwnedAnnotations ($name=null)
 Deletes all annotations owned by this object (annotations.owner_guid = $this->guid). More...
 
 disableAnnotations ($name= '')
 Disables annotations for this entity, optionally based on name. More...
 
 enableAnnotations ($name= '')
 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 ($name="")
 Count annotations. More...
 
 getAnnotationsAvg ($name)
 Get the average of an integer type annotation. More...
 
 getAnnotationsSum ($name)
 Get the sum of integer type annotations of a given name. More...
 
 getAnnotationsMin ($name)
 Get the minimum of integer type annotations of given name. More...
 
 getAnnotationsMax ($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 ($options=[])
 Returns the ACLs owned by the entity. More...
 
 getOwnedAccessCollection ($subtype)
 Returns the first ACL owned by the entity with a given subtype. More...
 
 getEntitiesFromRelationship (array $options=[])
 Gets an array of entities with a relationship to this entity. More...
 
 countEntitiesFromRelationship ($relationship, $inverse_relationship=false)
 Gets the number of entities from a specific relationship type. More...
 
 canEdit ($user_guid=0)
 Can a user edit this entity? More...
 
 canDelete ($user_guid=0)
 Can a user delete this entity? More...
 
 canEditMetadata ($metadata=null, $user_guid=0)
 Can a user edit metadata on this entity? More...
 
 canWriteToContainer ($user_guid=0, $type= 'all', $subtype= 'all')
 Can a user add an entity to this container. More...
 
 canComment ($user_guid=0, $default=null)
 Can a user comment on an entity? More...
 
 canAnnotate ($user_guid=0, $annotation_name= '')
 Can a user annotate an entity? More...
 
 getAccessID ()
 Returns the access_id. More...
 
 getGUID ()
 Returns the guid. More...
 
 getType ()
 Returns the entity type. 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 ($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 ($input_name, $type= 'icon', array $coords=[])
 Saves icons using an uploaded file as the source. More...
 
 saveIconFromLocalFile ($filename, $type= 'icon', array $coords=[])
 Saves icons using a local file as the source. More...
 
 saveIconFromElggFile (\ElggFile $file, $type= 'icon', array $coords=[])
 Saves icons using a file located in the data store as the source. More...
 
 getIcon ($size, $type= 'icon')
 Returns entity icon as an ElggIcon object The icon file may or may not exist on filestore. More...
 
 deleteIcon ($type= 'icon')
 Removes all icon files and metadata for the passed type of icon. More...
 
 getIconLastChange ($size, $type= 'icon')
 Returns the timestamp of when the icon was changed. More...
 
 hasIcon ($size, $type= 'icon')
 Returns if the entity has an icon of the passed type. More...
 
 getIconURL ($params=[])
 Get the URL for this entity's icon. More...
 
 save ()
 Save an entity. More...
 
 refresh (stdClass $row)
 Load new data from database into existing entity. More...
 
 disable ($reason="", $recursive=true)
 Disable this entity. More...
 
 enable ($recursive=true)
 Enable the entity. More...
 
 isEnabled ()
 Is this entity enabled? More...
 
 delete ($recursive=true)
 Deletes the entity. More...
 
 toObject (array $params=[])
 Export an entity. More...
 
 getLocation ()
 Gets the 'location' metadata for the entity. More...
 
 setLocation ($location)
 Sets the 'location' metadata for the entity. More...
 
 setLatLong ($lat, $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 ($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 ($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 ($persist=true)
 Cache the entity in a session and persisted caches. More...
 
 invalidateCache ()
 Invalidate cache for 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...
 
 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 ()
 {} More...
 
 unserialize ($serialized)
 {} More...
 
- Public Member Functions inherited from Friendable
 addFriend ($friend_guid)
 Adds a user as a friend. 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 ($name, $value, $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

- Static Public Attributes inherited from ElggEntity
static $primary_attr_names
 
- Protected Attributes inherited from ElggEntity
 $temp_metadata = []
 
 $temp_annotations = []
 
 $temp_private_settings = []
 
 $volatile = []
 
 $orig_attributes = []
 
 $_is_cacheable = true
 
 $_cached_metadata
 
- Protected Attributes inherited from ElggData
 $attributes = []
 The main attributes of an entity. More...
 
 $valid = false
 
- Static Protected Attributes inherited from ElggEntity
static $integer_attr_names
 

Detailed Description

Definition at line 20 of file ElggUser.php.

Member Function Documentation

ElggUser::__set (   $name,
  $value 
)

{}

Definition at line 67 of file ElggUser.php.

ElggUser::addFriend (   $friend_guid,
  $create_river_item = false 
)

Adds a user as a friend.

Parameters
int$friend_guidThe GUID of the user to add
bool$create_river_itemCreate the river item announcing this friendship
Returns
bool

Definition at line 322 of file ElggUser.php.

ElggUser::ban (   $reason = '')

Ban this user.

Parameters
string$reasonOptional reason
Returns
bool

Definition at line 125 of file ElggUser.php.

ElggUser::cache (   $persist = true)

Cache the entity in a session and persisted caches.

Parameters
bool$persistStore in persistent cache
Returns
void

Definition at line 539 of file ElggUser.php.

ElggUser::canComment (   $user_guid = 0,
  $default = null 
)

Can a user comment on this user?

See also
::canComment()
Parameters
int$user_guidUser guid (default is logged in user)
bool$defaultDefault permission
Returns
bool
Since
1.8.0

Definition at line 481 of file ElggUser.php.

ElggUser::delete (   $recursive = true)

Definition at line 571 of file ElggUser.php.

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

{Gets this entity's friends.

Parameters
array$optionsOptions array. See elgg_get_entities() for a list of options. 'relationship_guid' is set to this entity, relationship name to 'friend' and type to 'user'.
Returns
[]|int|mixed
}

Implements Friendable.

Definition at line 387 of file ElggUser.php.

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

{Get an array of owned by this entity's friends.

Parameters
array$optionsOptions array. See elgg_get_entities() for a list of options. 'relationship_guid' is set to this entity, type to 'object', relationship name to 'friend' and relationship_join_on to 'container_guid'.
Returns
[]|int|mixed
}

Implements Friendable.

Definition at line 435 of file ElggUser.php.

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

{Gets users who have made this entity a friend.

Parameters
array$optionsOptions array. See elgg_get_entities() for a list of options. 'relationship_guid' is set to this entity, relationship name to 'friend', type to 'user' and inverse_relationship to true.
Returns
[]|int|mixed
}

Implements Friendable.

Definition at line 398 of file ElggUser.php.

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

Gets the user's groups.

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

Definition at line 414 of file ElggUser.php.

ElggUser::getLanguage (   $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 54 of file ElggUser.php.

ElggUser::getNotificationSettings ( )

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

Returns
array

Definition at line 519 of file ElggUser.php.

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

{Get an array of owned by this entity.

Parameters
array$optionsOptions array. See elgg_get_entities() for a list of options. 'type' is set to object and owner_guid to this entity.
Returns
[]|int|mixed
}

Implements Friendable.

Definition at line 425 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 451 of file ElggUser.php.

ElggUser::getType ( )

{}

Definition at line 42 of file ElggUser.php.

ElggUser::getURL ( )

{}

Definition at line 108 of file ElggUser.php.

ElggUser::initializeAttributes ( )
protected

{}

Definition at line 26 of file ElggUser.php.

ElggUser::invalidateCache ( )

Invalidate cache for entity.

Returns
void

Definition at line 560 of file ElggUser.php.

ElggUser::isAdmin ( )

Is this user admin?

Returns
bool

Definition at line 180 of file ElggUser.php.

ElggUser::isBanned ( )

Is this user banned or not?

Returns
bool

Definition at line 171 of file ElggUser.php.

ElggUser::isFriend ( )

Determines whether or not this user is a friend of the currently logged in user.

Returns
bool

Implements Friendable.

Definition at line 358 of file ElggUser.php.

ElggUser::isFriendOf (   $user_guid)

Determines whether or not this user is another user's friend.

Parameters
int$user_guidThe GUID of the user to check against
Returns
bool

Implements Friendable.

Definition at line 380 of file ElggUser.php.

ElggUser::isFriendsWith (   $user_guid)

Determines whether this user is friends with another user.

Parameters
int$user_guidThe GUID of the user to check against
Returns
bool

Implements Friendable.

Definition at line 369 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 282 of file ElggUser.php.

ElggUser::makeAdmin ( )

Make the user an admin.

Returns
bool

Definition at line 193 of file ElggUser.php.

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

{}

Definition at line 462 of file ElggUser.php.

ElggUser::removeAdmin ( )

Remove the admin flag for user.

Returns
bool

Definition at line 215 of file ElggUser.php.

ElggUser::removeFriend (   $friend_guid)

Removes a user as a friend.

Parameters
int$friend_guidThe GUID of the user to remove
Returns
bool

Implements Friendable.

Definition at line 349 of file ElggUser.php.

ElggUser::setLastAction ( )

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

See also
_elgg_session_boot() The session boot calls this at the beginning of every request
Returns
void

Definition at line 258 of file ElggUser.php.

ElggUser::setLastLogin ( )

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

Returns
void

Definition at line 237 of file ElggUser.php.

ElggUser::setNotificationSetting (   $method,
  $enabled = true 
)

Enable or disable a notification delivery method.

Parameters
string$methodMethod name
bool$enabledEnabled or disabled
Returns
bool

Definition at line 503 of file ElggUser.php.

ElggUser::setPassword (   $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 492 of file ElggUser.php.

ElggUser::setValidationStatus (   $status,
  $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 296 of file ElggUser.php.

ElggUser::unban ( )

Unban this user.

Returns
bool

Definition at line 148 of file ElggUser.php.


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