Class: MessageManager

Class for working with messages - errors, warnings etc.

Implements

\SmartFactory\Interfaces\IMessageManager

Authors

Oleg Schildt

Package

System

Source code

SmartFactory/MessageManager.php

Properties
$debug_mode protected	Internal variable for storing the state whether technical details, programmer warnings and debug information are also sent to the client.
$messages protected	Internal variable for storing the messages.
$write_source_file_and_line_by_debug protected	Internal variable for storing the flag that defines whether for each debug output the source file and line number are written from where it is called.

Methods
addBubbleMessage() public	Stores the information message to be reported.
addDebugMessage() public	Stores the debugging message to be reported.
addError() public	Stores the error to be reported.
addErrorFromSmartException() public	Stores the error to be reported.
addInfoMessage() public	Stores the information message to be reported.
addProgWarning() public	Stores the programming warning to be reported.
addWarning() public	Stores the warning to be reported.
clearAll() public	Clears all stored messages and active elements.
clearBubbleMessages() public	Clears the stored information messages.
clearDebugMessages() public	Clears the stored debugging messages.
clearErrors() public	Clears the stored error messages.
clearInfoMessages() public	Clears the stored information messages.
clearProgWarnings() public	Clears the stored programming warning messages.
clearWarnings() public	Clears the stored warning messages.
getBubbleMessages() public	Returns the array of information messages if any have been stored.
getDebugMessages() public	Returns the array of debugging messages if any have been stored.
getErrors() public	Returns the array of errors if any have been stored.
getInfoMessages() public	Returns the array of information messages if any have been stored.
getMessages() protected	This auxiliary function returns the messages of the desired type.
getProgWarnings() public	Returns the array of programming warnings if any have been stored.
getWarnings() public	Returns the array of warnings if any have been stored.
hasBubbleMessages() public	Checks whether an information message exist.
hasDebugMessages() public	Checks whether a stored debugging message exist.
hasErrors() public	Checks whether a stored error message exist.
hasInfoMessages() public	Checks whether an information message exist.
hasProgWarnings() public	Checks whether a stored programming warning exist.
hasWarnings() public	Checks whether a stored error warning exist.
init() public	Initializes the message manager.

Property: MessageManager::$debug_mode

protected bool $debug_mode = false;

Internal variable for storing the state whether technical details, programmer warnings and debug information are also sent to the client.

Type

bool

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Property: MessageManager::$messages

protected array $messages = [];

Internal variable for storing the messages.

Type

array

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Property: MessageManager::$write_source_file_and_line_by_debug

protected bool $write_source_file_and_line_by_debug = false;

Internal variable for storing the flag that defines whether for each debug output the source file and line number are written from where it is called.

Type

bool

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::addBubbleMessage()

public function addBubbleMessage(string $message, array $details = [], bool $autoclose = true): void;

Stores the information message to be reported.

Parameters

Name	Pass type	Value type	Default value	Description
$message	by value	string		The information message to be reported.
$details	by value	array	[]	The details might be useful if the message translations are provided on the client, not on the server, and the message should contain some details that may vary from case to case. In that case, the servers return the message id instead of final text and the details, the client uses the message id, gets the final translated text and substitutes the parameters through the details.
$autoclose	by value	bool	true	The flag that controls whether the message box should be closed automatically after a time.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::addBubbleMessage()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::addDebugMessage()

public function addDebugMessage(string $message, string $file = "", string $line = ""): void;

Stores the debugging message to be reported.

Details

Displaying of the debugging messages might be implemented to simplify the debugging process, e.g. to the browser console or in a lightbox.

Parameters

Name	Pass type	Value type	Default value	Description
$message	by value	string		The debugging message to be reported.
$file	by value	string	""	The source file where the debug output occurred. Per default, the file where the debug output called.
$line	by value	string	""	The source file line where the debug output occurred. Per default, the file line where the debug output called.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::addDebugMessage()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::addError()

public function addError(string $message, array $details = [], string $related_element = "", string $code = "", string $technical_info = "", string $file = "", string $line = "" ) : void;

Stores the error to be reported.

Parameters

Name	Pass type	Value type	Default value	Description
$message	by value	string		The error message to be reported.
$details	by value	array	[]	The details might be useful if the message translations are provided on the client, not on the server, and the message should contain some details that may vary from case to case. In that case, the servers return the message id instead of final text and the details, the client uses the message id, gets the final translated text and substitutes the parameters through the details.
$related_element	by value	string	""	The error element associated with the error.
$code	by value	string	""	The error code to be reported.
$technical_info	by value	string	""	The technical information for the error. Displaying of this part might be controlled over an option "debug_mode".
$file	by value	string	""	The source file where the error occurred. Per default, the file where the adding error called.
$line	by value	string	""	The source file line where the error occurred. Per default, the file line where the adding error called.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::addError()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::addErrorFromSmartException()

