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 389 to 455

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;

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

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

    $update_query = "
        UPDATE annotation
           SET
               resource_type_field = '{$resource_type_field}',
               user = '{$userref}',
               x = '{$x}',
               y = '{$y}',
               width = '{$width}',
               height = '{$height}',
               page = {$page}
         WHERE ref = '{$annotation_ref}'";
    sql_query($update_query);

    // 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);
        }
    sql_query("DELETE FROM annotation_node WHERE annotation = '{$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 12th May 2021 05:35 Europe/London time based on the source file dated 5th March 2021 16:05 Europe/London time.