TYPO3 CMS  TYPO3_6-2
Public Member Functions | Public Attributes | Protected Attributes | List of all members
TYPO3\CMS\Core\Messaging\AbstractMessage Class Reference
Inheritance diagram for TYPO3\CMS\Core\Messaging\AbstractMessage:
t3lib_message_AbstractMessage TYPO3\CMS\Core\Messaging\AbstractStandaloneMessage TYPO3\CMS\Core\Messaging\FlashMessage t3lib_message_AbstractStandaloneMessage TYPO3\CMS\Core\Messaging\ErrorpageMessage t3lib_FlashMessage t3lib_message_ErrorpageMessage

Public Member Functions

 getTitle ()
 
 setTitle ($title)
 
 getMessage ()
 
 setMessage ($message)
 
 getSeverity ()
 
 setSeverity ($severity=self::OK)
 
 __toString ()
 

Public Attributes

const NOTICE = -2
 
const INFO = -1
 
const OK = 0
 
const WARNING = 1
 
const ERROR = 2
 

Protected Attributes

 $title = ''
 
 $message = ''
 
 $severity = self::OK
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! A class used for any kind of messages.

Author
Ingo Renner ingo@.nosp@m.typo.nosp@m.3.org
Benjamin Mack benni.nosp@m.@typ.nosp@m.o3.or.nosp@m.g

Definition at line 22 of file AbstractMessage.php.

Member Function Documentation

◆ __toString()

TYPO3\CMS\Core\Messaging\AbstractMessage::__toString ( )

Creates a string representation of the message. Useful for command line use.

Returns
string A string representation of the message.

Definition at line 113 of file AbstractMessage.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\$message, TYPO3\CMS\Core\Messaging\AbstractMessage\$severity, and TYPO3\CMS\Core\Messaging\AbstractMessage\$title.

◆ getMessage()

TYPO3\CMS\Core\Messaging\AbstractMessage::getMessage ( )

Gets the message.

Returns
string The message.

Definition at line 74 of file AbstractMessage.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\$message.

◆ getSeverity()

TYPO3\CMS\Core\Messaging\AbstractMessage::getSeverity ( )

Gets the message' severity.

Returns
integer The message' severity, must be one of AbstractMessage::INFO or similar contstants

Definition at line 93 of file AbstractMessage.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\$severity.

◆ getTitle()

TYPO3\CMS\Core\Messaging\AbstractMessage::getTitle ( )

Gets the message's title.

Returns
string The message's title.

Definition at line 55 of file AbstractMessage.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\$title.

◆ setMessage()

TYPO3\CMS\Core\Messaging\AbstractMessage::setMessage (   $message)

Sets the message

Parameters
string$messageThe message
Returns
void

Definition at line 84 of file AbstractMessage.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\$message.

Referenced by TYPO3\CMS\Core\Messaging\FlashMessage\__construct(), and TYPO3\CMS\Core\Messaging\AbstractStandaloneMessage\__construct().

◆ setSeverity()

TYPO3\CMS\Core\Messaging\AbstractMessage::setSeverity (   $severity = self::OK)

Sets the message' severity

Parameters
integer$severityThe severity, must be one of AbstractMessage::INFO or similar constants
Returns
void

Definition at line 103 of file AbstractMessage.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\$severity, and TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange().

Referenced by TYPO3\CMS\Core\Messaging\FlashMessage\__construct(), and TYPO3\CMS\Core\Messaging\AbstractStandaloneMessage\__construct().

◆ setTitle()

TYPO3\CMS\Core\Messaging\AbstractMessage::setTitle (   $title)

Sets the message's title

Parameters
string$titleThe message's title
Returns
void

Definition at line 65 of file AbstractMessage.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\$title.

Referenced by TYPO3\CMS\Core\Messaging\FlashMessage\__construct(), and TYPO3\CMS\Core\Messaging\AbstractStandaloneMessage\__construct().

Member Data Documentation

◆ $message

TYPO3\CMS\Core\Messaging\AbstractMessage::$message = ''
protected

Definition at line 41 of file AbstractMessage.php.

Referenced by TYPO3\CMS\Core\Messaging\ErrorpageMessage\__construct(), TYPO3\CMS\Core\Messaging\FlashMessage\__construct(), TYPO3\CMS\Core\Messaging\AbstractStandaloneMessage\__construct(), TYPO3\CMS\Core\Messaging\AbstractMessage\__toString(), TYPO3\CMS\Core\Messaging\AbstractMessage\getMessage(), TYPO3\CMS\Core\Messaging\FlashMessage\render(), and TYPO3\CMS\Core\Messaging\AbstractMessage\setMessage().

◆ $severity

TYPO3\CMS\Core\Messaging\AbstractMessage::$severity = self::OK
protected

Definition at line 48 of file AbstractMessage.php.