public function addErrorFromSmartException(\SmartFactory\SmartException|\SmartFactory\SmartExceptionCollection $smart_exception ) : void;

Stores the error to be reported.

Parameters

Name	Pass type	Value type	Default value	Description
$smart_exception	by value	\SmartFactory\SmartException\|\SmartFactory\SmartExceptionCollection		The exception object of collection of exceptions.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::addErrorFromSmartException()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::addInfoMessage()

public function addInfoMessage(string $message, array $details = [], bool $autoclose = false): void;

Stores the information message to be reported.

Parameters

Name	Pass type	Value type	Default value	Description
$message	by value	string		The information message to be reported.
$details	by value	array	[]	The details might be useful if the message translations are provided on the client, not on the server, and the message should contain some details that may vary from case to case. In that case, the servers return the message id instead of final text and the details, the client uses the message id, gets the final translated text and substitutes the parameters through the details.
$autoclose	by value	bool	false	The flag that controls whether the message box should be closed automatically after a time.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::addInfoMessage()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::addProgWarning()

public function addProgWarning(string $message, string $file = "", string $line = ""): void;

Stores the programming warning to be reported.

Details

Programming warnings are shown only if the option "show programming warning" is active.

Parameters

Name	Pass type	Value type	Default value	Description
$message	by value	string		The programming warning message to be reported.
$file	by value	string	""	The source file where the error occurred. Per default, the file where the adding error called.
$line	by value	string	""	The source file line where the error occurred. Per default, the file line where the adding error called.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::addProgWarning()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::addWarning()

public function addWarning(string $message, array $details = [], string $related_element = ""): void;

Stores the warning to be reported.

Parameters

Name	Pass type	Value type	Default value	Description
$message	by value	string		The warning message to be reported.
$details	by value	array	[]	The details might be useful if the message translations are provided on the client, not on the server, and the message should contain some details that may vary from case to case. In that case, the servers return the message id instead of final text and the details, the client uses the message id, gets the final translated text and substitutes the parameters through the details.
$related_element	by value	string	""	The error element associated with the warning.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::addWarning()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::clearAll()

public function clearAll(): void;

Clears all stored messages and active elements.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::clearAll()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::clearBubbleMessages()

public function clearBubbleMessages(): void;

Clears the stored information messages.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::clearBubbleMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::clearDebugMessages()

public function clearDebugMessages(): void;

Clears the stored debugging messages.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::clearDebugMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::clearErrors()

public function clearErrors(): void;

Clears the stored error messages.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::clearErrors()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::clearInfoMessages()

public function clearInfoMessages(): void;

Clears the stored information messages.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::clearInfoMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::clearProgWarnings()

public function clearProgWarnings(): void;

Clears the stored programming warning messages.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::clearProgWarnings()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::clearWarnings()

public function clearWarnings(): void;

Clears the stored warning messages.

Returns

void

Overrides

\SmartFactory\Interfaces\IMessageManager::clearWarnings()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::getBubbleMessages()

public function getBubbleMessages(): array;

Returns the array of information messages if any have been stored.

Details

When the messages are requested, it is assumed they will be displayed. Thus, the message array is cleared to avoid displaying of the same messages twice.

Returns

array

Returns the array of information messages if any have been stored.

Overrides

\SmartFactory\Interfaces\IMessageManager::getBubbleMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::getDebugMessages()

public function getDebugMessages(): array;

Returns the array of debugging messages if any have been stored.

Details

When the messages are requested, it is assumed they will be displayed. Thus, the message array is cleared to avoid displaying of the same messages twice.

Returns

array

Returns the array of debugging messages if any have been stored.

Overrides

\SmartFactory\Interfaces\IMessageManager::getDebugMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::getErrors()

public function getErrors(): array;

Returns the array of errors if any have been stored.

Details

When the messages are requested, it is assumed they will be displayed. Thus, the message array is cleared to avoid displaying of the same messages twice.

Returns

array

Returns the array of errors if any have been stored.

Overrides

\SmartFactory\Interfaces\IMessageManager::getErrors()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::getInfoMessages()

public function getInfoMessages(): array;

Returns the array of information messages if any have been stored.

Details

When the messages are requested, it is assumed they will be displayed. Thus, the message array is cleared to avoid displaying of the same messages twice.

Returns

array

