Inheritance diagram for ElggUser:

Public Member Functions

__construct ($row=null)

Construct a new user entity. More...

delete ()

User specific override of the entity delete method. More...

getDisplayName ()

{Get the entity's display name.

Returns: string The title or name of this entity.

} More...

setDisplayName ($displayName)

{Sets the title or name of this entity.

Parameters

string $displayName The title or name of this entity.

Returns: void

} More...

__set ($name, $value)

{Set an attribute or metadata value for this entity.Anything that is not an attribute is saved as metadata.

Warning: Metadata set this way will inherit the entity's owner and access ID. If you want more control over metadata, use ElggEntity::setMetadata()

Parameters

string	$name	Name of the attribute or metadata
mixed	$value	The value to be set

Returns: void

See also: ElggEntity::setMetadata()

} More...

set ($name, $value)

{Sets the value of an attribute or metadata.

Parameters

string	$name	Name
mixed	$value	Value

Returns: bool

} 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...

getSites ($options="", $limit=10, $offset=0)

Get sites that this user is a member of. More...

addToSite ($site)

Add this user to a particular site. More...

removeFromSite ($site)

Remove this user from a particular site. More...

addFriend ($friend_guid)

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 ($options=array(), $limit=10, $offset=0)

Gets this user's friends. More...

getFriendsOf ($options=array(), $limit=10, $offset=0)

Gets users who have made this user a friend. More...

listFriends ($subtype="", $limit=10, array $vars=array())

Lists the user's friends. More...

getGroups ($options="", $limit=10, $offset=0)

Gets the user's groups. More...

listGroups ($subtype="", $limit=10, $offset=0)

Lists the user's groups. More...

getObjects ($options=array(), $limit=10, $offset=0)

Get an array of ElggObject owned by this user. More...

getFriendsObjects ($options=array(), $limit=10, $offset=0)

Get an array of ElggObjects owned by this user's friends. More...

countObjects ($subtype="")

Counts the number of ElggObjects owned by this user. More...

getCollections ($subtype="", $limit=10, $offset=0)

Get the collections associated with a user. More...

getOwnerGUID ()

Get a user's owner GUID. More...

getOwner ()

If a user's owner is blank, return its own GUID as the owner. More...

getExportableValues ()

Return an array of fields which can be exported. More...

canComment ($user_guid=0)

Can a user comment on this user? More...

Public Member Functions inherited from ElggEntity

__clone ()

Clone an entity. More...

__get ($name)

Get an attribute or metadata value. More...

get ($name)

Return the value of an attribute or metadata. More...

getMetadata ($name)

Return the value of a piece of metadata. More...

__unset ($name)

Unset a property from metadata or attribute. More...

setMetadata ($name, $value, $value_type='', $multiple=false, $owner_guid=0, $access_id=null)

Set metadata on this entity. More...

deleteMetadata ($name=null)

Deletes all metadata on this object (metadata.entity_guid = $this->guid). More...

deleteOwnedMetadata ($name=null)

Deletes all metadata owned by this object (metadata.owner_guid = $this->guid). More...

clearMetadata ($name='')

Remove metadata. More...

disableMetadata ($name='')

Disables metadata for this entity, optionally based on name. More...

enableMetadata ($name='')

Enables metadata for this entity, optionally based on name. 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...

clearRelationships ()

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...

removePrivateSetting ($name)

Removes private setting. 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, $vartype="")

Adds an annotation to an entity. More...

getAnnotations ($options=array(), $limit=50, $offset=0, $order="asc")

Gets an array of annotations. More...

clearAnnotations ($name="")

Remove an annotation or all annotations for this entity. 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...

getEntitiesFromRelationship ($options=array(), $inverse=false, $limit=50, $offset=0)

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...

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...

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...

getOwnerEntity ()

Gets the ElggEntity that owns this entity. More...

setContainerGUID ($container_guid)

Set the container for this object. More...

