Vstavané validačné pravidlá

CakePHP disponuje množstvom najčastejšie používaných validačných pravidiel, ktoré robia validáciu veľmi jednoduchou. My si teraz detailne predstavíme všetky preddefinované pravidlá, ktoré môže programátor jednoducho používať bez toho, aby ich musel priamo vytvárať.

Ukážky kódov sú prevzaté z Cookbook: Data Validation

alphaNumeric

Dáta v danom inpute musia obsahovať iba písmená a číslice

var $validate = array(
    'login' => array(
        'rule' => 'alphaNumeric',
        'message' => 'Usernames must only contain letters and numbers.'
    )
);

between

Určuje rozmedzie počtu znakov daného inputu. Určuje minimálnu a maximálnu dĺžku reťazca v inpute

var $validate = array(
    'password' => array(
        'rule' => array('between', 5, 15),
        'message' => 'Passwords must be between 5 and 15 characters long.'
    )
);

blank

Určuje, že daný input musí byť prázdny alebo môže obsahovať iba biele znaky. Medzi biele znaky patria medzera, tabulátor a nový riadok

var $validate = array(
    'id' => array(
        'rule' => 'blank',
        'on' => 'create'
    )
);

cc

Toto pravidlo sa používa na kontrolu, či daný input obsahuje správne čísla kreditných kariet. Prijíma 3 argumenty na základe toho, aké čísla kreditných kariet chceme validovať, a to konkrétne type, deep a regex.

Pre kľúč type môžu byť pridelené dve hodnoty, a to fast, all alebo niektoré z nasledujúcich:

• bankcard
• diners
• disc
• electron
• enroute
• jcb
• maestro
• mc
• solo
• switch
• visa
• voyager

Ak je kľúč type nastavený na hodnotu fast, budú sa automaticky kontrolovať čísla majoritných kreditných kariet. Ak je kľúč type nastavený na hodnotu all budú sa kontrolovať všetky prednastavené formáty čísiel kreditných kariet. Taktiež tomuto kľúču môžete priradiť pole, kde určíte, oproti ktorým kreditným kartám sa bude validácia vykonávať.

Kľúč deep by mal byť nastavený ako boolean hodnota. Defaultne je táto hodnota nastavená na false. Ak však nastavíme danú hodnotu na true, na validáciu sa použije Luhn algoritmus

Kľúč regex vám umožňuje zadať vlastný regulárny výraz. I keď sú možnosti validácie kreditných kariet široké, určite sa nám v niektorých prípadoch môže kľúč regex hodiť a tým pádom nie sú naše možnosti limitované na prednastavené hodnoty

var $validate = array(
    'ccnumber' => array(
        'rule' => array('cc', array('visa', 'maestro'), false, null),
        'message' => 'The credit card number you supplied was invalid.'
    )
);

comparison

Toto kritérium umožňuje porovnávať číselné hodnoty. Podporované operácie sú štandardné matematické operácie a to väčší, menší, väčší alebo rovný, menší alebo rovný, rovnajúci sa a nerovnajúci sa

var $validate = array(
    'age' => array(
        'rule' => array('comparison', '>=', 18),
        'message' => 'Must be at least 18 years old to qualify.'
    )
);

var $validate = array(
    'age' => array(
        'rule' => array('comparison', 'greater or equal', 18),
        'message' => 'Must be at least 18 years old to qualify.'
    )
);

date

Určuje správny formát dátumu. Prijíma jeden parameter, ktorým určujeme požadovaný formát vkladaného dátumu. Ako parameter smie byť použitý jeden z nasledujúcich kľú­čov

• ‘dmy’ e.g. 27–12–2006 or 27–12–06
• ‘mdy’ e.g. 12–27–2006 or 12–27–06
• ‘ymd’ e.g. 2006–12–27 or 06–12–27
• ‘dMy’ e.g. 27 December 2006 or 27 Dec 2006
• ‘Mdy’ e.g. December 27, 2006 or Dec 27, 2006
• ‘My’ e.g. (December 2006 or Dec 2006)
• ‘my’ e.g. 12/2006 or 12/06

Ak nie je žiadny kľúč určený, defaultne sa použije kľúč ymd.

