Knowledge Base

updateAnnotation()

Description

Update annotation and its tags if needed

Parameters

Column	Type	Default	Description
$annotation	array

Return

boolean

Location

include/annotation_functions.php lines 388 to 456

Definition

 
function updateAnnotation(array $annotation)
    {
    debug(sprintf('[annotations][fct=updateAnnotation] Param $annotation = %s', json_encode($annotation)));
    if(!isset($annotation['ref']) || !annotationEditable($annotation))
        {
        return false;
        }

    global $userref;

    // ResourceSpace specific properties
    $annotation_ref      = $annotation['ref'];
    $resource_type_field = $annotation['resource_type_field'];
    $resource            = $annotation['resource'];
    $page                = (isset($annotation['page']) && 0 < $annotation['page'] ? $annotation['page'] : null);
    $tags                = $annotation['tags'] ?? [];

    // Annotorious annotation
    $x      = $annotation['shapes'][0]['geometry']['x'];
    $y      = $annotation['shapes'][0]['geometry']['y'];
    $width  = $annotation['shapes'][0]['geometry']['width'];
    $height = $annotation['shapes'][0]['geometry']['height'];

    ps_query(
        'UPDATE annotation SET resource_type_field = ?, user = ?, x = ?, y = ?, width = ?, height = ?, page = ? WHERE ref = ?',
        [
            'i', $resource_type_field,
            'i', $userref,
            'd', $x,
            'd', $y,
            'd', $width,
            'd', $height,
            'i', $page,
            'i', $annotation_ref,
        ]
    );

    // Delete existing associations
    $nodes_to_remove = array();
    foreach(getAnnotationTags($annotation) as $tag)
        {
        $nodes_to_remove[] = $tag['ref'];
        }

    db_begin_transaction("updateAnnotation");

    if(0 < count($nodes_to_remove))
        {
        delete_resource_nodes($resource, $nodes_to_remove);
        }
    
    ps_query("DELETE FROM annotation_node WHERE annotation = ?", ['i', $annotation_ref]);

    // Add any tags associated with this annotation
    if(0 < count($tags))
        {
        // Prepare tags before association by adding new nodes to 
        // dynamic keywords list (if permissions allow it)
        $prepared_tags = prepareTags($tags);

        // Add new associations
        addAnnotationNodes($annotation_ref, $prepared_tags);
        add_resource_nodes($resource, array_column($prepared_tags, 'ref'), false);
        }

    db_end_transaction("updateAnnotation");

    return true;
    }


This article was last updated 3rd February 2023 03:05 Europe/London time based on the source file dated 29th December 2022 17:10 Europe/London time.