setContainer ($container_guid)

Set the container for this object. More...

getContainerGUID ()

Gets the container GUID for this entity. More...

getContainer ()

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...

setURL ($url)

Overrides the URL returned by getURL() More...

getIconURL ($size='medium')

Get the URL for this entity's icon. More...

getIcon ($size='medium')

Returns a URL for the entity's icon. More...

setIcon ($url, $size='medium')

Set an icon override for an icon and size. More...

getSites ($options=array())

Gets the sites this entity is a member of. More...

isFullyLoaded ()

Tests to see whether the object has been fully loaded. 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 ()

{Get a plain old object copy for public consumption.

Returns: stdClass

} 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...

setCalendarTimeAndDuration ($hour=null, $minute=null, $second=null, $day=null, $month=null, $year=null, $duration=null)

Set the time and duration of an object. More...

getCalendarStartTime ()

Returns the start timestamp. More...

getCalendarEndTime ()

Returns the end timestamp. More...

export ()

Export this class into an array of ODD Elements containing all necessary fields. More...

import (ODD $data)

Import data from an parsed ODD xml data array. 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...

Public Member Functions inherited from ElggData

__isset ($name)

Test if property is set either as an attribute or metadata. More...

getTimeCreated ()

Returns the UNIX epoch time that this entity was created. More...

getClassName ()

Return the class name of the object. More...

getObjectOwnerGUID ()

Return the GUID of the owner of this object. 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...

Protected Member Functions

initializeAttributes ()

Initialize the attributes array. More...

load ($guid)

Load the ElggUser data from the database. More...

create ()

{Create a new entry in the entities table.Saves the base information in the entities table for the entity. Saving the type-specific information is handled in the calling class method.

Warning: Entities must have an entry in both the entities table and their type table or they will throw an exception when loaded.

Returns: int The new entity's GUID

Exceptions

InvalidParameterException	If the entity's type has not been set.
IOException	If the new row fails to write to the DB.

} More...

update ()

{Update the entity in the database.

Returns: bool Whether the update was successful.

Exceptions

InvalidParameterException

} More...

prepareObject ($object)

{Prepare an object copy for toObject()

Parameters

stdClass $object Object representation of the entity

Returns: stdClass

} More...

Protected Member Functions inherited from ElggEntity

loadAdditionalSelectValues (array $data)

Stores non-attributes from the loading of the entity as volatile data. More...

Protected Member Functions inherited from ElggData

initialise_attributes ($pre18_api=true)

Initialise the attributes array. More...

getDatabase ()

Provides a pointer to the database object. More...

Additional Inherited Members
Protected Attributes inherited from ElggEntity
	$url_override
	If set, overrides the value of getURL() More...

	$icon_override
	Icon override, overrides the value of getIcon(). More...

	$temp_metadata = array()
	Holds metadata until entity is saved. More...

	$temp_annotations = array()
	Holds annotations until entity is saved. More...

	$temp_private_settings = array()
	Holds private settings until entity is saved. More...

	$volatile = array()
	Volatile data structure for this object, allows for storage of data in-memory that isn't sync'd back to the metadata table. More...

	$tables_split

	$tables_loaded

Protected Attributes inherited from ElggData
	$attributes = array()
	The main attributes of an entity. More...

	$valid = false

Detailed Description

Definition at line 19 of file ElggUser.php.

Constructor & Destructor Documentation

◆ __construct()

ElggUser::__construct ( $row = null )

Construct a new user entity.

Plugin developers should only use the constructor to create a new entity. To retrieve entities, use get_entity() and the elgg_get_entities* functions.

Parameters

stdClass $row Database row result. Default is null to create a new user.

Exceptions

IOException|InvalidParameterException if there was a problem creating the user.

Definition at line 56 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.

Warning: Metadata set this way will inherit the entity's owner and access ID. If you want more control over metadata, use ElggEntity::setMetadata()

Parameters

