CakePHP: tvoríme CMS - 4 (Model)

18. 6. 2008 | Tibor Piňo | Programování | 7319×

V minulej časti seriálu sme si vysvetlili srdce frameworku Active Record. Od dnešnej časti sa pustíme do programovania nášho CMS a začneme návrhom databázy a vytvorením databázovej vrstvy našej aplikácie tzv. Modelu.

1. Konvencie CakePHP

Aby sme vedeli správne navrhnúť databázu a CakePHP na jej základe správne chápal väzby medzi tabuľkami, je potrebné poznať konvencie pre návrh databázy. Čo myslíme tým, aby CakePHP správne chápal väzby medzi tabuľkami? Znamená to, že ak budeme mať databázu správne navrhnutú, framework bude automaticky rozpoznávať cudzie kľúče, primárne kľúče a väzby medzi tabuľkami a nebudeme ich musieť pre každú tabuľku explicitne zadávať.

Ešte je dobré poznamenať, že je veľmi rozumné zadávať názvy tabuliek, modelov atď. v anglickom jazyku. CakePHP automaticky chápe anglické jednotné a množné čísla, takže sa vyhneme zbytočným nastavovaniam (samozrejme je možné zadávať názvy aj v národných jazykoch, ale je to práca naviac a my preto budeme používať anglické konvencie).

Názvy tabuliek

Názvy tabuliek sa zapisujú pomenovaním v množnom čísle jednotiek, ktoré uchovávajú. Napríklad máme tabuľku, ktorá uchováva články, preto musí byť táto tabuľka pomenovaná v množnom čísle, v našom prípade articles.

Primárny kľúč

Primárny kľúč sa v tabuľkách označuje pomenovaním id. Taktiež platí, že môžeme používať aj iné pomenovanie pre primárny kľúč, ale opäť to musíme explicitne nastaviť.

Cudzie kľúče

Cudzie kľúče sa v tabuľkách označujú podľa tabuľky, kde sa pôvodne nachádzajú. Predstavme si, že každý článok má svojho autora. Čiže budeme mať dve tabuľky a to articles a users. V tabuľke articles sa bude potom pochopiteľne nachádzať cudzí kľúč z tabuľky users a to pomenovaním user_id. Čiže nám je hneď zrejmé, že cudzí kľúč sa tvorí podľa konvencie jednotne_cislo_tabulky_cudzieho_kluca_id.

Názvy atribútov

Ešte spomeniem, že je celkom vhodné, aby sa atribút názov pomenovával ako name. Oceníme to najmä pri generovaní select boxov vo väzbách 1:N, kde si budeme chcieť napríklad pri článku zvoliť kategóriu výberom z niekoľkých možností. Samozrejme aj tu platí, že môžeme používať iné pomenovanie ako name, avšak opäť by sme sa neskôr nevyhli niektorým nastaveniam, ktoré, ak dodržiavame konvencie, nie je potrebné vykonávať.

Spojovacia tabuľka pri väzbe N:M

Tabuľky, ktoré sú vo väzbe N:M, abecedne zoradíme a následne novú tabuľku pomenujeme podľa konvencie nazov_prvej_tabulky_nazov_druhej_tabulky. Predstavme si, že náš článok má N nálepiek a jedna nálepka môže byť v M článkoch. Máme teda tabuľky pomenované articles a tags a následne vytvoríme spojovaciu tabuľku, ktorú pomenujeme articles_tags. Cudzie kľúče do spojovacej tabuľky vytvoríme podľa konvencií, ktoré sme si definovali vyššie, čiže article_id a tag_id.

2. Navrhujeme databázu

Na obrázku môžeme vidieť našu databázu pre náš nový redakčný systém, ktorú sme navrhli na základe vyššie definovaných konvencií

3. Modely tabuliek

