Voici un titre de billet un peu barbare mais il s’agit ici de parler d’une erreur très spécifique qui peut survenir avec la version 2.0.2 de CodeIgniter lors de l’utilisation d’Acicrud.

Le cas de figure est le suivant, vous tentez de lire une entrée en base de données avec la méthode read($primary_key) (par exemple) et une erreur fatale est levée :

Call to a member function result_array() on a non-object in /system/database/DB_driver.php on line 837

La cause probable de cette erreur est une mauvaise configuration au niveau de la base de données ou au niveau d’Acicrud.

Voici une procédure de vérification qui vous permettra très certainement de corriger l’erreur :

• Si vous utilisez un préfixe de table, vous devez l’indiquer dans /application/config/database.php dans $db['default']['dbprefix'], assurez-vous d’avoir spécifié l’underscore final, par exemple « mon_prefixe_ ».
• Vérifiez ensuite que le modèle incriminé instancie bien la librairie Acicrud avec le nom de la table liée sans le préfixe et que le nom de la table est correct. Par exemple, pour une table nommée « my_prefix_users », l’appel du constructeur doit être le suivant : parent::__construct(‘users’);
• Dernière possibilité, vérifiez que la requête SQL générée par le driver de CodeIgniter est correcte, pour cela ouvrez /system/database/DB_driver.php et faîtes un echo de $sql en ligne 833 juste avant le $query = $this->query($sql);

Tutoriel ACICRUD #5

Depuis la version 1.1, Acicrud est capable de se connecter à n’importe qu’elle base de données configurée dans le fichier system/application/database.php.

Veuillez noter que cette fonctionnalité est totalement facultative et que la librairie travaillera avec votre base de données par défaut si vous ne définissez aucune base de travail dans votre modèle.

Afin d’utiliser une base de données différente de votre base de données par défaut, il suffit de spécifier le group à utiliser au constructeur d’ACICRUD. Dans notre exemple il s’agiera d’une base de données nommée « rescue_database« .

<?php
 
class Exemple_Model extends Acicrud {
 
    //CONSTRUCTOR   
 
    public function __construct()
    {
        parent::__construct('table_name', 'rescue_database');
    }
 
    //CUSTOM METHODS
 
}
 
?>

Tutoriel ACICRUD #5

Dans ce cinquième tutoriel d’utilisation de la librairie ACICURD pour CodeIgniter, nous allons voir comment définir de nouvelles méthodes dans les modèles utilisant ACICRUD et comment profiter de certaines méthodes de la librairie.

Création d’une méthode spécifique

Imaginons que vous désiriez sélectionner un champ username dans une table user à partir de l’identifiant de l’utilisateur id. Nous allons pour cela ajouter une nouvelle méthode dans notre modèle ayant exactement le fonctionnement que nous désirons et s’appuyant sur la méthode $this->row() qui exécute la requête Active Record et retourne un objet résultat.

Notez qu’il serait également possible d’utiliser la méthode getAll() d’ACICRUD pour arriver à ce résultat.

Voici le code du fichier user.php à placer dans le répertoire models :

<?php
 
class User extends Acicrud {
 
	//CONSTRUCTOR
	public function __construct()
	{
		parent::__construct('user');
	}
 
	//CUSTOM METHODS
 
	/**
	 * Return the username of an user identified by his id
	 *
	 * @param int $id
	 * @return Object
	 */
	public function get_username($id = null) {
 
		try {
 
			// Checking if $id is a valid primary key value
			$this->checkId($id);
 
			// Building the query
			$this->db->select('username')->from($this->table)->where($this->key, $id);
 
			// Returning the result
			return $this->row();		
 
		} catch(Exception $e) {
 
			throw($e); // Throws the ACICRUD's exception
 
		}
	}
 
}
 
?>

Il vous est donc tout à fait possible d’ajouter vos propres comportements au sein d’un modèle héritant de la librairie ACICRUD. Notez que dans cet exemple, la méthode s’appuie également sur le système d’exceptions géré par ACICRUD. Je vous conseille donc d’inclure l’appel de la méthode get_username dans votre contrôleur au sein d’un bloc try/catch.

Tutoriel suivant

» Utiliser plusieurs bases de données

Je vous propose au travers de ce tutoriel de mettre en évidence 3 bonnes pratiques concernant la gestion de base de données sous CodeIgniter et plus particulièrement par rapport à la création de modèles basés sur la classe Active Record.

Je précise avant tout que les points évoqués ci-après sont pleinement compatibles avec ACICRUD, ma librairie d’abstraction de modèles pour CodeIgniter.

Gérer efficacement les préfixes de tables

