annotations.php

Go to the documentation of this file.

<?php
function row_to_elggannotation($row) {
    if (!($row instanceof \stdClass)) {
        // @todo should throw in this case?
        return $row;
    }

    return new \ElggAnnotation($row);
}

function elgg_get_annotation_from_id($id) {
    return _elgg_services()->annotations->get($id);
}

function elgg_delete_annotation_by_id($id) {
    return _elgg_services()->annotations->delete($id);
}

function create_annotation($entity_guid, $name, $value, $value_type = '',
        $owner_guid = 0, $access_id = ACCESS_PRIVATE) {
    return _elgg_services()->annotations->create(
        $entity_guid, $name, $value, $value_type, $owner_guid, $access_id);
}

function update_annotation($annotation_id, $name, $value, $value_type, $owner_guid, $access_id) {
    return _elgg_services()->annotations->update($annotation_id, $name, $value, $value_type, $owner_guid, $access_id);
}

function elgg_get_annotations(array $options = array()) {
    return _elgg_services()->annotations->find($options);
}

function elgg_list_annotations($options) {
    $defaults = array(
        'limit' => 25,
        'offset' => (int) max(get_input('annoff', 0), 0),
        'no_results' => '',
    );

    $options = array_merge($defaults, $options);

    return elgg_list_entities($options, 'elgg_get_annotations', 'elgg_view_annotation_list');
}

function elgg_delete_annotations(array $options) {
    return _elgg_services()->annotations->deleteAll($options);
}

function elgg_disable_annotations(array $options) {
    return _elgg_services()->annotations->disableAll($options);
}

function elgg_enable_annotations(array $options) {
    return _elgg_services()->annotations->enableAll($options);
}

function elgg_get_entities_from_annotations(array $options = array()) {
    return _elgg_services()->annotations->getEntities($options);
}

function elgg_list_entities_from_annotations($options = array()) {
    return elgg_list_entities($options, 'elgg_get_entities_from_annotations');
}

function elgg_get_entities_from_annotation_calculation($options) {
    return _elgg_services()->annotations->getEntitiesFromCalculation($options);
}

function elgg_list_entities_from_annotation_calculation($options) {
    $defaults = array(
        'calculation' => 'sum',
        'order_by' => 'annotation_calculation desc'
    );
    $options = array_merge($defaults, $options);

    return elgg_list_entities($options, 'elgg_get_entities_from_annotation_calculation');
}

function elgg_annotation_exists($entity_guid, $annotation_type, $owner_guid = null) {
    return _elgg_services()->annotations->exists($entity_guid, $annotation_type, $owner_guid);
}

function _elgg_set_comment_url($hook, $type, $url, $params) {
    $annotation = $params['extender'];
    /* @var \ElggExtender $annotation */
    if ($annotation->getSubtype() == 'generic_comment') {
        $entity = $annotation->getEntity();
        if ($entity) {
            return $entity->getURL() . '#item-annotation-' . $annotation->id;
        }
    }
}

function _elgg_annotations_test($hook, $type, $tests) {
    global $CONFIG;
    $tests[] = $CONFIG->path . 'engine/tests/ElggCoreAnnotationAPITest.php';
    $tests[] = $CONFIG->path . 'engine/tests/ElggAnnotationTest.php';
    return $tests;
}

function _elgg_annotations_init() {
    elgg_register_plugin_hook_handler('extender:url', 'annotation', '_elgg_set_comment_url');
    elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_annotations_test');
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('init', 'system', '_elgg_annotations_init');
};