metadata.php

Go to the documentation of this file.

<?php
function row_to_elggmetadata($row) {
    if (!($row instanceof \stdClass)) {
        return $row;
    }
 
    return new \ElggMetadata($row);
}
 
function elgg_get_metadata_from_id($id) {
    return _elgg_services()->metadataTable->get($id);
}
 
function elgg_delete_metadata_by_id($id) {
    return _elgg_services()->metadataTable->delete($id);
}
 
function create_metadata($entity_guid, $name, $value, $value_type = '', $owner_guid = 0,
        $access_id = ACCESS_PRIVATE, $allow_multiple = false) {
 
    return _elgg_services()->metadataTable->create($entity_guid, $name, $value,
        $value_type, $owner_guid, $access_id, $allow_multiple);
}
 
function update_metadata($id, $name, $value, $value_type, $owner_guid, $access_id) {
    return _elgg_services()->metadataTable->update($id, $name, $value,
        $value_type, $owner_guid, $access_id);
}
 
function create_metadata_from_array($entity_guid, array $name_and_values, $value_type, $owner_guid,
        $access_id = ACCESS_PRIVATE, $allow_multiple = false) {
 
    return _elgg_services()->metadataTable->createFromArray($entity_guid, $name_and_values,
        $value_type, $owner_guid, $access_id, $allow_multiple);
 
}
 
function elgg_get_metadata(array $options = array()) {
    return _elgg_services()->metadataTable->getAll($options);
}
 
function elgg_delete_metadata(array $options) {
    return _elgg_services()->metadataTable->deleteAll($options);
}
 
function elgg_disable_metadata(array $options) {
    return _elgg_services()->metadataTable->disableAll($options);
}
 
function elgg_enable_metadata(array $options) {
    return _elgg_services()->metadataTable->enableAll($options);
}
 
function elgg_get_entities_from_metadata(array $options = array()) {
    return _elgg_services()->metadataTable->getEntities($options);
}
 
function elgg_list_entities_from_metadata($options) {
    return elgg_list_entities($options, 'elgg_get_entities_from_metadata');
}
 
function _elgg_get_entity_metadata_where_sql($e_table, $n_table, $names = null, $values = null,
        $pairs = null, $pair_operator = 'AND', $case_sensitive = true, $order_by_metadata = null,
        $owner_guids = null) {
    return _elgg_services()->metadataTable->getEntityMetadataWhereSql($e_table, $n_table, $names,
        $values, $pairs, $pair_operator, $case_sensitive, $order_by_metadata, $owner_guids);
}
 
function metadata_array_to_values($array) {
    $valuearray = array();
 
    if (is_array($array)) {
        foreach ($array as $element) {
            $valuearray[] = $element->value;
        }
    }
 
    return $valuearray;
}
 
function get_metadata_url($id) {
    return _elgg_services()->metadataTable->getUrl($id);
}
 
function register_metadata_as_independent($type, $subtype = '*') {
    _elgg_services()->metadataTable->registerMetadataAsIndependent($type, $subtype);
}
 
function is_metadata_independent($type, $subtype) {
    return _elgg_services()->metadataTable->isMetadataIndependent($type, $subtype);
}
 
function metadata_update($event, $object_type, $object) {
    return _elgg_services()->metadataTable->handleUpdate($event, $object_type, $object);
}
 
function _elgg_invalidate_metadata_cache($action, array $options) {
    // remove as little as possible, optimizing for common cases
    $cache = _elgg_services()->metadataCache;
    if (empty($options['guid'])) {
        // safest to clear everything unless we want to make this even more complex :(
        $cache->flush();
    } else {
        if (empty($options['metadata_name'])) {
            // safest to clear the whole entity
            $cache->clear($options['guid']);
        } else {
            switch ($action) {
                case 'delete':
                    $cache->markEmpty($options['guid'], $options['metadata_name']);
                    break;
                default:
                    $cache->markUnknown($options['guid'], $options['metadata_name']);
            }
        }
    }
}
 
elgg_register_event_handler('update', 'all', 'metadata_update');
 
function _elgg_metadata_test($hook, $type, $value, $params) {
    global $CONFIG;
    $value[] = $CONFIG->path . 'engine/tests/ElggCoreMetadataAPITest.php';
    $value[] = $CONFIG->path . 'engine/tests/ElggCoreMetadataCacheTest.php';
    return $value;
}
 
elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_metadata_test');