Afin de débuter cet article, parlons des préfixes de tables pour vos applications. Puisqu’il est admit par le simple fait d’utiliser une librairie d’abstraction de base de données comme Active Record sous CodeIgniter, que votre base de données est abstraite, c’est à dire que l’on ne connaît pas en théorie quel système de gestion de base de données est utilisé en production, je considère également admit que vous ne devriez pas connaître la liste des tables présentes dans la base de données de production (ou du moins qu’il ne faut pas en tenir compte lors de la création du schéma de base de données de votre application).

Ainsi, afin d’éviter toute collision de table avec un autre système utilisant la même base de données, il devient très utile de préfixer l’ensemble des tables de notre application par une chaîne unique mais explicite.

Pour illustrer ceci, nous allons partir du principe que nous concevons une application nommée « Gestion » pour un client donné. Nous ne pouvons pas connaître à l’avance la liste des tables dans la base de données qu’utilise déjà notre client pour ses autres applications.

Aussi, afin d’éviter toute collision sur les noms de tables, nous allons choisir de préfixer nos tables avec la chaîne « gestion_ ».

C’est ainsi que toutes nos tables SQL devront être créées avec ce préfixe, comme par exemple « gestion_user », « gestion_user_acl », etc. De cette manière, si la base de données de production comporte déjà une table nommée « user », cela ne générera aucun conflit.

Ceci est très facilement gérable avec CodeIgniter, en effet il suffit d’indiquer le préfixe de table à utiliser dans le fichier de configuration database.php. Ainsi, Active Record utilisera automatiquement le préfixe de nos tables pour lors de la génération de requêtes SQL.

$db['production']['hostname'] = "localhost";
$db['production']['username'] = "root";
$db['production']['password'] = "password";
$db['production']['database'] = "the_production_database";
$db['production']['dbdriver'] = "mysql";
$db['production']['dbprefix'] = "gestion_";
$db['production']['pconnect'] = FALSE;
$db['production']['db_debug'] = FALSE;
$db['production']['cache_on'] = FALSE;
$db['production']['cachedir'] = "";
$db['production']['char_set'] = "utf8";
$db['production']['dbcollat'] = "utf8_general_ci";

Ne pas coder en dur les noms de table !

Voici une règle simple mais souvent oubliée : éviter de coder en dur. Ceci est particulièrement valable pour les noms de tables !

Voici comment profiter simplement de la programmation orientée objet afin de transformer notre nom de table en attribut de classe de notre modèle.

<?php
 
class User extends Model {
 
    public $table = 'user';
 
    public function __construct()
    {
        parent::__construct();
 
    }
 
    public function example() {
 
    	//$this->table is used instead of the 'user' string.
        //Active Record will use `gestion_user`
    	$this->db->select()->from($this->table);
 
    	$query = $this->db->get();
 
    	return $query->result();
 
    }
 
}
 
?>

Ainsi, à chaque fois que nous aurons besoin d’appeler la table utilisée par le modèle, il suffira d’utiliser $this->table, ce qui aura également comme avantage de rendre les méthodes du modèle plus génériques.

Utiliser un préfixe de table avec la classe Database

Il existe certains cas de figures ou les méthodes évoquées ci-dessus ne suffisent pas totalement. C’est notamment le cas lorsqu’une requête SQL doit être effectuée sur plusieurs tables ou lorsque le query builder d’Active Record n’est plus utilisé.

Prenons un exemple concret en sélectionnant des données dans la table gestion_user via la méthode query(). Dans ce cas précis, le préfixe de table ne sera pas automatiquement ajouté par CodeIgniter puisque query() permet justement d’écrire manuellement une requête SQL.

Il faut alors utiliser $this->db->dbprefix() afin de générer le préfixe de table adéquat.

<?php
 
class User extends Model {
 
    public $table = 'user';
 
    public function __construct()
    {
        parent::__construct();
 
    }
 
    public function manuel_query() {
 
    	//One way
    	$query = $this->db->query('SELECT * FROM `' . $this->db->dbprefix($this->table) . '` LIMIT 0 , 30');
 
    	//Second way
    	$query = $this->db->query('SELECT * FROM `' . $this->db->dbprefix . $this->table . '` LIMIT 0 , 30');
    }
 
}
 
?>

Notez que les deux méthodes produisent un résultat identique.

Conclusion

Il existe de nombreuses méthodes permettant d’améliorer la qualité et la généricité des modèles sous CodeIgniter, et nous n’abordons même pas les notions d’ORM ou de CRUD dans cet article. Quoiqu’il en soit, je suis sûr que chaque développeur CodeIgniter utilise ses propres techniques, aussi n’hésitez pas à partager les vôtres en commentant ce billet

