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

Public Member Functions

 __get ($name)
 Get a value from attributes or private settings. More...
 
 get ($name)
 Override entity get and sets in order to save data to private data store. More...
 
 __set ($name, $value)
 Set an attribute or private setting value. More...
 
 set ($name, $value)
 Override entity get and sets in order to save data to private data store. More...
 
 __unset ($name)
 Unset a property from private settings or attribute. More...
 
 __isset ($name)
 Test if property is set either as an attribute or private setting. More...
 
 setContext ($context)
 Set the widget context. More...
 
 getContext ()
 Get the widget context. More...
 
 getTitle ()
 Get the title of the widget. More...
 
 move ($column, $rank)
 Move the widget. More...
 
 saveSettings ($params)
 Saves the widget's settings. More...
 
- Public Member Functions inherited from ElggObject
 __construct ($row=null)
 Create a new . More...
 
 getDisplayName ()
 {} More...
 
 setDisplayName ($displayName)
 {} More...
 
 getExportableValues ()
 Return an array of fields which can be exported. More...
 
 canComment ($user_guid=0)
 Can a user comment on this object? 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...
 

Protected Member Functions

 initializeAttributes ()
 Set subtype to widget. More...
 
- Protected Member Functions inherited from ElggObject
 initializeAttributes ()
 Initialize the attributes array to include the type, title, and description. 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

- Static Public Member Functions inherited from ElggObject
static getExternalAttributes ()
 Get default values for attributes stored in a separate table. More...
 
- 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 16 of file ElggWidget.php.

Member Function Documentation

ElggWidget::__get (   $name)

Get a value from attributes or private settings.

Parameters
string$nameThe name of the value
Returns
mixed

Definition at line 35 of file ElggWidget.php.

ElggWidget::__isset (   $name)

Test if property is set either as an attribute or private setting.

Use isset($entity->property)

See Also
->__isset
Parameters
string$nameThe name of the attribute or private setting.
Returns
bool
Since
2.2.0

Definition at line 129 of file ElggWidget.php.

ElggWidget::__set (   $name,
  $value 
)

Set an attribute or private setting value.

Parameters
string$nameThe name of the value to set
mixed$valueThe value to set
Returns
void

Definition at line 71 of file ElggWidget.php.

ElggWidget::__unset (   $name)

Unset a property from private settings or attribute.

See Also
->__unset
Parameters
string$nameThe name of the attribute or metadata.
Returns
void
Since
2.2.0

Definition at line 109 of file ElggWidget.php.

ElggWidget::get (   $name)

Override entity get and sets in order to save data to private data store.

Parameters
string$nameName
Returns
mixed

Definition at line 59 of file ElggWidget.php.

ElggWidget::getContext ( )

Get the widget context.

Returns
string
Since
1.8.0

Definition at line 155 of file ElggWidget.php.

ElggWidget::getTitle ( )

Get the title of the widget.

Returns
string
Since
1.8.0

Definition at line 165 of file ElggWidget.php.

ElggWidget::initializeAttributes ( )
protected

Set subtype to widget.

Returns
void

Definition at line 23 of file ElggWidget.php.

ElggWidget::move (   $column,
  $rank 
)

Move the widget.

Parameters
int$columnThe widget column
int$rankZero-based rank from the top of the column
Returns
void
Since
1.8.0

Definition at line 181 of file ElggWidget.php.

ElggWidget::saveSettings (   $params)

Saves the widget's settings.

Plugins can override the save mechanism using the plugin hook: 'widget_settings', <widget handler="" identifier>="">. The widget and the parameters are passed. The plugin hook handler should return true to indicate that it has successfully saved the settings.

Warning
The values in the parameter array cannot be arrays
Parameters
array$paramsAn array of name => value parameters
Returns
bool
Since
1.8.0

Definition at line 281 of file ElggWidget.php.

ElggWidget::set (   $name,
  $value 
)

Override entity get and sets in order to save data to private data store.

Parameters
string$nameName
string$valueValue
Returns
bool

Definition at line 92 of file ElggWidget.php.

ElggWidget::setContext (   $context)

Set the widget context.

Parameters
string$contextThe widget context
Returns
bool
Since
1.8.0

Definition at line 145 of file ElggWidget.php.


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