Magazine High tech

Mise en place d'un bootstrap amélioré avec Initializer

Publié le 20 avril 2009 par Wtc0der

Je vais essayer par cet article de présenter la mise en place d'un bootstrap basé sur l'utilisation d'un "Initializer" lui même chargé au travers d'un plugin du contrôleur frontal

Cet Initializer doit permettre (comme son nom l'indique) l'initialisation de l'environnement d'exécution du script en fonction du contexte.

Je m'explique :

Imaginons que je travail sur un projet avec Fabrice : notre script doit être capable de s'exécuter dans 4 contextes différents :

  • Ma machine locale
  • La machine locale de Fabrice
  • Le serveur de test
  • Le serveur de production

orga

En effet, pour chacun de ces 4 environnements, les paramètres de connexions à la base de donnée, le chemin vers certain répertoire ou encore la gestion des erreurs peuvent avoir besoin d'être différent.

Notre script doit donc être capable d'identifier dans quel contexte il se trouve et d'appliquer au besoin les ajustement qui s'impose : C'est le rôle de l'Initializer.

Le Bootstrap :

~/application/bootstrap.php

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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<?php
/**
 * My new Zend Framework project
 *
 * @author
 * @version
 */
set_include_path('.' PATH_SEPARATOR '../data'
PATH_SEPARATOR '../library'
PATH_SEPARATOR '../application/default/models/'
PATH_SEPARATOR get_include_path());
require_once 'Initializer.php';
require_once "Zend/Loader.php";
// Parametrage de l'autoload
Zend_Loader::registerAutoload();
// Création d'un espace de nom en session, et stockage de ce dernier dans la registry
$temp = new Zend_Session_Namespace('MVC_session');
Zend_Registry::set('session', $temp);
// Préparation du controleur frontal
$frontController = Zend_Controller_Front::getInstance();
// Enregistrement de notre plugin "Initilizer"
$frontController->registerPlugin(new Initializer());
// Lancement du controleur frontal (dispatch)
try {
$frontController->dispatch();
} catch (Exception $e) {
$message = sprintf('<hr>DEBUG INFOS :<br />
<strong>Exception de type <em>%s</em>
<br/><br/><u><font size="+2" color="red">%s</font></u>
<br/><br/>

envoyée dans %s à la ligne <b>%d</b> </strong>
 <p>Stack Trace : %s </p><hr>'
,

get_class($e),
$e->getMessage(),
$e->getFile(),
$e->getLine(),
Zend_Debug::dump($e,null,false));
exit($message);
}

Comme vous pouvez le voir, notre bootstrap ne possède rien de particulier si ce n'est cette ligne :

27
28
// Enregistrement de notre plugin "Initilizer"
$frontController->registerPlugin(new Initializer());


Nous demandons à notre contrôleur frontal d'enregistrer, c'est à dire de prendre en compte et d'utiliser un plugin : une instance de la classe Initializer.
C'est cette dernière qui va nous permettre d'affiner l'environnement d'exécution en fonction du contexte.

L'Initializer :

L'initializer est un concept, une notion.

Il est représenté par une classe qui étend Zend_Controller_Plugin_Abstract et qui est utilisée via un plugin du contrôleur frontal :
(Plus d'info sur le site du framework)

~/application/Initializer.php

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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<?php
/**
 * My new Zend Framework project
 *
 * @author
 * @version
 */
require_once 'Zend/Controller/Plugin/Abstract.php';
require_once 'Zend/Controller/Front.php';
require_once 'Zend/Controller/Request/Abstract.php';
require_once 'Zend/Controller/Action/HelperBroker.php';
/**
 *
 * Configuration de l'env d'execution en fonction du contexte
* (test, development, production, etc.)
*
 */
class Initializer extends Zend_Controller_Plugin_Abstract
{
/**
  * @var Zend_Config
  */
protected static $_config;
/**
  * @var string Current environment
  */
protected $_env;
/**
  * @var Zend_Controller_Front
  */
protected $_front;
/**
  * @var string Path to application root
  */
protected $_root;
/**
  * Constructor
  *
  * Initialise l'environement.
  *
  * @param string $env
  * @param string|null $root
  * @return void
  */
public function __construct($env = null, $root = null)
{

if($_SERVER['DOCUMENT_ROOT'] == '/var/www/public/') {
$this->_env = 'PROD';
} elseif($_SERVER['DOCUMENT_ROOT'] == '/home/dev/public_html/public/') {
$this->_env = 'TEST';
} elseif($_SERVER['DOCUMENT_ROOT'] == '/home/fabrice/public_html/public') {
$this->_env = 'DEV';
} elseif($_SERVER['DOCUMENT_ROOT'] == '/home/antoine/public_html/public') {
$this->_env = 'DEV';
}else {
exit;
}

date_default_timezone_set('Europe/Paris');
$root = null;
if (null === $root) {
$root = realpath(dirname(__FILE__) '/../');
}
$this->_root = $root;
$this->_front = Zend_Controller_Front::getInstance();
$this->initPhpConfig();
}
/**
  * Initialize environment
  *
  * @param string $env
  * @return void
  */
protected function _setEnv($env)
{
$this->_env = $env;
}
/**
  * Initialize Data bases
  *
  * @return void
  */
public function initPhpConfig()
{
// set the test environment parameters
if ($env != 'PROD') {
// Enable all errors so we'll know when something goes wrong.
error_reporting(E_ALL ^ E_NOTICE);
ini_set('display_startup_errors', 1);
ini_set('display_errors', 1);
$this->_front->throwExceptions(true);
} else {
//error_reporting(E_ALL ^ E_NOTICE);
ini_set('display_startup_errors', 0);
ini_set('display_errors', 0);
$this->_front->throwExceptions(false);
}
}
/**
  * Route startup
  *
  * @return void
  */
public function routeStartup(Zend_Controller_Request_Abstract $request)
{
$this->initDb();
$this->initHelpers();
$this->initView();
$this->initPlugins();
$this->initRoutes();
$this->initControllers();
$this->initAcl();
}
/**
  * Initialize data bases
  *
  * @return void
  */
public function initDb()
{
$Config = new Zend_Config_Ini($this->_root
.
'/application/config/config.ini'
,
$this->_env);

$Reg = Zend_Registry::getInstance();
$Reg -> set('config', $Config);
$Reg -> set('env', $this->_env);
$temp = Zend_Db::factory($Config->db->default);
Zend_Registry::set('db', $temp);
Zend_Db_Table::setDefaultAdapter($temp);
}
/**
  * Initialize action helpers
  *
  * @return void
  */
public function initHelpers()
{
// register the default action helpers
Zend_Controller_Action_HelperBroker::addPath('../application/default/helpers',
'Zend_Controller_Action_Helper');
}
/**
  * Initialize view
  *
  * @return void
  */
public function initView()
{
// Bootstrap layouts
Zend_Layout::startMvc(array(
'layoutPath' => $this->_root '/application/default/layouts',
'layout' => 'main'
));
}
/**
  * Initialize plugins
  *
  * @return void
  */
public function initPlugins()
{
}
/**
  * Initialize routes
  *
  * @return void
  */
public function initRoutes()
{
}
/**
  * Initialize Controller paths
  *
  * @return void
  */
public function initControllers()
{
$this->_front->setModuleControllerDirectoryName('controllers');
$this->_front->addModuleDirectory("../application");
$this->_front->addControllerDirectory($this->_root
'/application/default/controllers', 'default');

$this->_front->addControllerDirectory($this->_root
'/application/test/controllers'
, 'test');

}
public function InitAcl()
{
}
}


Toute la magie s'oppère dans le contructeur !

Dans notre exemple, nous nous basons sur la variable d'environement $_SERVER['DOCUMENT_ROOT'] pour détecter le contexte d'exécution :
(Nous aurions pu aussi bien utiliser l'adresse IP du serveur)

51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
    public function __construct($env = null, $root = null)
{
if($_SERVER['DOCUMENT_ROOT'] == '/var/www/public/') {
$this->_env = 'PROD';
} elseif($_SERVER['DOCUMENT_ROOT'] == '/home/dev/public_html/public/') {
$this->_env = 'TEST';
} elseif($_SERVER['DOCUMENT_ROOT'] == '/home/fabrice/public_html/public') {
$this->_env = 'DEV_FABRICE';
} elseif($_SERVER['DOCUMENT_ROOT'] == '/home/antoine/public_html/public') {
$this->_env = 'DEV_ANTOINE';
}else {
exit;
}

Nous retrouvons bien nos 4 environnements de d'exécution différents appelés sous :

  • PROD pour l'environnement de production
  • TEST pour l'environnement de test
  • DEV_FABRICE pour la machine locale de Fabrice
  • DEV_ANTOINE pour ma machine locale

Nous pouvons à present initialiser la connexion à la base de donnée via notre fichier config en fonction du contexte :

136
137
138
139
140
141
142
143
144
145
146
147
public function initDb()
{
$Config = new Zend_Config_Ini($this->_root
'/application/config/config.ini'
, $this->_env);
$Reg = Zend_Registry::getInstance();
$Reg -> set('config', $Config);
$Reg -> set('env', $this->_env);
$temp = Zend_Db::factory($Config->db->default);
Zend_Registry::set('db', $temp);
Zend_Db_Table::setDefaultAdapter($temp);
}

Le fichier de config pourrait alors ressembler à ceci :

~/application/config/config.ini

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
[DEV_FABRICE]
db.default.adapter = PDO_MYSQL
db.default.params.host = localhost
db.default.params.username = fabrice
db.default.params.password = azerty
db.default.params.dbname = mabase
[DEV_ANTOINE]
db.default.adapter = PDO_MYSQL
db.default.params.host = localhost
db.default.params.username = antoine
db.default.params.password = 123456
db.default.params.dbname = mabase
[TEST]
db.default.adapter = PDO_MYSQL
db.default.params.host = localhost
db.default.params.username = serveur_test
db.default.params.password = linux
db.default.params.dbname = DB_TEST
[PROD]
db.default.adapter = PDO_MYSQL
db.default.params.host = 192.168.0.2
db.default.params.username = production
db.default.params.password = password
db.default.params.dbname = DB_PROD


Ou configurer la gestion des erreurs via la méthode initPhpConfig comme ceci :

97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
    public function initPhpConfig()
{
// set the test environment parameters
if ($env != 'PROD') {
// Enable all errors so we'll know when something goes wrong.
error_reporting(E_ALL ^ E_NOTICE);
ini_set('display_startup_errors', 1);
ini_set('display_errors', 1);
$this->_front->throwExceptions(true);
} else {
//error_reporting(E_ALL ^ E_NOTICE);
ini_set('display_startup_errors', 0);
ini_set('display_errors', 0);
$this->_front->throwExceptions(false);
}
}



Pour conclure :

Cet exemple montre clairement l'avantage que peut représenter l'utilisation du concepte "d'Initializer" dans un développement en mode collaboratif et permet de séparer une fois de plus 2 logiques différentes, celle du lancement brute de l'application (le bootstrap) et celle de l'initialisation de l'application (l'Initializer).



Vous pourriez être intéressé par :

Retour à La Une de Logo Paperblog

Ces articles peuvent vous intéresser :

A propos de l’auteur


Wtc0der 1 partage Voir son profil
Voir son blog

l'auteur n'a pas encore renseigné son compte l'auteur n'a pas encore renseigné son compte l'auteur n'a pas encore renseigné son compte