Databázu už máme správne navrhnutú a môžeme sa pustiť do tej najzaujímavejšej časti, a to je návrh databázovej vrstvy našej aplikácie, tzv. Modelu, čo je jedna z troch častí návrhového vzoru Model View Controller. Ako sme si už spomínali v predchádzajúcej časti seriálu, modely sa umiestňujú do adresára app/models. V našom prípade vytvoríme 4 modely, i keď máme tabuliek spolu 5. Ako sme si už spomínali, model sa pre spojovaciu tabuľku nevytvára a kedže máme databázu správne navrhnutú, všetku potrebnú prácu v súvislosti so spojovacou tabuľkou vykoná Cake automaticky. Predtým, než začneme vytvárať samotné modely, treba poznamenať, že model sa pomenováva ako jednotné číslo názvu tabuľky, čiže napr. pre našu tabuľku articles sa bude model nazývať Article a bude umiestnený v súbore app/models/article.php

Model Article umiestený v súbore /app/models/article.php:

<?php
class Article extends AppModel {

        var $name = 'Article';
        var $useTable = 'articles';
        var $validate = array(
                'title' => VALID_NOT_EMPTY,
                'text' => VALID_NOT_EMPTY,
                'user_id' => array('numeric'),
                'created' => array('date')
        );

        var $belongsTo = array('User');
        var $hasAndBelongsToMany = array('Tag');
        var $hasMany = array('Comment');
}
?>

Model User umiestnený v súbore /app/models/user.php:

<?php
class User extends AppModel {

        var $name = 'User';
        var $useTable = 'users';
        var $validate = array(
                'username' => VALID_NOT_EMPTY,
                'password' => VALID_NOT_EMPTY
        );

        var $hasMany = array('Article');

}
?>

Model Comment umiestnený v súbore /app/models/comment.php:

<?php
class Comment extends AppModel {

        var $name = 'Comment';
        var $useTable = 'comments';
        var $validate = array(
                'title' => VALID_NOT_EMPTY,
                'text' => VALID_NOT_EMPTY,
                'username' => VALID_NOT_EMPTY,
                'article_id' => array('numeric')
        );

        var $belongsTo = array('Article');

}
?>

Model Tag umiestnený v súbore /app/models/tag.php:

<?php
class Tag extends AppModel {

        var $name = 'Tag';
        var $useTable = 'tags';
        var $validate = array(
                'name' => VALID_NOT_EMPTY,
                'seo_link' => VALID_NOT_EMPTY
        );

        var $hasAndBelongsToMany = array('Article');

}
?>

Ako môžeme vidieť vyššie, v kóde sme už uviedli aj validačné kritéria, ktoré sme si priblížili už v predchádzajúcej časti seriálu (podrobne sa im budeme venovať v niektorej z nasledujúcich častí). Využívať ich však budeme až v časti nasledujúcej, v ktorej sa budeme venovať vytváraniu zvyšných dvoch častí architektúry MVC, a to Controller a View.

Aby sme si mohli otestovať, či sme našu databázu skutočne navrhli správne, môžeme využiť tzv. scaffolding. Cake nám pomocou scaffolding dokáže na základe vytvorených modelov automaticky skonštruovať ukážkovú aplikáciu, pomocou ktorej môžeme otestovať, či nám väzby v našej tabuľke fungujú správne. Potrebujeme však ku každému modelu vytvoriť Controller, aby sme mohli určiť, že Cake má používať na vytvorenie aplikácie scaffolding (ako som už spomínal vyššie, controlleru sa budeme venovať v nasledujúcej časti, preto nám teraz stačí bez hlbšieho vysvetlenie skopírovať jednotlivé kódy do konkrétnych súborov s controllermi).

Controller Articles umiestnený v súbore /app/controllers/articles_controller.php:

<?php
class ArticlesController extends AppController {

        var $name = 'Articles';
        var $scaffold;
}
?>

Controller Users umiestnený v súbore /app/controllers/users_controller.php:

<?php
class UsersController extends AppController {

        var $name = 'Users';
        var $scaffold;
}
?>

Controller Comments umiestnený v súbore /app/controllers/comments_controller.php:

<?php
class CommentsController extends AppController {

        var $name = 'Comments';
        var $scaffold;
}
?>

Controller Tags umiestnený v súbore /app/controllers/tags_controller.php:

<?php
class TagsController extends AppController {

        var $name = 'Tags';
        var $scaffold;
}
?>

