Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ElggSite Class Reference
Inheritance diagram for ElggSite:
ElggEntity ElggData Locatable Importable Elgg\EntityIcon Loggable Exportable

Public Member Functions

 __construct ($row=null)
 Create a new . More...
 
 delete ()
 Delete the site. More...
 
 disable ($reason="", $recursive=true)
 Disable the site. More...
 
 getURL ()
 Returns the URL for this site. More...
 
 getDisplayName ()
 {} More...
 
 setDisplayName ($displayName)
 {} More...
 
 getMembers ($options=array())
 Gets an array of 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 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...
 
 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...
 
 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...
 
 get ($name)
 Return the value of an attribute or metadata. More...
 
 getDisplayName ()
 Get the entity's display name. More...
 
 setDisplayName ($displayName)
 Sets the title or name of this entity. 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...
 
 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...
 
 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...
 
 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...
 
 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)
 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...
 
 setURL ($url)
 Overrides the URL returned by getURL() More...
 
 saveIconFromUploadedFile ($input_name, $type= 'icon', array $coords=array())
 Saves icons using an uploaded file as the source. More...
 
 saveIconFromLocalFile ($filename, $type= 'icon', array $coords=array())
 Saves icons using a local file as the source. More...
 
 saveIconFromElggFile (\ElggFile $file, $type= 'icon', array $coords=array())
 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=array())
 Get the URL for this entity's icon. 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 persisted. 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 ()
 {} 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...
 
 getExportableValues ()
 Returns an array of fields which can be exported. 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...
 
 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...
 
- Public Member Functions inherited from ElggData
 __isset ($name)
 Test if property is set either as an attribute or metadata. 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 ()
 Get a plain old object copy for public consumption. More...
 
 getClassName ()
 Return the class name of the 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...
 

Static Public Member Functions

static getExternalAttributes ()
 Get default values for attributes stored in a separate table. More...
 

Protected Member Functions

 initializeAttributes ()
 Initialize the attributes array. More...
 
 load ($guid)
 Loads the full when given a guid. More...
 
 create ()
 {} More...
 
 update ()
 {} More...
 
 prepareObject ($object)
 {} More...
 
- Protected Member Functions inherited from ElggEntity
 initializeAttributes ()
 Initialize the attributes array. More...
 
 create ()
 Create a new entry in the entities table. More...
 
 update ()
 Update the entity in the database. More...
 
 load ($guid)
 Loads attributes from the entities table into the object. More...
 
 loadAdditionalSelectValues (array $data)
 Stores non-attributes from the loading of the entity as volatile data. More...
 
 prepareObject ($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...
 
 get ($name)
 Fetch the specified attribute. More...
 
 set ($name, $value)
 Set the specified attribute. More...
 

Additional Inherited Members

- Protected Attributes inherited from ElggEntity
 $url_override
 If set, overrides the value of getURL() 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...
 
 $orig_attributes = array()
 Holds the original (persisted) attribute values that have been changed but not yet saved. More...
 
- Protected Attributes inherited from ElggData
 $attributes = array()
 The main attributes of an entity. More...
 
 $valid = false
 

Detailed Description

Definition at line 28 of file ElggSite.php.

Constructor & Destructor Documentation

ElggSite::__construct (   $row = null)

Create a new .

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$rowDatabase row result. Default is null to create a new site.
Exceptions
IOExceptionIf cannot load remaining data from db
InvalidParameterExceptionIf not passed a db result

Definition at line 70 of file ElggSite.php.

Member Function Documentation

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$entityUser, group, or object entity
Returns
bool

Definition at line 300 of file ElggSite.php.

ElggSite::addObject (   $object_guid)

Adds an object to the site.

Parameters
int$object_guidGUID
Returns
bool

Definition at line 395 of file ElggSite.php.

ElggSite::addUser (   $user_guid)

Adds a user to the site.

Parameters
int$user_guidGUID
Returns
bool

Definition at line 351 of file ElggSite.php.

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

ElggSite::create ( )
protected

{}

Definition at line 128 of file ElggSite.php.

ElggSite::delete ( )

Delete the site.

Note
You cannot delete the current site.
Returns
bool
Exceptions
SecurityException

Definition at line 185 of file ElggSite.php.

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

Disable the site.

Note
You cannot disable the current site.
Parameters
string$reasonOptional reason for disabling
bool$recursiveRecursively disable all contained entities?
Returns
bool
Exceptions
SecurityException

Definition at line 205 of file ElggSite.php.

ElggSite::getDisplayName ( )

{}

Definition at line 227 of file ElggSite.php.

ElggSite::getDomain ( )

Get the domain for this site.

Returns
string
Since
1.9

Definition at line 448 of file ElggSite.php.

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$optionsOptions array for elgg_get_entities_from_relationship() Parameters set automatically by this method: 'relationship', 'relationship_guid', 'inverse_relationship'
Returns
array

Definition at line 332 of file ElggSite.php.

ElggSite::getExportableValues ( )

Return an array of fields which can be exported.

Returns
array

Implements Exportable.

Definition at line 434 of file ElggSite.php.

static ElggSite::getExternalAttributes ( )
staticfinal

Get default values for attributes stored in a separate table.

Returns
array private
See Also
::getEntities

Definition at line 51 of file ElggSite.php.

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

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

Parameters
array$optionsAn associative array for key => value parameters accepted by elgg_get_entities(). Common parameters include 'limit', and 'offset'.
Returns
array of

Definition at line 248 of file ElggSite.php.

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

Returns an array of entities that belong to the site.

Warning
This only returns objects that have been explicitly added to the site through addObject()
Parameters
string$subtypeEntity subtype
int$limitLimit
int$offsetOffset
Returns
array

Definition at line 382 of file ElggSite.php.

ElggSite::getURL ( )

Returns the URL for this site.

Returns
string The URL

Definition at line 220 of file ElggSite.php.

ElggSite::initializeAttributes ( )
protected

Initialize the attributes array.

This is vital to distinguish between metadata and base attributes.

Returns
void

Definition at line 36 of file ElggSite.php.

ElggSite::isPublicPage (   $url = '')

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

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

Parameters
string$urlDefaults to the current URL.
Returns
bool
Since
1.8.0

Definition at line 504 of file ElggSite.php.

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

List the members of this site.

Parameters
array$optionsAn 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 275 of file ElggSite.php.

ElggSite::load (   $guid)
protected

Loads the full when given a guid.

Parameters
mixed$guidGUID of entity or database row object
Returns
bool
Exceptions
InvalidClassException

Definition at line 108 of file ElggSite.php.

ElggSite::prepareObject (   $object)
protected

{}

Definition at line 416 of file ElggSite.php.

ElggSite::removeEntity (   $entity)

Removes an entity from this site.

Parameters
\ElggEntity$entityUser, group, or object entity
Returns
bool

Definition at line 314 of file ElggSite.php.

ElggSite::removeObject (   $object_guid)

Remvoes an object from the site.

Parameters
int$object_guidGUID
Returns
bool

Definition at line 408 of file ElggSite.php.

ElggSite::removeUser (   $user_guid)

Removes a user from the site.

Parameters
int$user_guidGUID
Returns
bool

Definition at line 364 of file ElggSite.php.

ElggSite::setDisplayName (   $displayName)

{}

Definition at line 234 of file ElggSite.php.

ElggSite::update ( )
protected

{}

Definition at line 159 of file ElggSite.php.


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