SubscriptionsService.php

Go to the documentation of this file.

<?php

namespace Elgg\Notifications;

use Elgg\Database;

class SubscriptionsService {

    const RELATIONSHIP_PREFIX = 'notify';

    public $methods;

    protected $db;

    public function __construct(Database $db, array $methods = []) {
        $this->db = $db;
        $this->methods = $methods;
    }

    public function getSubscriptions(NotificationEvent $event) {

        $subscriptions = [];

        if (empty($this->methods)) {
            return [];
        }

        $object = $event->getObject();
        if (!$object instanceof \ElggData) {
            return [];
        }
        
        // get subscribers only for \ElggEntity if it isn't private
        if (($object instanceof \ElggEntity) && ($object->access_id !== ACCESS_PRIVATE)) {
            $prefixLength = strlen(self::RELATIONSHIP_PREFIX);
            $records = $this->getSubscriptionRecords($object->getContainerGUID());
            foreach ($records as $record) {
                $deliveryMethods = explode(',', $record->methods);
                $subscriptions[$record->guid] = substr_replace($deliveryMethods, '', 0, $prefixLength);
            }
        }

        $params = [
            'event' => $event,
            'origin' => Notification::ORIGIN_SUBSCRIPTIONS,
        ];
        return _elgg_services()->hooks->trigger('get', 'subscriptions', $params, $subscriptions);
    }

    public function getSubscriptionsForContainer($container_guid) {

        $subscriptions = [];

        if (empty($this->methods)) {
            return $subscriptions;
        }

        $prefixLength = strlen(self::RELATIONSHIP_PREFIX);
        $records = $this->getSubscriptionRecords($container_guid);
        foreach ($records as $record) {
            $deliveryMethods = explode(',', $record->methods);
            $subscriptions[$record->guid] = substr_replace($deliveryMethods, '', 0, $prefixLength);
        }

        return $subscriptions;
    }

    public function addSubscription($userGuid, $method, $targetGuid) {
        if (!in_array($method, $this->methods)) {
            return false;
        }
        $prefix = self::RELATIONSHIP_PREFIX;
        return add_entity_relationship($userGuid, "$prefix$method", $targetGuid);
    }

    public function removeSubscription($userGuid, $method, $targetGuid) {
        $prefix = self::RELATIONSHIP_PREFIX;
        return remove_entity_relationship($userGuid, "$prefix$method", $targetGuid);
    }

    protected function getSubscriptionRecords($container_guid) {

        $container_guid = (int) $container_guid;

        // create IN clause
        $rels = $this->getMethodRelationships();
        if (!$rels) {
            return [];
        }
        array_walk($rels, [$this->db, 'sanitizeString']);
        $methods_string = "'" . implode("','", $rels) . "'";

        $db_prefix = $this->db->prefix;
        $query = "SELECT guid_one AS guid, GROUP_CONCAT(relationship SEPARATOR ',') AS methods
            FROM {$db_prefix}entity_relationships
            WHERE guid_two = $container_guid AND
                    relationship IN ($methods_string) GROUP BY guid_one";
        return $this->db->getData($query);
    }

    protected function getMethodRelationships() {
        $prefix = self::RELATIONSHIP_PREFIX;
        $names = [];
        foreach ($this->methods as $method) {
            $names[] = "$prefix$method";
        }
        return $names;
    }
}