SystemMessagesService.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Exceptions\InvalidArgumentException;

class SystemMessagesService {

    const SUCCESS = 'success';
    const ERROR = 'error';
    const SESSION_KEY = '_elgg_msgs';

    public function __construct(protected \ElggSession $session) {
    }

    public function dumpRegister(string $register_name = ''): array {
        $set = $this->loadRegisters();
        $return = [];

        foreach ($set as $prop => $values) {
            if ($register_name === $prop || $register_name === '') {
                if ($values || $register_name === $prop) {
                    $return[$prop] = $values;
                }

                $set[$prop] = [];
            }
        }

        // support arbitrary registers for 2.0 BC
        if ($register_name && !isset($return[$register_name])) {
            $return[$register_name] = [];
        }

        $this->saveRegisters($set);
        return $return;
    }

    public function count(string $register_name = ''): int {
        $set = $this->loadRegisters();
        $count = 0;

        foreach ($set as $prop => $values) {
            if ($register_name === $prop || $register_name === '') {
                $count += count($values);
            }
        }

        return $count;
    }

    public function addSuccessMessage(string $message): void {
        $this->addMessage(new \ElggSystemMessage($message, 'success'));
    }

    public function addErrorMessage(string $message): void {
        $this->addMessage(new \ElggSystemMessage($message, 'error'));
    }

    public function addMessage($message): void {
        if (is_array($message)) {
            $message = \ElggSystemMessage::factory($message);
        }
        
        if (!$message instanceof \ElggSystemMessage) {
            throw new InvalidArgumentException(__METHOD__ . ' $message needs to be an \ElggSystemMessage or an array of options');
        }
        
        $set = $this->loadRegisters();
        $set[$message->getType()][] = $message;
        $this->saveRegisters($set);
    }

    public function loadRegisters(): array {
        return $this->session->get(self::SESSION_KEY, []);
    }

    public function saveRegisters(array $set): void {
        $filter = function ($el) {
            return ($el instanceof \ElggSystemMessage) && $el->getMessage() !== '';
        };

        $data = [];
        foreach ($set as $prop => $values) {
            if (!is_array($values)) {
                continue;
            }
            
            $arr = array_filter($values, $filter);
            if (!empty($arr)) {
                $data[$prop] = array_values($arr);
            }
        }

        $this->session->set(self::SESSION_KEY, $data);
    }
}