ElggMetadata Class Reference

Inheritance diagram for ElggMetadata:

List of all members.

Public Member Functions
	__construct ($id=null)
	Construct a metadata object.
	canEdit ($user_guid=0)
	Determines whether or not the user can edit this piece of metadata.
	save ()
	Save metadata object.
	delete ()
	Delete the metadata.
	disable ()
	Disable the metadata.
	enable ()
	Enable the metadata.
	getURL ()
	Get a url for this item of metadata.
	getObjectFromID ($id)
	For a given ID, return the object associated with it.
Protected Member Functions
	initializeAttributes ()
	(non-PHPdoc)

---

Detailed Description

Definition at line 14 of file ElggMetadata.php.

---

Constructor & Destructor Documentation

ElggMetadata::__construct

(

$

id = null

)

Construct a metadata object.

Parameters:

mixed

$id ID of metadata or a database row as stdClass object

Definition at line 34 of file ElggMetadata.php.

---

Member Function Documentation

ElggMetadata::canEdit

(

$

user_guid = 0

)

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

Parameters:

int

$user_guid The GUID of the user (defaults to currently logged in user)

Returns:

bool Depending on permissions

Reimplemented from ElggExtender.

Definition at line 61 of file ElggMetadata.php.

ElggMetadata::delete

(

)

Delete the metadata.

Returns:

bool

Reimplemented from ElggData.

Definition at line 95 of file ElggMetadata.php.

ElggMetadata::disable

(

)

Disable the metadata.

Returns:

bool

Since:

1.8

Definition at line 111 of file ElggMetadata.php.

ElggMetadata::enable

(

)

Enable the metadata.

Returns:

bool

Since:

1.8

Definition at line 127 of file ElggMetadata.php.

ElggMetadata::getObjectFromID

(

$

id

)

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 Metadata ID

Returns:

ElggMetadata

Implements Loggable.

Definition at line 155 of file ElggMetadata.php.

ElggMetadata::getURL

(

)

Get a url for this item of metadata.

Returns:

string

Reimplemented from ElggData.

Definition at line 140 of file ElggMetadata.php.

ElggMetadata::initializeAttributes

(

)

[protected]

(non-PHPdoc)

See also:

ElggData::initializeAttributes()

Returns:

void

Reimplemented from ElggExtender.

Definition at line 23 of file ElggMetadata.php.

ElggMetadata::save

(

)

Save metadata object.

Returns:

int|bool the metadata object id or true if updated

Exceptions:

IOException

Reimplemented from ElggData.

Definition at line 75 of file ElggMetadata.php.

---

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

• engine/classes/ElggMetadata.php