Jet\Logger_Interface

Toto rozhraní definuje backend loggeru.

Metoda	Význam
public log( string $event_class, string $event, string $event_message, string $context_object_id = '', string $context_object_name = '', mixed $context_object_data = [], Auth_User_Interface\|bool $current_user = false )	Provede zalogování (tedy faktické uložení záznamu) události. Parametry: $event_class Třída / druh události. $event Identifikátor události. Má se jednat o textovou konstantu, která jednoznačně identifikuje danou událost. $event_message Textový popis události - čitelný pro uživatele. Může / má obsahovat i podrobnosti o události (např: 'Uživatel XXXX (id:123) se odhlásil') $context_object_id ID objektu, kterého se událost týká. Tedy například pokud je událost úprava článku, tak tento parametr by měl mít hodnotu ID editovaného článku. $context_object_name Uživatelem čitelný název objektu, kterého se událost týká. Například při editaci článku může mít tento parametr hodnotu titulku článku a podobně. $context_object_data Libovolná kontextová data události. Jako příklad si opět vezměme editaci článku. Může to být klidně instance daného článku a do logu se tedy zaznamená jeho podoba po úpravě. Může tak například vzniknout i historie úprav a podobně. $current_user Pokud je v době události přihlášen platný uživatel, pak je loggeru předána jeho instance. V opačném případě je předána hodnota false.

Metoda

Význam

public log(
string $event_class,
string $event,
string $event_message,
string $context_object_id = '',
string $context_object_name = '',
mixed $context_object_data = [],
Auth_User_Interface|bool $current_user = false
)

Provede zalogování (tedy faktické uložení záznamu) události.
Parametry:

$event_class
Třída / druh události.
$event
Identifikátor události. Má se jednat o textovou konstantu, která jednoznačně identifikuje danou událost.
$event_message
Textový popis události - čitelný pro uživatele. Může / má obsahovat i podrobnosti o události (např: 'Uživatel XXXX (id:123) se odhlásil')
$context_object_id
ID objektu, kterého se událost týká. Tedy například pokud je událost úprava článku, tak tento parametr by měl mít hodnotu ID editovaného článku.
$context_object_name
Uživatelem čitelný název objektu, kterého se událost týká. Například při editaci článku může mít tento parametr hodnotu titulku článku a podobně.
$context_object_data
Libovolná kontextová data události. Jako příklad si opět vezměme editaci článku. Může to být klidně instance daného článku a do logu se tedy zaznamená jeho podoba po úpravě. Může tak například vzniknout i historie úprav a podobně.
$current_user
Pokud je v době události přihlášen platný uživatel, pak je loggeru předána jeho instance. V opačném případě je předána hodnota false.