ElggData Class Reference

Inheritance diagram for ElggData:

Public Member Functions
	__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...
	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...
Public Member Functions inherited from Loggable
	getSystemLogID ()
	Return an identification for the object for storage in the system log. More...
	getType ()
	Return the type of the object - eg. More...
	getSubtype ()
	Return a subtype. More...
	getObjectFromID ($id)
	For a given ID, return the object associated with it. More...
Public Member Functions inherited from Exportable
	export ()
	This must take the contents of the object and convert it to exportable ODD. More...
	getExportableValues ()
	Return a list of all fields that can be exported. More...

Protected Member Functions
	initialise_attributes ($pre18_api=true)
	Initialise the attributes array. More...
	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...

Protected Attributes
	$attributes = array()
	The main attributes of an entity. More...
	$valid = false

Detailed Description

Definition at line 9 of file ElggData.php.

Member Function Documentation

ElggData::__isset

(

$name

)

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

Use isset($entity->property)

Parameters

string

$name

The name of the attribute or metadata.

Returns

bool

Definition at line 80 of file ElggData.php.

ElggData::current

(

)

Iterator interface.

See also

Iterator::current()

Returns

mixed

Definition at line 192 of file ElggData.php.

ElggData::delete ( )

abstract

Delete this data.

Returns

bool

ElggData::get (   $name )

abstractprotected

Fetch the specified attribute.

Parameters

string

$name

The attribute to fetch

Returns

mixed The attribute, if it exists. Otherwise, null.

ElggData::getClassName

(

)

Return the class name of the object.

Returns

string

Implements Loggable.

Definition at line 152 of file ElggData.php.

ElggData::getDatabase ( )

protected

Provides a pointer to the database object.

Returns

Elgg_Database The database where this data is (will be) stored.

Definition at line 67 of file ElggData.php.

ElggData::getObjectOwnerGUID

(

)

Return the GUID of the owner of this object.

Returns

int

Implements Loggable.

Definition at line 163 of file ElggData.php.

ElggData::getTimeCreated

(

)

Returns the UNIX epoch time that this entity was created.

Returns

int UNIX epoch time

Definition at line 131 of file ElggData.php.

ElggData::getURL ( )

abstract

Get a URL for this object.

Returns

string

ElggData::initialise_attributes (   $pre18_api = true )

protected

Initialise the attributes array.

This is vital to distinguish between metadata and base parameters.

Parameters

bool

$pre18_api

Compatibility for subclassing in 1.7 -> 1.8 change. Passing true (default) emits a deprecation notice. Passing false returns false. Core constructors always pass false. Does nothing either way since attributes are initialized by the time this is called.

Returns

void

Definition at line 39 of file ElggData.php.

ElggData::initializeAttributes ( )

protected

Initialize the attributes array.

This is vital to distinguish between metadata and base parameters.

Returns

void

Definition at line 53 of file ElggData.php.

ElggData::key

(

)

Iterator interface.

See also

Iterator::key()

Returns

string

Definition at line 203 of file ElggData.php.

ElggData::next

(

)

Iterator interface.

See also

Iterator::next()

Returns

void

Definition at line 214 of file ElggData.php.

ElggData::offsetExists

(

$offset

)

Array access interface.

See also

ArrayAccess::offsetExists()

Parameters

int

$offset

Offset

Returns

int

Definition at line 290 of file ElggData.php.

ElggData::offsetGet

(

$key

)

Array access interface.

See also

ArrayAccess::offsetGet()

Parameters

mixed

$key

Name

Returns

mixed

Definition at line 258 of file ElggData.php.

ElggData::offsetSet	(		$key,
			$value
	)

Array access interface.

See also

ArrayAccess::offsetSet()

Parameters

mixed	$key	Name
mixed	$value	Value

Returns

void

Definition at line 243 of file ElggData.php.

ElggData::offsetUnset

(

$key

)

Array access interface.

See also

ArrayAccess::offsetUnset()

Parameters

mixed

$key

Name

Returns

void

Definition at line 274 of file ElggData.php.

ElggData::rewind

(

)

Iterator interface.

See also

Iterator::rewind()

Returns

void

Definition at line 181 of file ElggData.php.

ElggData::save ( )

abstract

Save this data to the appropriate database table.

Returns

bool

ElggData::set (   $name,   $value  )

abstractprotected

Set the specified attribute.

Parameters

string	$name	The attribute to set
mixed	$value	The value to set it to

Returns

bool The success of your set function?

ElggData::toObject ( )

abstract

Get a plain old object copy for public consumption.

Returns

stdClass

ElggData::valid

(

)

Iterator interface.

See also

Iterator::valid()

Returns

bool

Definition at line 225 of file ElggData.php.

Member Data Documentation

ElggData::$attributes = array()

protected

The main attributes of an entity.

Holds attributes to save to database Blank entries for all database fields should be created by the constructor. Subclasses should add to this in their constructors. Any field not appearing in this will be viewed as metadata

Definition at line 23 of file ElggData.php.

ElggData::$valid = false

protected

Definition at line 172 of file ElggData.php.

---

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

• engine/classes/ElggData.php