Message for the user. More...

Collaboration diagram for ilSystemStyleMessage:

Public Member Functions
	__construct (string $message, int $type_id=self::TYPE_SUCCESS)

	getMessageOutput ()

	getMessage ()

	setMessage (string $message)

	getTypeId ()

	setTypeId (int $type_id)

Data Fields
const	TYPE_INFO = 0

const	TYPE_SUCCESS = 1

const	TYPE_ERROR = 2

Protected Member Functions
	isValidTypeId (int $type_id)

Protected Attributes
string	$message = ''

int	$type_id = self::TYPE_SUCCESS

Detailed Description

Message for the user.

Mostly they are stacked, to be shown on rendering to the user all at once.

Definition at line 24 of file class.ilSystemStyleMessage.php.

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleMessage::__construct	(	string	$message,
		int	$type_id = `self::TYPE_SUCCESS`
	)

Definition at line 33 of file class.ilSystemStyleMessage.php.

    {
        $this->setMessage($message);
        $this->setTypeId($type_id);
    }

References setMessage(), and setTypeId().

Here is the call graph for this function:

Member Function Documentation

◆ getMessage()

ilSystemStyleMessage::getMessage ( )

Definition at line 44 of file class.ilSystemStyleMessage.php.

                                : string
    {
        return $this->message;
    }

References $message.

Referenced by ilSystemStyleMessageTest\testConstructor(), and ilSystemStyleMessageTest\testGetAndSetMessage().

Here is the caller graph for this function:

◆ getMessageOutput()

ilSystemStyleMessage::getMessageOutput ( )

Definition at line 39 of file class.ilSystemStyleMessage.php.

                                      : string
    {
        return $this->message . '</br>';
    }

Referenced by ilSystemStyleMessageTest\testGetMessageOutput().

Here is the caller graph for this function:

◆ getTypeId()

ilSystemStyleMessage::getTypeId ( )

Definition at line 54 of file class.ilSystemStyleMessage.php.

                               : int
    {
        return $this->type_id;
    }

References $type_id.

Referenced by ilSystemStyleMessageTest\testConstructor(), and ilSystemStyleMessageTest\testGetAndSetTypeID().

Here is the caller graph for this function:

◆ isValidTypeId()

ilSystemStyleMessage::isValidTypeId ( int $type_id )

protected

Definition at line 71 of file class.ilSystemStyleMessage.php.

                                                  : bool
    {
        switch ($type_id) {
            case self::TYPE_ERROR:
            case self::TYPE_INFO:
            case self::TYPE_SUCCESS:
                return true;
            default:
                return false;
        }
    }

References $type_id, TYPE_ERROR, TYPE_INFO, and TYPE_SUCCESS.

Referenced by setTypeId().

Here is the caller graph for this function:

◆ setMessage()

ilSystemStyleMessage::setMessage ( string $message )

Definition at line 49 of file class.ilSystemStyleMessage.php.

                                               : void
    {
        $this->message = $message;
    }

References $message.

Referenced by __construct(), and ilSystemStyleMessageTest\testGetAndSetMessage().

Here is the caller graph for this function:

◆ setTypeId()

ilSystemStyleMessage::setTypeId ( int $type_id )

Exceptions

ilSystemStyleMessageStackException

Definition at line 62 of file class.ilSystemStyleMessage.php.

                                           : void
    {
        if ($this->isValidTypeId($type_id)) {
            $this->type_id = $type_id;
        } else {
            throw new ilSystemStyleMessageStackException(ilSystemStyleMessageStackException::MESSAGE_STACK_TYPE_ID_DOES_NOT_EXIST);
        }
    }