string	$name	Name of the attribute or metadata
mixed	$value	The value to be set

Returns: void

See also: ElggEntity::setMetadata()

}

Reimplemented from ElggEntity.

Definition at line 211 of file ElggUser.php.

◆ addFriend()

ElggUser::addFriend ( $friend_guid )

Adds a user as a friend.

Parameters

int $friend_guid The GUID of the user to add

Returns: bool

Implements Friendable.

Definition at line 377 of file ElggUser.php.

◆ addToSite()

ElggUser::addToSite ( $site )

Add this user to a particular site.

Parameters

ElggSite $site The site to add this user to. This used to be the the site guid (still supported by deprecated)

Returns: bool

Reimplemented from ElggEntity.

Definition at line 344 of file ElggUser.php.

◆ ban()

ElggUser::ban ( $reason = "" )

Ban this user.

Parameters

string $reason Optional reason

Returns: bool

Definition at line 249 of file ElggUser.php.

◆ canComment()

ElggUser::canComment ( $user_guid = 0 )

Can a user comment on this user?

See also: ElggEntity::canComment()

Parameters

int $user_guid User guid (default is logged in user)

Returns: bool

Since: 1.8.0

Reimplemented from ElggEntity.

Definition at line 744 of file ElggUser.php.

◆ countObjects()

ElggUser::countObjects ( $subtype = "" )

Counts the number of ElggObjects owned by this user.

Parameters

string $subtype The subtypes of the objects, if any

Returns: int The number of ElggObjects

Implements Friendable.

Definition at line 662 of file ElggUser.php.

◆ create()

ElggUser::create ( )

protected

{Create a new entry in the entities table.Saves the base information in the entities table for the entity. Saving the type-specific information is handled in the calling class method.

Warning: Entities must have an entry in both the entities table and their type table or they will throw an exception when loaded.

Returns: int The new entity's GUID

Exceptions

InvalidParameterException	If the entity's type has not been set.
IOException	If the new row fails to write to the DB.

}

Reimplemented from ElggEntity.

Definition at line 125 of file ElggUser.php.

◆ delete()

ElggUser::delete ( )

User specific override of the entity delete method.

Returns: bool

Reimplemented from ElggData.

Definition at line 180 of file ElggUser.php.

◆ getCollections()

ElggUser::getCollections	(	$subtype = `""`,
		$limit = `10`,
		$offset = `0`
	)

Get the collections associated with a user.

Parameters

string	$subtype	Optionally, the subtype of result we want to limit to
int	$limit	The number of results to return
int	$offset	Any indexing offset

Returns: array|false

Definition at line 676 of file ElggUser.php.

◆ getDisplayName()

ElggUser::getDisplayName ( )

{Get the entity's display name.

Returns: string The title or name of this entity.

}

Reimplemented from ElggEntity.

Definition at line 197 of file ElggUser.php.

◆ getExportableValues()

ElggUser::getExportableValues ( )

Return an array of fields which can be exported.

Returns: array

Reimplemented from ElggEntity.

Definition at line 727 of file ElggUser.php.

◆ getFriends()

ElggUser::getFriends	(	$options = `array()`,
		$limit = `10`,
		$offset = `0`
	)

Gets this user's friends.

Parameters

array	$options	Options array. See elgg_get_entities_from_relationship() for a list of options. 'relationship_guid' is set to this entity, relationship name to 'friend' and type to 'user'.
int	$limit	The number of users to retrieve (deprecated)
int	$offset	Indexing offset, if any (deprecated)

Returns: array|false Array of ElggUser, or false, depending on success

Implements Friendable.

Definition at line 452 of file ElggUser.php.

◆ getFriendsObjects()

ElggUser::getFriendsObjects	(	$options = `array()`,
		$limit = `10`,
		$offset = `0`
	)

Get an array of ElggObjects owned by this user's friends.

Parameters