var $validate = array(
    'born' => array(
        'rule' => 'date',
        'message' => 'Enter a valid date in YY-MM-DD format.',
        'allowEmpty' => true
    )
);

decimal

Určuje správny formát desatinného čísla. Prijíma jeden parameter, ktorým určujeme počet čísiel za desatinnou bodkou (pozor: podporovaný je len anglický formát a desatinná čiarka nie je podporovaná). Ak tento parameter nie je určený, každé číslo, ktoré nebude mať za desatinnou bodkou aspoň jedno číslo, skončí chybou

var $validate = array(
    'price' => array(
        'rule' => array('decimal', 2)
    )
);

email

Určuje správny formáta email adresy. Prijíma jeden parameter ako bolean hodnotu, ktorým určujeme, či sa má kontrolovať aj doména uvedená v email adrese.

var $validate = array('email' => array('rule' => 'email'));

var $validate = array(
    'email' => array(
        'rule' => array('email', true),
        'message' => 'Please supply a valid email address.'
    )
);

equalTo

Určuje akej hodnote a akému typu sa má rovnať reťazec z daného inputu

var $validate = array(
    'food' => array(
        'rule' => array('equalTo', 'cake'),
        'message' => 'This value must be the string cake'
    )
);

extension

Určuje správnu príponu ako napr. .jpg alebo .png. Umožňuje taktiež určiť aj viac prípon pre daný input, a to vložením požadovaných prípon do poľa

