Elgg  Version master
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ElggData Class Reference

A generic class that contains shared code among , , and . More...

Inheritance diagram for ElggData:
Elgg\Collections\CollectionItemInterface ElggAccessCollection ElggEntity ElggExtender ElggRelationship ElggGroup ElggObject ElggSite ElggUser ElggAnnotation ElggMetadata ElggAdminNotice ElggComment ElggFile ElggPlugin ElggUpgrade ElggWidget ElggIcon ElggTempFile

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...
 
 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...
 
 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 , , and .

Definition at line 10 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$nameThe name of the attribute or metadata.
Returns
bool

Definition at line 57 of file ElggData.php.

ElggData::__serialize ( )

Called during serialization.

Returns
array
See also
serialize()
Since
4.1

Definition at line 270 of file ElggData.php.

ElggData::__unserialize ( array  $data)

Called during unserialization.

Parameters
array$dataserialized data
Returns
void
See also
unserialize()
Since
4.1

Definition at line 283 of file ElggData.php.

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$nameThe name of the attribute or metadata.
Returns
void

Definition at line 70 of file ElggData.php.

ElggData::current ( )

Iterator interface.

See also
Iterator::current()
Returns
mixed

Definition at line 139 of file ElggData.php.

ElggData::delete ( )
abstract

Delete this data.

Returns
bool
ElggData::getDatabase ( )
protected

Provides a pointer to the database object.

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

Definition at line 44 of file ElggData.php.

ElggData::getID ( )

{Get unique item identifier within a collection.

Returns
string|int
}

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 252 of file ElggData.php.

ElggData::getPriority ( )

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

Returns
int
}

Implements Elgg\Collections\CollectionItemInterface.

Definition at line 259 of file ElggData.php.

ElggData::getTimeCreated ( )

Returns the UNIX epoch time that this entity was created.

Returns
int UNIX epoch time

Definition at line 100 of file ElggData.php.

ElggData::getURL ( )
abstract

Get a URL for this object.

Returns
string
ElggData::initializeAttributes ( )
protected

Initialize the attributes array.

This is vital to distinguish between metadata and base parameters.

Returns
void

Definition at line 35 of file ElggData.php.

ElggData::key ( )

Iterator interface.

See also
Iterator::key()
Returns
string

Definition at line 151 of file ElggData.php.

ElggData::next ( )

Iterator interface.

See also
Iterator::next()
Returns
void

Definition at line 163 of file ElggData.php.

ElggData::offsetExists (   $offset)

Array access interface.

See also
::offsetExists()
Parameters
int$offsetOffset
Returns
bool

Definition at line 245 of file ElggData.php.

ElggData::offsetGet (   $key)

Array access interface.

See also
::offsetGet()
Parameters
mixed$keyName
Returns
mixed

Definition at line 210 of file ElggData.php.

ElggData::offsetSet (   $key,
  $value 
)

Array access interface.

See also
::offsetSet()
Parameters
mixed$keyName
mixed$valueValue
Returns
void

Definition at line 194 of file ElggData.php.

ElggData::offsetUnset (   $key)

Array access interface.

See also
::offsetUnset()
Parameters
mixed$keyName
Returns
void

Definition at line 228 of file ElggData.php.

ElggData::rewind ( )

Iterator interface.

See also
Iterator::rewind()
Returns
void

Definition at line 127 of file ElggData.php.

ElggData::save ( )
abstract

Save this data to the appropriate database table.

Returns
bool
ElggData::toObject ( array  $params = [])
abstract

Get a plain old object copy for public consumption.

Parameters
array$paramsExport parameters
Returns
ElggData::valid ( )

Iterator interface.

See also
Iterator::valid()
Returns
bool

Definition at line 175 of file ElggData.php.

Member Data Documentation

ElggData::$attributes = []
protected

Definition at line 26 of file ElggData.php.

ElggData::$valid = false
protected

Definition at line 117 of file ElggData.php.


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