Elgg\Database\MetadataTable Class Reference

This class interfaces with the database to perform CRUD operations on metadata. More...

Public Member Functions
	__construct (protected AccessCache $access_cache, protected MetadataCache $metadata_cache, protected Database $db, protected Events $events, protected EntityTable $entityTable)
	Constructor. More...
	getTags (array $options=[])
	Get popular tags and their frequencies. More...
	get (int $id)
	Get a specific metadata object by its id. More...
	delete (\ElggMetadata $metadata)
	Deletes metadata using its ID. More...
	create (\ElggMetadata $metadata, bool $allow_multiple=false)
	Create a new metadata object, or update an existing one (if multiple is allowed) More...
	update (\ElggMetadata $metadata)
	Update a specific piece of metadata. More...
	getAll (array $options=[])
	Returns metadata. More...
	getRowsForGuids (array $guids)
	Returns metadata rows. More...
	deleteAll (array $options)
	Deletes metadata based on $options. More...
	getIDsByName (int $entity_guid, string $name)
	Returns ID(s) of metadata with a particular name attached to an entity. More...

Public Attributes
const	TABLE_NAME = 'metadata'
const	DEFAULT_JOIN_ALIAS = 'n_table'

Detailed Description

This class interfaces with the database to perform CRUD operations on metadata.

Definition at line 20 of file MetadataTable.php.

Constructor & Destructor Documentation

__construct()

Elgg\Database\MetadataTable::__construct	(	protected AccessCache	$access_cache,
		protected MetadataCache	$metadata_cache,
		protected Database	$db,
		protected Events	$events,
		protected EntityTable	$entityTable
	)

Constructor.

Parameters

AccessCache	$access_cache	The access cache
MetadataCache	$metadata_cache	A cache for this table
Database	$db	The Elgg database
Events	$events	The events registry
EntityTable	$entityTable	The EntityTable database wrapper

Definition at line 37 of file MetadataTable.php.

Member Function Documentation

create()

Elgg\Database\MetadataTable::create	(	\ElggMetadata	$metadata,
		bool	$allow_multiple = false
	)

Create a new metadata object, or update an existing one (if multiple is allowed)

Metadata can be an array by setting allow_multiple to true, but it is an indexed array with no control over the indexing

Parameters

\ElggMetadata	$metadata	Metadata
bool	$allow_multiple	Allow multiple values for one key. Default is false

Returns

int|false id of metadata or false if failure

Exceptions

LogicException

Definition at line 188 of file MetadataTable.php.

delete()

Elgg\Database\MetadataTable::delete

(

\ElggMetadata

$metadata

)

Deletes metadata using its ID.

Parameters

\ElggMetadata

$metadata

Metadata

Returns

bool

Definition at line 155 of file MetadataTable.php.

deleteAll()

Elgg\Database\MetadataTable::deleteAll

(

array

$options

)

Deletes metadata based on $options.

Warning

Unlike elgg_get_metadata() this will not accept an empty options array! This requires at least one constraint: metadata_name(s), metadata_value(s), or guid(s) must be set.

See also

elgg_get_metadata()

elgg_get_entities()

Parameters

array

$options

Options

Returns

bool

Exceptions

InvalidArgumentException

Definition at line 357 of file MetadataTable.php.

get()

Elgg\Database\MetadataTable::get

(

int

$id

)

Get a specific metadata object by its id.

See also

MetadataTable::getAll()

Parameters

int

$id

The id of the metadata object being retrieved.

Returns

\ElggMetadata|null

Definition at line 138 of file MetadataTable.php.

getAll()

Elgg\Database\MetadataTable::getAll

(

array

$options = []

)

Returns metadata.

Accepts all elgg_get_entities() options for entity restraints.

See also

elgg_get_entities()

Parameters

array

$options

Options

Returns

\ElggMetadata[]|mixed

Definition at line 314 of file MetadataTable.php.

getIDsByName()

Elgg\Database\MetadataTable::getIDsByName	(	int	$entity_guid,
		string	$name
	)

Returns ID(s) of metadata with a particular name attached to an entity.

Parameters

int	$entity_guid	Entity guid
string	$name	Metadata name

Returns

int[]|int|null

Definition at line 417 of file MetadataTable.php.

getRowsForGuids()

Elgg\Database\MetadataTable::getRowsForGuids

(

array

$guids

)

Returns metadata rows.

Used internally for metadata preloading

Parameters

array

$guids

Array of guids to fetch metadata rows for

Returns

\ElggMetadata[]

Definition at line 329 of file MetadataTable.php.

getTags()

Elgg\Database\MetadataTable::getTags

(

array

$options = []

)

Get popular tags and their frequencies.

Accepts all options supported by {

See also

elgg_get_metadata()}

Returns an array of objects that include "tag" and "total" properties

Parameters

array

$options

Options

@option int $threshold Minimum number of tag occurrences @option string[] $tag_names tag names to include in search

Returns

\stdClass[]|false

Definition at line 60 of file MetadataTable.php.

update()

Elgg\Database\MetadataTable::update

(

\ElggMetadata

$metadata

)

Update a specific piece of metadata.

Parameters

\ElggMetadata

$metadata

Updated metadata

Returns

bool

Definition at line 273 of file MetadataTable.php.

Member Data Documentation

DEFAULT_JOIN_ALIAS

const Elgg\Database\MetadataTable::DEFAULT_JOIN_ALIAS = 'n_table'

Definition at line 26 of file MetadataTable.php.

TABLE_NAME

const Elgg\Database\MetadataTable::TABLE_NAME = 'metadata'

Definition at line 24 of file MetadataTable.php.

---

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

• engine/classes/Elgg/Database/MetadataTable.php