ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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

array $success = []
 
array $error = []
 
string $description = ''
 

Detailed Description

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

Definition at line 25 of file ilPRGMessageCollection.php.

Member Function Documentation

◆ add()

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

◆ getDescription()

ilPRGMessageCollection::getDescription ( )

Definition at line 71 of file ilPRGMessageCollection.php.

71 : string
72 {
73 return $this->description;
74 }

References $description.

Referenced by ilPRGMessagePrinter\showMessages().

+ Here is the caller graph for this function:

◆ getErrors()

ilPRGMessageCollection::getErrors ( )
Returns
string[]

Definition at line 51 of file ilPRGMessageCollection.php.

51 : array
52 {
53 return $this->error;
54 }

References $error.

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

+ Here is the caller graph for this function:

◆ getSuccess()

ilPRGMessageCollection::getSuccess ( )
Returns
string[]

Definition at line 43 of file ilPRGMessageCollection.php.

43 : array
44 {
45 return $this->success;
46 }

References $success.

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

+ Here is the caller graph for this function:

◆ hasAnyMessages()

ilPRGMessageCollection::hasAnyMessages ( )

Definition at line 66 of file ilPRGMessageCollection.php.

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

References error(), and ILIAS\UI\examples\MessageBox\Success\success().

Referenced by ilStudyProgrammeGUIMessagesTest\testAddErrorMessages().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasErrors()

ilPRGMessageCollection::hasErrors ( )

Definition at line 61 of file ilPRGMessageCollection.php.

61 : bool
62 {
63 return count($this->error) > 0;
64 }

References error().

Referenced by ilPRGMessagePrinter\showMessages(), ilStudyProgrammeGUIMessagesTest\testAddErrorMessages(), and ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkRelevant().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hasSuccess()

ilPRGMessageCollection::hasSuccess ( )

Definition at line 56 of file ilPRGMessageCollection.php.

56 : bool
57 {
58 return count($this->success) > 0;
59 }

References ILIAS\UI\examples\MessageBox\Success\success().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ withNewTopic()

ilPRGMessageCollection::withNewTopic ( string  $description)

Definition at line 31 of file ilPRGMessageCollection.php.

32 {
33 $clone = clone $this;
34 $clone->success = [];
35 $clone->error = [];
36 $clone->description = $description;
37 return $clone;
38 }
Holds information about multi-actions, mainly in context of member-assignemnts and status changes.

References $description.

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

+ Here is the caller graph for this function:

Field Documentation

◆ $description

string ilPRGMessageCollection::$description = ''
protected

Definition at line 29 of file ilPRGMessageCollection.php.

Referenced by getDescription(), and withNewTopic().

◆ $error

array ilPRGMessageCollection::$error = []
protected

Definition at line 28 of file ilPRGMessageCollection.php.

Referenced by getErrors().

◆ $success

array ilPRGMessageCollection::$success = []
protected

Definition at line 27 of file ilPRGMessageCollection.php.

Referenced by add(), and getSuccess().


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