Referenced by TYPO3\CMS\Core\Messaging\ErrorpageMessage\__construct(), TYPO3\CMS\Core\Messaging\FlashMessage\__construct(), TYPO3\CMS\Core\Messaging\AbstractStandaloneMessage\__construct(), TYPO3\CMS\Core\Messaging\AbstractMessage\__toString(), TYPO3\CMS\Core\Messaging\FlashMessage\getClass(), TYPO3\CMS\Core\Messaging\AbstractMessage\getSeverity(), and TYPO3\CMS\Core\Messaging\AbstractMessage\setSeverity().

◆ $title

TYPO3\CMS\Core\Messaging\AbstractMessage::$title = ''
protected

Definition at line 34 of file AbstractMessage.php.

Referenced by TYPO3\CMS\Core\Messaging\ErrorpageMessage\__construct(), TYPO3\CMS\Core\Messaging\FlashMessage\__construct(), TYPO3\CMS\Core\Messaging\AbstractStandaloneMessage\__construct(), TYPO3\CMS\Core\Messaging\AbstractMessage\__toString(), TYPO3\CMS\Core\Messaging\AbstractMessage\getTitle(), TYPO3\CMS\Core\Messaging\FlashMessage\render(), and TYPO3\CMS\Core\Messaging\AbstractMessage\setTitle().

◆ ERROR

const TYPO3\CMS\Core\Messaging\AbstractMessage::ERROR = 2

Definition at line 28 of file AbstractMessage.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\deleteTask(), TYPO3\CMS\Reports\Report\Status\ConfigurationStatus\executeAdminCommand(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), TYPO3\CMS\Backend\Module\BaseScriptClass\extObjContent(), TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction(), TYPO3\CMS\Documentation\Controller\DocumentController\fetchAction(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent(), TYPO3\CMS\Openid\Wizard\getReturnUrl(), TYPO3\CMS\Setup\Controller\SetupModuleController\main(), TYPO3\CMS\Backend\Controller\LoginController\makeLogoutForm(), TYPO3\CMS\Filelist\Controller\FileListController\menuConfig(), TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\pushErrorMessagesToFlashMessageQueue(), TYPO3\CMS\Extensionmanager\Controller\ActionController\removeExtensionAction(), TYPO3\CMS\Saltedpasswords\Utility\ExtensionManagerConfigurationUtility\setErrorLevel(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\stopTask(), TYPO3\CMS\Extensionmanager\Controller\ListController\terAction(), TYPO3\CMS\Extensionmanager\Controller\ActionController\toggleExtensionInstallationStateAction(), TYPO3\CMS\Extensionmanager\Controller\DownloadController\updateExtensionAction(), TYPO3\CMS\Scheduler\Task\CachingFrameworkGarbageCollectionAdditionalFieldProvider\validateAdditionalFields(), TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionAdditionalFieldProvider\validateAdditionalFields(), TYPO3\CMS\Scheduler\Task\TableGarbageCollectionAdditionalFieldProvider\validateNumberOfDaysAdditionalField(), and TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\writeLog().

◆ INFO

const TYPO3\CMS\Core\Messaging\AbstractMessage::INFO = -1

Definition at line 25 of file AbstractMessage.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getFileCountField(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree(), TYPO3\CMS\Backend\Controller\PageLayoutController\getHeaderFlashMessagesForCurrentPid(), TYPO3\CMS\Backend\Controller\PageTreeNavigationController\main(), TYPO3\CMS\Setup\Controller\SetupModuleController\main(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Saltedpasswords\Utility\ExtensionManagerConfigurationUtility\setErrorLevel(), and TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\writeLog().

◆ NOTICE

const TYPO3\CMS\Core\Messaging\AbstractMessage::NOTICE = -2

Definition at line 24 of file AbstractMessage.php.

Referenced by TYPO3\CMS\Filelist\Controller\FileListController\__construct().

◆ OK

const TYPO3\CMS\Core\Messaging\AbstractMessage::OK = 0

Definition at line 26 of file AbstractMessage.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser(), TYPO3\CMS\Reports\Report\Status\ConfigurationStatus\executeAdminCommand(), TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction(), TYPO3\CMS\Saltedpasswords\Utility\ExtensionManagerConfigurationUtility\renderFlashMessage(), TYPO3\CMS\Saltedpasswords\Utility\ExtensionManagerConfigurationUtility\setErrorLevel(), and TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\writeLog().

◆ WARNING

const TYPO3\CMS\Core\Messaging\AbstractMessage::WARNING = 1

Definition at line 27 of file AbstractMessage.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser(), TYPO3\CMS\Scheduler\Task\FileStorageExtractionAdditionalFieldProvider\getFileCountField(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Backend\Controller\EditDocumentController\printContent(), TYPO3\CMS\Core\Resource\Service\UserStorageCapabilityService\renderIsPublic(), TYPO3\CMS\Saltedpasswords\Utility\ExtensionManagerConfigurationUtility\setErrorLevel(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\stopTask(), TYPO3\CMS\Backend\View\PageLayoutView\tt_content_drawItem(), and TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\writeLog().