PHP Class ElggData, Elgg

Inheritance: implements Loggable, implements Iterator, implements ArrayAccess, implements Exportable
Mostrar archivo Open project: elgg/elgg Class Usage Examples

Protected Properties

Property Type Description
$attributes 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
$valid * ITERATOR INTERFACE

Public Methods

Method Description
__isset ( string $name ) : boolean Test if property is set either as an attribute or metadata.
current ( ) : mixed Iterator interface
delete ( ) : boolean Delete this data.
getTimeCreated ( ) : integer Returns the UNIX epoch time that this entity was created
getURL ( ) : string Get a URL for this object
key ( ) : string Iterator interface
next ( ) : void Iterator interface
offsetExists ( integer $offset ) : integer Array access interface
offsetGet ( mixed $key ) : mixed Array access interface
offsetSet ( mixed $key, mixed $value ) : void Array access interface
offsetUnset ( mixed $key ) : void Array access interface
rewind ( ) : void Iterator interface
save ( ) : boolean Save this data to the appropriate database table.
toObject ( ) : stdClass Get a plain old object copy for public consumption
valid ( ) : boolean Iterator interface

Protected Methods

Method Description
getDatabase ( ) : Database Provides a pointer to the database object.
initializeAttributes ( ) : void Initialize the attributes array.

Method Details

__isset() public method

Test if property is set either as an attribute or metadata.
public __isset ( string $name ) : boolean
$name string The name of the attribute or metadata.
return boolean

current() public method

Iterator interface
See also: Iterator::current()
public current ( ) : mixed
return mixed

delete() abstract public method

Delete this data.
abstract public delete ( ) : boolean
return boolean

getDatabase() protected method

Provides a pointer to the database object.
protected getDatabase ( ) : Database
return Elgg\Database The database where this data is (will be) stored.

getTimeCreated() public method

Returns the UNIX epoch time that this entity was created
public getTimeCreated ( ) : integer
return integer UNIX epoch time

getURL() abstract public method

Get a URL for this object
abstract public getURL ( ) : string
return string

initializeAttributes() protected method

This is vital to distinguish between metadata and base parameters.
protected initializeAttributes ( ) : void
return void

key() public method

Iterator interface
See also: Iterator::key()
public key ( ) : string
return string

next() public method

Iterator interface
See also: Iterator::next()
public next ( ) : void
return void

offsetExists() public method

Array access interface
See also: ArrayAccess::offsetExists()
public offsetExists ( integer $offset ) : integer
$offset integer Offset
return integer

offsetGet() public method

Array access interface
See also: ArrayAccess::offsetGet()
public offsetGet ( mixed $key ) : mixed
$key mixed Name
return mixed

offsetSet() public method

Array access interface
See also: ArrayAccess::offsetSet()
public offsetSet ( mixed $key, mixed $value ) : void
$key mixed Name
$value mixed Value
return void

offsetUnset() public method

Array access interface
See also: ArrayAccess::offsetUnset()
public offsetUnset ( mixed $key ) : void
$key mixed Name
return void

rewind() public method

Iterator interface
See also: Iterator::rewind()
public rewind ( ) : void
return void

save() abstract public method

Save this data to the appropriate database table.
abstract public save ( ) : boolean
return boolean

toObject() abstract public method

Get a plain old object copy for public consumption
abstract public toObject ( ) : stdClass
return stdClass

valid() public method

Iterator interface
See also: Iterator::valid()
public valid ( ) : boolean
return boolean

Property Details

$attributes protected_oe property

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
protected $attributes

$valid protected_oe property

* ITERATOR INTERFACE
protected $valid