Jet\UI_messages

V tomto případě nejde o element UI, ale o malý subsystém pro vytváření uživatelských zpráv. Tedy například informací o tom, že nějaká akce proběhla úspěšně, nebo naopak o chybách a problémech.

Subsystém pracuje ve dvou režimech:

  • Zprávy v session
    Jedná se o tak zvané nastavení zpráv. Element zprávy se vytvoří, ale je umístěn do session. Ze session jsou následně při nejbližší možné příležitosti (obvykle dalším načtení a zobrazení stránky po přesměrování) takové zprávy přečteny a zobrazeny.
  • Zprávy pro okamžité použití
    V tomto režimu se zprávy vytváří, ale nejsou ukládány do session. Předpokládá se, že se použijí (tedy zobrazí) okamžitě. Zpráva je v takovém případě vlastně běžný UI element.

Třídy zpráv

Pro grafické rozlišení podoby zprávy (informace o úspěšné operaci bude mít určitě jinou podobu než chybové hlášení) jsou předefinovány následující konstanty. I zde platí, že v případě potřeby si můžete definovat třídy zpráv vlastní.

Konstanta Hodnota
UI_messages::C_SUCCESSsuccess
UI_messages::C_INFOinfo
UI_messages::C_WARNINGwarning
UI_messages::C_DANGERdanger

Kontext zpráv

V režimu nastavení zpráv je možné používat kontext zprávy. Kontext je libovolný textový řetězec, který lze ke zprávě přiřadit a následně podle něj ze session získat zprávy, které do daného kontextu patří.

Přehled metod

Metoda Význam
public static set(
string $class,
string $message,
string $context=''
) : void		 Vytvoří a nastaví zprávu do session.

Parametry:
  • $class
    Třída zprávy - rozlišení její podoby
  • $message
    Zpráva samotná
  • $context
    Kontext zprávy (volitelně)
public static get(
string|null $context=null
) : UI_messages_message[]		 Ze session získá nastavené zprávy. Buď všechny zprávy pokud je parametr $context=null, nebo pouze zprávy s určitým kontextem.
public static create(
string $class,
string $message,
string $context=''
) : UI_messages_message		 Vytvoří zprávu pro okamžité použití.

Parametry:
  • $class
    Třída zprávy - rozlišení její podoby
  • $message
    Zpráva samotná
  • $context
    Kontext zprávy (volitelně)
public static success(
string $message,
string $context=''
) : void		 Zkrácený zápis zápisu zprávy.
Nastaví zprávu třídy UI_messages::C_SUCCESS
public static createSuccess(
string $message
) : UI_messages_message		 Zkrácený zápis vytvoření zprávy.
Vytvoří zprávu třídy UI_messages::C_SUCCESS
public static info(
string $message,
string $context=''
) : void		 Zkrácený zápis zápisu zprávy.
Nastaví zprávu třídy UI_messages::C_INFO
public static createInfo(
string $message
) : UI_messages_message		 Zkrácený zápis vytvoření zprávy.
Vytvoří zprávu třídy UI_messages::C_INFO
public static warning(
string $message,
string $context=''
)		 Zkrácený zápis zápisu zprávy.
Nastaví zprávu třídy UI_messages::C_WARNING
public static createWarning(
string $message
) : UI_messages_message		 Zkrácený zápis vytvoření zprávy.
Vytvoří zprávu třídy UI_messages::C_WARNING
public static danger(
string $message,
string $context=''
)		 Zkrácený zápis zápisu zprávy.
Nastaví zprávu třídy UI_messages::C_DANGER
public static createDanger(
string $message
) : UI_messages_message		 Zkrácený zápis vytvoření zprávy.
Vytvoří zprávu třídy UI_messages::C_DANGER
Předchozí kapitola
Jet\UI_dataGrid_footer
Další kapitola
Jet\UI_messages_message
GitHub