[PDF] Créer des sites Web rapide avec CakePHP : La session de CakePHP et Request Handler | Cours informatique

(1)

Version 2.x

Cake Software Foundation

(2)

(3)

1 Pour Commencer 1

Tutoriel d’un Blog. . . 1

Blog Tutoriel - Ajouter la logique. . . 9

2 Installation 29 Conditions requises . . . 29 Licence . . . 30 Télécharger CakePHP . . . 30 Permissions . . . 30 Configuration . . . 30 Développement . . . 31 Production. . . 32

Installation avancée et URL Rewriting . . . 32

A vous de jouer ! . . . 35

3 Débuter avec CakePHP 37 Qu’est ce que CakePHP ? Pourquoi l’Utiliser ? . . . 37

Comprendre le système M-V-C (Model-View-Controller) . . . 38

Où obtenir de l’aide . . . 40

4 Controllers (Contrôleurs) 43 Le Controller App . . . 43

Les paramètres de requête. . . 44

Les Actions du Controller. . . 44

Request Life-cycle callbacks . . . 45

Les Méthodes du Controller. . . 46

Les attributs du Controller . . . 53

En savoir plus sur les controllers . . . 54

5 Views (Vues) 75 Templates de Vues . . . 75

Utiliser les Blocs de Vues . . . 77

Layouts . . . 79

Elements. . . 81

(4)

En savoir plus sur les vues . . . 86

6 Models (Modèles) 181 Comprendre les Models . . . 181

Pour en savoir plus sur les Models . . . 183

7 Librairies du Coeur 309 Usage Général . . . 309 Behaviors (Comportements) . . . 330 Components (Composants) . . . 330 Helpers (Assistants) . . . 380 Utilitaires . . . 380 8 Plugins 487 Comment Installer des Plugins . . . 487

Comment Utiliser des Plugins . . . 489

Comment Créer des Plugins . . . 490

9 Shells, Tasks & Outils de Console 497 La console de CakePHP. . . 497

Créer un Shell . . . 499

Les tâches Shell . . . 500

Invoquer d’autres shells à partir de votre shell . . . 501

Niveaux de sortie de la Console. . . 502

Style de sortie . . . 502

Configurer les options et générer de l’aide . . . 503

Routing dans shells / CLI . . . 510

API de Shell . . . 510 Plus de sujets . . . 513 10 Développement 533 Configuration . . . 533 Routing . . . 545 Sessions . . . 561 Exceptions. . . 567

Gestion des Erreurs . . . 573

Debugger . . . 575

Testing. . . 578

REST . . . 601

Filtres du Dispatcher . . . 605

11 Déploiement 609 Vérifier votre sécurité . . . 609

Définir le document root . . . 609

Mise à jour de core.php . . . 609

Améliorer les performances de votre application . . . 610

12 Authentification Simple et Autorisation de l’Application 611 Créer le code lié de tous les users . . . 611

Authentification (Connexion et Deconnexion) . . . 614

Autorisation (Qui est autorisé à accéder à quoi) . . . 616

(5)

Initialiser les tables Acl dans la BdD . . . 622

Agir comme un requêteur . . . 623

Créer les ACOs (Access Control Objects) . . . 624

14 Application Simple contrôlée par Acl - partie 2 627 Un outil automatique pour la création des ACOs . . . 627

Configurer les permissions . . . 628

Connexion . . . 629

Déconnexion . . . 630

C’est fini ! . . . 630

15 Tutoriels et exemples 631 Tutoriel d’un Blog. . . 631

Blog Tutoriel - Ajouter la logique. . . 634

16 Contribuer 647 Documentation . . . 647

Tickets . . . 655

Code . . . 655

Normes de codes . . . 657

Guide de Compatibilité Rétroactive. . . 668

Le processus de développement CakePHP . . . 670

17 Annexes 673 2.10 Guide de Migration . . . 673 2.9 Guide de Migration . . . 674 2.8 Guide de Migration . . . 675 2.7 Guide de Migration . . . 676 2.6 Guide de Migration . . . 678 2.5 Guide de Migration . . . 681 2.4 Guide de Migration . . . 686 2.3 Guide de Migration . . . 691 2.2 Guide de Migration . . . 697 2.1 Guide de Migration . . . 702 2.0 Guide de Migration . . . 712

Migration de la version 1.2 vers la 1.3 . . . 740

Informations générales . . . 756

18 Indices et tables 759

Index 761

(6)

(7)

Pour Commencer

Le framework CakePHP fournit une base robuste pour votre application. Il peut gérer tous les aspects, de la requête initiale de l’utilisateur et son cheminement jusqu’au rendu final de la page web. Et puisque le framework suit les principes du MVC, il vous permet de facilement personnaliser et offre la plupart des aspects de votre application. Le framework fournit aussi une structure organisationnelle basique, des noms de fichier jusqu’aux noms des tables de la base de données, en gardant toute votre application cohérente et logique. Ce concept est simple mais puissant. Suivez les conventions et vous saurez toujours exactement où les choses se trouvent et comment elles sont organisées. La meilleure façon de découvrir et d’apprendre CakePHP est de s’assoir et de construire quelque chose. Pour com-mencer, nous construirons une application simple de blog.

Tutoriel d’un Blog

Bienvenue sur CakePHP. Vous consultez probablement ce tutoriel parce que vous voulez en apprendre plus à propos du fonctionnement de CakePHP. C’est notre but d’améliorer la productivité et de rendre le développement plus agréable : nous espérons que vous le découvrirez au fur et à mesure que vous plongerez dans le code.

Ce tutoriel vous accompagnera à travers la création d’une simple application de blog. Nous récupérerons et installerons CakePHP, créerons et configurerons une base de données et ajouterons suffisamment de logique applicative pour lister, ajouter, éditer et supprimer des posts.

Voici ce dont vous aurez besoin :

1. Un serveur web fonctionnel. Nous supposerons que vous utilisez Apache, bien que les instructions pour utiliser d’autres serveurs doivent être assez semblables. Nous aurons peut-être besoin de jouer un peu sur la configu-ration du serveur, mais la plupart des personnes peuvent faire fonctionner CakePHP sans aucune configuconfigu-ration préalable.

2. Un serveur de base de données. Dans ce tutoriel, nous utiliserons MySQL. Vous aurez besoin d’un minimum de connaissance en SQL afin de créer une base de données : CakePHP prendra les rênes à partir de là. 3. Des connaissances de base en PHP. Plus vous aurez d’expérience en programmation orienté objet, mieux ce

sera ; mais n’ayez crainte, même si vous êtes adepte de la programmation procédurale.

(8)

4. Enfin, vous aurez besoin de connaissances de base à propos du motif de conception MVC. Un bref aperçu de ce motif dans le chapitreComprendre le système M-V-C (Model-View-Controller). Ne vous inquiétez pas : il n’y a qu’une demi-page de lecture.

Maintenant, lançons-nous !

Obtenir CakePHP

Tout d’abord, récupérons une copie récente de CakePHP.

Pour obtenir la dernière version, allez sur le site GitHub du projet CakePHP :https://github.com/cakephp/cakephp/tags et téléchargez la dernière version de la 2.0.

Vous pouvez aussi cloner le dépôt en utilisantgit4_:

git clone -b 2.x git://github.com/cakephp/cakephp.git

Peu importe comment vous l’avez téléchargé, placez le code à l’intérieur du « DocumentRoot » de votre serveur. Une fois terminé, votre répertoire d’installation devrait ressembler à quelque chose comme cela :

/chemin_du_document_root /app /lib /plugins /vendors .htaccess index.php README

A présent, il est peut-être temps de voir un peu comment fonctionne la structure de fichiers de CakePHP : lisez le chapitreStructure du dossier de CakePHP.

Permissions du répertoire Tmp

