Modèles

Un modèle est une classe métier, représentant une partie des données d'une application. Dans la plupart des cas, un modèle est associé à une table de la base de données.
Phalcon\Mvc\Model est la classe de base des models d'une application. Cette classe met à disposition des fonctionnalités CRUD, offre des possibilités de recherche avancées, et permet de gérer les relations entre models, le tout sans avoir besoin d'utiliser SQL.

Phalcon implémente ActiveRecord pour sa partie ORM, il utilise donc l'héritage sur les Models, par opposition à certains ORM qui implémentent DataMapper (Doctrine 2) et permettent de travailler avec des models plus indépendants de la couche technique liée à la persistance (POPO).

<?php

class Utilisateur extends \Phalcon\Mvc\Model
{

}

<?php
class Utilisateur extends \Phalcon\Mvc\Model{

    /**
     *
     * @var string
     */
    protected $prenom;

    /**
     *
     * @var string
     */
    protected $nom;


    /**
     * Method to set the value of field prenom
     *
     * @param string $prenom
     * @return $this
     */
    public function setPrenom($prenom)
    {
        $this->prenom = $prenom;

        return $this;
    }

    /**

    /**
     * Method to set the value of field nom
     *
     * @param string $nom
     * @return $this
     */
    public function setNom($nom)
    {
        $this->nom = $nom;

        return $this;
    }

    /**
     * Returns the value of field prenom
     *
     * @return string
     */
    public function getPrenom()
    {
        return $this->prenom;
    }

    /**
     * Returns the value of field nom
     *
     * @return string
     */
    public function getNom()
    {
        return $this->nom;
    }

}

Par défaut, Phalcon effectue un mappage entre classes et tables de la base de données de la façon suivante :

• Table ⇔ Classe du même nom
• Enregistrement ⇔ instance de classe (objet métier)
• Colonne (champ) ⇔ membre de données du même nom

Base de données (Table)	Modèle objet (Classe)

Si le nom de la table de la base de données ne correspond pas au nom de la classe, il est possible de surdéfinir la méthode getSource :

class Users extends \Phalcon\Mvc\Model{

    //Retourne le nom de la table correspondant à la classe
    public function getSource(){
        return "Utilisateur";
    }

}

De même, si les noms de champ de la table ne correspondent pas aux membres de données de la classe :

<?php

class Utilisateur extends \Phalcon\Mvc\Model
{
    protected $code;
    protected $name;
    
    public function columnMap()
    {
        //Les clés correspondent aux noms dans la table
        //Les valeurs aux noms dans l'application
        return array(
            'id' => 'code',
            'nom' => 'name'
        );
    }

}

Avec Phalcon, les relations peuvent être définies grâce à la méthode initialize() du modèle. Les méthodes belongsTo(), hasOne(), hasMany() and hasManyToMany() definissent des relations entre 1 ou plusieurs membres du modèle courant et des membres d'un autre modèle. Chacune de ces méthodes requiert 3 paramètres : le membre local, le modèle cible, les membres cibles.

Exemple :

Base de données (Table)	Modèle objet (Classe)

Chaque utilisateur appartient à une catégorie :

class Utilisateur extends \Phalcon\Mvc\Model{

    ...

    /**
     *
     * @var integer
     */
    protected $idCategorie;

    public function initialize()
    {
    	$this->belongsTo("idCategorie", "Categorie", "id");
    }
    ...

1. idCategorie : membre local intervenant dans l'association (clé étrangère)
2. Categorie : Classe référencée associée
3. id : membre référencé dans la classe associée

Création d'une action dans le contrôleur IndexController pour afficher un utilisateur et sa catégorie :

<?php

class IndexController extends \Phalcon\Mvc\Controller{
    ...
        public function showUserAction($id){
    	$user=Utilisateur::findFirst($id);
    	echo $user->getNom()." : ".$user->getCategorie()->getNom();
    }
}

Affichage de la réponse obtenue :

Phalcon charge l'utilisateur, et l'instance de catégorie correspondant, accessible grâce aux méthodes magiques _set et _get

Chaque catégorie est associée à 1 ou plusieurs utilisateurs :

class Categorie extends \Phalcon\Mvc\Model{

    /**
     *
     * @var integer
     */
    protected $id;

    /**
     *
     * @var string
     */
    protected $nom;

