A Site entity. More...

Inheritance diagram for ElggSite:

Public Member Functions

__construct ($row=null)

Create a new \ElggSite. More...

delete ()

Delete the site. More...

disable ($reason="", $recursive=true)

Disable the site. More...

getURL ()

Returns the URL for this site. 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...

getMembers ($options=array(), $offset=0)

Gets an array of \ElggUser entities who are members of the site. More...

listMembers ($options=array())

List the members of this site. More...

addEntity (\ElggEntity $entity)

Adds an entity to the site. More...

removeEntity ($entity)

Removes an entity from this site. More...

getEntities (array $options=array())

Get an array of entities that belong to the site. More...

addUser ($user_guid)

Adds a user to the site. More...

removeUser ($user_guid)

Removes a user from the site. More...

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

Returns an array of \ElggObject entities that belong to the site. More...

addObject ($object_guid)

Adds an object to the site. More...

removeObject ($object_guid)

Remvoes an object from the site. More...

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

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

getExportableValues ()

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

getDomain ()

Get the domain for this site. More...

checkWalledGarden ()

Halts bootup and redirects to the site front page if site is in walled garden mode, no user is logged in, and the URL is not a public page. More...

isPublicPage ($url='')

Returns if a URL is public for this site when in Walled Garden mode. More...

Public Member Functions inherited from ElggEntity

__clone ()

Clone an entity. More...

__set ($name, $value)

Set an attribute or metadata value for this entity. More...

set ($name, $value)

Sets the value of an attribute or metadata. 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...

canComment ($user_guid=0)

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

getOwner ()

Return the guid of the entity's owner. 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...

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

addToSite ($site)

Add this entity to a site. More...

removeFromSite ($site)

Remove this entity from a site. 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...

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)

Loads the full \ElggSite when given a guid. 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

A Site entity.

\ElggSite represents a single site entity.

An \ElggSite object is an \ElggEntity child class with the subtype of "site." It is created upon installation and holds information about a site:

name
description
url

Every \ElggEntity belongs to a site.

Definition at line 28 of file ElggSite.php.

Constructor & Destructor Documentation

◆ __construct()

ElggSite::__construct ( $row = null )

Create a new \ElggSite.

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

Exceptions

IOException	If cannot load remaining data from db
InvalidParameterException	If not passed a db result

Definition at line 57 of file ElggSite.php.

Member Function Documentation

◆ addEntity()

ElggSite::addEntity ( \ElggEntity $entity )

Adds an entity to the site.

This adds a 'member_of_site' relationship between between the entity and the site. It does not change the site_guid of the entity.

Parameters

\ElggEntity $entity User, group, or object entity

Returns: bool

Definition at line 306 of file ElggSite.php.

◆ addObject()

ElggSite::addObject ( $object_guid )

Adds an object to the site.

Parameters

int $object_guid GUID

Returns: bool

Definition at line 401 of file ElggSite.php.

◆ addUser()

ElggSite::addUser ( $user_guid )

Adds a user to the site.

Parameters

int $user_guid GUID

Returns: bool

Definition at line 357 of file ElggSite.php.

◆ checkWalledGarden()

ElggSite::checkWalledGarden ( )

Halts bootup and redirects to the site front page if site is in walled garden mode, no user is logged in, and the URL is not a public page.

Returns: void

Since: 1.8.0

Definition at line 482 of file ElggSite.php.

◆ create()

ElggSite::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 ElggSite.php.

◆ delete()

ElggSite::delete ( )

Delete the site.

Note: You cannot delete the current site.

Returns: bool

Exceptions

SecurityException

Reimplemented from ElggData.

Definition at line 182 of file ElggSite.php.

◆ disable()

ElggSite::disable	(	$reason = `""`,
		$recursive = `true`
	)

Disable the site.

Note: You cannot disable the current site.

Parameters

string	$reason	Optional reason for disabling
bool	$recursive	Recursively disable all contained entities?

Returns: bool

Exceptions

SecurityException

Reimplemented from ElggEntity.

Definition at line 202 of file ElggSite.php.

◆ getCollections()

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

Get the collections associated with a site.

Parameters

string	$subtype	Subtype
int	$limit	Limit
int	$offset	Offset

Returns: mixed

Definition at line 429 of file ElggSite.php.

◆ getDisplayName()

ElggSite::getDisplayName ( )

{Get the entity's display name.

Returns: string The title or name of this entity.

}

Reimplemented from ElggEntity.

Definition at line 224 of file ElggSite.php.

◆ getDomain()

ElggSite::getDomain ( )

Get the domain for this site.

Returns: string