Ensuite vous devrez mettre le répertoire app/tmp en écriture pour le serveur web. La meilleur façon de le faire est de trouver sous quel utilisateur votre serveur web tourne. Vous pouver mettre <?php echo exec('whoami'); ?>à l’intérieur de tout fichier PHP que votre serveur web execute. Vous devriez voir afficher un nom d’utilisateur. Changez le possesseur du répertoire app/tmp pour cet utilisateur. La commande finale que vous pouvez lancer (dans *nix) pourrait ressembler à ceci :

$ chown -R www-data app/tmp

Si pour une raison ou une autre, CakePHP ne peut écrire dans ce répertoire, vous verrez des avertissements et des exceptions attrapées vous disant que les données de cache n’ont pas pu être écrites.

Créer la base de données du blog

Maintenant, mettons en place la base de données pour notre blog. Si vous ne l’avez pas déjà fait, créez une base de données vide avec le nom de votre choix pour l’utiliser dans ce tutoriel. Pour le moment, nous allons juste créer une simple table pour stocker nos posts. Nous allons également insérer quelques posts à des fins de tests. Exécutez les requêtes SQL suivantes dans votre base de données :

(9)

/* D'abord, créons la table des posts : */ CREATE TABLE posts (

id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY, title VARCHAR(50),

body TEXT,

created DATETIME DEFAULT NULL, modified DATETIME DEFAULT NULL );

/* Puis insérons quelques posts pour les tests : */ INSERT INTO posts (title, body, created)

VALUES ('Le titre', 'Voici le contenu du post.', NOW()); INSERT INTO posts (title, body, created)

VALUES ('Encore un titre', 'Et le contenu du post qui suit.', NOW()); INSERT INTO posts (title, body, created)

VALUES ('Le retour du titre', 'C\'est très excitant, non ?', NOW());

Le choix des noms pour les tables et les colonnes ne sont pas arbitraires. Si vous respectez les conventions de nommage de CakePHP pour les bases de données et les classes (toutes deux expliquées au chapitreConventions de CakePHP), vous tirerez profit d’un grand nombre de fonctionnalités automatiques et vous éviterez des étapes de configurations. CakePHP est suffisamment souple pour implémenter les pires schémas de bases de données, mais respecter les conven-tions vous fera gagner du temps.

Consultez le chapitreConventions de CakePHPpour plus d’informations, mais il suffit de comprendre que nommer notre table “posts” permet de la relier automatiquement à notre model Post, et qu’avoir des champs “modified” et “created” permet de les avoir gérés automagiquement par CakePHP.

Configurer la base de données CakePHP

En avant : indiquons à CakePHP où se trouve notre base de données et comment s’y connecter. Pour la plupart d’entre vous, c’est la première et dernière fois que vous configurerez quelque chose.

Une copie du fichier de configuration CakePHP pour la base de données se trouve dans /app/Config/database. php.default. Faites une copie de ce fichier dans le même répertoire mais nommez le database.php.

Le fichier de configuration devrait être assez simple : remplacez simplement les valeurs du tableau $default par celles qui correspondent à votre installation. Un exemple de tableau de configuration complet pourrait ressembler à ce qui suit :

public $default = array(

'datasource' => 'Database/Mysql', 'persistent' => false, 'host' => 'localhost', 'port' => '', 'login' => 'cakeBlog', 'password' => 'c4k3-rUl3Z', 'database' => 'cake_blog_tutorial', 'schema' => '', 'prefix' => '', 'encoding' => 'utf8' );

Une fois votre nouveau fichier database.php sauvegardé, vous devriez être en mesure d’ouvrir votre navigateur internet et de voir la page d’accueil de CakePHP. Elle devrait également vous indiquer que votre fichier de connexion a été trouvé, et que CakePHP peut s’y connecter avec succès.

(10)

Note : Rappelez-vous que vous aurez besoin d’avoir PDO, et pdo_mysql activés dans votre php.ini.

Configuration facultative

Il y a quelques autres éléments qui peuvent être configurés. La plupart des développeurs configurent les éléments de cette petite liste, mais ils ne sont pas obligatoires pour ce tutoriel. Le premier consiste à définir une chaîne de caractères personnalisée (ou « grain de sel ») afin de sécuriser les hashs. Le second consiste à définir un nombre personnalisé (ou « graine ») à utiliser pour le chiffrage.

Le « grain de sel » est utilisé pour générer des hashes. Changez la valeur par défaut de Security.salt dans / app/Config/core.phpà la ligne 187. La valeur de remplacement doit être longue, difficile à deviner et aussi aléatoire que possible :

/**

* Une chaîne aléatoire utilisée dans les méthodes de hachage sécurisées. */

Configure::write('Security.salt', _{'pl345e-P45s_7h3*S@l7!'});

La « graine cipher » est utilisée pour le chiffrage/déchiffrage des chaînes de caractères. Changez la valeur par défaut de Security.cipherSeeddans /app/Config/core.php à la ligne 192. La valeur de remplacement doit être un grand nombre entier aléatoire :

/**

* Une chaîne aléatoire de chiffre utilisée pour le chiffrage/déchiffrage * des chaînes de caractères.

*/

Configure::write('Security.cipherSeed', '7485712659625147843639846751');

Une note sur mod_rewrite

Occasionnellement, les nouveaux utilisateurs peuvent avoir des problèmes de mod_rewrite. Par exemple si la page d’accueil de CakePHP a l’air bizarre (pas d’images ou de styles CSS), cela signifie probablement que mod_rewrite ne fonctionne pas sur votre système. Merci de vous référer à la section suivante sur l’URL rewriting pour que votre serveur web fonctionne :

URL Rewriting

Apache et mod_rewrite (et .htaccess)

Alors que CakePHP est construit pour travailler avec mod_rewrite –et habituellement il l’est– nous avons remarqué que certains utilisateurs se battent pour obtenir un bon fonctionnement sur leurs systèmes.

Ici il y a quelques trucs que vous pourriez essayer pour que cela fonctionne correctement. Premièrement, regardez votre fichier httpd.conf (Assurez-vous que vous avez édité le httpd.conf du système plutôt que celui d’un utilisateur-ou le httpd.conf d’un site spécifique).

Ces fichiers peuvent varier selon les différentes distributions et les versions d’Apache. Vous pouvez allez voirhttp: //wiki.apache.org/httpd/DistrosDefaultLayoutpour plus d’informations.

1. Assurez-vous qu’un .htaccess est permis et que AllowOverride est défini à All pour le bon DocumentRoot. Vous devriez voir quelque chose comme :

(11)

# Chaque répertoire auquel Apache a accès peut être configuré avec # respect pour lesquels les services et les fonctionnalités sont

# autorisés et/ou désactivés dans ce répertoire (et ses sous-répertoires). #

# Premièrement, nous configurons "par défault" pour être un ensemble # très restrictif de fonctionnalités. # <Directory /> Options FollowSymLinks AllowOverride All # Order deny,allow # Deny from all

</Directory>

Pour les utilisateurs qui ont apache 2.4 et supérieur, vous devez modifier le fichier de configuration pour votre httpd.confou la configuration de l’hôte virtuel pour ressembler à ce qui suit :

Options FollowSymLinks AllowOverride All Require all granted

</Directory>

2. Assurez-vous que vous avez chargé correctement mod_rewrite. Vous devriez voir quelque chose comme : LoadModule rewrite_module libexec/apache2/mod_rewrite.so

Dans la plupart des systèmes, ceux-ci vont être commentés donc vous aurez juste besoin de retirer les symboles # en début de ligne.

Après que vous avez fait des changements, re-démarrez Apache pour être sûr que les paramètres soient actifs. Vérifiez que vos fichiers .htaccess sont effectivement dans le bon répertoire.

Cela peut arriver pendant la copie parce que certains systèmes d’exploitation traitent les fichiers qui com-mencent par “.” en caché et du coup ne les voient pas pour les copier.

3. Assurez-vous que votre copie de CakePHP vient de la section des téléchargements du site de notre dépôt Git, et a été dézippé correctement en vérifiant les fichiers .htaccess.