array	$options	Options array. See elgg_get_entities_from_relationship() 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'.
int	$limit	Number of results to return (deprecated)
int	$offset	Any indexing offset (deprecated)

Returns: array|false

Implements Friendable.

Definition at line 633 of file ElggUser.php.

◆ getFriendsOf()

ElggUser::getFriendsOf	(	$options = `array()`,
		$limit = `10`,
		$offset = `0`
	)

Gets users who have made this user a friend.

Parameters

array	$options	Options array. See elgg_get_entities_from_relationship() for a list of options. 'relationship_guid' is set to this entity, relationship name to 'friend', type to 'user' and inverse_relationship to true.
int	$limit	The number of users to retrieve (deprecated)
int	$offset	Indexing offset, if any (deprecated)

Returns: array|false Array of ElggUser, or false, depending on success

Implements Friendable.

Definition at line 483 of file ElggUser.php.

◆ getGroups()

ElggUser::getGroups	(	$options = `""`,
		$limit = `10`,
		$offset = `0`
	)

Gets the user's groups.

Parameters

array	$options	Options array. Used to be the subtype string.
int	$limit	The number of groups to retrieve (deprecated)
int	$offset	Indexing offset, if any (deprecated)

Returns: array|false Array of ElggGroup, or false, depending on success

Definition at line 542 of file ElggUser.php.

◆ getObjects()

ElggUser::getObjects	(	$options = `array()`,
		$limit = `10`,
		$offset = `0`
	)

Get an array of ElggObject owned by this user.

Parameters

array	$options	Options array. See elgg_get_entities() for a list of options. 'type' is set to object and owner_guid to this entity.
int	$limit	Number of results to return (deprecated)
int	$offset	Any indexing offset (deprecated)

Returns: array|false

Implements Friendable.

Definition at line 604 of file ElggUser.php.

◆ getOwner()

ElggUser::getOwner ( )

If a user's owner is blank, return its own GUID as the owner.

Returns: int User GUID

Reimplemented from ElggEntity.

Definition at line 702 of file ElggUser.php.

◆ getOwnerGUID()

ElggUser::getOwnerGUID ( )

Get a user's owner GUID.

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

Returns: int

Reimplemented from ElggEntity.

Definition at line 688 of file ElggUser.php.

◆ getSites()

ElggUser::getSites	(	$options = `""`,
		$limit = `10`,
		$offset = `0`
	)

Get sites that this user is a member of.

Parameters

array	$options	Options array. Used to be $subtype
int	$limit	The number of results to return (deprecated)
int	$offset	Any indexing offset (deprecated)

Returns: array

Definition at line 328 of file ElggUser.php.

◆ initializeAttributes()

ElggUser::initializeAttributes ( )

protected

Initialize the attributes array.

This is vital to distinguish between metadata and base attributes.

Returns: void

Reimplemented from ElggEntity.

Definition at line 28 of file ElggUser.php.

◆ isAdmin()

ElggUser::isAdmin ( )

Is this user admin?

Returns: bool

Definition at line 276 of file ElggUser.php.

◆ isBanned()

ElggUser::isBanned ( )

Is this user banned or not?

Returns: bool

Definition at line 267 of file ElggUser.php.

◆ isFriend()

ElggUser::isFriend ( )

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

Returns: bool

Implements Friendable.

Definition at line 415 of file ElggUser.php.

◆ isFriendOf()

ElggUser::isFriendOf ( $user_guid )

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

Parameters

int $user_guid The GUID of the user to check against

Returns: bool

Implements Friendable.

Definition at line 437 of file ElggUser.php.

◆ isFriendsWith()

ElggUser::isFriendsWith ( $user_guid )

Determines whether this user is friends with another user.

Parameters

int $user_guid The GUID of the user to check against

Returns: bool

Implements Friendable.

Definition at line 426 of file ElggUser.php.

◆ listFriends()

ElggUser::listFriends	(		$subtype = `""`,
			$limit = `10`,
		array	$vars = `array()`
	)

