L'autoloader
Zend_Loader_Autoloader propose une solution intelligente et
souple d'auto-chargement (autoload) pour Zend Framework. Il a été conçu pour remplir
plusieurs objectifs :
Proposer un autoloader à base d'espaces de noms (auparavant, les espaces de
noms étaient interceptés).
Proposer d'enregistrer des autoloads personnalisés, et les gérer comme une
pile. (A l'heure actuelle, ceci permet de s'affranchir de certaines contraintes avec
spl_autoload, qui ne permet pas le ré-enregistrement d'une fonction à
base d'objet).
Proposer un autoload optimisé pour les espaces de noms, qui permet une
meilleure résolution des noms de classes.
Zend_Loader_Autoloader est un singleton, il est donc
universellement accessible. Ceci permet d'enregistrer des autoload depuis n'importe où dans
votre code.
Utiliser le chargeur automatique (autoloader)
La première fois qu'une instance de l'autoloader est créée, il s'enregistre
lui-même sur la fonction spl_autoload. Vous récupérez son instance via la
méthode getInstance() :
Par défaut, l'autoloader est configurer pour capturer les espaces de noms "Zend_"
et "ZendX_". Si votre propre librairie de code utilise un espace de noms différent, vous
devez alors enregistrer celui-ci avec la méthode registerNamespace(). Par
exemple, si votre librairie possède l'espace de noms "My_", vous devriez agir comme
cela :
registerNamespace('My_');
]]>
Préfixes des espaces de noms
Notez que l'exemple précédent enregistre "My_" et non "My". Ceci car
Zend_Loader_Autoloader est un autoloader global, et n'a
aucune idée qu'un préfixe de classe possède un underscore. Si c'est votre
cas, alors faites le apparaître lors de son enregistrement dans
l'autoloader.
Il est aussi possible que vous enregistriez vos propres fonctions d'autoload,
optionnellement avec un espace de noms spécifique,
Zend_Loader_Autoloader va alors tenter de l'utiliser lorsque
nécessaire (lors de l'auto-chargement).
Par exemple, vous pourriez avoir besoin d'un ou plusieurs composants eZcomponents
avec votre application Zend Framework. Pour utiliser ses capacités d'autoload, ajoutez
son autoloader à votre pile grâce à pushAutoloader() :
pushAutoloader(array('ezcBase', 'autoload'), 'ezc');
]]>
Ceci indique que les classes dont le nom commence par "ezc" devra utiliser cette
fonction d'autoload.
unshiftAutoloader(), elle, rajoute la méthode d'autoload au début de
la pile.
Par défaut, Zend_Loader_Autoloader ne supprime aucune
erreur lorsqu'il utilise son autoloader interne, s'appuyant sur
Zend_Loader::loadClass(). La plupart du temps, c'est le
comportement recherché. Cependant, si vous voulez faire apparaître les éventuelles
erreurs de chargement, appelez alors suppressNotFoundWarnings() :
suppressNotFoundWarnings(true);
]]>
Enfin, il se peut que vous vouliez que l'autoloader par défaut charge toutes les
classes de tous les espaces de noms. Par exemple, les librairies PEAR ne partagent pas
un espace de noms commun, ce qui rend la tâche difficile si on veut associer chacun des
espaces de noms internes. Utilisez alors setFallbackAutoloader() pour
rendre l'autoloader "global" et charger tous les espaces de noms :
setFallbackAutoloader(true);
]]>
L'interface de l'autoloader
Vous pouvez donc ajouter des fonctions de chargement par espace de noms, mais Zend
Framework définit aussi une interface pour l'autoload,
Zend_Loader_Autoloader_Interface :
L'utilisation de l'interface vous permet de passer un objet aux méthodes
pushAutoloader() et unshiftAutoloader() de
Zend_Loader_Autoloader :
pushAutoloader($foo, 'Foo_');
]]>
Référence de l'autoloader
Voici un guide des méthodes de
Zend_Loader_Autoloader.
Méthodes de Zend_Loader_Autoloader
Méthode
Valeur de retour
Paramètres
Description
getInstance()
Zend_Loader_Autoloader
N/A
Retourne l'instance singleton de
Zend_Loader_Autoloader Au premier appel,
enregistre l'autoloader avec spl_autoload. Cette
méthode est statique.
resetInstance()
void
N/A
Remet à zéro l'état interne de
Zend_Loader_Autoloader en désenregistrant les
fonctions d'autoload éventuellement présentes, ainsi que tous les
espaces de noms.
autoload($class)
string|false
$class, requis. Une
classe à charger.
Essaye de résoudre un nom de classe en fichier, et tente de la
charger.
setDefaultAutoloader($callback)
Zend_Loader_Autoloader
$callback,
requis.
Spécifie une fonction PHP à utiliser comme autoloader par défaut.
getDefaultAutoloader()
callback
N/A
Retourne la fonction d'autoload par défaut, il s'agit par
défaut de Zend_Loader::loadClass().
setAutoloaders(array $autoloaders)
Zend_Loader_Autoloader
$autoloaders,
requis.
Passe une liste d'autoloaders (sous forme de noms de
fonctions PHP) à ajouter à la pile de ceux déjà présents.
getAutoloaders()
array
N/A
Récupère la pile d'autoloaders interne.
getNamespaceAutoloaders($namespace)
array
$namespace,
requis
Récupère tous les autoloaders qui sont associés à un
certain espace de noms.
registerNamespace($namespace)
Zend_Loader_Autoloader
$namespace,
requis.
Enregistre un ou plusieurs espaces de noms, avec
l'autoloader par défaut. Si $namespace est une chaîne,
c'est cet espace de noms qui sera enregistré, si c'est un tableau de
chaînes, ils le seront tous.
unregisterNamespace($namespace)
Zend_Loader_Autoloader
$namespace,
requis.
Désenregistre (supprime) un espace de noms depuis
l'autoloader par défaut. Si $namespace est une chaîne,
c'est cet espace de noms qui sera désenregistré, si c'est un tableau
de chaînes, ils le seront tous.
getRegisteredNamespace()
array
N/A
Retourne un tableau comportant tous les espaces de noms
enregistrés avec l'autoloader par défaut.
suppressNotFoundWarnings($flag = null)
boolean|Zend_Loader_Autoloader
$flag, optionnel.
Affecte ou récupère la valeur du paramètre indiquant si l'autoloader
par défaut doit supprimer les warnings "file not found". Si aucun
argument (ou null) lui est passé, il retourne sa valeur actuelle,
dans le cas contraire, il retournera l'instance de l'autoloader
permettant le chainage des méthodes.
setFallbackAutoloader($flag)
Zend_Loader_Autoloader
$flag, requis.
Affecte la valeur du drapeau utilisé pour déterminer si
l'autoloader par défaut doit être utilisé comme "catch-all" pour
charger tous les espaces de noms.
isFallbackAutoloader()
boolean
N/A
Retourne la valeur du drapeau utilisé pour déterminer si
l'autoloader par défaut doit être utilisé comme "catch-all" pour
charger tous les espaces de noms.
getClassAutoloaders($class)
array
$class, requis.
Retourne une liste d'autoloaders d'espaces de noms qui pourraient
correspondre à la classe indiquée. Si aucun ne correspond, la
liste de tous les autoloaders globaux (non associés à des espaces de
noms) sera retournée.
unshiftAutoloader($callback, $namespace = '')
Zend_Loader_Autoloader
$callback, requis. Une
fonction PHP valide.
$namespace, optionnel.
Une chaîne représentant un préfixe de classe.
Ajoute un autoloader au début de la pile des autoloaders
internes. Si un espace de noms est fourni, il sera utilisé pour cet
autoloader, sinon l'autoloader sera global.
pushAutoloader($callback, $namespace = '')
Zend_Loader_Autoloader
$callback, requis. Une
fonction PHP valide.
$namespace, optionnel.
Une chaîne représentant un préfixe de classe.
Ajoute un autoloader à la fin de la pile des autoloaders
internes. Si un espace de noms est fourni, il sera utilisé pour cet
autoloader, sinon l'autoloader sera global.
removeAutoloader($callback, $namespace = '')
Zend_Loader_Autoloader
$callback, requis. Une
fonction PHP valide.
$namespace, optionnel.
Une chaîne représentant un préfixe de classe, ou un tableau
de chaînes.
Supprime un autoloader de la pile interne. Si un espace de
noms est indiqué, supprime l'autoloader pour cet espace de noms
uniquement.