Le répertoire root de CakePHP (a besoin d’être copié dans votre document, cela redirige tout vers votre app CakePHP) :

RewriteEngine on

RewriteRule ^$ app/webroot/ [L] RewriteRule (_.*) app/webroot/$1 [L]

</IfModule>

Le répertoire app de CakePHP (sera copié dans le répertoire supérieur de votre application avec Bake) :

RewriteEngine on

RewriteRule ^$ webroot/ [L] RewriteRule (_.*) webroot/$1 [L]

</IfModule>

Le répertoire webroot de CakePHP (sera copié dans le webroot de votre application avec Bake) :

RewriteEngine On

RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-f

(12)

RewriteRule ^(_.*)$ index.php/$1 [QSA,L]

</IfModule>

Si votre site CakePHP a toujours des problèmes avec mod_rewrite, essayez de modifier les paramètres pour les Hôtes Virtuels. Si vous êtes sur Ubuntu, modifiez le fichier /etc/apache2/sites-available/default (l’endroit dépend de la distribution). Dans ce fichier, assurez-vous que AllowOverride None a été changé en AllowOverride All, donc vous devez avoir :

Options FollowSymLinks AllowOverride All

</Directory>

Options Indexes FollowSymLinks MultiViews AllowOverride All

Order Allow,Deny Allow from all

</Directory>

Si vous êtes sur Mac OSX, une autre solution est d’utiliser l’outilvirtualhostx5_{pour faire un Hôte Virtuel pour} pointer vers votre dossier.

Pour beaucoup de services d’hébergement (GoDaddy, 1and1), votre serveur web est en fait déjà distribué à par-tir d’un répertoire utilisateur qui utilise déjà mod_rewrite. Si vous installez CakePHP dans un répertoire utili-sateur (http://exemple.com/~username/cakephp/), ou toute autre structure d’URL qui utilise déjà mod_rewrite, vous aurez besoin d’ajouter les requêtes (statements) RewriteBase aux fichiers .htaccess que CakePHP utilise (/.htaccess, /app/.htaccess, /app/webroot/.htaccess).

Ceci peut être ajouté dans la même section que la directive RewriteEngine, donc par exemple, votre fichier .htaccess dans webroot ressemblerait à ceci :

RewriteEngine On

RewriteBase /path/to/cake/app RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-f RewriteRule ^(_.*)$ index.php/$1 [QSA,L]

</IfModule>

Les détails de ces changements dépendront de votre configuration, et pourront inclure des choses supplémen-taires qui ne sont pas liées à CakePHP. Merci de vous renseigner sur la documentation en ligne d’Apache pour plus d’informations.

4. (Optionel) Pour améliorer la configuration de production, vous devriez empêcher les assets invalides d’être parsés par CakePHP. Modifiez votre webroot .htaccess pour quelque chose comme :

RewriteEngine On

RewriteBase /path/to/cake/app RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-f

RewriteCond %{REQUEST_URI} !^/(app/webroot/)?(img|css|js)/(_.*)$ RewriteRule ^(_.*)$ index.php [QSA,L]

</IfModule>

Ce qui est au-dessus va simplement empêcher les assets incorrects d’être envoyés à index.php et à la place d’afficher la page 404 de votre serveur web.

De plus, vous pouvez créer une page HTML 404 correspondante, ou utiliser la page 404 de CakePHP intégrée en ajoutant une directive ErrorDocument :

(13)

ErrorDocument 404 /404-not-found

De belles URLs sur nginx

nginx ne fait pas usage de fichiers .htaccess comme Apache et Lighttpd, il est donc nécessaire de créer les URLs réécrites disponibles dans la configuration du site. selon votre configuration, vous devrez modifier cela, mais à tout le moins, vous aurez besoin de PHP fonctionnant comme une instance FastCGI.

server {

listen 80;

server_name www.example.com;

rewrite ^(_.*) http://example.com$1 permanent; }

server {

listen 80;

server_name example.com;

# root directive should be global

root /var/www/example.com/public/app/webroot/; index index.php;

access_log /var/www/example.com/log/access.log;

error_log /var/www/example.com/log/error.log; location / {

try_files $uri $uri/ /index.php?$args; }

location ~ \.php$ {

include /etc/nginx/fastcgi_params; try_files $uri =404;

fastcgi_pass 127.0.0.1:9000; fastcgi_index index.php;

fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; }

}

Si pour une raison exotique vous ne pouvez pas changer votre répertoire racine et devez lancer votre projet à partir d’un sous-dossier comme example.com/subfolder/, vous devrez injecter « /webroot » dans chaque requête.

location ~ ^/(subfolder)/(_.*)? { index index.php;

set $new_uri /$1/webroot/$2;

try_files $new_uri $new_uri/ /$1/index.php?$args;

... php handling ...

}

Note : Les récentes configurations de PHP-FPM sont définies pour écouter sur le socket php-fpm au lieu du port TCP 9000 sur l’adresse 127.0.0.1. Si vous obtenez une erreur 502 de mauvaise passerelle avec la configuration du dessus, essayez de remplacer le port TCP du fastcgi_pass par le chemin du socket (ex : fastcgi_pass unix

(14)

fpm.sock ;).

Rewrites d’URL sur IIS7 (serveurs Windows)

IIS7 ne supporte pas nativement les fichiers .htaccess. Bien qu’il existe des add-ons qui peuvent ajouter ce support, vous pouvez aussi importer les règles des .htaccess dans IIS pour utiliser les rewrites natifs de CakePHP. Pour ce faire, suivez ces étapes :

1. Utilisezl’installeur de la plateforme Web de Microsoft6 pour installer l’URLRewrite Module 2.07 ou télé-chargez le directement (32-bit8/64-bit9).

2. Créez un nouveau fichier dans votre dossier CakePHP, appelé web.config.

3. Utilisez Notepad ou tout autre éditeur XML-safe, copiez le code suivant dans votre nouveau fichier web.config. . . <?xml version="1.0" encoding="UTF-8"?> <configuration> <system.webServer> <rewrite> <rules>

<rule name="Rewrite requests to test.php" stopProcessing="true">

<match _{url="^test.php(.*)$" ignoreCase="false"} />

<action type="Rewrite" url="app/webroot/test.php{R:1}" /> </rule>

<rule _{name="Exclude direct access to app/webroot/*"}

stopProcessing="true">

<match _{url="^app/webroot/(.*)$" ignoreCase="false"} /> <action type="None" />

</rule>

<rule name="Rewrite routed access to assets(img, css, files, js,

˓→favicon)"

stopProcessing="true">

<match _{url="^(img|css|files|js|favicon.ico)(.*)$"} /> <action type="Rewrite" url="app/webroot/{R:1}{R:2}"

appendQueryString="false" /> </rule>

<rule name="Rewrite requested file/folder to index.php" stopProcessing="true">

<match _{url="^(.*)$" ignoreCase="false"} /> <action type="Rewrite" url="index.php"

appendQueryString="true" /> </rule> </rules> </rewrite> </system.webServer> </configuration>

Une fois que le fichier web.config est créé avec les bonnes règles de réécriture des liens de IIS, les liens CakePHP, les CSS, le JavaScript, et le reroutage devraient fonctionner correctement.

6. http://www.microsoft.com/web/downloads/platform.aspx 7. http://www.iis.net/downloads/microsoft/url-rewrite

8. http://www.microsoft.com/en-us/download/details.aspx?id=5747 9. http://www.microsoft.com/en-us/download/details.aspx?id=7435

(15)

URL-Rewriting sur lighttpd

Lighttpd ne supporte pas les fonctions .htaccess, par conséquent vous pouvez retirer tous les fichiers .htaccess. Dans la configuration lighttpd, assurez-vous d’activer « mod_rewrite ». Ajoutez une ligne :

url.rewrite-if-not-file =(

"^([^\?]*)(\?(.+))?$" => "/index.php?url=$1&$3"

)

Règles de rewrite URL pour Hiawatha

La règle nécessaire UrlToolkit (pour le rewriting URL) pour utiliser CakePHP avec Hiawatha est : UrlToolkit {

ToolkitID = cakephp RequestURI exists Return Match _.* Rewrite /index.php }

Je ne veux / ne peux utiliser l’URL rewriting

Si vous ne voulez ou ne pouvez pas utiliser l’URL rewriting sur votre serveur web, référez-vous à la sectioncore configuration.

Maintenant continuez surBlog Tutoriel - Ajouter la logiquepour commencer à construire votre première application CakePHP.

Blog Tutoriel - Ajouter la logique

Créer un model Post

La classe Model est le pain quotidien des applications CakePHP. En créant un model CakePHP qui interagira avec notre base de données, nous aurons mis en place les fondations nécessaires pour faire plus tard nos opérations de lecture, d’insertion, d’édition et de suppression.

Les fichiers des classes Model de CakePHP se trouvent dans /app/Model, et le fichier que nous allons créer main-tenant sera enregistré dans /app/Model/Post.php. Le fichier complet devrait ressembler à ceci :

class Post extends AppModel { }

La convention de nommage est vraiment très importante dans CakePHP. En nommant notre model Post, CakePHP peut automatiquement déduire que ce model sera utilisé dans le controller PostsController, et sera lié à la table posts de la base de données.

Note : CakePHP créera dynamiquement un objet model pour vous, s’il ne trouve pas le fichier correspondant dans /app/Model. Cela veut aussi dire que si vous n’avez pas nommé correctement votre fichier (par ex. post.php ou posts.php au lieu de Post.php), CakePHP ne reconnaîtra pas votre configuration et utilisera ses objets model par défaut.

(16)

Pour plus d’informations sur les models, comme les préfixes des tables, les callbacks, et la validation, consultez le chapitreModels (Modèles)du manuel.

Créer un controller Posts

Nous allons maintenant créer un controller pour nos posts. Le controller est l’endroit où s’exécutera toute la logique métier pour l’intéraction du processus de post. En un mot, c’est l’endroit où vous jouerez avec les models et où les tâches liées aux posts s’exécutent. Nous placerons ce nouveau controller dans un fichier appelé PostsController. phpà l’intérieur du dossier /app/Controller. Voici à quoi devrait ressembler le controller de base :

class PostsController extends AppController { public $helpers = array('Html', 'Form'); }

Maintenant, ajoutons une action à notre controller. Les actions représentent souvent une simple fonction ou une in-terface dans une application. Par exemple, quand les utilisateurs requêtent www.exemple.com/posts/index (qui est la même chose que www.exemple.com/posts/), ils pourraient s’attendre à voir une liste de posts. Le code pour cette action devrait ressembler à quelque chose comme ça :

class PostsController extends AppController { public $helpers = array('Html', 'Form'); public function index() {

$this->set('posts', $this->Post->find('all')); }

}

En définissant la fonction index() dans notre PostsController, les utilisateurs peuvent accéder à cette logique en de-mandant www.exemple.com/posts/index. De la même façon, si nous devions définir une fonction appelée foobar(), les utilisateurs pourrait y accéder en demandant www.exemple.com/posts/foobar.

Avertissement : Vous pourriez être tenté de nommer vos controllers et vos actions d’une certaine manière pour obtenir une certaine URL. Résistez à cette tentation. Suivez les conventions CakePHP (le nom des controllers au pluriel, etc.) et nommez vos actions de façon lisible et compréhensible. Vous pouvez lier les URLs à votre code en utilisant ce qu’on appelle des « routes », on le verra plus tard.

La seule instruction que cette action utilise est set(), pour transmettre les données du controller à la vue (que nous créerons à la prochaine étape). La ligne définit la variable de vue appelée “posts” qui est égale à la valeur de retour de la méthode find('all') du model Post. Notre model Post est automatiquement disponible via $this->Post, parce que nous avons suivi les conventions de nommage de CakePHP.

Pour en apprendre plus sur les controllers de CakePHP, consultez le chapitreControllers (Contrôleurs).

Créer les Vues des Posts

Maintenant que nous avons nos données en provenance du model, ainsi que la logique applicative et les flux définis par notre controller, nous allons créer une vue pour l’action « index » que nous avons créé ci-dessus.

Les vues de CakePHP sont juste des fragments de présentation « assaisonnée », qui s’intègrent au sein d’un layout applicatif. Pour la plupart des applications, elles sont un mélange de HTML et PHP, mais les vues peuvent aussi être constituées de XML, CSV ou même de données binaires.

Un Layout est un code de présentation, encapsulé autour d’une vue. Ils peuvent être définis et interchangés, mais pour le moment, utilisons juste celui par défaut.

(17)

Vous souvenez-vous, dans la dernière section, comment nous avions assigné la variable “posts” à la vue en utilisant la méthode set() ? Cela devrait transmettre les données à la vue qui ressemblerait à quelque chose comme cela : // print_r($posts) affiche: Array ( [0] => Array ( [Post] => Array ( [id] => 1 [title] => Le titre

[body] => Voici le contenu du post.

[created] => 2008-02-13 18:34:55 [modified] => ) ) [1] => Array ( [Post] => Array ( [id] => 2

[title] => Encore un titre

[body] => Et le contenu du post qui suit.

[created] => 2008-02-13 18:34:56 [modified] => ) ) [2] => Array ( [Post] => Array ( [id] => 3

[title] => Le retour du titre

[body] => C'est très excitant, non ?

[created] => 2008-02-13 18:34:57 [modified] =>

) )

)

