Annotations.php

Go to the documentation of this file.

<?php

namespace Elgg\Traits\Entity;

trait Annotations {
    
    protected array $temp_annotations = [];
    
    public function deleteAnnotations(?string $name = null): bool {
        if ($this->guid) {
            return elgg_delete_annotations([
                'guid' => $this->guid,
                'limit' => false,
                'annotation_name' => $name,
            ]);
        }
        
        if ($name) {
            unset($this->temp_annotations[$name]);
        } else {
            $this->temp_annotations = [];
        }
        
        return true;
    }
    
    public function deleteOwnedAnnotations(?string $name = null): bool {
        // access is turned off for this because they might
        // no longer have access to an entity they created annotations on
        return elgg_call(ELGG_IGNORE_ACCESS, function() use ($name) {
            return elgg_delete_annotations([
                'annotation_owner_guid' => $this->guid,
                'limit' => false,
                'annotation_name' => $name,
            ]);
        });
    }
    
    private function getAnnotationCalculation(string $name, string $calculation): mixed {
        return elgg_get_annotations([
            'guid' => $this->guid,
            'distinct' => false,
            'annotation_name' => $name,
            'annotation_calculation' => $calculation
        ]);
    }
    
    public function annotate($name, $value, $access_id = ACCESS_PRIVATE, $owner_guid = 0, $value_type = '') {
        if (!$this->guid) {
            $this->temp_annotations[$name] = $value;
            return true;
        }
        
        if (!$owner_guid) {
            $owner_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        $annotation = new \ElggAnnotation();
        $annotation->entity_guid = $this->guid;
        $annotation->name = $name;
        $annotation->value = $value;
        $annotation->owner_guid = $owner_guid;
        $annotation->access_id = $access_id;
        
        if (!empty($value_type)) {
            $annotation->value_type = $value_type;
        }
        
        if ($annotation->save()) {
            return $annotation->id;
        }
        
        return false;
    }
    
    public function getAnnotations(array $options = []) {
        if ($this->guid) {
            $options['guid'] = $this->guid;
            
            return elgg_get_annotations($options);
        } else {
            $name = elgg_extract('annotation_name', $options, '');
            
            if (isset($this->temp_annotations[$name])) {
                return [$this->temp_annotations[$name]];
            }
        }
        
        return [];
    }
    
    public function countAnnotations(string $name = ''): int {
        return $this->getAnnotationCalculation($name, 'count');
    }
    
    public function getAnnotationsAvg(string $name) {
        return $this->getAnnotationCalculation($name, 'avg');
    }
    
    public function getAnnotationsSum(string $name) {
        return $this->getAnnotationCalculation($name, 'sum');
    }
    
    public function getAnnotationsMin(string $name) {
        return $this->getAnnotationCalculation($name, 'min');
    }
    
    public function getAnnotationsMax(string $name) {
        return $this->getAnnotationCalculation($name, 'max');
    }
}