TYPO3\CMS\Extbase\Error\Message Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Error\Message:

Public Member Functions
	__construct ($message, $code, array $arguments=array(), $title='')
	getMessage ()
	getCode ()
	getArguments ()
	getTitle ()
	render ()
	__toString ()

Protected Attributes
	$message = 'Unknown message'
	$code
	$arguments = array()
	$title = ''

Detailed Description

An object representation of a generic message. Usually, you will use Error, Warning or Notice instead of this one.

http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later

Definition at line 29 of file Message.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Error\Message::__construct	(		$message,
			$code,
		array	$arguments = array(),
			$title = ''
	)

Constructs this error

Parameters

string	$message	An english error message which is used if no other error message can be resolved
integer	$code	A unique error code
array	$arguments	Array of arguments to be replaced in message
string	$title	optional title for the message

Definition at line 68 of file Message.php.

References TYPO3\CMS\Extbase\Error\Message\$arguments, TYPO3\CMS\Extbase\Error\Message\$code, TYPO3\CMS\Extbase\Error\Message\$message, and TYPO3\CMS\Extbase\Error\Message\$title.

Member Function Documentation

__toString()

TYPO3\CMS\Extbase\Error\Message::__toString

(

)

Converts this error into a string

Returns

string

Definition at line 135 of file Message.php.

References TYPO3\CMS\Extbase\Error\Message\render().

getArguments()

TYPO3\CMS\Extbase\Error\Message::getArguments

(

)

Get arguments

Returns

array

Definition at line 101 of file Message.php.

References TYPO3\CMS\Extbase\Error\Message\$arguments.

getCode()

TYPO3\CMS\Extbase\Error\Message::getCode

(

)

Returns the error code

Returns

string The error code

Definition at line 91 of file Message.php.

References TYPO3\CMS\Extbase\Error\Message\$code.

getMessage()

TYPO3\CMS\Extbase\Error\Message::getMessage

(

)

Returns the error message

Returns

string The error message

Definition at line 81 of file Message.php.

References TYPO3\CMS\Extbase\Error\Message\$message.

getTitle()

TYPO3\CMS\Extbase\Error\Message::getTitle

(

)

Get title

Returns

string

Definition at line 111 of file Message.php.

References TYPO3\CMS\Extbase\Error\Message\$title.

render()

TYPO3\CMS\Extbase\Error\Message::render

(

)

Return the rendered message

Returns

string

Definition at line 121 of file Message.php.

References TYPO3\CMS\Extbase\Error\Message\$message.

Referenced by TYPO3\CMS\Extbase\Error\Message\__toString().

Member Data Documentation

$arguments

TYPO3\CMS\Extbase\Error\Message::$arguments = array()

protected

Definition at line 50 of file Message.php.

Referenced by TYPO3\CMS\Extbase\Error\Message\__construct(), and TYPO3\CMS\Extbase\Error\Message\getArguments().

$code

TYPO3\CMS\Extbase\Error\Message::$code

protected

Definition at line 43 of file Message.php.

Referenced by TYPO3\CMS\Extbase\Error\Message\__construct(), and TYPO3\CMS\Extbase\Error\Message\getCode().

$message

TYPO3\CMS\Extbase\Error\Message::$message = 'Unknown message'

protected

Definition at line 36 of file Message.php.

Referenced by TYPO3\CMS\Extbase\Error\Message\__construct(), TYPO3\CMS\Extbase\Error\Message\getMessage(), and TYPO3\CMS\Extbase\Error\Message\render().

$title

TYPO3\CMS\Extbase\Error\Message::$title = ''

protected

Definition at line 57 of file Message.php.

Referenced by TYPO3\CMS\Extbase\Error\Message\__construct(), and TYPO3\CMS\Extbase\Error\Message\getTitle().