    public function initialize(){
    	$this->hasMany("id", "Utilisateur", "idCategorie",array("alias"=>"utilisateurs"));
    }
    ...

1. id : membre local intervenant dans l'association (clé primaire)
2. Utilisateur : Classe associée
3. idCategorie : membre associé
4. utilisateurs : alias du membre créé par l'association (collection d'Utilisateurs)

<?php

class IndexController extends \Phalcon\Mvc\Controller{
    ...
    public function showCategorieAction($id){
    	$categorie=Categorie::findFirst($id);
    	echo "<h1>".$categorie->getNom()."</h1>";
    	echo "<hr>";
    	foreach ($categorie->getUtilisateurs() as $user){
    		echo($user->getNom()."<br>");
    	}
    }
}

Affichage de la réponse obtenue :

Le getter getUtilisateurs() peut également être utilisé pour filtrer les utilisateurs de la catégorie affichée :

<?php

class IndexController extends \Phalcon\Mvc\Controller{
    ...
    public function showCategorieAction($id){
    	$categorie=Categorie::findFirst($id);
    	echo "<h1>".$categorie->getNom()."</h1>";
    	echo "<hr>";
        //Affichage des utilisateurs dont le nom contient CA
    	foreach ($categorie->getUtilisateurs("nom like '%CA%'") as $user){
    		echo($user->getNom()."<br>");
    	}
    }
}

Base de données	Modèle objet

Les utilisateurs disposent de droits :

<?php

class Utilisateur extends \Phalcon\Mvc\Model{

    ...

    public function initialize()
    {
    	$this->belongsTo("idCategorie", "Categorie", "id");
    	$this->hasManyToMany("id", "UtilisateurDroit", "idUtilisateur", "idDroit", "Droit", "id",array("alias"=>"droits"));
    }
    ...
}

Création d'une action dans le contrôleur IndexController pour afficher un utilisateur et ses droits :

<?php

class IndexController extends \Phalcon\Mvc\Controller{
    ...
    public function showUserDroitsAction($id){
    	$user=Utilisateur::findFirst($id);
    	echo "<h1>".$user->getNom()." : ".$user->getCategorie()->getNom()."</h1>";
    	echo "<ul>";
    	foreach ($user->getDroits() as $droit){
    		echo "<li>".$droit->getLibelle()."</li>";
    	}
    	echo "</ul>";
    }
    ...
}

Lister tous les enregistrements d'une table :

$utilisateurs = Utilisateur::find();
foreach($utilisateurs as $utilisateur){
    echo $utilisateur->getNom()."<br>";
}
echo "Nombre d'utilisateurs : ", count($utilisateurs), "\n";

Poser une condition :

// Comptage du nombre d'adultes
$utilisateurs = Utilisateur::find("adulte = 1");
echo "Adultes ", count($utilisateurs), "\n";

Trier :

$utilisateurs = Utilisateur::find(array(
    "adulte = 1",
    "order" => "nom"
));
foreach ($utilisateurs as $utilisateur) {
    echo $utilisateur->nom, "\n";
}

Tri et limite :

$utilisateurs = Robots::find(array(
    "adulte = 1",
    "order" => "nom",
    "limit" => 5
));
foreach ($utilisateurs as $utilisateur) {
   echo $utilisateur->nom, "\n";
}

L'utilisation de la méthode findFirst() permet d'obtenir le premier enregistrement répondant au(x) critère(s) :

// Premier utilisateur ?
$utilisateur = Utilisateur::findFirst();
echo "Le nom du premier utilisateur est ", $utilisateur->getNom(), "\n";

Premier utilisateur répondant à un critère :

$utilisateur = Utilisateur::findFirst("adulte = 1");
echo "Le premier adulte est : ", $utilisateur->getNom(), "\n";

Premier utilisateur répondant à un critère, avec classement par nom :

$utilisateur = Utilisateur::findFirst(array("adulte = 1", "order" => "nom"));
echo "Le premier adulte est : ", $utilisateur->getNom(), "\n";

Les méthodes find() et findFirst() permettent de définir des critères à partir d'un tableau associatif :

$utilisateur = Utilisateur::findFirst(array(
    "adulte = 1",
    "order" => "nom DESC",
    "limit" => 30
));

$utilisateurs = Utilisateur::find(array(
    "conditions" => "adulte = ?1",
    "bind"       => array(1 => 1)
));

Il est également possible de créer des requêtes de façon orientée objet :

$utilisateurs = Utilisateur::query()
    ->where("adulte = :value:")
    ->andWhere("nom like 'C%'")
    ->bind(array("value" => 1))
    ->orderBy("nom")
    ->execute();

PHQL : Phalcon Query Language, SQL orienté objet, offre également la possibilité d'interroger la base de données :

Requête simple :

