comments.php

Go to the documentation of this file.

<?php
elgg_register_event_handler('init', 'system', '_elgg_comments_init');

function _elgg_comments_init() {
    elgg_register_entity_type('object', 'comment');
    elgg_register_plugin_hook_handler('register', 'menu:entity', '_elgg_comment_setup_entity_menu', 900);
    elgg_register_plugin_hook_handler('entity:url', 'object', '_elgg_comment_url_handler');
    elgg_register_plugin_hook_handler('container_permissions_check', 'object', '_elgg_comments_container_permissions_override');
    elgg_register_plugin_hook_handler('permissions_check', 'object', '_elgg_comments_permissions_override');
    elgg_register_plugin_hook_handler('email', 'system', '_elgg_comments_notification_email_subject');

    elgg_register_page_handler('comment', '_elgg_comments_page_handler');

    elgg_register_ajax_view('core/ajax/edit_comment');
}

function _elgg_comments_page_handler($page) {

    switch ($page[0]) {

        case 'edit':
            elgg_gatekeeper();

            if (empty($page[1])) {
                register_error(elgg_echo('generic_comment:notfound'));
                forward(REFERER);
            }
            $comment = get_entity($page[1]);
            if (!($comment instanceof ElggComment) || !$comment->canEdit()) {
                register_error(elgg_echo('generic_comment:notfound'));
                forward(REFERER);
            }

            $target = $comment->getContainerEntity();
            if (!($target instanceof ElggEntity)) {
                register_error(elgg_echo('generic_comment:notfound'));
                forward(REFERER);
            }

            $title = elgg_echo('generic_comments:edit');
            elgg_push_breadcrumb($target->getDisplayName(), $target->getURL());
            elgg_push_breadcrumb($title);

            $params = array(
                'entity' => $target,
                'comment' => $comment,
                'is_edit_page' => true,
            );
            $content = elgg_view_form('comment/save', null, $params);

            $params = array(
                'content' => $content,
                'title' => $title,
                'filter' => '',
            );
            $body = elgg_view_layout('content', $params);
            echo elgg_view_page($title, $body);

            return true;
            break;

        default:
            return false;
            break;
    }
}

function _elgg_comment_setup_entity_menu($hook, $type, $return, $params) {
    if (elgg_in_context('widgets')) {
        return $return;
    }

    $entity = $params['entity'];
    if (!elgg_instanceof($entity, 'object', 'comment')) {
        return $return;
    }

    // Remove edit link and access level from the menu
    foreach ($return as $key => $item) {
        if ($item->getName() === 'access') {
            unset($return[$key]);
        }
    }

    return $return;
}

function _elgg_comment_url_handler($hook, $type, $return, $params) {
    $entity = $params['entity'];
    /* @var ElggObject $entity */

    if (!elgg_instanceof($entity, 'object', 'comment') || !$entity->getOwnerEntity()) {
        // not a comment or has no owner

        // @todo handle anonymous comments
        return $return;
    }

    $container = $entity->getContainerEntity();
    if (!$container) {
        return $return;
    }

    return $container->getURL();
}

function _elgg_comments_container_permissions_override($hook, $type, $return, $params) {

    // is someone trying to comment, if so override permissions check
    if ($params['subtype'] === 'comment') {
        return true;
    }

    return $return;
}

function _elgg_comments_permissions_override($hook, $type, $return, $params) {
    $entity = $params['entity'];
    $user = $params['user'];

    if (elgg_instanceof($entity, 'object', 'comment') && $user) {
        return $entity->getOwnerGUID() == $user->getGUID();
    }

    return $return;
}

function _elgg_comments_notification_email_subject($hook, $type, $returnvalue, $params) {

    $notification = elgg_extract('notification', $returnvalue['params']);

    if ($notification instanceof Elgg_Notifications_Notification) {
        $object = elgg_extract('object', $notification->params);

        if ($object instanceof ElggComment) {
            $container = $object->getContainerEntity();

            $returnvalue['subject'] = 'Re: ' . $container->getDisplayName();
        }
    }

    return $returnvalue;
}