Skúste si zadať do url prehliadača napríklad adresy www.tvoja-adresa/articles, www.tvoja-adresa/comments alebo www.tvoja-adresa/users. Aké jednoduché však? Scaffolding je mocný nástroj tohto frameworku a dokáže nám značne uľahčiť prácu pri návrhu zložitejších vzťahov v databáze, preto určite stojí zato ho v ranom štádiu vývoja používať.

Záver

Týmto je náš náš návrh databázy kompletný a v budúcej časti seriálu sa bližšie pozrieme na zvyšné dve časti architektúry MVC a to konkrétne Controller a View.

       

Komentáře

[JoHnY2]

Chtel bych se zaptat zadrhej (pro me extremni) vetsiny MVC frameworku. Jak resit navrhy aplikaci nad existujicima databazema, se kterejma se neda hejbat. Vetsina MVC implementujicich nejakym zpusobem Model neni vubec schopna zit nad databazi, ktera se nedrzi jejich konvenci.

Jak je na tom Cake, pripadne nevite po jakym PHP frameworku bych se mel podiva ?

V blizky dobe si na me brousi zuby hromada staryho kodu, kterej bude potreba nad stavajicima databazema pretvorit na neco lepsiho nez HTML3.2 + PHP3.

[tatramat]

v $useTable nemusi byt nazvy tabulek danych konvenci. pak je take mozne $primaryKey='muj_primary_key' v has/belongs je tez mozno definovat vlastni foreignKey... koneckoncu, muzete si napsat vlastni VirtualModel a v nem si vse osetrit po svem a dalsi modely derivovat z Virtualu.

vice viz http://api.cakephp.org

[Daniel Kvasnička ml.]

Vyzkousej Propel. Sice konkretne schopnost reverzniho zkoumani existujici DB (http://propel.phpdb.org/trac/wiki/Users/Documentation/1.3/HowTos/ExistingDatabases) jsem u nej jeste nepouzil, ale jinak je to paradni ORM knihovna.

I kdyby reverzni nevyslo, muzes rucne napsat propelovske XML schema podle sve databaze. Propel te nijak omezovat nebude.

[alexovi]

"Predstavme si, že každý článok má svojho autora. Čiže budeme mať dve tabuľky a to articles a users"

Chcel by som poprosit autora aby si po sebe skontroloval co napise. Uz som si to vsimol aj v minulom clanku (v obrazkoch). Ano viem, ze si to mozem domysliet. ale je to zbytocne matuce.

[alexovi]

No pozeram, ze k tomu zmateniu u mna doslo. V minulej casti bola tabulka s autormi nazvana authors a z tabulky articles sa do nej odkazovala cez user_id (posledne 2 obrazky). V dnesnej casti uz sa aspon pouziva user konzistentne.

[Tibor Piňo]

Dakujem za upozornenie. Samozrejme to po sebe citam a taktiez to po mne cita vela ludi, ale zatial si to nikto nevsimol. Samozrejme sa to budem snazit opravit co najskor. Dakujem za pozorne citanie

[LJ]

Mám dvě otázky:

1. Jak by se soubory controlleru, modelu a view jmenovaly a jak by vypadaly, pokud bych chtěl ukládat do více tabulek najednou. Příklad: Formulář skladové příjemky s skládá z jedné hlavičky a n položek (jejich počet předem neznám) Samozřejmě se celá příjemka musí uložit v jediné transakci (nepoužívám MySQL ale Oracle) například do tabulek doklad_hlavicka (do té uložím data z hlavičky dokladu) a doklad_radek (do té uložím n záznamů s daty jednotlivých řádků dokladu). Můžete mi někdo naznačit, jak by tato struktura v cakePHP vypadala?

2. Co v případě, že vazební tabulka pro vazbu M:N neobsahuje pouze vazební klíče, ale i další informace o vazbě (naprosto běžná situace)

[tatramat]

mam jednu odpoved: co se trochu pidit? http://book.cakephp.org/view/66/models

[tatramatka]

a kdy se muzeme tesit na dalsi dil? mesic v cudu a kde nic tu nic...