var $validate = array(
    'image' => array(
        'rule' => array('extension', array('gif', 'jpeg', 'png', 'jpg'),
        'message' => 'Please supply a valid image.'
    )
);

file

Toto validančé kritérium zatiaľ nie je definované.

ip

Určuje správny formát IPv4 adresy

var $validate = array(
    'clientip' => array(
        'rule' => 'ip',
        'message' => 'Please supply a valid IP address.'
    )
);

minLength

Určuje minimálnu dĺžku znakov, ktorú musí odosielaný reťazec obsahovať

var $validate = array(
    'login' => array(
        'rule' => array('minLength', '8'),
        'message' => 'Usernames must be at least 8 characters long.'
    )
);

maxLength

Určuje maximálnu dĺžku znakov, ktorú musí odosielaný reťazec obsahovať

var $validate = array(
    'login' => array(
        'rule' => array('maxLength', '15'),
        'message' => 'Usernames must be no larger than 15 characters long.'
    )
);

money

Toto validančé kritérium zatiaľ nie je definované.

multiple

Toto validančé kritérium zatiaľ nie je definované.

numeric

Určuje, či sa jedná o číslo v správnom formáte

var $validate = array(
    'cars' => array(
        'rule' => 'numeric',
        'message' => 'Please supply the number of cars.'
    )
);

phone

Určuje správny formát telefónneho čísla vo formáte US. Pre kontrolu čísla v inom formáte prijíma ako druhý parameter regulárny výraz, ktorým môžeme určiť správny formát národného čísla

var $validate = array(
    'phone' => array(
        'rule' => array('phone', null, 'us')
    )
);

postal

Určuje správny formát zip code. Jedná sa o obdobu PSČ. Prednastavené sú čísla z UK, US a Kanady. Pre kontrolu čísla v inom formáte prijíma ako druhý parameter regulárny výraz, ktorým môžeme určiť správny formát národného čísla

var $validate = array(
    'zipcode' => array(
        'rule' => array('postal', null, 'us')
    )
);

range

Určuje, či daná hodnota spadá do určeného rozsahu.

var $validate = array(
    'number' => array(
        'rule' => array('range', 0, 10),
        'message' => 'Please enter a number between 0 and 10'
    )
);

ssn

Určuje formát social security number. Jedná sa o obdobu rodného čísla. Pre kontrolu čísla v inom formáte prijíma ako druhý parameter regulárny výraz, ktorým môžeme určiť správny formát národného čísla.

var $validate = array(
    'ssn' => array(
        'rule' => array('ssn', null, 'us')
    )
);

url

Určuje správny formát URL adresy. Podporované protokoly sú http(s), ftp(s), news a gopher.

var $validate = array(
    'website' => array(
        'rule' => 'url'
    )
);

Vlastné validačné pravidlá

Ako sme už mohli zistiť, prednastavené pravidlá nám poskytujú vysoký komfort pri validácii dát bez nutnosti písať vlastné pravidlá. Určite však niekedy nastane situáciu, že budeme nútený napísať vlastné validačné pravidlo. K tomu nám CakePHP ponúka dve možnosti, jednou je definovanie regulárneho výrazu, druhou možnosťou je vytvoriť vlastnú metódu.

Regulárny výraz ako validačné pravidlo

Pre tých, ktorý majú v láske regulárne výrazy nie je nič jednoduchšie, ako definovať vlastné pravidlá pomocou nich. Treba však poznamenať, že je to najrýchlejší spôsob, ako vlastné pravidlá vytvárať

var $validate = array(
    'login' => array(
        'rule' => array('custom', '/[a-z0-9]{3,}$/i'),
        'message' => 'Only letters and integers, min 3 characters'
    )
);

Príklad vyššie nám ukazuje, že input login môže obsahovať iba číslice a písmená, a musí obsahovať minimálne 3 znaky.

Vlastná validačná metóda

V niektorých prípadoch môže byť však regulárny výraz nedostatočný. Predstavme si situáciu, že potrebujeme zaistiť, že login je unikátny. K tomuto nám dokonale poslúži vlastná validačná metóda

<?php
class User extends AppModel {
    var $name = 'User';

    var $validate = array(
        'login' => array(
            'rule' => array('checkUnique', 'login'),
            'message' => 'Login name already taken.'
        )
    );

    function checkUnique($data, $fieldName) {
        $valid = false;
        if(isset($fieldName) && $this->hasField($fieldName))
        {
            $valid = $this->isUnique(array($fieldName => $data));
        }
        return $valid;
   }
}
?>

Ak by ste chceli predávať parametre našej novej validačnej metóde, pridajte extra element do poľa rule (v ukážke login) a v metóde daný element zachyťte ako ďalší parameter za parametrom $data (v ukážke $fieldName)

Validačnú metódu môžeme umiestniť buď do modelu, ale rovnako i do behavior, ktoré model implementuje.

Validačnou metódou môžeme prepísať prednastavené validačné pravidlá a to tým, že ich pomenujeme rovnakým názvom. Napríklad by sme v našom modely vytvorili metódu nazvanú file, znamenalo by to, že sme tým prepísali metódu z triedy Validation a pri použití validačného pravidla file sa bude volať nami vytvorená metóda z nášho modelu.

Týmto je náš článok u konca. V poslednej časti tohto miniseriálu si ukážeme ako validovať dáta, ktoré nie sú namapované na databázovú tabuľku, a taktiež si ukážeme ucelený príklad jednoduchej validácie.

Ako motivačný príklad si predstavme situáciu, že užívateľ odosiela dáta z prihlasovacieho formulára. V danom formulári chceme určiť, že prihlasovacie meno bude minimálne 5 znakov dlhé a že heslo nebude prázdne. CakePHP takúto situáciu rieši veľmi elegantne a definovanie validačných pravidiel robí veľmi jednoduchým.

Prvým krokom k validácii dát je vytvorenie validačných pravidiel v modely. To docielime použitím poľa validate v našom modely. Kód by mohol vyzerať následovne

<?php
class User extends AppModel {
    var $name = 'User';
    var $validate = array(
        'login' => 'alphaNumeric'
    );
}
?>

Na ukážke vyššie môžeme vidieť definovanie pravidiel pre validáciu. Príklad definuje pravidlo pre input pomenovaný login a určuje, že z daného inputu bude prijímaný vstup v podobe písmen a číslic. Definovaním takýchto pravidiel umožňujeme CakePHP automaticky zobrazovať chybové hlášky pri daných vstupných poliach v prípade, že dané pole neobsahuje očakávaný vstup a tým uľahčuje programátorovi množstvo času. V našom konkrétnom prípade by odosielanie formulára skončilo chybovou hláškou vtedy, ak by sme do daného inputu vložili znak, ktorý by nebol buď písmeno alebo číslica, a snažili by sme sa takýto formulár odoslať.

CakePHP má množstvo prednastavených validačných pravidiel a ich použitie je veľmi jednoduché. Prednastavené pravidlá nám okrem iného umožňujú kontrolovať email adresu, url, dátum a iné často používané pravidlá (všetky pravidlá si detailne predstavíme v nasledujúcich častiach textu). Na ďalšom príklade môžeme vidieť komplexný príklad, ktorý nám demonštruje možnosti validácie v CakePHP. Príklad je prevzatý z Cookbook: Data Validation

<?php
class User extends AppModel {
    var $name = 'User';
    var $validate = array(
        'login' => array(
            'alphanumeric' => array(
                'rule' => 'alphaNumeric',
                'required' => true,
                'message' => 'Alphabets and numbers only'
                ),
            'between' => array(
                'rule' => array('between', 5, 15),
            'message' => 'Between 5 to 15 characters'
            )
        ),
        'password' => array(
            'rule' => array('minLength', '8'),
            'message' => 'Mimimum 8 characters long'
        ),
        'email' => 'email',
        'born' => array(
            'rule' => 'date',
            'message' => 'Enter a valid date',
            'allowEmpty' => true
        )
    );
}
?>

Príklad vyššie nám ukazuje, ako priradiť niekoľko pravidiel jednému inputu. Môžeme vidieť, že input login má definované dve pravidlá. Prvé nám hovorí, že daný vstup môže obsahovať len písmená a číslice, druhé pravidlo určuje, že login môže mať dĺžku od 5 do 15 znakov. Taktiež môžeme na príklade pozorovať, ako k jednotlivým inputom zobraziť chybové správy v prípade, ak je validácia neúspešná a daný vstup nevyhovuje určeným pravidlám. Ak však vstavané validačné pravidlá nevyhovujú vašim predstavám, samozrejme si môžete vytvoriť vlastné podľa svojich predstáv.

Teraz už máme veľmi dobrú a ucelenú predstavu o validácii v CakePHP a o jej možnostiach. Keďže máme niekoľko možností, ako definovať jednotlivé pravidlá pre daný vstup, poďme si ich bližšie predstaviť.

Základné pravidlo

Ako názov napovedá, jedná sa o základný a najjednoduchší spôsob definovania validačných pravidiel. Syntax je nasledovná

var $validate = array('fieldName' => 'rule');

Ako môžeme vidieť, validačné pole obsahuje dvojicu, a to fieldName, čo je názov input prvku v našom formulári a rule, čo môže byť napríklad vstavané pravidlo alebo regulárny výraz.

Jedno pravidlo pre input

Tento spôsob je rozšírením základného pravidla a poskytuje nám širšie možnosti pri validovaní vstupu. Príklad je opäť prevzatý z Cookbook: Data Validation

var $validate = array(
    'fieldName1' => array(
        'rule' => 'ruleName', // or: array('ruleName', 'param1', 'param2' ...)
        'required' => true,
        'allowEmpty' => false,
        'on' => 'create', // or: 'update'
        'message' => 'Your Error Message'
    )
);

Ako môžeme vidieť, jednému inputu je priradené pole s piatimi kľúčmi. V ukážke je zobrazený len jeden input, samozrejme ich môžeme definovať ľubovoľne a každý z nich môže obsahovať pole s kľúčmi s vlastnými hodnotami. Poďme si teda priblížiť, čo dané kľúče znamenajú

rule

Tento kľúč definuje validačné pravidlo pre daný input. Tento kľúč nie je omedzený len na použitie jedného pravidla, ale môže taktiež obsahovať pole so vstavanými validačnými pravidlami, názov metódy v modely, názov metódy zo základnej triedy Validation alebo vlastný regulárny výraz.

required

Tomuto kľúču by mala byť priradená boolean hodnota. Tento kľúč nám určuje, či sa má vo formulári nachádzať daný input alebo nie. Ak teda nastavíme hodnotu na true, to znamená, že daný formulár pri odoslaní musí tento input prvok obsahovať, či už prázdny alebo nie. Pozor však, tento kľúč nám neurčuje, či musí daný input obsahovať dáta alebo nie, hovorí nám len, že daný prvok vo formulári musí byť.

allowEmpty

Tomuto kľúču by mala byť priradená boolean hodnota. Tento kľúč nám určuje, či daný input musí obsahovať dáta alebo nie. Ak teda hodnotu tohto kľúča nastavíme na true, to znamená, že daný input nesmie byť odoslaný ako prázdny a musí obsahovať dáta.

on

Tento kľúč nám umožňuje určiť, pri akých akciách sa má daná validácia vykonávať. V našom príklade sme určili, že daná validácia sa bude vykonávať pri akcii create a pri akcii update bude validácia neaktívna. Ak je dané kľúč nastavený na null, validácia sa bude vykonávať pri oboch akciách.

message

Tento kľúč nám umožňuje určiť vlastnú chybovú hlášku pre daný input.

Viac pravidiel pre input

Tento spôsob sme si už naznačili v časti, kde sme si predstavovali validáciu v CakePHP. Poďme sa pozrieť na nasledujúci príklad

var $validate = array(
    'login' => array(
       'alphanumeric' => array(
            'rule' => 'alphaNumeric',
            'required' => true,
            'message' => 'Alphabets and numbers only'
             ),
        'between' => array(
            'rule' => array('between', 5, 15),
            'message' => 'Between 5 to 15 characters'
        )
    )
)

Môžeme vidieť, že vstupné pole login má definované dve pravidlá, prvé nám hovorí, že daný vstup môže obsahovať len písmená a číslice, druhé pravidlo určuje, že login môže mať dĺžku od 5 do 15 znakov. V daných pravidlách môžeme využiť taktiež kľúče, ktoré sme si predstavili v časti Jedno pravidlo pre input.

Týmto je náš článok u konca. V ďalšej časti sa detailne pozrieme na vstavané validačné pravidlá, ktoré nám ponúka CakePHP a ukážeme si ucelený príklad, ako celý mechanizmus validácie funguje.

The Cookbook

http://book.cakephp.org

Ak sa dostanete na toto miesto, začali ste na správnom mieste. Tento manuál by mal byť pravdepodobne prvým miestom, kde dostanete odpovede na vaše prvotné otázky. CookBook sa snaží poskytnúť ucelený pohľad na všetky základné rysy frameworku a predstaviť ich z pohľadu začiatočníka. Manuál a API sú k dispozícii online.

The API

http://api.cakephp.org/…classes.html

Priamo k veci a priamo od vývojárov jádra. CakePHP API (Application Programming Interface) je najviac obsiahla dokumentácia všetkých interných detailov fungovania frameworku. Je to priama referenčná príručka kódu frameworku. Mnohým vývojárom poskytuje najhodnotnejší zdroj informácií.

IRC kanál

#cakephp @ irc.freenode.net

Pre tých čo potrebujú okamžitú radu môžu využiť oficiálny CakePHP IRC kanál. Takmer vždy tam nájdete niekoho z vývojového týmu, najmä počas denného svetla v amerike alebo iných skúsených užívateľov, ktorí sa vám budú snažiť ochotne pomôcť pri riešení vašich problémov. S najväčšou pravdepodobnosťou sa dohovoríte len po anglicky, avšak nie je vylúčené, že nájdete aj niekoho z vášho okolia.

The Bakery

http://bakery.cakephp.org

Tzv. pekáreň, v ktorej môžete nájsť množstvo tutoriálov, štúdií a príkladov kódu. Obsah je vytváraný samotnou komunitou a môžete tu nájsť množstvo cenných rád, ktoré riešia konkrétne problémy. A to všetko aj s hotovými kódmi.

CakeForge

http://www.cakeforge.org

CakeForge je ďalší zdroj pre vývojárov, ktorý môžete použiť na hosťovanie svojich projektov a zdieľať ich tak s ostatnými. Ak hľadáte (alebo chcete zdieľať) svoje komponenty alebo pluginy, CakeForge je to pravé pre vás.

The Official CakePHP website

http://www.cakephp.org

Oficiálna stránka je vždy najlepšie miesto pre návštevu. Poskytuje prehľad o najnovších verziách CakePHP, množstvo zaujímavostí a noviniek z vývoja. Oficiálna stránka je najlepším miestom ako získať najnovšiu verziu tohto frameworku.

The Google Group

http://groups.google.com/group/cake-php

CakePHP disponuje taktiež veľmi aktívnou Google Group. Je to skvelé miesto pre vyhľadávanie v archivovaných odpovediach, často kladených otázkach a odpovedí na aktuálne problémy. Táto skupina je v anglickom jazyku a s iným jazykom ako anglickým sa tu bohužiaľ nedohovoríte.

Slovenské a české zdroje

IMS Blog – môj blog, ktorému sa aktívne venujem
Abclinuxu.cz – seriál na známom linuxovom servery www.abclinuxu.cz
Programujte.com – seriál na servery www.programujte.com

Ak viete ešte o nejakých zaujímavých zdrojoch informácií o CakePHP, neváhajte sa s nimi podeliť v diskusii k článku.

Článok je voľne inšpirovaný v Cookbook::Un­derstanding Model-View-Controller. Týmto by autor chcel požiadať ostatných, ktorí by mali záujem na preklade Cookbook do slovenského jazyka, nech vyjadria svoj postoj v diskusii k článku.

Úvod

CakePHP je postavený na návrhovom vzore MVC. Pri programovaní aplikácií postavených na tomto návrhovom vzore, MVC rozdeľuje danú aplikáciu na 3 základné vrstvy

1. Model – reprezentuje dáta aplikácie
2. View – zobrazuje dáta modelu
3. Controller – prijíma požiadavky od klienta a na základe konkrétnych požiadaviek riadi beh aplikácie

Obrázok znázorňuje request od klienta a jeho následné spracovanie v CakePHP. Pre ilustráciu si predstavme, že klient nazvaný „Ricardo“ klikol na odkaz „Buy A Custom Cake Now!“ na domovskej stránke našej web aplikácie.

1. Ricardo klikol na odkaz smerujúci na adresu www.example.com/cakes/buy a jeho prehliadač vytvoril request na váš webový server.
2. Dispatcher kontruluje request URL (/cakes/buy) a smeruje daný request na správny controller.
3. Controller vykonáva určitú logiku aplikácie. Pre príklad, controller môže kontrolovať, či je Ricardo prihlásený.
4. Controller taktiež používa modely na získanie prístupu k aplikačným dátam. Modely najčastejšie reprezentujú databázové tabuľky, ale môžu byť taktiež reprezentované LDAP entitami, RSS kanálmi alebo súbormi v systéme. V našom príklade controller používa model na získanie Ricardových posledných nákupov z databázy.
5. Controller okrem iného predáva dáta do ďalšej časti MVC architektúry nazvanej View. View vezme dáta a pripraví ich pre zobrazenie v klientovi. Views sú v CakePHP najčastejšie vo formáte HTML, avšak môžu byť aj jednoducho vo formáte PDF, XML alebo v inom formáte.
6. Akonáhle view kompletne pripraví dáta pre zobrazenie, následne sú spracované dáta vrátené ako response do Ricardovho klienta.

Takmer každý request do vašej aplikácie bude nasledovať obdobný postup, preto je dobré si daný postup poriadne zapamätať a samozrejme mu aj porozumieť.

Výhody

Prečo používať MVC? Pretože je to je ustálený návrhový vzor, ktorý pretvorí aplikáciu na udržateľný, modulárny a rýchlo sa vyvíjúci balík. Nové vlastnosti sú pridávané jednoducho a staré rysy dostávajú novú tvár. Modulárny a oddelený návrh taktiež umožňuje developerom a návrhárom pracovať súčasne, zahŕňa taktiež možnosť rychlého prototypovania. Separácia taktiež umožňuje developerom robiť zmeny v jednej časti aplikácie bez ovplyvnenia zvyšných častí.

Ak ste nikdy predtým nevyvíjali aplikáciu touto cestou, určite to zaberie určitý čas zoznámiť sa s návrhovým vzorom MVC, ale som presvedčený, že ak tak raz urobíte, nikdy to nebude chcieť robiť inak.