ElggExtender Class Reference

Inheritance diagram for ElggExtender:

List of all members.

Public Member Functions
	getOwner ()
	Return the owner of this annotation.
	getOwnerEntity ()
	Return the owner entity.
	getEntity ()
	Returns the entity this is attached to.
	save ()
	Save this data to the appropriate database table.
	delete ()
	Delete this data.
	canEdit ($user_guid=0)
	Determines whether or not the specified user can edit this.
	getURL ()
	Return a url for this extender.
	getExportableValues ()
	Return an array of fields which can be exported.
	export ()
	Export this object.
	getSystemLogID ()
	Return an identification for the object for storage in the system log.
	getClassName ()
	Return the class name of the object.
	getObjectOwnerGUID ()
	Return the GUID of the owner of this object.
	getType ()
	Return a type of the object - eg.
	getSubtype ()
	Return a subtype.
	rewind ()
	current ()
	key ()
	next ()
	valid ()
	offsetSet ($key, $value)
	offsetGet ($key)
	offsetUnset ($key)
	offsetExists ($offset)
Protected Member Functions
	get ($name)
	Get an attribute.
	set ($name, $value, $value_type="")
	Set an attribute.
Protected Attributes
	$attributes

---

Detailed Description

Definition at line 16 of file extender.php.

---

Member Function Documentation

ElggExtender::canEdit

(

$

user_guid = 0

)

Determines whether or not the specified user can edit this.

Parameters:

int

$user_guid The GUID of the user (defaults to currently logged in user)

Returns:

true|false

Definition at line 118 of file extender.php.

ElggExtender::current

(

)

Definition at line 214 of file extender.php.

ElggExtender::delete

(

)

[abstract]

Delete this data.

Reimplemented in ElggAnnotation, and ElggMetadata.

ElggExtender::export

(

)

Export this object.

Returns:

array

Implements Exportable.

Definition at line 151 of file extender.php.

ElggExtender::get

(

$

name

)

[protected]

Get an attribute.

Parameters:

string

$name

Returns:

mixed

Definition at line 34 of file extender.php.

ElggExtender::getClassName

(

)

Return the class name of the object.

Implements Loggable.

Definition at line 175 of file extender.php.

ElggExtender::getEntity

(

)

Returns the entity this is attached to.

Returns:

ElggEntity The enttiy

Definition at line 98 of file extender.php.

ElggExtender::getExportableValues

(

)

Return an array of fields which can be exported.

Implements Exportable.

Definition at line 134 of file extender.php.

ElggExtender::getObjectOwnerGUID

(

)

Return the GUID of the owner of this object.

Implements Loggable.

Definition at line 182 of file extender.php.

ElggExtender::getOwner

(

)

Return the owner of this annotation.

Returns:

mixed

Definition at line 79 of file extender.php.

ElggExtender::getOwnerEntity

(

)

Return the owner entity.

Returns:

mixed

Since:

1.7.0

Definition at line 89 of file extender.php.

ElggExtender::getSubtype

(

)

Return a subtype.

For metadata & annotations this is the 'name' and for relationship this is the relationship type.

Implements Loggable.

Definition at line 197 of file extender.php.

ElggExtender::getSystemLogID

(

)

Return an identification for the object for storage in the system log.

This id must be an integer.

Returns:

int

Implements Loggable.

Definition at line 168 of file extender.php.

ElggExtender::getType

(

)

Return a type of the object - eg.

object, group, user, relationship, metadata, annotation etc

Implements Loggable.

Definition at line 189 of file extender.php.

ElggExtender::getURL

(

)

[abstract]

Return a url for this extender.

Returns:

string

Reimplemented in ElggAnnotation, and ElggMetadata.

ElggExtender::key

(

)

Definition at line 218 of file extender.php.

ElggExtender::next

(

)

Definition at line 222 of file extender.php.

ElggExtender::offsetExists

(

$

offset

)

Definition at line 255 of file extender.php.

ElggExtender::offsetGet

(

$

key

)

Definition at line 242 of file extender.php.

ElggExtender::offsetSet	(	$	key,
		$	value
	)

Definition at line 236 of file extender.php.

ElggExtender::offsetUnset

(

$

key

)

Definition at line 248 of file extender.php.

ElggExtender::rewind

(

)

Definition at line 210 of file extender.php.

ElggExtender::save

(

)

[abstract]

Save this data to the appropriate database table.

Reimplemented in ElggAnnotation, and ElggMetadata.

ElggExtender::set	(	$	name,
		$	value,
		$	value_type = ""
	)			[protected]

Set an attribute.

Parameters:

	string	$name
	mixed	$value
	string	$value_type

Returns:

boolean

Definition at line 65 of file extender.php.

ElggExtender::valid

(

)

Definition at line 226 of file extender.php.

---

Member Data Documentation

ElggExtender::$attributes [protected]

Definition at line 26 of file extender.php.

---

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

• engine/lib/extender.php