PHP Class ElggMetadata, Elgg

This class describes metadata that can be attached to an \ElggEntity. It is rare that a plugin developer needs to use this API for metadata. Almost all interaction with metadata occurs through the methods of \ElggEntity. See its __set(), __get(), and setMetadata() methods.

Inheritance: extends ElggExtender

Mostra file Open project: elgg/elgg Class Usage Examples

Public Methods

Method	Description
__construct ( stdClass $row = null )	Construct a metadata object
canEdit ( integer $user_guid ) : boolean	Determines whether or not the user can edit this piece of metadata
delete ( ) : boolean	Delete the metadata
disable ( ) : boolean	Disable the metadata
enable ( ) : boolean	Enable the metadata
getObjectFromID ( integer $id ) : ElggMetadata	For a given ID, return the object associated with it.
save ( ) : integer \| boolean	Save metadata object

Protected Methods

Method	Description
initializeAttributes ( ) : void	(non-PHPdoc)

Method Details

__construct() public method

Plugin developers will probably never need to use this API. See \ElggEntity for its API for setting and getting metadata.

public __construct ( stdClass $row = null )
$row	stdClass	Database row as \stdClass object

canEdit() public method

Determines whether or not the user can edit this piece of metadata

delete() public method

Delete the metadata

public delete ( ) : boolean
return	boolean

disable() public method

Disable the metadata

Since: 1.8

public disable ( ) : boolean
return	boolean

enable() public method

Enable the metadata

Since: 1.8

public enable ( ) : boolean
return	boolean

getObjectFromID() public method

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

public getObjectFromID ( integer $id ) : ElggMetadata
$id	integer	Metadata ID
return	ElggMetadata

initializeAttributes() protected method

(non-PHPdoc)

See also: ElggData::initializeAttributes()

protected initializeAttributes ( ) : void
return	void

save() public method

Save metadata object

public save ( ) : integer \| boolean
return	integer \| boolean	the metadata object id or true if updated

public canEdit ( integer $user_guid ) : boolean
$user_guid	integer	The GUID of the user (defaults to currently logged in user)
return	boolean