Les fichiers des vues de CakePHP sont stockés dans /app/View à l’intérieur d’un dossier dont le nom correspond à celui du controller (nous aurons à créer un dossier appelé “Posts” dans ce cas). Pour mettre en forme les données de ces posts dans un joli tableau, le code de notre vue devrait ressembler à quelque chose comme cela

<h1>Blog posts</h1> <table> <tr> <th>Id</th> <th>Titre</th> <th>Créé le</th> </tr>

(18)

<?php foreach ($posts as $post): ?>

<tr>

<?php echo $this->Html->link($post['Post']['title'],

array('controller' => 'posts', 'action' => 'view', $post['Post']['id']));

˓→?>

</td>

<?php endforeach; ?> <?php unset($post); ?>

</table>

Vous avez sans doute remarqué l’utilisation d’un objet appelé $this->Html. C’est une instance de la classe

Cake-PHPHtmlHelper. CakePHP est livré avec un ensemble de « helpers » (des assistants) pour les vues, qui réalisent en

un clin d’œil des choses comme le « linking » (mettre les liens dans un texte), l’affichage des formulaires, du JavaS-cript et de l’AJAX. Vous pouvez en apprendre plus sur la manière de les utiliser dans le chapitreHelpers (Assistants), mais ce qu’il est important de noter ici, c’est que la méthode link() génèrera un lien HTML à partir d’un titre (le premier paramètre) et d’une URL (le second paramètre).

Lorsque vous indiquez des URLs dans CakePHP, il est recommandé d’utiliser les tableaux. Ceci est expliqué dans le chapitre des Routes. Utiliser les tableaux dans les URLs vous permet de tirer profit des capacités de CakePHP à ré-inverser les routes. Vous pouvez aussi utiliser les URLs relatives depuis la base de l’application comme suit /controller/action/param1/param2.

A ce stade, vous devriez être en mesure de pointer votre navigateur sur la pagehttp://www.exemple.com/posts/index. Vous devriez voir votre vue, correctement formatée avec le titre et le tableau listant les posts.

Si vous avez essayé de cliquer sur l’un des liens que nous avons créés dans cette vue (le lien sur le titre d’un post mène à l’URL : /posts/view/un_id_quelconque), vous avez sûrement été informé par CakePHP que l’action n’a pas encore été définie. Si vous n’avez pas été informé, soit quelque chose s’est mal passé, soit en fait vous aviez déjà défini l’action, auquel cas vous êtes vraiment sournois ! Sinon, nous allons la créer sans plus tarder dans le Controller Posts : // File: /app/Controller/PostsController.php

