ilPRGMessageCollection Class Reference

Holds information about multi-actions, mainly in context of member-assignemnts and status changes. More...

Collaboration diagram for ilPRGMessageCollection:

Public Member Functions
	withNewTopic (string $description)
	getSuccess ()
	getErrors ()
	hasSuccess ()
	hasErrors ()
	hasAnyMessages ()
	getDescription ()
	add (bool $success, string $message, string $record_identitifer)

Protected Attributes
	$success = []
	$error = []
	$description = ''

Detailed Description

Holds information about multi-actions, mainly in context of member-assignemnts and status changes.

Definition at line 7 of file ilPRGMessageCollection.php.

Member Function Documentation

add()

ilPRGMessageCollection::add	(	bool	$success,
		string	$message,
		string	$record_identitifer
	)

Definition at line 58 of file ilPRGMessageCollection.php.

References $message, and success().

Referenced by ilObjStudyProgramme\changeAmountOfPoints(), ilObjStudyProgramme\changeProgressDeadline(), ilObjStudyProgramme\changeProgressValidityDate(), ilObjStudyProgramme\markAccredited(), ilObjStudyProgrammeMembersGUI\markAccreditedByProgressId(), ilObjStudyProgramme\markNotRelevant(), ilObjStudyProgramme\markRelevant(), ilStudyProgrammeGUIMessagesTest\testAddMessages(), ilObjStudyProgramme\unmarkAccredited(), ilObjStudyProgrammeMembersGUI\unmarkAccreditedByProgressId(), ilObjStudyProgrammeIndividualPlanGUI\updateRequiredPoints(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

ilPRGMessageCollection::getDescription

(

)

Definition at line 53 of file ilPRGMessageCollection.php.

References $description.

Referenced by ilPRGMessagePrinter\showMessages(), and ilStudyProgrammeGUIMessagesTest\testCollectionDefaults().

                                     : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getErrors()

ilPRGMessageCollection::getErrors

(

)

Returns

string[]

Definition at line 33 of file ilPRGMessageCollection.php.

References $error.

Referenced by ilPRGMessagePrinter\showMessages(), ilStudyProgrammeGUIMessagesTest\testAddMessages(), and ilStudyProgrammeGUIMessagesTest\testCollectionDefaults().

                                : array
    {
        return $this->error;
    }

Here is the caller graph for this function:

getSuccess()

ilPRGMessageCollection::getSuccess

(

)

Returns

string[]

Definition at line 25 of file ilPRGMessageCollection.php.

References $success.

Referenced by ilPRGMessagePrinter\showMessages(), ilStudyProgrammeGUIMessagesTest\testAddMessages(), and ilStudyProgrammeGUIMessagesTest\testCollectionDefaults().

                                 : array
    {
        return $this->success;
    }

Here is the caller graph for this function:

hasAnyMessages()

ilPRGMessageCollection::hasAnyMessages

(

)

Definition at line 48 of file ilPRGMessageCollection.php.

References success().

Referenced by ilStudyProgrammeGUIMessagesTest\testAddErrorMessages(), ilStudyProgrammeGUIMessagesTest\testAddMessages(), and ilStudyProgrammeGUIMessagesTest\testCollectionDefaults().

                                     : bool
    {
        return count($this->error) > 0 || count($this->success) > 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasErrors()

ilPRGMessageCollection::hasErrors

(

)

Definition at line 43 of file ilPRGMessageCollection.php.

Referenced by ilPRGMessagePrinter\showMessages(), ilStudyProgrammeGUIMessagesTest\testAddMessages(), and ilStudyProgrammeGUIMessagesTest\testCollectionDefaults().

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

Here is the caller graph for this function:

hasSuccess()

ilPRGMessageCollection::hasSuccess

(

)

Definition at line 38 of file ilPRGMessageCollection.php.

References success().

Referenced by ilPRGMessagePrinter\showMessages(), ilStudyProgrammeGUIMessagesTest\testAddMessages(), and ilStudyProgrammeGUIMessagesTest\testCollectionDefaults().

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

Here is the call graph for this function:

Here is the caller graph for this function:

withNewTopic()

ilPRGMessageCollection::withNewTopic

(

string

$description

)

Definition at line 13 of file ilPRGMessageCollection.php.

References $description.

Referenced by ilPRGMessagePrinter\getMessageCollection(), and ilStudyProgrammeGUIMessagesTest\testAddErrorMessages().

                                                      : ilPRGMessageCollection
    {
        $clone = clone $this;
        $clone->success = [];
        $clone->error = [];
        $clone->description = $description;
        return $clone;
    }

Here is the caller graph for this function:

Field Documentation

$description

ilPRGMessageCollection::$description = ''

protected

Definition at line 11 of file ilPRGMessageCollection.php.

Referenced by getDescription(), and withNewTopic().

$error

ilPRGMessageCollection::$error = []

protected

Definition at line 10 of file ilPRGMessageCollection.php.

Referenced by getErrors().

$success

ilPRGMessageCollection::$success = []

protected

Definition at line 9 of file ilPRGMessageCollection.php.

Referenced by getSuccess().

---

The documentation for this class was generated from the following file:

• Modules/StudyProgramme/classes/helpers/ilPRGMessageCollection.php