ModuleMessage

Package framework.modules
Inheritance class ModuleMessage » Module » LsObject
Since 1.0
Source Code /framework/classes/modules/message/Message.class.php
Модуль системных сообщений Позволяет показывать пользователю сообщения двух видов - об ошибке и об успешном действии. 
$this->Message_AddErrorSingle($this->Lang_Get('not_access'),$this->Lang_Get('error'));

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
_aBehaviors Список поведений в виде готовых объектов, формируется автоматически LsObject
aBehaviors array Список поведений LsObject
aMsgError array Массив сообщений со статусом ОШИБКА ModuleMessage
aMsgErrorSession array Массив ошибок, который будут показаны на СЛЕДУЮЩЕЙ страничке ModuleMessage
aMsgNotice array Массив сообщений со статусом СООБЩЕНИЕ ModuleMessage
aMsgNoticeSession array Массив сообщений, который будут показаны на СЛЕДУЮЩЕЙ страничке ModuleMessage
bIsInit bool Указывает на то, была ли проведенна инициализация модуля Module

Public Methods

Hide inherited methods

MethodDescriptionDefined By
AddBehaviorHook() Добавляет хук поведения LsObject
AddError() Добавляет новое сообщение об ошибке ModuleMessage
AddErrorSingle() Создаёт единственное сообщение об ошибке(т.е. очищает все предыдущие) ModuleMessage
AddNotice() Добавляет новое сообщение ModuleMessage
AddNoticeSingle() Создаёт единственное сообщение, удаляя предыдущие ModuleMessage
AttachBehavior() Присоединяет поведение к объекту LsObject
ClearError() Очищает стек ошибок ModuleMessage
ClearNotice() Очищает стек сообщений ModuleMessage
DetachBehavior() Отсоединяет поведение от объекта LsObject
GetBehavior() Возвращает объект поведения по его имени LsObject
GetBehaviors() Возвращает все объекты поведения LsObject
GetError() Получает список сообщений об ошибке ModuleMessage
GetErrorSession() Возвращает список ошибок, ModuleMessage
GetNotice() Получает список сообщений ModuleMessage
GetNoticeSession() Возвращает список сообщений, ModuleMessage
Init() Инициализация модуля ModuleMessage
RemoveBehaviorHook() Удаляет хук поведения LsObject
RunBehaviorHook() Запускает хук поведения на выполнение LsObject
SetInit() Помечает модуль как инициализированный Module
Shutdown() При завершении работы модуля передаем списки сообщений в шаблоны Smarty ModuleMessage
__call() Ставим хук на вызов неизвестного метода и считаем что хотели вызвать метод какого либо модуля LsObject
__clone() Блокируем копирование/клонирование объекта Module
__construct() Конструктор, запускается автоматически при создании объекта LsObject
__get() Обработка доступа к объекты поведения LsObject
isInit() Возвращает значение флага инициализации модуля Module

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
PrepareBehaviors() Инициализация поведений LsObject

Property Details

aMsgError property
protected array $aMsgError;

Массив сообщений со статусом ОШИБКА

aMsgErrorSession property
protected array $aMsgErrorSession;

Массив ошибок, который будут показаны на СЛЕДУЮЩЕЙ страничке

aMsgNotice property
protected array $aMsgNotice;

Массив сообщений со статусом СООБЩЕНИЕ

aMsgNoticeSession property
protected array $aMsgNoticeSession;

Массив сообщений, который будут показаны на СЛЕДУЮЩЕЙ страничке

Method Details

AddError() method
public void AddError(string $sMsg, string $sTitle=NULL, bool $bUseSession=false)
$sMsg string Сообщение
$sTitle string Заголовок
$bUseSession bool Показать сообщение при следующем обращении пользователя к сайту
Source Code: /framework/classes/modules/message/Message.class.php#101 (show)
public function AddError($sMsg, $sTitle = null, $bUseSession = false)
{
    if (!$bUseSession) {
        $this->aMsgError[] = array('msg' => $sMsg, 'title' => $sTitle);
    } else {
        $this->aMsgErrorSession[] = array('msg' => $sMsg, 'title' => $sTitle);
    }
}

Добавляет новое сообщение об ошибке