class PostsController extends AppController { public $helpers = array('Html', 'Form'); public function index() {

public function view($id = null) { if (!$id) {

throw new NotFoundException(__('Invalid post')); }

$post = $this->Post->findById($id); if (!$post) {

$this->set('post', $post); }

}

L’appel de set() devrait vous être familier. Notez que nous utilisons findById() plutôt que find('all') parce que nous voulons seulement récupérer les informations d’un seul post.

(19)

Notez que notre action « view » prend un paramètre : l’ID du post que nous aimerions voir. Ce paramètre est transmis à l’action grâce à l’URL demandée. Si un utilisateur demande /posts/view/3, alors la valeur “3” est transmise à la variable $id.

Nous faisons aussi une petite vérification d’erreurs pour nous assurer qu’un utilisateur accède bien à l’enregsitrement. Si un utilisateur requête /posts/view, nous lancerons un NotFoundException et laisserons le Gestionnaire d’Erreur de CakePHP ErrorHandler prendre le dessus. Nous exécutons aussi une vérification similaire pour nous assurer que l’utilisateur a accède à un enregistrement qui existe.

Maintenant, créons la vue pour notre nouvelle action « view » et plaçons-la dans /app/View/Posts/view.ctp.

Vérifiez que cela fonctionne en testant les liens de la page /posts/index ou en affichant manuellement un post via /posts/view/1.

Ajouter des Posts

Lire depuis la base de données et nous afficher les posts est un bon début, mais lançons-nous dans l’ajout de nouveaux posts.

Premièrement, commençons par créer une action add() dans le PostsController : class PostsController extends AppController {

public $helpers = array('Html', 'Form', 'Flash'); public $components = array('Flash');

public function index() {

public function view($id) { if (!$id) {

$this->set('post', $post); }

public function add() {

if ($this->request->is('post')) {

$this->Post->create();

if ($this->Post->save($this->request->data)) {

$this->Flash->success(__('Your post has been saved.')); return $this->redirect(array('action' => 'index')); }

$this->Flash->error(__('Unable to add your post.')); }

(20)

} }

Note : $this->request->is() prend un unique argument, qui peut être la METHOD request (get, put, post, delete) ou toute identifier de request (ajax). Ce n’est pas une façon de vérifier une data postée spécifique. Par exemple, $this->request->is('book') ne retournera pas true si les data du book ont été postées.

Note : Vous avez besoin d’inclure le component Flash (FlashComponent) et le helper Flash (FlashHelper) dans chaque controller que vous utiliserez. Si nécessaire, incluez-les dans le controller principal (AppController) pour qu’ils soient accessibles à tous les controllers.

Voici ce que fait l’action add() : si la requête HTTP est de type POST, essayez de sauvegarder les données en utilisant le model « Post ». Si pour une raison quelconque, la sauvegarde a échouée, affichez simplement la vue. Cela nous donne une chance de voir les erreurs de validation de l’utilisateur et d’autres avertissements.

Chaque requête de CakePHP contient un objet CakeRequest qui est accessible en utilisant $this->request. Cet objet contient des informations utiles sur la requête qui vient d’être reçue, et permet de contrôler les flux de votre application. Dans ce cas, nous utilisons la méthodeCakeRequest::is()pour vérifier que la requête est de type POST.

Lorsqu’un utilisateur utilise un formulaire pour poster des données dans votre application, ces informations sont dis-ponibles dans $this->request->data. Vous pouvez utiliser les fonctionspr()oudebug()pour les afficher si vous voulez voir à quoi cela ressemble.

Nous utilisons la méthode FlashComponent::success() du component Flash (FlashComponent) pour défi-nir un message dans une variable session et qui sera affiché dans la page juste après la redirection. Dans le layout, nous trouvons la fonction FlashHelper::render() qui permet d’afficher et de nettoyer la variable correspon-dante. La méthodeController::redirectdu controller permet de rediriger vers une autre URL. Le paramètre array('action' => 'index')sera traduit vers l’URL /posts (dans notre cas l’action « index » du controller « Posts »). Vous pouvez vous référer à la fonctionRouter::url()dansl’API10_{pour voir les différents formats} d’URL acceptés dans les différentes fonctions de CakePHP.

L’appel de la méthode save() vérifiera les erreurs de validation et interrompra l’enregistrement si une erreur survient. Nous verrons la façon dont les erreurs sont traitées dans les sections suivantes.

Nous appelons la méthode create() en premier afin de réinitialiser l’état du model pour sauvegarder les nouvelles informations. Cela ne crée pas réellement un enregistrement dans la base de données mais réinitialise Model : :$id et définit Model : :$data en se basant sur le champ par défaut dans votre base de données.

Valider les données

Cake place la barre très haute pour briser la monotonie de la validation des champs de formulaires. Tout le monde déteste le dévelopement de formulaires interminables et leurs routines de validations. Cake rend tout cela plus facile et plus rapide.

Pour tirer profit des fonctionnalités de validation, vous devez utiliser le helper « Form » (FormHelper) dans vos vues.

FormHelperest disponible par défaut dans toutes les vues avec la variables $this->Form.

Voici le code de notre vue « add » (ajout)

(21)

<h1>Ajouter un post</h1>

<?php

echo $this->Form->create('Post'); echo $this->Form->input('title');

echo $this->Form->input('body', array('rows' => '3')); echo $this->Form->end('Sauvegarder le post');

?>

Nous utilisons leFormHelperpour générer la balise d’ouverture d’une formulaire HTML. Voici le code HTML généré par $this->Form->create() :

.. code-block:: html

Si create() est appelée sans aucun paramètre, CakePHP suppose que vous construisez un formulaire qui envoie les données en POST à l’action add() (ou edit() quand id est dans les données du formulaire) du controller actuel. La méthode $this->Form->input() est utilisée pour créer des éléments de formulaire du même nom. Le premier paramètre dit à CakePHP à quels champs ils correspondent et le second paramètre vous permet de spécifier un large éventail d’options - dans ce cas, le nombre de lignes du textarea. Il y a un peu d’introspection et « d’automagie » ici : input()affichera différents éléments de formulaire selon le champ spécifié du model.

L’appel de la méthode $this->Form->end() génère un bouton de soumission et ajoute la balise de fermeture du formulaire. Si une chaîne de caractères est passée comme premier paramètre de la méthode end(), le helper « Form » affichera un bouton de soumission dont le nom correspond à celle-ci. Encore une fois, référez-vous au chapitreHelpers (Assistants)pour en savoir plus sur les helpers.

A présent, revenons en arrière et modifions notre vue /app/View/Posts/index.ctp pour ajouter un lien « Ajouter un post ». Ajoutez la ligne suivante avant <table> :

<?php echo $this->Html->link(

'Ajouter un Post',

array('controller' => 'posts', 'action' => 'add') ); ?>

Vous vous demandez peut-être : comment je fais pour indiquer à CakePHP mes exigences de validation ? Les règles de validation sont définies dans le model. Retournons donc à notre model Post et procédons à quelques ajustements : class Post extends AppModel {

public $validate = array(

'title' => array( 'rule' => 'notBlank' ), 'body' => array( 'rule' => 'notBlank' ) ); }

Le tableau $validate indique à CakePHP comment valider vos données lorsque la méthode save() est appelée. Ici, j’ai spécifié que les deux champs « body » et « title » ne doivent pas être vides. Le moteur de validation de CakePHP est puissant, il dispose d’un certain nombre de règles intégrées (code de carte bancaire, adresse emails, etc.) et d’une souplesse pour ajouter vos propres règles de validation. Pour plus d’informations sur cette configuration, consultez le chapitreValidation des Données.

(22)

Maintenant que vos règles de validation sont en place, utilisez l’application pour essayer d’ajouter un post avec un titre et un contenu vide afin de voir comment cela fonctionne. Puisque que nous avons utilisé la méthode

FormHelper::input()du helper « Form » pour créer nos éléments de formulaire, nos messages d’erreurs de

validation seront affichés automatiquement.

Editer des Posts

L’édition de posts : nous y voilà. Vous êtes un pro de CakePHP maintenant, vous devriez donc avoir adopté le prin-cipe. Créez d’abord l’action puis la vue. Voici à quoi l’action edit() du controller Posts (PostsController) devrait ressembler :

public function edit($id = null) { if (!$id) {

if ($this->request->is(array('post', 'put'))) {

$this->Post->id = $id;

if ($this->Post->save($this->request->data)) {

$this->Flash->success(__('Your post has been updated.')); return $this->redirect(array('action' => 'index')); }

$this->Flash->error(__('Unable to update your post.')); }

if (!$this->request->data) {

$this->request->data = $post; }

}

Cette action s’assure d’abord que l’utilisateur a essayé d’accéder à un enregistrement existant. S’il n’y a pas de pa-ramètre $id passé, ou si le post n’existe pas, nous lançons une NotFoundException pour que le gestionnaire d’Erreurs ErrorHandler de CakePHP s’en occupe.

Ensuite l’action vérifie si la requête est une requête POST ou PUT. Si elle l’est, alors nous utilisons les données POST pour mettre à jour notre enregistrement Post, ou sortir et montrer les erreurs de validation à l’utilisateur.

S’il n’y a pas de données définies dans $this->request->data, nous le définissons simplement dans le post récupéré précédemment.

La vue d’édition devrait ressembler à quelque chose comme cela :

<h1>Editer le post</h1>

<?php

echo $this->Form->create('Post'); echo $this->Form->input('title');

echo $this->Form->input('body', array('rows' => '3')); echo $this->Form->input('id', array('type' => 'hidden')); echo $this->Form->end('Save Post');

(23)

Cette vue affiche le formulaire d’édition (avec les données pré-remplies) avec les messages d’erreur de validation nécessaires.

Une chose à noter ici : CakePHP supposera que vous éditez un model si le champ “id” est présent dans le tableau de données. S’il n’est pas présent (ce qui revient à notre vue « add »), CakePHP supposera que vous insérez un nouveau model lorsque save() sera appelée.

Vous pouvez maintenant mettre à jour votre vue « index » avec des liens pour éditer des posts :

<h1>Blog posts</h1>

<p><?php echo $this->Html->link("Ajouter un Post", array('action' => 'add')); ?></p> <table> <tr> <th>Id</th> <th>Title</th> <th>Action</th> <th>Created</th> </tr>

<! Ici se trouve la boucle de notre tableau $posts, impression de l\'info du post

--˓→>

<tr>

<?php echo $this->Html->link(

$post['Post']['title'],

array('action' => 'view', $post['Post']['id']) ); ?>

</td> <td>

'Editer',

array('action' => 'edit', $post['Post']['id']) ); ?>

</td> <td>

<?php echo $post['Post']['created']; ?>

</td> </tr>

<?php endforeach; ?>

</table>

Supprimer des Posts

A présent, mettons en place un moyen de supprimer les posts pour les utilisateurs. Démarrons avec une action delete()dans le controller Posts (PostsController) :

public function delete($id) {

if ($this->request->is('get')) {

throw new MethodNotAllowedException(); }

(24)

if ($this->Post->delete($id)) {

$this->Flash->success(

__('Le post avec id : %s a été supprimé.', h($id)) );

} else {

$this->Flash->error(

__('Le post avec l\'id: %s n\'a pas pu être supprimé.', h($id)) );

}

return $this->redirect(array('action' => 'index')); }

Cette logique supprime le Post spécifié par $id, et utilise $this->Flash->success() pour afficher à l’utilisateur un message de confirmation après l’avoir redirigé sur /posts. Si l’utilisateur tente une suppression en utilisant une requête GET, une exception est levée. Les exceptions manquées sont capturées par le gestionnaire d’exceptions de CakePHP et un joli message d’erreur est affiché. Il y a plusieursExceptionsintégrées qui peuvent être utilisées pour indiquer les différentes erreurs HTTP que votre application pourrait rencontrer.

Etant donné que nous exécutons juste un peu de logique et de redirection, cette action n’a pas de vue. Vous voudrez peut-être mettre à jour votre vue « index » avec des liens pour permettre aux utilisateurs de supprimer des Posts, ainsi :

<h1>Blog posts</h1>

<p><?php echo $this->Html->link(

'Ajouter un Post', array('action' => 'add') ); ?></p> <table> <tr> <th>Id</th> <th>Titre</th> <th>Actions</th> <th>Créé le</th> </tr>

<!-- Ici, nous bouclons sur le tableau $post afin d'afficher les informations des

˓→posts -->

<tr>

$post['Post']['title'],

array('action' => 'view', $post['Post']['id']) ); ?>

</td> <td>

<?php echo $this->Form->postLink(

'Supprimer',

array('action' => 'delete', $post['Post']['id']), array('confirm' => 'Etes-vous sûr ?'));

?>

'Editer',

(25)

); ?>

</td> <td>

<?php echo $post['Post']['created']; ?>

</td> </tr>

<?php endforeach; ?>

</table>

UtiliserpostLink()permet de créer un lien qui utilise du Javascript pour supprimer notre post en faisant une requête POST. Autoriser la suppression par une requête GET est dangereux à cause des robots d’indexation qui peuvent tous les supprimer.

Note : Ce code utilise aussi le helper « Form » pour demander à l’utilisateur une confirmation avant de supprimer le post.

Routes

Pour certains, le routage par défaut de CakePHP fonctionne suffisamment bien. Les développeurs qui sont sensibles à la facilité d’utilisation et à la compatibilité avec les moteurs de recherches apprécieront la manière dont CakePHP lie des URLs à des actions spécifiques. Nous allons donc faire une rapide modification des routes dans ce tutoriel. Pour plus d’informations sur les techniques de routages, consultez le chapitreConfiguration des Routes.

Par défaut, CakePHP effectue une redirection d’une personne visitant la racine de votre site (par ex :http://www. exemple.com) vers le controller Pages (PagesController) et affiche le rendu de la vue appelée « home ». Au lieu de cela, nous voudrions la remplacer avec notre controller Posts (PostsController).

Le routage de CakePHP se trouve dans /app/Config/routes.php. Vous devrez commenter ou supprimer la ligne qui définit la route par défaut. Elle ressemble à cela :

Router::connect(

'/',

array('controller' => 'pages', 'action' => 'display', 'home') );

Cette ligne connecte l’URL “/” à la page d’accueil par défaut de CakePHP. Nous voulons que cette URL soit connectée à notre propre controller, remplacez donc la ligne par celle-ci :

Router::connect('/', array('controller' => 'posts', 'action' => 'index'));

Cela devrait connecter les utilisateurs demandant “/” à l’action index() de notre controller Posts (PostsController).

Note : CakePHP peut aussi faire du “reverse routing” (ou routage inversé). Par exemple, pour la route définie plus haut, en ajoutant array('controller' => 'posts', 'action' => 'index') à la fonction retournant un tableau, l’URL “/” sera utilisée. Il est d’ailleurs bien avisé de toujours utiliser un tableau pour les URLs afin que vos routes définissent où vont les URLs, mais aussi pour s’assurer qu’elles aillent dans la même direction.

(26)

Conclusion

Créer des applications de cette manière vous apportera, paix, honneur, amour et argent au-delà même de vos fantasmes les plus fous. Simple n’est ce pas ? Gardez à l’esprit que ce tutoriel était très basique. CakePHP a beaucoup plus de fonctionnalités à offrir et il est aussi souple dans d’autres domaines que nous n’avons pas souhaité couvrir ici pour simplifier les choses. Utilisez le reste de ce manuel comme un guide pour développer des applications plus riches en fonctionnalités.

Maintenant que vous avez créé une application CakePHP basique, vous êtes prêt pour les choses sérieuses. Commencez votre propre projet et lisez le reste du Cookbook et l”API11_.

Si vous avez besoin d’aide, il y a plusieurs façons d’obtenir de l’aide - merci de regarder la pageOù obtenir de l’aide Bienvenue sur CakePHP !

Prochaines lectures suggérées

Voici les différents chapitres que les gens veulent souvent lire après :

1. Layouts: Personnaliser les Layouts de votre application.

2. Elements: Inclure et ré-utiliser les portions de vues.

3. Scaffolding: Construire une ébauche d’application sans avoir à coder.

4. Génération de code avec BakeGénérer un code CRUD basique.

5. Authentification Simple et Autorisation de l’Application: Tutoriel sur l’enregistrement et la connexion d’utili-sateurs.

Lectures supplémentaires

Une requête CakePHP typique

Nous avons découvert les ingrédients de bases de CakePHP, regardons maintenant comment chaque objet travaille avec les autres pour répondre à une requête simple. Poursuivons sur notre exemple original de requête, imaginons que notre ami Ricardo vient de cliquer sur le lien « Achetez un Cake personnalisé maintenant ! » sur la page d’accueil d’une application CakePHP.

Figure : 2. Typical CakePHP Request.

Noir = élément obligatoire, Gris = élément optionnel, Bleu = rappel (callback)

1. Ricardo clique sur le lien pointant vershttp://www.exemple.com/cakes/buyet son navigateur envoie une re-quête au serveur Web.

2. Le routeur analyse l’URL afin d’extraire les paramètres de cette requête : le controller, l’action et tout argument qui affectera la logique métier pendant cette requête.

3. En utilisant les routes, l’URL d’une requête est liée à une action d’un controller (une méthode d’une classe controller spécifique). Dans notre exemple, il s’agit de la méthode buy() du Controller Cakes. La fonction de rappel du controller, beforeFilter(), est appelée avant que toute logique de l’action du controller ne soit exécutée.

4. Le controller peut utiliser des models pour accéder aux données de l’application. Dans cet exemple, le control-ler utilise un model pour récupérer les derniers achats de Ricardo depuis la base de données. Toute méthode de rappel du model, tout behavior ou toute source de données peut s’appliquer pendant cette opération. Bien que l’utilisation du model ne soit pas obligatoire, tous les controllers CakePHP nécessitent au départ, au moins un model.

(27)

Fig. 1.1 – Diagramme représentant une requête CakePHP typique.

(28)

5. Une fois que le model a récupéré les données, elles sont retournées au controller. Des fonctions de rappel du model peuvent s’exécuter.

6. Le controller peut faire usage de components pour affiner les données ou pour effectuer d’autres opérations (manipulation de session, authentification ou envoi de mails par exemple).

7. Une fois que le controller a utilisé les models et components pour préparer suffisamment les données, ces données sont passées à la vue grâce à la méthode set(). Les méthodes de rappel (callbacks) du controller peuvent être appliquées avant l’envoi des données. La logique de la vue est exécutée, laquelle peut inclure l’utilisation d’elements et/ou de helpers. Par défaut, la vue est rendue à travers un layout (mise en page). 8. D’autres fonctions de rappel (callbacks) du controller (commeafterFilter) peuvent être exécutées. La

vue complète et finale est envoyée au navigateur de Ricardo.

Conventions de CakePHP

Nous sommes de grands fans des conventions plutôt que de la configuration. Bien que cela réclame un peu de temps pour apprendre les conventions de CakePHP, à terme vous gagnerez du temps : en suivant les conventions, vous aurez des fonctionnalités automatiques et vous vous libérerez du cauchemar de la maintenance par l’analyse des fichiers de configuration. Les conventions sont aussi là pour créer un environnement de développement uniforme, permettant à d’autres développeurs de s’investir dans le code plus facilement.

Les conventions de CakePHP ont été créées à partir de nombreuses années d’expérience dans le développement Web et de bonnes pratiques. Alors que nous vous conseillons d’utiliser ces conventions lors de vos développements CakePHP, nous devons mentionner que la plupart de ces principes sont facilement contournables - ce qui est particulièrement utile lorsque vous travaillez avec d’anciennes applications.

Les conventions des Controllers

Les noms des classes de controller sont au pluriel, CamelCased et se terminent par Controller. PeopleControlleret LatestArticlesController sont des exemples respectant cette convention. La première méthode que vous écrivez pour un controller devrait être index(). Lorsqu’une requête pointe vers un controller sans action, le comportement par défaut de CakePHP est d’exécuter la fonction index() de ce controller. Ainsi, la requêtehttp://www.exemple.com/apples/renvoie à la fonction index() de ApplesController, alors quehttp://www.exemple.com/apples/viewrenvoie vers la fonction view() de ApplesController.

Vous pouvez aussi changer la visibilité des méthodes des controllers dans CakePHP en préfixant les noms de méthode des controllers avec des underscores. Si une méthode du controller a été préfixée avec un underscore, la méthode ne sera pas accessible directement à partir du web mais est disponible pour une utilisation interne. Par exemple : class NewsController extends AppController {

public function latest() {

$this->_findNewArticles(); }

protected function _findNewArticles() {

// Logique pour trouver les derniers articles de nouvelles }

}

Alors que la pagehttp://www.exemple.com/news/latest/est accessible pour l’utilisateur comme d’habitude, quelqu’un qui essaie d’aller sur la page http://www.example.com/news/_findNewArticles/aura une erreur, car la méthode est précédée d’un underscore. Vous pouvez aussi utiliser les mots-clés de visibilité de PHP pour indiquer si la méthode peut ou non être accessible à partir d’une URL. Les méthodes non-publiques ne sont pas accessibles.

(29)

Considérations URL pour les noms de Controller

Comme vous venez de voir, un controller à mot unique renvoie facilement vers un chemin URL en minuscules. Par exemple, ApplesController (qui serait défini dans le nom de fichier “ApplesController.php”) est accessible à l’adressehttp://exemple.com/apples.

Les controllers à multiples mots peuvent être de forme “inflecté” qui correspondent au nom du controller : — /redApples

— /RedApples — /Red_apples — /red_apples

iront tous vers l’index du controller RedApples. Cependant, la convention est que vos URLs soient en minus-cules et avec des underscores, c’est pourquoi /red_apples/go_pick est la forme correcte pour accéder à l’action RedApplesController::go_pick.

Pour plus d’informations sur les URLs de CakePHP et la gestion des paramètres, allez voirConfiguration des Routes.

Conventions des Fichiers et des Noms de Classe

En général, les noms de fichiers correspondent aux noms des classes c’est-à-dire en CamelCase. Donc si vous avez une classe MaChouetteClasse, alors dans Cake, le fichier devra être nommé MaChouetteClasse.php. Voici des exemples de la manière dont on nomme les fichiers, pour chacun des différents types de classes que vous utiliseriez habituellement dans une application CakePHP :

— La classe controller BisousEtCalinsController devra se trouver dans un fichier nommé BisousEtCalinsCon-troller.php.

— La classe Component (Composant) MonSuperComponent devra se trouver dans un fichier nommé MonSu-perComponent.php.

— La classe Model ValeurOption devra se trouver dans un fichier nommé ValeurOption.php.

— La classe Behavior (Comportement) SpecialementFunkableBehavior devra se trouver dans un fichier nommé SpecialementFunkableBehavior.php.

— La classe View (Vue) SuperSimpleView devra se trouver dans un fichier nommé SuperSimpleView.ctp. — La classe Helper (Assistant) LeMeilleurQuiSoitHelper devra se trouver dans un fichier nommé

LeMeilleur-QuiSoitHelper.php.

Chaque fichier sera situé dans le répertoire approprié dans votre dossier app.

Conventions pour les Models et les Sources de données

Les noms de classe de model sont au singulier et en CamelCase. Person, BigPerson et ReallyBigPerson en sont des exemples.

Les noms de tables correspondant aux models CakePHP sont au pluriel et utilisent le caractère souligné (underscore). Les tables correspondantes aux models mentionnés ci-dessus seront donc respectivement : people, big_people, et really_big_people.

Note des traducteurs francophones : seul le dernier mot est au pluriel et tous les pluriels français ne seront pas compris par CakePHP sans lui indiquer précisément (par exemple cheval/chevaux). Voir pour cela le chapitre sur les inflexions. Pour vous assurer de la syntaxe des mots pluriels et singuliers, vous pouvez utiliser la bibliothèque utilitaire

Inflector. Voir la documentation surInflectorpour plus d’informations.

Les noms des champs avec deux mots ou plus doivent être avec des underscores comme ici : first_name.

Les clés étrangères des relations hasMany, belongsTo ou hasOne sont reconnues par défaut grâce au nom (singulier) du model associé, suivi de _id. Donc, si un Cuisinier hasMany Cake, la table « cakes » se référera à un cuisinier de la table

(30)

cuisiniers via une clé étrangère cuisinier_id. Pour une table avec un nom de plusieurs mots comme « type_categories », la clé étrangère sera type_categorie_id.

Les tables de jointure utilisées dans les relations hasAndBelongsToMany (HABTM) entre models doivent être nom-mées d’après le nom des tables des models qu’elles unissent, par ex des users qui sont liés par une relation HABTM avec des groups seraient joints par une table groups_users et ces noms doivent être dans l’ordre alphabétique (« pommes_zebres » plutôt que « zebres_pommes »).

Toutes les tables avec lesquelles les models de CakePHP interagissent (à l’exception des tables de jointure), nécessitent une clé primaire simple pour identifier chaque ligne de manière unique. Si vous souhaitez modéliser une table qui n’a pas de clé primaire sur un seul champ, la convention de CakePHP veut qu’une clé primaire sur un seul champ soit ajoutée à la table.

Si le nom de la clé primaire n’est pas id, vous devez définir l’attribut Model.primaryKey.

CakePHP n’accepte pas les clés primaires composées. Dans l’éventualité où vous voulez manipuler directement les données de votre table de jointure, cela veut dire que vous devez soit utiliser les appels directs àquery, soit ajouter une clé primaire pour être en mesure d’agir sur elle comme un model normal. Exemple :

CREATE TABLE posts_tags (

id INT(10) NOT NULL AUTO_INCREMENT, post_id INT(10) NOT NULL,

tag_id INT(10) NOT NULL, PRIMARY KEY(id

);

Plutôt que d’utiliser une clé auto-incrémentée comme clé primaire, vous pouvez aussi utiliser un champ char(36). CakePHP utilisera alors un UUID de 36 caractères (String : :uuid) lorsque vous sauvegardez un nouvel enregistrement en utilisant la méthode Model : :save.

Conventions des vues

Les fichiers de vue sont nommés d’après les fonctions du controller qu’elles affichent, sous une forme avec underscores. La fonction soyezPret() de la classe PersonnesController cherchera un gabarit de vue dans : /app/View/Personnes/soyez_pret.ctp.

Le schéma classique est /app/View/Controller/nom_de_fonction_avec_underscore.ctp.

En utilisant les conventions CakePHP dans le nommage des différentes parties de votre application, vous gagnerez des fonctionnalités sans les tracas et les affres de la configuration. Voici un exemple récapitulant les conventions abordées :

— Nom de la table dans la base de données : « personnes »

— Classe du Model : « Personne », se trouvant dans /app/Model/Personne.php

— Classe du Controller : « PersonnesController », se trouvant dans /app/Controller/PersonnesController.php — Template de Vue : se trouve dans /app/View/Personnes/index.ctp

En utilisant ces conventions, CakePHP sait qu’une requête de typehttp://exemple.com/personnes/sera liée à un appel à la fonction index() du Controller PersonnesController, dans lequel le model Personne est automatiquement disponible (et automatiquement lié à la table “personnes” dans la base) et rendue dans un fichier. Aucune de ces relations n’a été configurée par rien d’autre que la création des classes et des fichiers dont vous aviez besoin de toute façon.

Maintenant que vous avez été initié aux fondamentaux de CakePHP, vous devriez essayer de dérouler le tutoriel du Blog CakePHPTutoriel d’un Blogpour voir comment les choses s’articulent.

Structure du dossier de CakePHP

Après avoir téléchargé et extrait CakePHP, voici les fichiers et répertoires que vous devriez voir : — app

(31)

— lib — vendors — plugins — .htaccess — index.php — README

Vous remarquerez trois dossiers principaux :

— Le dossier app sera celui où vous exercerez votre magie : c’est là que vous placerez les fichiers de votre application.

— Le dossier lib est l’endroit où nous avons exercé notre propre magie. Engagez-vous personnellement à ne pas modifier les fichiers dans ce dossier. Nous ne pourrons pas vous aider si vous avez modifié le cœur du framework. A la place, regardez dans lesExtensions de l’Applicationmodifiées.

— Enfin, le dossier vendors est l’endroit où vous placerez vos librairies PHP tierces dont vous avez besoin pour vos applications CakePHP.

Le dossier App

Le répertoire app de CakePHP est l’endroit où vous réaliserez la majorité du développement de votre application. Regardons de plus près les dossier à l’intérieur de app.

Config Contient les (quelques) fichiers de configuration utilisés par CakePHP. Informations de connexion à la base de données, démarrage, fichiers de configuration de base et tous fichiers du même genre doivent être rangés ici. Console Contient les commandes de la console et les Tasks de la console pour votre application. Ce répertoire peut aussi contenir un répertoire Templates pour personnaliser la sortie de bake. Pour plus d’informations, regardezShells, Tasks & Outils de Console.

Controller Contient vos Controllers et leurs Components.

Lib Contient les librairies qui ne proviennent pas de librairies externes. Cela vous permet de séparer les librairies internes de votre organisme des librairies externes.

Locale Stocke les fichiers pour l’internationalisation.

Model Pour les Models, Behaviors et Sources de Données de votre application. Plugin Contient les packages des Plugins.

Test Ce répertoire contient tous les cas de test, et les fixtures de test pour votre application. Le répertoire Test/ Casedevra refléter votre application et contenir un ou plusieurs cas de test par classe dans votre application. Pour plus d’informations sur les cas de test et les fixtures de test, référez-vous à la documentationTesting. tmp C’est ici que CakePHP enregistre les données temporaires. La manière dont sont stockées les données

ac-tuelles dépend de la configuration que vous avez effectuée, mais ce répertoire est habituellement utilisé pour déposer les descriptions de models, les logs et parfois les informations de session.

Assurez-vous que ce dossier existe et qu’il est en écriture, autrement la performance de votre application sera sévèrement impactée. En mode debug, CakePHP vous avertira si ce n’est pas le cas.

Vendor Toute classe ou librairie tierce doit être mise ici, de sorte qu’il sera facile d’y accéder par la fonction App : :import(“vendor”,”name”). Les observateurs avisés noteront que cela semble redondant avec le répertoire vendorsà la racine de l’arborescence. Nous aborderons les différences entre les deux lorsque nous discuterons de la gestion multi-applications et des configurations systèmes plus complexes.

View Les fichiers de présentation sont placés ici : éléments, pages d’erreur, helpers, layouts et vues.

webroot Dans un environnement de production, ce dossier doit être la racine de votre application. Les sous-répertoires sont utilisés pour les feuilles de style CSS, les images et les fichiers Javascript.

Structure de CakePHP

CakePHP dispose de classes de Controllers (Contrôleurs), de Models (Modèles), et de Views (Vues), mais il dispose de classes et objets supplémentaires qui rendent le développement en MVC plus rapide et amusant. Les Components