Tutoriel ACICRUD #4

Dans ce quatrième tutoriel d’utilisation de la librairie ACICURD pour CodeIgniter, nous verrons tout d’abord comment supprimer une ligne en base de données, puis comment supprimer un ensemble de données grâce à la méthode delete().

Pour supprimer un élement, nous allons simplement lire une ligne identifiée par son id (en utilisant la méthode read() afin que les processus de vérification de l’existence de l’identifiant soient exécutés) puis appliquer sur l’instance de notre modèle la méthode delete().

Pour cela voici le code d’un contrôleur CodeIgniter qui possède une méthode deleteElement($id) prenant comme paramètre d’entrée l’identifiant de la ligne à supprimer :

<?php
 
class Element extends Controller {
 
	public function __construct()
	{
		parent::__construct();	
		$this->load->model('elementModel');
	}
 
	public function deleteElement($id)
	{
		try {
 
			//Try to read the row identified by $id
			$element = $this->elementModel->read($id);
 
			//Delete the database row
			$this->elementModel->delete($element->id);
 
		} catch(Exception $e) {
 
			die('Wrong id');
 
		}
	}
 
}
?>

La suppression de plusieurs lignes en base de données est également possible avec la méthode delete(), pour cela il suffit de fournir à la méthode un tableau associatif représentant les données Active Record de la clause WHERE à utiliser pour la suppression.

L’exemple ci-dessous supprimera les données pour lesquelles le champ is_valid est différent de 1.

<?php
 
class Element extends Controller {
 
	public function __construct()
	{
		parent::__construct();	
		$this->load->model('elementModel');
	}
 
	public function deleteInvalidRows()
	{
		//Delete rows via a custom WHERE clause
		$this->elementModel->delete(array( 'is_valid !=' => 1) );
 
	}
 
}
?>

Tutoriel suivant

» Ajouter des custom methods à vos modèles

Tutoriel ACICRUD #3

Voici le troisième tutoriel d’utilisation d’ACICRUD, vous pouvez si vous le désirez consulter les tutoriels précédents.

Dans ce tutoriel, nous allons voir comment créer une ligne en base de données grâce à la fonction create() de la librairie ACICRUD pour CodeIgniter.

Pour cela, nous allons imaginer que nous disposons d’une page HTML contenant un formulaire permettant de renseigner le titre ainsi que la description de notre exemple.

Pour rappel : Exemple { idExemple, title, description, date }

Nous allons donc créer le code permettant de récupérer les données du formulaire et de créer la ligne en base de données dans un contrôleur CodeIgniter. Notez qu’il n’est pas nécessaire de définir l’objet temporaire $o ni de préciser qu’il possède un attribut représentant la clé primaire. ACICRUD n’a besoin que des données à insérer pour exécuter la fonction create().

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

<?php
 
class Form extends Controller {
 
	public function index()
	{	
		//Form_validation stuff
		$this->load->library('form_validation');
 
		$this->form_validation->set_rules('title', 'Title', 'required');
		$this->form_validation->set_rules('description', 'Description', 'required');
 
		if ($this->form_validation->run() == FALSE)
		{
			$this->load->view('myform');
		}
		else
		{
			//Validation success
			$this->load->model('exemple');
 
			$o->title = $this->input->post('title');
			$o->description = $this->input->post('description');
			$o->date = date("Y-m-d H:i:s");
 
			//Creating the row in the database
			$this->exemple->create($o);
		}
	}
	}
?>

Tutoriel suivant

» Supprimer des données avec Acicrud

Tutoriel ACICRUD #2

Dans ce deuxième tutoriel sur l’utilisation de la librairie Acicrud nous allons voir comment lire des données depuis la base de données.

Comme expliqué dans les précédents billets, le principe d’Acicrud est d’ajouter une couche applicative objet dans les modèles afin de générer des objets fidèles au modèle de données représenté par la base de données.

Concrètement, Acicrud permet d’intéragir avec la base de données en  manipulant directement des objets PHP.

Prérequis

Nous supposerons utiliser le modèle exemple précédemment créé dans le turoriel #1.

Nous supposerons également que notre table SQL est bâtie sur le modèle de donnée suivant :

Exemple { idExemple, title, description, date }

Lecture d’une ligne en base de données

La lecture d’une ligne se fait à partir de son identifiant (clé primaire) ou à partir d’un tableau associatif représentant la clause WHERE à utiliser (attention read est volontairement prévu pour lire une et une seule entrée), la méthode read() retourne un objet fidèle à la ligne en base de données :

<?php
 
$this->load->model('exemple');
 
