Subscriptions.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Traits\Entity;
 
use Elgg\Exceptions\InvalidArgumentException;
 
trait Subscriptions {
    
    public function addSubscription(int $user_guid = 0, string|array $methods = [], ?string $type = null, ?string $subtype = null, ?string $action = null): bool {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        if (!empty($user_guid) && is_array($methods) && empty($methods)) {
            $user = get_user($user_guid);
            if ($user instanceof \ElggUser) {
                $methods = $user->getNotificationSettings('default', true);
                if (empty($methods)) {
                    return true;
                }
            }
        }
        
        $methods = $this->normalizeSubscriptionMethods($methods);
        
        $result = true;
        foreach ($methods as $method) {
            $result &= _elgg_services()->subscriptions->addSubscription($user_guid, $method, $this->guid, $type, $subtype, $action);
        }
        
        return $result;
    }
    
    public function hasSubscription(int $user_guid = 0, string|array $methods = [], ?string $type = null, ?string $subtype = null, ?string $action = null): bool {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        $methods = $this->normalizeSubscriptionMethods($methods);
        
        $result = true;
        foreach ($methods as $method) {
            $result &= _elgg_services()->subscriptions->hasSubscription($user_guid, $method, $this->guid, $type, $subtype, $action);
        }
        
        return $result;
    }
    
    public function hasSubscriptions(int $user_guid = 0, string|array $methods = []): bool {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        $methods = $this->normalizeSubscriptionMethods($methods);
        
        return _elgg_services()->subscriptions->hasSubscriptions($user_guid, $this->guid, $methods);
    }
    
    public function removeSubscription(int $user_guid = 0, string|array $methods = [], ?string $type = null, ?string $subtype = null, ?string $action = null): bool {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        $methods = $this->normalizeSubscriptionMethods($methods);
        
        $result = true;
        foreach ($methods as $method) {
            $result &= _elgg_services()->subscriptions->removeSubscription($user_guid, $method, $this->guid, $type, $subtype, $action);
        }
        
        return $result;
    }
    
    public function removeSubscriptions(int $user_guid = 0, string|array $methods = []): bool {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        $methods = (array) $methods;
        
        return _elgg_services()->subscriptions->removeSubscriptions($user_guid, $this->guid, $methods);
    }
    
    public function getSubscriptions(int $user_guid = 0, string|array $methods = [], ?string $type = null, ?string $subtype = null, ?string $action = null): array {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        $methods = (array) $methods;
        
        return _elgg_services()->subscriptions->getEntitySubscriptions($this->guid, $user_guid, $methods, $type, $subtype, $action);
    }
    
    public function getSubscribers(string|array $methods = []): array {
        $methods = (array) $methods;
        
        return _elgg_services()->subscriptions->getSubscribers($this->guid, $methods);
    }
    
    public function muteNotifications(int $user_guid = 0): bool {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        return _elgg_services()->subscriptions->muteNotifications($user_guid, $this->guid);
    }
    
    public function hasMutedNotifications(int $user_guid = 0): bool {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        return _elgg_services()->subscriptions->hasMutedNotifications($user_guid, $this->guid);
    }
    
    public function unmuteNotifications(int $user_guid = 0): bool {
        if ($user_guid === 0) {
            $user_guid = _elgg_services()->session_manager->getLoggedInUserGuid();
        }
        
        return _elgg_services()->subscriptions->unmuteNotifications($user_guid, $this->guid);
    }
    
    protected function normalizeSubscriptionMethods(string|array $methods = []): array {
        $methods = (array) $methods;
        
        foreach ($methods as $method) {
            if (!is_string($method) || $method === '') {
                $dbt = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
                $caller = $dbt[1]['function'] ?? 'unknown';
                
                throw new InvalidArgumentException(elgg_echo('Entity:Subscriptions:InvalidMethodsException', [$caller]));
            }
        }
        
        return $methods ?: _elgg_services()->notifications->getMethods();
    }
}