Lists the user's friends.

Parameters

string	$subtype	Optionally, the user subtype (leave blank for all)
int	$limit	The number of users to retrieve
array	$vars	Display variables for the user view

Returns: string Rendered list of friends

Since: 1.8.0

Definition at line 514 of file ElggUser.php.

◆ listGroups()

ElggUser::listGroups	(	$subtype = `""`,
		$limit = `10`,
		$offset = `0`
	)

Lists the user's groups.

Parameters

string	$subtype	Optionally, the user subtype (leave blank for all)
int	$limit	The number of users to retrieve
int	$offset	Indexing offset, if any

Returns: string

Definition at line 576 of file ElggUser.php.

◆ load()

ElggUser::load ( $guid )

protected

Load the ElggUser data from the database.

Parameters

mixed $guid ElggUser GUID or stdClass database row from entity table

Returns: bool

Reimplemented from ElggEntity.

Definition at line 104 of file ElggUser.php.

◆ makeAdmin()

ElggUser::makeAdmin ( )

Make the user an admin.

Returns: bool

Definition at line 290 of file ElggUser.php.

◆ prepareObject()

ElggUser::prepareObject ( $object )

protected

{Prepare an object copy for toObject()

Parameters

stdClass $object Object representation of the entity

Returns: stdClass

}

Reimplemented from ElggEntity.

Definition at line 710 of file ElggUser.php.

◆ removeAdmin()

ElggUser::removeAdmin ( )

Remove the admin flag for user.

Returns: bool

Definition at line 307 of file ElggUser.php.

◆ removeFriend()

ElggUser::removeFriend ( $friend_guid )

Removes a user as a friend.

Parameters

int $friend_guid The GUID of the user to remove

Returns: bool

Implements Friendable.

Definition at line 393 of file ElggUser.php.

◆ removeFromSite()

ElggUser::removeFromSite ( $site )

Remove this user from a particular site.

Parameters

ElggSite $site The site to remove the user from. Used to be site GUID

Returns: bool

Reimplemented from ElggEntity.

Definition at line 360 of file ElggUser.php.

◆ set()

ElggUser::set	(	$name,
		$value
	)

{Sets the value of an attribute or metadata.

Parameters

string	$name	Name
mixed	$value	Value

Returns: bool

}

Reimplemented from ElggEntity.

Definition at line 235 of file ElggUser.php.

◆ setDisplayName()

ElggUser::setDisplayName ( $displayName )

{Sets the title or name of this entity.

Parameters

string $displayName The title or name of this entity.

Returns: void

}

Reimplemented from ElggEntity.

Definition at line 204 of file ElggUser.php.

◆ unban()

ElggUser::unban ( )

Unban this user.

Returns: bool

Definition at line 258 of file ElggUser.php.

◆ update()

ElggUser::update ( )

protected

{Update the entity in the database.

Returns: bool Whether the update was successful.

Exceptions

InvalidParameterException

}

Reimplemented from ElggEntity.

Definition at line 152 of file ElggUser.php.

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

engine/classes/ElggUser.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __set()

◆ addFriend()

◆ addToSite()

◆ ban()

◆ canComment()

◆ countObjects()

◆ create()

◆ delete()

◆ getCollections()

◆ getDisplayName()

◆ getExportableValues()

◆ getFriends()

◆ getFriendsObjects()

◆ getFriendsOf()

◆ getGroups()

◆ getObjects()

◆ getOwner()

◆ getOwnerGUID()

◆ getSites()

◆ initializeAttributes()

◆ isAdmin()

◆ isBanned()

◆ isFriend()

◆ isFriendOf()

◆ isFriendsWith()

◆ listFriends()

◆ listGroups()

◆ load()

◆ makeAdmin()

◆ prepareObject()

◆ removeAdmin()

◆ removeFriend()

◆ removeFromSite()

◆ set()

◆ setDisplayName()

◆ unban()

◆ update()