AddErrorSingle() method
public void AddErrorSingle(string $sMsg, string $sTitle=NULL, bool $bUseSession=false)
$sMsg string Сообщение
$sTitle string Заголовок
$bUseSession bool Показать сообщение при следующем обращении пользователя к сайту
Source Code: /framework/classes/modules/message/Message.class.php#117 (show)
public function AddErrorSingle($sMsg, $sTitle = null, $bUseSession = false)
{
    $this->ClearError();
    $this->AddError($sMsg, $sTitle, $bUseSession);
}

Создаёт единственное сообщение об ошибке(т.е. очищает все предыдущие)

AddNotice() method
public void AddNotice(string $sMsg, string $sTitle=NULL, bool $bUseSession=false)
$sMsg string Сообщение
$sTitle string Заголовок
$bUseSession bool Показать сообщение при следующем обращении пользователя к сайту
Source Code: /framework/classes/modules/message/Message.class.php#130 (show)
public function AddNotice($sMsg, $sTitle = null, $bUseSession = false)
{
    if (!$bUseSession) {
        $this->aMsgNotice[] = array('msg' => $sMsg, 'title' => $sTitle);
    } else {
        $this->aMsgNoticeSession[] = array('msg' => $sMsg, 'title' => $sTitle);
    }
}

Добавляет новое сообщение

AddNoticeSingle() method
public void AddNoticeSingle(string $sMsg, string $sTitle=NULL, bool $bUseSession=false)
$sMsg string Сообщение
$sTitle string Заголовок
$bUseSession bool Показать сообщение при следующем обращении пользователя к сайту
Source Code: /framework/classes/modules/message/Message.class.php#146 (show)
public function AddNoticeSingle($sMsg, $sTitle = null, $bUseSession = false)
{
    $this->ClearNotice();
    $this->AddNotice($sMsg, $sTitle, $bUseSession);
}

Создаёт единственное сообщение, удаляя предыдущие

ClearError() method
public void ClearError()
Source Code: /framework/classes/modules/message/Message.class.php#166 (show)
public function ClearError()
{
    $this->aMsgError = array();
    $this->aMsgErrorSession = array();
}

Очищает стек ошибок

ClearNotice() method
public void ClearNotice()
Source Code: /framework/classes/modules/message/Message.class.php#156 (show)
public function ClearNotice()
{
    $this->aMsgNotice = array();
    $this->aMsgNoticeSession = array();
}

Очищает стек сообщений

GetError() method
public array GetError()
{return} array
Source Code: /framework/classes/modules/message/Message.class.php#177 (show)
public function GetError()
{
    return $this->aMsgError;
}

Получает список сообщений об ошибке

GetErrorSession() method
public array GetErrorSession()
{return} array
Source Code: /framework/classes/modules/message/Message.class.php#209 (show)
public function GetErrorSession()
{
    return $this->aMsgErrorSession;
}

Возвращает список ошибок, которые необходимо поместить в сессию

GetNotice() method
public array GetNotice()
{return} array
Source Code: /framework/classes/modules/message/Message.class.php#187 (show)
public function GetNotice()
{
    return $this->aMsgNotice;
}

Получает список сообщений

GetNoticeSession() method
public array GetNoticeSession()
{return} array
Source Code: /framework/classes/modules/message/Message.class.php#198 (show)
public function GetNoticeSession()
{
    return $this->aMsgNoticeSession;
}

Возвращает список сообщений, которые необходимо поместить в сессию

Init() method
public void Init()
Source Code: /framework/classes/modules/message/Message.class.php#63 (show)
public function Init()
{
    /**
     * Добавляем сообщения и ошибки, которые содержались в сессии
     */
    $aNoticeSession = $this->Session_Get('message_notice_session');
    if (is_array($aNoticeSession) and count($aNoticeSession)) {
        $this->aMsgNotice = $aNoticeSession;
    }
    $aErrorSession = $this->Session_Get('message_error_session');
    if (is_array($aErrorSession) and count($aErrorSession)) {
        $this->aMsgError = $aErrorSession;
    }
}

Инициализация модуля

Shutdown() method
public void Shutdown()
Source Code: /framework/classes/modules/message/Message.class.php#82 (show)
public function Shutdown()
{
    /**
     * Добавляем в сессию те сообщения, которые были отмечены для сессионного использования
     */
    $this->Session_Set('message_notice_session', $this->GetNoticeSession());
    $this->Session_Set('message_error_session', $this->GetErrorSession());

    $this->Viewer_Assign('aMsgError', $this->GetError());
    $this->Viewer_Assign('aMsgNotice', $this->GetNotice());
}

При завершении работы модуля передаем списки сообщений в шаблоны Smarty