ilPRGMessageCollection.php

Go to the documentation of this file.

<?php declare(strict_types = 1);

class ilPRGMessageCollection
{
    protected $success = [];
    protected $error = [];
    protected $description = '';

    public function withNewTopic(string $description) : ilPRGMessageCollection
    {
        $clone = clone $this;
        $clone->success = [];
        $clone->error = [];
        $clone->description = $description;
        return $clone;
    }
    
    public function getSuccess() : array
    {
        return $this->success;
    }
    
    public function getErrors() : array
    {
        return $this->error;
    }

    public function hasSuccess() : bool
    {
        return count($this->success) > 0;
    }

    public function hasErrors() : bool
    {
        return count($this->error) > 0;
    }

    public function hasAnyMessages() : bool
    {
        return count($this->error) > 0 || count($this->success) > 0;
    }
    
    public function getDescription() : string
    {
        return $this->description;
    }

    public function add(bool $success, string $message, string $record_identitifer) : void
    {
        $entry = [$message, $record_identitifer];
        if ($success) {
            $this->success[] = $entry;
        } else {
            $this->error[] = $entry;
        }
    }
}