Returns the array of information messages if any have been stored.

Overrides

\SmartFactory\Interfaces\IMessageManager::getInfoMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::getMessages()

protected function getMessages(array $messages): array;

This auxiliary function returns the messages of the desired type.

Parameters

Name	Pass type	Value type	Default value	Description
$messages	by value	array		The messages to be retrieved.

Returns

array

Returns the array of messages.

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::getProgWarnings()

public function getProgWarnings(): array;

Returns the array of programming warnings if any have been stored.

Details

When the messages are requested, it is assumed they will be displayed. Thus, the message array is cleared to avoid displaying of the same messages twice.

Returns

array

Returns the array of programming warnings if any have been stored.

Overrides

\SmartFactory\Interfaces\IMessageManager::getProgWarnings()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::getWarnings()

public function getWarnings(): array;

Returns the array of warnings if any have been stored.

Details

When the messages are requested, it is assumed they will be displayed. Thus, the message array is cleared to avoid displaying of the same messages twice.

Returns

array

Returns the array of warnings if any have been stored.

Overrides

\SmartFactory\Interfaces\IMessageManager::getWarnings()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::hasBubbleMessages()

public function hasBubbleMessages(): bool;

Checks whether an information message exist.

Returns

bool

Returns true if the information message exists, otherwise false.

Overrides

\SmartFactory\Interfaces\IMessageManager::hasBubbleMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::hasDebugMessages()

public function hasDebugMessages(): bool;

Checks whether a stored debugging message exist.

Returns

bool

Returns true if the stored debugging message exists, otherwise false.

Overrides

\SmartFactory\Interfaces\IMessageManager::hasDebugMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::hasErrors()

public function hasErrors(): bool;

Checks whether a stored error message exist.

Returns

bool

Returns true if the stored error message exists, otherwise false.

Overrides

\SmartFactory\Interfaces\IMessageManager::hasErrors()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::hasInfoMessages()

public function hasInfoMessages(): bool;

Checks whether an information message exist.

Returns

bool

Returns true if the information message exists, otherwise false.

Overrides

\SmartFactory\Interfaces\IMessageManager::hasInfoMessages()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::hasProgWarnings()

public function hasProgWarnings(): bool;

Checks whether a stored programming warning exist.

Returns

bool

Returns true if the stored programming warning message exists, otherwise false.

Overrides

\SmartFactory\Interfaces\IMessageManager::hasProgWarnings()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::hasWarnings()

public function hasWarnings(): bool;

Checks whether a stored error warning exist.

Returns

bool

Returns true if the stored warning message exists, otherwise false.

Overrides

\SmartFactory\Interfaces\IMessageManager::hasWarnings()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Method: MessageManager::init()

public function init(array $parameters): void;

Initializes the message manager.

Parameters

Name	Pass type	Value type	Default value	Description
$parameters	by value	array		Settings for message management as an associative array in the form key => value: $parameters["debug_mode"] - if set to True, the technical details, programmer warnings and debug information are also sent to the client. Use it only during debugging! $parameters["write_source_file_and_line_by_debug"] - the flag that defines whether for each debug output the source file and line number are written from where it is called.

Returns

void

Throws

\Exception

It might throw an exception in the case of any errors.

Overrides

\SmartFactory\Interfaces\IMessageManager::init()

Authors

Oleg Schildt

Source code

SmartFactory/MessageManager.php

Class: MessageManager

Implements

Authors

Package

Source code

Property: MessageManager::$debug_mode

Type

Authors

Source code

Property: MessageManager::$messages

Type

Authors

Source code

Property: MessageManager::$write_source_file_and_line_by_debug

Type

Authors

Source code

Method: MessageManager::addBubbleMessage()

Parameters

Returns

Overrides

Authors

Source code

See also

Method: MessageManager::addDebugMessage()

Details

Parameters

Returns

Overrides

Authors

Source code

See also

Method: MessageManager::addError()

Parameters

Returns

Overrides

Authors

Source code

See also

Method: MessageManager::addErrorFromSmartException()

Parameters

Returns

Overrides

Authors

Source code

See also

Method: MessageManager::addInfoMessage()

Parameters

Returns

Overrides

Authors

Source code

See also

Method: MessageManager::addProgWarning()

Details

Parameters

Returns

Overrides

Authors

Source code

See also

Method: MessageManager::addWarning()

Parameters

Returns

Overrides

Authors

Source code

See also

Method: MessageManager::clearAll()

Returns

Overrides

Authors

Source code

See also

Method: MessageManager::clearBubbleMessages()

Returns

Overrides

Authors

Source code

See also