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

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

next() public method

Iterator interface

offsetExists() public method

Array access interface

offsetGet() public method

Array access interface

offsetSet() public method

Array access interface

offsetUnset() public method

Array access interface

rewind() public method

Iterator interface

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

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

public offsetExists ( integer $offset ) : integer
$offset	integer	Offset
return	integer

public offsetGet ( mixed $key ) : mixed
$key	mixed	Name
return	mixed

public offsetSet ( mixed $key, mixed $value ) : void
$key	mixed	Name
$value	mixed	Value
return	void

public offsetUnset ( mixed $key ) : void
$key	mixed	Name
return	void