Since: 1.9

Definition at line 469 of file ElggSite.php.

◆ getEntities()

ElggSite::getEntities ( array $options = array() )

Get an array of entities that belong to the site.

This only returns entities that have been explicitly added to the site through addEntity().

Parameters

array $options Options array for elgg_get_entities_from_relationship() Parameters set automatically by this method: 'relationship', 'relationship_guid', 'inverse_relationship'

Returns: array

Definition at line 338 of file ElggSite.php.

◆ getExportableValues()

ElggSite::getExportableValues ( )

Return an array of fields which can be exported.

Returns: array

Reimplemented from ElggEntity.

Definition at line 455 of file ElggSite.php.

◆ getMembers()

ElggSite::getMembers	(	$options = `array()`,
		$offset = `0`
	)

Gets an array of \ElggUser entities who are members of the site.

Parameters

array	$options	An associative array for key => value parameters accepted by elgg_get_entities(). Common parameters include 'limit', and 'offset'. Note: this was $limit before version 1.8
int	$offset	Offset

Returns: array of \ElggUsers

Definition at line 247 of file ElggSite.php.

◆ getObjects()

ElggSite::getObjects	(	$subtype = `""`,
		$limit = `10`,
		$offset = `0`
	)

Returns an array of \ElggObject entities that belong to the site.

Warning: This only returns objects that have been explicitly added to the site through addObject()

Parameters

string	$subtype	Entity subtype
int	$limit	Limit
int	$offset	Offset

Returns: array

Definition at line 388 of file ElggSite.php.

◆ getURL()

ElggSite::getURL ( )

Returns the URL for this site.

Returns: string The URL

Reimplemented from ElggEntity.

Definition at line 217 of file ElggSite.php.

◆ initializeAttributes()

ElggSite::initializeAttributes ( )

protected

Initialize the attributes array.

This is vital to distinguish between metadata and base attributes.

Returns: void

Reimplemented from ElggEntity.

Definition at line 36 of file ElggSite.php.

◆ isPublicPage()

ElggSite::isPublicPage ( $url = '' )

Returns if a URL is public for this site when in Walled Garden mode.

Pages are registered to be public by {@elgg_plugin_hook public_pages walled_garden}.

Parameters

string $url Defaults to the current URL.

Returns: bool

Since: 1.8.0

Definition at line 525 of file ElggSite.php.

◆ listMembers()

ElggSite::listMembers ( $options = array() )

List the members of this site.

Parameters

array $options An associative array for key => value parameters accepted by elgg_list_entities(). Common parameters include 'full_view', 'limit', and 'offset'.

Returns: string

Since: 1.8.0

Definition at line 281 of file ElggSite.php.

◆ load()

ElggSite::load ( $guid )

protected

Loads the full \ElggSite when given a guid.

Parameters

mixed $guid GUID of \ElggSite entity or database row object

Returns: bool

Exceptions

InvalidClassException

Reimplemented from ElggEntity.

Definition at line 104 of file ElggSite.php.

◆ prepareObject()

ElggSite::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 437 of file ElggSite.php.

◆ removeEntity()

ElggSite::removeEntity ( $entity )

Removes an entity from this site.

Parameters

\ElggEntity $entity User, group, or object entity

Returns: bool

Definition at line 320 of file ElggSite.php.

◆ removeObject()

ElggSite::removeObject ( $object_guid )

Remvoes an object from the site.

Parameters

int $object_guid GUID

Returns: bool

Definition at line 414 of file ElggSite.php.

◆ removeUser()

ElggSite::removeUser ( $user_guid )

Removes a user from the site.

Parameters

int $user_guid GUID

Returns: bool

Definition at line 370 of file ElggSite.php.

◆ setDisplayName()

ElggSite::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 231 of file ElggSite.php.

◆ update()

ElggSite::update ( )

protected

{Update the entity in the database.

Returns: bool Whether the update was successful.

Exceptions

InvalidParameterException

}

Reimplemented from ElggEntity.

Definition at line 156 of file ElggSite.php.

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

engine/classes/ElggSite.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addEntity()

◆ addObject()

◆ addUser()

◆ checkWalledGarden()

◆ create()

◆ delete()

◆ disable()

◆ getCollections()

◆ getDisplayName()

◆ getDomain()

◆ getEntities()

◆ getExportableValues()

◆ getMembers()

◆ getObjects()

◆ getURL()

◆ initializeAttributes()

◆ isPublicPage()

◆ listMembers()

◆ load()

◆ prepareObject()

◆ removeEntity()

◆ removeObject()

◆ removeUser()

◆ setDisplayName()

◆ update()