Overview

Packages

  • ClipIt
    • clipit
      • api
    • urjc
      • backend
  • Elgg
    • Core
      • Access
      • Authentication
      • Cache
      • Caches
      • Core
      • DataMode
        • Site
      • DataModel
        • Annotations
        • Entities
        • Extender
        • File
        • Importable
        • Loggable
        • Notable
        • Object
        • User
      • DataStorage
      • Exception
      • Exceptions
        • Stub
      • FileStore
        • Disk
      • Groups
      • Helpers
      • HMAC
      • Memcache
      • Metadata
      • Navigation
      • ODD
      • Output
      • Plugins
        • Settings
      • Sessions
      • SocialModel
        • Friendable
        • Locatable
      • WebServicesAPI
      • Widgets
      • XML
      • XMLRPC
    • Exceptions
      • Stub
  • None
  • PHP

Classes

  • ElggMetadata
  • Overview
  • Package
  • Class
  • Tree

Class ElggMetadata

ElggMetadata This class describes metadata that can be attached to ElggEntities.

ElggData implements Loggable, Iterator, ArrayAccess, Exportable
Extended by ElggExtender
Extended by ElggMetadata
Package: Elgg\Core\Metadata
Located at ElggMetadata.php
Methods summary
protected
# initializeAttributes( )

(non-PHPdoc)

(non-PHPdoc)

See

ElggData::initializeAttributes()

Overrides

ElggExtender::initializeAttributes()
public
# __construct( mixed $id = null )

Construct a metadata object

Construct a metadata object

Parameters

$id
mixed
$id ID of metadata or a database row as stdClass object
public boolean
# canEdit( integer $user_guid = 0 )

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

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

Parameters

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

Returns

boolean
Depending on permissions

Overrides

ElggExtender::canEdit()
public integer|boolean
# save( )

Save metadata object

Save metadata object

Returns

integer|boolean
the metadata object id or true if updated

Throws

IOException
public boolean
# delete( )

Delete the metadata

Delete the metadata

Returns

boolean
public boolean
# disable( )

Disable the metadata

Disable the metadata

Returns

boolean

Since

1.8
public boolean
# enable( )

Enable the metadata

Enable the metadata

Returns

boolean

Since

1.8
public string
# getURL( )

Get a url for this item of metadata.

Get a url for this item of metadata.

Returns

string
public ElggMetadata
# getObjectFromID( integer $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.

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

$id
integer
$id Metadata ID

Returns

ElggMetadata
Methods inherited from ElggExtender
export(), get(), getEntity(), getExportableValues(), getOwnerEntity(), getOwnerGUID(), getSubtype(), getSystemLogID(), getType(), set()
Methods inherited from ElggData
__get(), __isset(), __set(), current(), getClassName(), getTimeCreated(), key(), next(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), rewind(), valid()
Properties inherited from ElggData
$attributes, $valid
Magic properties summary
public string $value_type
#
public integer $owner_guid
#
public string $enabled
#
Magic properties inherited from ElggExtender
$access_id, $entity_guid, $id, $name, $time_created, $type, $value
API documentation generated by ApiGen 2.8.0