Jak sama nazwa wskazuje, klasa Utils zawiera użyteczne narzędzia. Obiektu tej klasy nie trzeba tworzyć. Wszystkie metody są statyczne i upraszczają niektóre zadania.

Metody klasy \core\Utils

Utils::addRoute($action, $controller, $roles = null)

dodaje ścieżkę do routingu w uproszczonej postaci (bez podania przestrzeni nazw kontrolera - używana domyślna lokalizacja) oraz metody akcji (używana domyślna metoda z prefiksem "action_".$action). Parametr $action określa nazwę akcji (część URL) na której podstawie router podejmuje decyzję o wyborze konkretnego kontrolera do uruchomienia.

Nazwy ról są opcjonalne. Można podać jedną rolę np. "admin" albo kilka w postaci tabelarycznej np. ["user","admin"].

Utils::addRouteEx($action, $namespace, $controller, $method, $roles = null)

analogicznie do addRoute - dodaje ścieżkę do routingu pozwalając określić niestandardową przestrzeń nazw dla kontrolera oraz nazwę metody akcji w kontrolerze.

Utils::addErrorMessage($text, $index = null)

upraszcza dodanie komunikatu o błędzie bez konieczności jawnego tworzenia obiektu klasy message

Utils::addInfoMessage($text, $index = null)

upraszcza dodanie komunikatu informacyjnego bez konieczności jawnego tworzenia obiektu klasy message

Utils::addWarningMessage($text, $index = null)

upraszcza dodanie komunikatu ostrzegawczego błędzie bez konieczności jawnego tworzenia obiektu klasy message

Utils::URL($action, $params = null)

generuje (zwraca) bezwzględny URL do podanej akcji, uwzględniający parametry przekazane opcjonalnie jako drugi parametr (w formie tablicy zawierające wpisy "parametr" => "wartość"). Metoda uwzględnia konfigurację systemu - ustawione przyjazne url'e lub nie. Zobacz przykłady poniżej.

Utils::relURL($action, $params = null)

generuje (zwraca) względny URL do podanej akcji, uwzględniający parametry przekazane opcjonalnie jako drugi parametr (w formie tablicy zawierające wpisy "parametr" => "wartość"). Metoda uwzględnia konfigurację systemu - ustawione przyjazne url'e lub nie. Zobacz przykłady poniżej.

Utils::URL_noclean($action, $params = null)

generuje (zwraca) bezwzględny URL do podanej akcji, uwzględniający parametry przekazane opcjonalnie jako drugi parametr (w formie tablicy zawierające wpisy "parametr" => "wartość"). Metoda zawsze generuje parametry bez uwzględnienia przyjaznych linków. Zobacz przykłady poniżej.

Utils::relURL_noclean($action, $params = null)

generuje (zwraca) bezwzględny URL do podanej akcji, uwzględniający parametry przekazane opcjonalnie jako drugi parametr (w formie tablicy zawierające wpisy "parametr" => "wartość"). Metoda zawsze generuje parametry bez uwzględnienia przyjaznych linków. Zobacz przykłady poniżej.

Generowanie URL

Ostatnie metody klasy \core\Utils pozwalają na generowanie URLi do podanej akcji, ułatwiając pracę w systemie w tym zakresie. Metody pozwalają przekazać dowolną liczbę parametrów. W rzeczywistości można przekazać jeden lub null. Przykłady pokazują przekazanie dwóch parametrów.

Zakładając, iż aplikacja jest skonfigurowana dla serwera localhost oraz podfolderu aplikacja, kolejne metody zwrócą co następuje:

Utils::URL("deleteUser", [ "user_id" => 23, "after" => "main" ])

zwrócona wartość:

gdy przyjazne linki włączone (domyślnie): http://localhost/aplikacja/public/deleteUser/23

Utils::relURL("deleteUser", [ "user_id" => 23, "after" => "main" ])

zwrócona wartość:

gdy przyjazne linki włączone (domyślnie): /aplikacja/public/deleteUser/23/main

gdy przyjazne linki wyłączone (niestandardowo): /aplikacja/public/index.php?action=deleteUser&user_id=23&after=main

Należy zwrócić uwagę, iż dla przyjaznych linków nie są przekazywane nazwy parametrów. Jeśli chcesz użyć nazw parametrów to należy użyć metody relURL_noclean().

Utils::URL_noclean("deleteUser", [ "user_id"=> 23, "after" => "main" ])

zwrócona wartość:

gdy przyjazne linki włączone (domyślnie): http://localhost/aplikacja/public/deleteUser?user_id=23&after=main

gdy przyjazne linki wyłączone (niestandardowo): http://localhost/aplikacja/public/index.php?action=deleteUser&user_id=23&after=main

Należy zwrócić uwagę, iż dla przyjaznych linków nie są przekazywane nazwy parametrów. Jeśli chcesz użyć nazw parametrów to należy użyć metody URL_noclean().

Utils::relURL_noclean("deleteUser", [ "user_id"=> 23, "after" => "main" ])

zwrócona wartość:

gdy przyjazne linki włączone (domyślnie): /aplikacja/public/deleteUser?user_id=23&after=main

gdy przyjazne linki wyłączone (niestandardowo): /aplikacja/public/index.php?action=deleteUser&user_id=23&after=main

Należy zwrócić uwagę, iż dla przyjaznych linków nie są przekazywane nazwy parametrów. Jeśli chcesz użyć nazw parametrów to należy użyć metody URL_noclean().