SystemMessagesService.php

Go to the documentation of this file.

<?php
namespace Elgg;

use Elgg\SystemMessages\RegisterSet;

class SystemMessagesService {

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

    protected $session;

    public function __construct(\ElggSession $session) {
        $this->session = $session;
    }

    public function dumpRegister($register_name = '') {
        $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($register_name = "") {
        $set = $this->loadRegisters();
        $count = 0;

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

        return $count;
    }

    public function addSuccessMessage($message) {
        $set = $this->loadRegisters();
        foreach ((array)$message as $str) {
            $set->success[] = $str;
        }
        $this->saveRegisters($set);
    }

    public function addErrorMessage($error) {
        $set = $this->loadRegisters();
        foreach ((array)$error as $str) {
            $set->error[] = $str;
        }
        $this->saveRegisters($set);
    }

    public function loadRegisters() {
        $registers = $this->session->get(self::SESSION_KEY, array());
        $set = new RegisterSet();
        foreach ($registers as $key => $register) {
            $set->{$key} = $register;
        }
        return $set;
    }

    public function saveRegisters(RegisterSet $set) {
        $filter = function ($el) {
            return is_string($el) && $el !== "";
        };

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

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