A generic class that contains shared code among \ElggExtender, \ElggEntity, and \ElggRelationship. More...

Inheritance diagram for ElggData:

Public Member Functions
	__isset ($name)
	Test if property is set either as an attribute or metadata. More...

	__unset ($name)
	Unset a property from metadata or attribute. 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 (array $params=[])
	Get a plain old object copy for public consumption. More...

	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 (int $id)
	For a given ID, return the object associated with it. More...

	rewind ()
	Iterator interface. More...

	current ()
	Iterator interface. More...

	key ()
	Iterator interface. More...

	next ()
	Iterator interface. More...

	valid ()
	Iterator interface. More...

	offsetSet ($offset, $value)
	Array access interface. More...

	offsetGet ($offset)
	Array access interface. More...

	offsetUnset ($offset)
	Array access interface. More...

	offsetExists ($offset)
	Array access interface. More...

	getID ()
	{Get unique item identifier within a collection. Returns string\|int } More...

	getPriority ()
	{Get priority (weight) of the item within a collection. Returns int } More...

	__serialize ()
	Called during serialization. More...

	__unserialize (array $data)
	Called during unserialization. More...

Protected Member Functions
	initializeAttributes ()
	Initialize the attributes array. More...

	getDatabase ()
	Provides a pointer to the database object. More...

Protected Attributes
	$attributes = []

	$valid = false

Detailed Description

A generic class that contains shared code among \ElggExtender, \ElggEntity, and \ElggRelationship.

Definition at line 10 of file ElggData.php.

Member Function Documentation

◆ __isset()

ElggData::__isset ( $name )

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

@tip Use isset($entity->property)

Parameters

string $name The name of the attribute or metadata.

Returns: bool

Definition at line 56 of file ElggData.php.

◆ __serialize()

ElggData::__serialize ( )

Called during serialization.

Returns: array

See also: serialize()

Since: 4.1

Definition at line 310 of file ElggData.php.

◆ __unserialize()

ElggData::__unserialize ( array $data )

Called during unserialization.

Parameters

array $data serialized data

Returns: void

See also: unserialize()

Since: 4.1

Definition at line 323 of file ElggData.php.

◆ __unset()

ElggData::__unset ( $name )

Unset a property from metadata or attribute.

Warning: If you use this to unset an attribute, you must save the object!

Parameters

string $name The name of the attribute or metadata.

Returns: void

Definition at line 69 of file ElggData.php.

◆ current()

ElggData::current ( )

Iterator interface.

See also: Iterator::current()

Returns: mixed

Definition at line 179 of file ElggData.php.

◆ delete()

ElggData::delete ( )

abstract

Delete this data.

Returns: bool

Reimplemented in ElggRelationship, ElggMetadata, ElggAnnotation, and ElggAccessCollection.

◆ getDatabase()

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 43 of file ElggData.php.

◆ getID()

ElggData::getID ( )

{Get unique item identifier within a collection.

Returns: string|int

}

Implements Elgg\Collections\CollectionItemInterface.

Reimplemented in ElggPlugin.

Definition at line 292 of file ElggData.php.

◆ getObjectFromID()

ElggData::getObjectFromID ( int $id )

abstract

For a given ID, return the object associated with it.

This is used by the river functionality primarily. This is useful for checking access permissions etc on objects.

Parameters

int $id GUID of an entity

Returns: static|false

Reimplemented in ElggRelationship, ElggMetadata, ElggEntity, ElggAnnotation, and ElggAccessCollection.

◆ getPriority()

ElggData::getPriority ( )

{Get priority (weight) of the item within a collection.

Returns: int

}

Implements Elgg\Collections\CollectionItemInterface.

Reimplemented in ElggPlugin.

Definition at line 299 of file ElggData.php.

◆ getSubtype()

ElggData::getSubtype ( )

abstract

Return a subtype.

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

Returns: string

Reimplemented in ElggRelationship, ElggExtender, ElggEntity, and ElggAccessCollection.

◆ getSystemLogID()

ElggData::getSystemLogID ( )

abstract

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

This id must be an integer. Unsaved implementations should return 0.

Returns: int

Reimplemented in ElggRelationship, ElggExtender, ElggEntity, and ElggAccessCollection.

◆ getTimeCreated()

