ElggAnnotation.php

Go to the documentation of this file.

<?php
class ElggAnnotation extends ElggExtender {

    protected function initializeAttributes() {
        parent::initializeAttributes();

        $this->attributes['type'] = 'annotation';
    }

    public function __construct($row = null) {
        $this->initializeAttributes();

        if (!empty($row)) {
            // Create from db row
            if ($row instanceof stdClass) {
                $annotation = $row;

                $objarray = (array) $annotation;
                foreach ($objarray as $key => $value) {
                    $this->attributes[$key] = $value;
                }
            } else {
                // get an ElggAnnotation object and copy its attributes
                elgg_deprecated_notice('Passing an ID to constructor is deprecated. Use elgg_get_annotation_from_id()', 1.9);
                $annotation = elgg_get_annotation_from_id($row);
                $this->attributes = $annotation->attributes;
            }
        }
    }

    public function save() {
        if ($this->id > 0) {
            return update_annotation($this->id, $this->name, $this->value, $this->value_type,
                $this->owner_guid, $this->access_id);
        } else {
            $this->id = create_annotation($this->entity_guid, $this->name, $this->value,
                $this->value_type, $this->owner_guid, $this->access_id);

            if (!$this->id) {
                throw new IOException("Unable to save new " . get_class());
            }
            return $this->id;
        }
    }

    public function delete() {
        $result = _elgg_delete_metastring_based_object_by_id($this->id, 'annotation');
        if ($result) {
            elgg_delete_river(array('annotation_id' => $this->id));
        }

        return $result;
    }

    public function disable() {
        return _elgg_set_metastring_based_object_enabled_by_id($this->id, 'no', 'annotations');
    }

    public function enable() {
        return _elgg_set_metastring_based_object_enabled_by_id($this->id, 'yes', 'annotations');
    }

    public function canEdit($user_guid = 0) {

        if ($user_guid) {
            $user = get_user($user_guid);
            if (!$user) {
                return false;
            }
        } else {
            $user = elgg_get_logged_in_user_entity();
            $user_guid = elgg_get_logged_in_user_guid();
        }

        $result = false;
        if ($user) {
            // If the owner of annotation is the specified user, they can edit.
            if ($this->getOwnerGUID() == $user_guid) {
                $result = true;
            }

            // If the user can edit the entity this is attached to, they can edit.
            $entity = $this->getEntity();
            if ($result == false && $entity->canEdit($user->getGUID())) {
                $result = true;
            }
        }

        // Trigger plugin hook - note that $user may be null
        $params = array('entity' => $entity, 'user' => $user, 'annotation' => $this);
        return elgg_trigger_plugin_hook('permissions_check', 'annotation', $params, $result);
    }

    // SYSTEM LOG INTERFACE

    public function getObjectFromID($id) {
        return elgg_get_annotation_from_id($id);
    }
}