Pomocné funkcie

Tieto funkcie sú globálne dostupné z každého miesta aplikácie.

Funkcie

c

Číta z konfiguračného súboru config.php podľa zadaného kľúča.

Volanie

c($configKey)

Parametre

  1. configKey -> Kľúč konfiguračného pola.

Návratová hodnota

Vráti hodnotu z congig.php súboru podľa kľúča. Ak sa klúč nenájde, funkcia vráti false.

setTemplate

Nastavuje používanú šablonu.

Volanie

setTemplate($templateName)

Parametre

  1. templateName -> Názov šablony.

setHeaders

Nastavuje premenné pre hlavičku šablony.

Volanie

setHeaders($headers)

Parametre

  1. headers -> Je pole, ktorého hodnoty sa nastavujú pre nasledujúce kľúče:
    • title
    • description
    • keywords
    • index (hodnoty: 'INDEX', 'NOINDEX')
    • follow (hodnoty: 'FOLLOW', 'NOFOLLOW')
    • imageindex (hodnoty: 'IMAGEINDEX', 'NOIMAGEINDEX')

getHeader

Vracia premennú pre hlavičku šablony podla zadaného kľúča.

Volanie

getHeader($key)

Parametre

  1. key -> Kľúč k polu premenných pre hlavičku šablony.

Návratová hodnota

Vráti premennú pre hlavičku šablony podla zadaného kľúča. Ak sa klúč nenájde, funkcia vráti false.

url

Používa sa na generovanie interných odkazov aplikácie. Všetky linky na podstránky aplikácie je potrebné tvoriť pomocou tejto funkcie.

Volanie

url([$page, ''], [$params, []], [$hash, ''])

Parametre

  1. page -> Nepovinný parameter s prednastavenou hodnotou ''. Časť url s názvom podstránky a jej segmentami. Ak je použitá predvolená hodnota, link bude smerovať na domovskú stránku.
  2. params -> Nepovinný parameter s prednastavenou hodnotou []. Pole parametrov url. Kľúč je názov parametra.
  3. hash -> Nepovinný parameter s prednastavenou hodnotou ''. Hash ktorý nastavuje scroll pozíciu odkazovanej stránky.

Návratová hodnota

Vráti interný link aplikácie.

redirect

Používa sa na interné presmerovanie v rámci aplikácie.

Volanie

redirect([$url, ''], [$statusCode, 302])

Parametre

  1. url -> Nepovinný parameter s prednastavenou hodnotou ''. Časť url s názvom podstránky a jej segmentami. Ak je použitá predvolená hodnota, link bude smerovať na domovskú stránku.
  2. statusCode -> Nepovinný parameter s prednastavenou hodnotou 302. Kód statusu odpovede. Kód 302 znamená "zdroj sa dočasne nachádza na inéj adrese". Kód 301 znamená "zdroj sa trvale nachádza na inéj adrese".

redirectOut

Používa sa na presmerovanie aplikácie.

Volanie

redirectOut($url, [$statusCode, 302])

Parametre

  1. url -> Kompletná adresa url.
  2. statusCode -> Nepovinný parameter s prednastavenou hodnotou 302. kód statusu odpovede. Kód 302 znamená "zdroj sa dočasne nachádza na inéj adrese". Kód 301 znamená "zdroj sa trvale nachádza na inéj adrese".

segment

Súži na získanie segmentu z url. Segmenty sú indexované od čísla 1.

Volanie

segment($segment)

Parametre

  1. segment -> Číslo požadovaného segmentu.

Návratová hodnota

Vráti hodnotu požadovaného segmentu. Ak segment neexistuje, vráti false.

segmentsRequired

Skontroluje, či sa počet segmentov v url zhoduje s požadovaným počtom segmentov. V prípade že sa počty líšia, aplikácia bude púresmerovaná na chybovú stránku 404.

Volanie

segmentsRequired($segments)

Parametre

  1. segments -> Počet požadovaných segmentov.