ElggData::getTimeCreated ( )

Returns the UNIX epoch time that this entity was created.

Returns: int UNIX epoch time

Definition at line 99 of file ElggData.php.

◆ getType()

ElggData::getType ( )

abstract

Return the type of the object - eg.

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

Returns: string

Reimplemented in ElggRelationship, ElggExtender, ElggEntity, and ElggAccessCollection.

◆ getURL()

ElggData::getURL ( )

abstract

Get a URL for this object.

Returns: string

Reimplemented in ElggSite, ElggRelationship, ElggExtender, ElggEntity, and ElggAccessCollection.

◆ initializeAttributes()

ElggData::initializeAttributes ( )

protected

Initialize the attributes array.

This is vital to distinguish between metadata and base parameters.

Returns: void

Reimplemented in ElggWidget, ElggUser, ElggUpgrade, ElggTempFile, ElggSite, ElggRelationship, ElggPlugin, ElggObject, ElggMetadata, ElggIcon, ElggGroup, ElggFile, ElggExtender, ElggEntity, ElggComment, ElggAnnotation, ElggAdminNotice, and ElggAccessCollection.

Definition at line 34 of file ElggData.php.

◆ key()

ElggData::key ( )

Iterator interface.

See also: Iterator::key()

Returns: string

Definition at line 191 of file ElggData.php.

◆ next()

ElggData::next ( )

Iterator interface.

See also: Iterator::next()

Returns: void

Definition at line 203 of file ElggData.php.

◆ offsetExists()

ElggData::offsetExists ( $offset )

Array access interface.

See also: \ArrayAccess::offsetExists()

Parameters

int $offset An offset to check for

Returns: bool

Definition at line 285 of file ElggData.php.

◆ offsetGet()

ElggData::offsetGet ( $offset )

Array access interface.

See also: \ArrayAccess::offsetGet()

Parameters

mixed $offset The offset to retrieve

Returns: mixed

Definition at line 250 of file ElggData.php.

◆ offsetSet()

ElggData::offsetSet	(	$offset,
		$value
	)

Array access interface.

See also: \ArrayAccess::offsetSet()

Parameters

mixed	$offset	The offset to assign the value to
mixed	$value	The value to set

Returns: void

Definition at line 234 of file ElggData.php.

◆ offsetUnset()

ElggData::offsetUnset ( $offset )

Array access interface.

See also: \ArrayAccess::offsetUnset()

Parameters

mixed $offset The offset to unset

Returns: void

Definition at line 268 of file ElggData.php.

◆ rewind()

ElggData::rewind ( )

Iterator interface.

See also: Iterator::rewind()

Returns: void

Definition at line 167 of file ElggData.php.

◆ save()

ElggData::save ( )

abstract

Save this data to the appropriate database table.

Returns: bool

Reimplemented in ElggUpgrade, ElggTempFile, ElggSite, ElggRelationship, ElggPlugin, ElggMetadata, ElggIcon, ElggEntity, ElggAnnotation, and ElggAccessCollection.

◆ toObject()

ElggData::toObject ( array $params = [] )

abstract

Get a plain old object copy for public consumption.

Parameters

array $params Export parameters

Returns: \Elgg\Export\Data

Reimplemented in ElggRelationship, ElggExtender, ElggEntity, and ElggAccessCollection.

◆ valid()

bool is the iterator still ElggData::valid ( )

Iterator interface.

ITERATOR INTERFACE.

See also: Iterator::valid()

Returns: bool

Definition at line 215 of file ElggData.php.

Member Data Documentation

◆ $attributes

ElggData::$attributes = []

protected

Definition at line 25 of file ElggData.php.

◆ $valid

ElggData::$valid = false

protected

Definition at line 157 of file ElggData.php.

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

engine/classes/ElggData.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __isset()

◆ __serialize()

◆ __unserialize()

◆ __unset()

◆ current()

◆ delete()

◆ getDatabase()

◆ getID()

◆ getObjectFromID()

◆ getPriority()

◆ getSubtype()

◆ getSystemLogID()

◆ getTimeCreated()

◆ getType()

◆ getURL()

◆ initializeAttributes()

◆ key()

◆ next()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ rewind()

◆ save()

◆ toObject()

◆ valid()

Member Data Documentation

◆ $attributes

◆ $valid