try {
	$o = $this->exemple->read(1); //Primary key id
} catch(Exception $e) {
	echo "Wrong ID";
}
 
var_dump($o);
 
//Produces
/*
object(stdClass) (4) {
  ["idExemple"]=>
  string(2) "1"
  ["title"]=>
  string(8) "title..."
  ["description"]=>
  string(15) "description..."
  ["date"]=>
  string(19) "2009-04-30 21:00:00"
}
*/
 
try {
	//Associative array method produces a custom WHERE clause. Be careful, read is intended to read one unique entry.
	$o = $this->exemple->read(array('title' => 'title...')); 
} catch(Exception $e) {
	echo "No result found.";
}
 
var_dump($o);
 
//Produces
/*
object(stdClass) (4) {
  ["idExemple"]=>
  string(2) "1"
  ["title"]=>
  string(8) "title..."
  ["description"]=>
  string(15) "description..."
  ["date"]=>
  string(19) "2009-04-30 21:00:00"
}
*/
 
 
?>

L’objet $o représente physiquement l’élément lu en base de données. Ses attributs portent les noms de champs et ses valeurs sont les données de la ligne.

Lecture de toutes les lignes d’une table en base de données

Il est très fréquent de devoir récupérer l’ensemble des données d’une table. Acicrud fournit une méthode pour cela s’appelant getAll().

Cette méthode prend trois paramètres optionnels qui sont $limit, $order et $where.

$limit permet d’effectuer un LIMIT SQL afin de limiter le nombre de lignes retournées par la requête, il suffit de passer un nombre.

$order est un tableau associatif qui permet de trier les données, par exemple pour trier par title ascendant, il faudra passer un tableau associatif :

array(‘title’ => ‘ASC’).

Il est également possible d’indiquer plusieurs tris : array(‘date’ => ‘DESC’, ‘title’ => ‘ASC’ ).

Le paramètre $where permet d’ajouter une clause WHERE personnalisée, il suffit de passer un tableau indexé de la même manière qu’avec la librairie Active Record de CodeIgniter.

La métode getAll() va retourner un tableau d’objets fidèles qui peuvent par exemple être facilement passés à une vue pour affichage.

<?php
 
$this->load->model('exemple');
 
try {
 
	//Retrieve an array of objects, this array can be passed to a view for displaying data
	foreach($this->exemple->getAll(10, array('date' => 'DESC')) as $row) {
 
		var_dump($row); 
 
		//Produces
		/*
		object(stdClass) (4) {
		  ["idExemple"]=>
		  string(2) "the id"
		  ["title"]=>
		  string(8) "the title"
		  ["description"]=>
		  string(15) "the description"
		  ["date"]=>
		  string(19) "the date"
		}
		*/
	}
 
} catch(Exception $e) {
	echo $e->getMessage();
}
 
?>

Support and feedback are both available in English and in French.

Tutoriel suivant

» Insérer des données avec Acicrud

Tutoriel ACICRUD #1

Dans ce premier tutoriel sur l’utilisation de la librairie ACICRUD pour CodeIgniter nous allons voir comment installer la librairie dans votre application et comment créer un modèle utilisant la librairie.

Installation d’ACICRUD

L’installation d’ACICRUD est relativement classique, téléchargez la dernière version de la librairie sur la page dédiée, décompréssez l’archive et placez le fichier Acicrud.php dans le répertoire system/application/libraries.

Je vous conseille d’autocharger ACICURD ainsi que la librairie de base de données afin de ne plus s’en préoccuper, pour cela rajouter dans le fichier system/application/config/autoload.php

$autoload['libraries'] = array('database', 'acicrud');

À partir de là, la librairie est installée et sera disponible dans l’ensemble de votre application.

Création d’un modèle

La création d’un modèle est relativement simple, il suffit de faire hériter le modèle de la classe Acicrud au lieu de Model.

 
* @copyright © 2008-2009 Samuel Sanchez - All rights reserved / Tous droits réservés
* @tutorial Set the class name and the constructor method name to your model name, then rename 'table_name' into your sql table name.
*
*/
class Exemple extends Acicrud {
 
	//CONSTRUCTOR
	public function Exemple()
	{
		parent::Acicrud('table_name');
	}
 
	//CUSTOM METHODS
 
}

Il suffit d’indiquer dans le constructeur le nom de la table que le modèle doit utiliser. Le modèle pourra bien-sûr accéder à n’importe qu’elle table de la base de données dans une custom method.

Chargement du modèle

Il ne reste plus qu’à charger le modèle dans votre application :

$this->load->model('exemple');

Support and feedback are both available in English and in French.

Tutoriel suivant

» Lire facilement des données avec Acicrud