notification.php

Go to the documentation of this file.

<?php
use Elgg\Notifications\NotificationEventHandler;

function elgg_register_notification_event(string $object_type, string $object_subtype, array $actions = [], string $handler = NotificationEventHandler::class): void {
    _elgg_services()->notifications->registerEvent($object_type, $object_subtype, $actions, $handler);
}

function elgg_unregister_notification_event(string $object_type, string $object_subtype, array $actions = []): void {
    _elgg_services()->notifications->unregisterEvent($object_type, $object_subtype, $actions);
}

function elgg_register_notification_method(string $name): void {
    _elgg_services()->notifications->registerMethod($name);
}

function elgg_get_notification_methods(): array {
    return _elgg_services()->notifications->getMethods();
}

function elgg_unregister_notification_method(string $name): void {
    _elgg_services()->notifications->unregisterMethod($name);
}

function elgg_get_notification_events(): array {
    return _elgg_services()->notifications->getEvents();
}

function elgg_get_subscriptions_for_container(int $container_guid): array {
    $methods = _elgg_services()->notifications->getMethods();
    
    return _elgg_services()->subscriptions->getSubscriptionsForContainer($container_guid, $methods);
}

function notify_user(int|array $to, int $from = 0, string $subject = '', string $message = '', array $params = [], $methods_override = null): array {

    $params['subject'] = $subject;
    $params['body'] = $message;
    $params['methods_override'] = $methods_override;

    if (!empty($from)) {
        $sender = get_entity($from);
    } else {
        $sender = elgg_get_site_entity();
    }
    
    if (!$sender instanceof \ElggEntity) {
        return [];
    }

    $recipients = [];
    $to = (array) $to;
    foreach ($to as $guid) {
        $recipient = get_entity($guid);
        if (!$recipient instanceof \ElggEntity) {
            continue;
        }
        
        $recipients[] = $recipient;
    }

    return _elgg_services()->notifications->sendInstantNotifications($sender, $recipients, $params);
}

function elgg_send_email(\Elgg\Email $email): bool {
    return _elgg_services()->emails->send($email);
}

function elgg_enqueue_notification_event(string $action, \ElggData $object, ?\ElggEntity $actor = null): void {
    _elgg_services()->notifications->enqueueEvent($action, $object, $actor);
}