UnbanUserEventHandler.php

Go to the documentation of this file.

<?php

namespace Elgg\Notifications;

class UnbanUserEventHandler extends NotificationEventHandler {
    
    protected function recipientIsBannedUser(\ElggUser $recipient): bool {
        return $this->getEventEntity()?->guid === $recipient->guid;
    }
        
    protected function getNotificationSubject(\ElggUser $recipient, string $method): string {
        if (!$this->recipientIsBannedUser($recipient)) {
            return parent::getNotificationSubject($recipient, $method);
        }
        
        return elgg_echo('user:notification:unban:subject', [elgg_get_site_entity()->getDisplayName()]);
    }
    
    protected function getNotificationBody(\ElggUser $recipient, string $method): string {
        if (!$this->recipientIsBannedUser($recipient)) {
            return parent::getNotificationBody($recipient, $method);
        }
        
        $site = elgg_get_site_entity();
        
        return elgg_echo('user:notification:unban:body', [
            $site->getDisplayName(),
            $site->getURL(),
        ]);
    }
    
    protected function addMuteLink(): bool {
        return false;
    }
    
    public function getSubscriptions(): array {
        $result = parent::getSubscriptions();
        
        if (_elgg_services()->config->security_notify_user_ban) {
            $result[$this->getEventEntity()?->guid] = ['email'];
        }
        
        return $result;
    }
    
    public static function isConfigurableByUser(): bool {
        return false;
    }
}