    public function allUsersAction(){
    	$query = $this->modelsManager->createQuery("SELECT * FROM Utilisateur);
    	$utilisateurs = $query->execute();
    	foreach ($utilisateurs as $utilisateur)
    		echo $utilisateur->getNom()."<br>";
    }

Requête avec paramètres :

    public function adultesAction(){
    	$query = $this->modelsManager->createQuery("SELECT * FROM Utilisateur WHERE adulte = :value:");
    	$utilisateurs = $query->execute(array(
    			'value' => true
    	));
    	foreach ($utilisateurs as $utilisateur)
    		echo $utilisateur->getNom()."<br>";
    }

Requête partielle :

    public function allUsersAction(){
    	$query = $this->modelsManager->createQuery("SELECT u.nom, u.prenom FROM Utilisateur as u");
    	$rs = $query->execute();
    	foreach ($rs as $utilisateur)
    		echo $utilisateur->nom."<br>";
    }

PHSQL retourne dans ce cas un recordSet constitué d'objets génériques, et non une collection d'objet de type Utilisateur.

Requête partielle avec Jointure : Utilisateurs et catégorie

    public function allUsersAction(){
    	$query = $this->modelsManager->createQuery("SELECT u.nom, u.prenom,c.nom as categorie FROM Utilisateur u JOIN Categorie c");
    	$rs = $query->execute();
    	foreach ($rs as $utilisateur)
    		echo $utilisateur->nom." ".$utilisateur->categorie."<br>";
    }

Requête complète avec jointure :

    public function allUsersAction(){
    	$query = $this->modelsManager->createQuery("SELECT u.* FROM Utilisateur u JOIN Categorie c");
    	$utilisateurs = $query->execute();
    	foreach ($utilisateurs as $utilisateur)
    		echo $utilisateur->getNom()." ".$utilisateur->getCategorie()->getNom()."<br>";
    }

La méthode Phalcon\Mvc\Model::save() permet d'ajouter, ou de modifier un enregistrement, s'il existe déjà dans la base de données (la valeur de la clé primaire détermine cette existence).

    public function addUserAction(){
    	$user       = new Utilisateur();
    	$user->setNom("SMITH");
    	$user->setPrenom("John");
    	$user->setIdcategorie(1);
    	$user->setAge(30);
    	$user->setAdulte(1);
    	if ($user->save() == false) {
    		echo "Problème d'enregistrement \n";
    		foreach ($user->getMessages() as $message) {
    			echo $message, "\n";
    		}
    	} else {
    		echo "Utilisateur ajouté";
    	}
    }

Mise à jour par passage d'un tableau associatif à la méthode save() :

$droit= new Droit();
$droit ->save(array(
    "libelle" => "Donner des droits",
    "admin" => 1
));

Mise à jour à partir du post d'un formulaire :

$droit= new Droit();
$droit ->save($_POST);

Il est possible de préciser en second paramètre les colonnes (libelle et admin) à affecter :

$droit= new Droit();
$droit->save($_POST, array('libelle', 'admin'));

Ou de faire clairement la distinction entre l'ajout (create()) et la mise à jour (update()) :

$droit       = new Droit();
$droit->setNom("Donner des droits");
$droit->setAdmin(1);

//L'enregistrement doit être créé
if ($droit->create() == false) {
    echo "Impossible d'ajouter ce droit : \n";
    foreach ($droit->getMessages() as $message) {
        echo $message, "\n";
    }
} else {
    echo "Un nouveau droit a été créé !";
}

Mise à jour d'un objet et de l'objet associé par un belongsTo :

    public function addCategorieUserAction(){
    	$categorie=new Categorie();
    	$categorie->setNom("Auteurs");

    	$user=new Utilisateur();
    	$user->setNom("SMITH");
    	$user->setPrenom("ROBERT");
    	$user->setAge(30);
    	$user->setAdulte(1);

    	$user->categorie=$categorie;
    	if($user->save()==false){
    		echo "Problème d'enregistrement \n";
    		foreach ($user->getMessages() as $message) {
    			echo $message, "\n";
    		}
    	}else{
    		echo "Catégorie  & utilisateur sauvegardés";
    	}
    }

La méthode Phalcon\Mvc\Model::delete() permet de supprimer un enregistrement :

<?php

$user = Utilisateur::findFirst(11);
if ($user != false) {
    if ($user->delete() == false) {
        echo "Impossible de supprimer l'utilisateur : \n";
        foreach ($user->getMessages() as $message) {
            echo $message, "\n";
        }
    } else {
        echo "L'utilisateur a été supprimé";
    }
}

Il est également possible de supprimer plusieurs enregistrement en parcourant un résultat avec un foreach :

 
<?php

foreach (Utilisateur::find("ville='Caen'") as $user) {
    if ($user->delete() == false) {
        echo "Impossible de supprimer l'utilisateur : \n";
        foreach ($user->getMessages() as $message) {
            echo $message, "\n";
        }
    } else {
        echo "L'utilisateur a été supprimé";
    }
}

Phalcon permet de gérer/contrôler la mise à jour des objets via des événements, contrôlable de préférence par mise en place d'un eventManager.

Phalcon met a disposition un ensemble d'outils permettant d'associer un comportement aux objets : voir behaviors :

• timeStempable : pour mémoriser l'heure de mise à jour/ajout d'objets
• softDelete : pour marquer des enregistrements comme supprimés