annotations.php

Go to the documentation of this file.

<?php
function elgg_get_annotation_from_id(int $id): ?\ElggAnnotation {
    return _elgg_services()->annotationsTable->get($id);
}

function elgg_delete_annotation_by_id(int $id): bool {
    $annotation = elgg_get_annotation_from_id($id);
    if (!$annotation) {
        return false;
    }

    return $annotation->delete();
}

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

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

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

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

function elgg_delete_annotations(array $options): bool {
    return _elgg_services()->annotationsTable->deleteAll($options);
}

function elgg_disable_annotations(array $options): bool {
    return _elgg_services()->annotationsTable->disableAll($options);
}

function elgg_enable_annotations(array $options): bool {
    return _elgg_services()->annotationsTable->enableAll($options);
}

function elgg_annotation_exists(int $entity_guid, string $name, int $owner_guid = 0): bool {
    if ($owner_guid < 1) {
        $owner_guid = elgg_get_logged_in_user_guid();
    }

    return _elgg_services()->annotationsTable->exists($entity_guid, $name, $owner_guid);
}