Elgg  Version 3.0
Public Member Functions | Protected Member Functions | List of all members
ElggMetadata Class Reference

ElggMetadata. More...

Inheritance diagram for ElggMetadata:
ElggExtender ElggData Elgg\Collections\CollectionItemInterface

Public Member Functions

 __construct (stdClass $row=null)
 Constructor. More...
 
 canEdit ($user_guid=0)
 Determines whether or not the user can edit this piece of metadata. More...
 
 save ()
 Save metadata object. More...
 
 delete ()
 Delete the metadata. More...
 
 getObjectFromID ($id)
 {} More...
 
- Public Member Functions inherited from ElggExtender
 __set ($name, $value)
 Set an attribute. More...
 
 setValue ($value, $value_type= '')
 Set the value of the extender. More...
 
 __get ($name)
 Gets an attribute. More...
 
 getOwnerGUID ()
 Get the GUID of the extender's owner entity. More...
 
 getOwnerEntity ()
 Get the entity that owns this extender. More...
 
 getEntity ()
 Get the entity this describes. More...
 
 canEdit ($user_guid=0)
 Returns if a user can edit this entity extender. More...
 
 toObject (array $params=[])
 {} More...
 
 getSystemLogID ()
 Return an identification for the object for storage in the system log. More...
 
 getType ()
 Return a type of extension. More...
 
 getSubtype ()
 Return a subtype. More...
 
 getURL ()
 Get a url for this extender. More...
 
- Public Member Functions inherited from ElggData
 __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 ()
 {} More...
 
 unserialize ($serialized)
 {} More...
 

Protected Member Functions

 initializeAttributes ()
 {} More...
 
- Protected Member Functions inherited from ElggExtender
 initializeAttributes ()
 {} More...
 
- Protected Member Functions inherited from ElggData
 initializeAttributes ()
 Initialize the attributes array. More...
 
 getDatabase ()
 Provides a pointer to the database object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ElggExtender
static detectValueType ($value, $value_type="")
 Detect the value_type for a value to be stored as metadata or an annotation. More...
 
- Protected Attributes inherited from ElggExtender
 $int_columns
 
- Protected Attributes inherited from ElggData
 $attributes = []
 The main attributes of an entity. More...
 
 $valid = false
 

Detailed Description

ElggMetadata.

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

Definition at line 11 of file ElggMetadata.php.

Constructor & Destructor Documentation

ElggMetadata::__construct ( stdClass  $row = null)

Constructor.

Parameters
stdClass$rowDatabase row

Definition at line 27 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_guidThe GUID of the user (defaults to currently logged in user)
Returns
bool
See also
elgg_set_ignore_access()

Definition at line 47 of file ElggMetadata.php.

ElggMetadata::delete ( )

Delete the metadata.

Returns
bool

Definition at line 75 of file ElggMetadata.php.

ElggMetadata::getObjectFromID (   $id)

{}

Definition at line 82 of file ElggMetadata.php.

ElggMetadata::initializeAttributes ( )
protected

{}

Definition at line 16 of file ElggMetadata.php.

ElggMetadata::save ( )

Save metadata object.

Returns metadata on success, false on failure

Returns
int|false

Definition at line 62 of file ElggMetadata.php.


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