Tutoriel Zend Framework sur le contrôleur frontal Zend_Controller_Front, explication détaillée de l'utilisation

L'exemple dans cet article décrit l'utilisation du contrôleur frontal du didacticiel Zend Framework Zend_Controller_Front. Partagez-le avec tout le monde pour votre référence, comme suit :

Fonctions principales

Le mécanisme de base de l'implémentation MVC de ZendFramework passe par le contrôleur frontal Zend_Controller_Front, qui est utilisé pour initialiser l'environnement de requête, traiter les requêtes et la distribution des routes. Pour terminer l'opération de réponse, Zend_Controller_Front adopte le mode singleton, donc une application n'a qu'un seul contrôleur frontal. Si vous avez besoin que le contrôleur frontal fournisse certaines fonctions spéciales, vous pouvez hériter de Zend_Controller_Front pour personnaliser le contrôleur frontal.

Méthode principale

getInstance()

est utilisée pour obtenir l'instance du contrôleur frontal. La seule façon de créer un objet contrôleur frontal.

$front = Zend_Controller_Front::getInstance();

setControllerDirectory() et addControllerDirectory()

setControllerDirectory() définit l'emplacement de stockage du fichier de classe du contrôleur d'action du contrôleur d'action. Les paramètres peuvent être des chaînes de chemin ou des tableaux associatifs.

Par exemple :

//路径是相对于应用的/application目录下
// 字符串
$front->setControllerDirectory('../application/controllers');
// 关联数组
$front->setControllerDirectory(array(
  'default' => '../application/controllers',
  'blog'  => '../modules/blog/controllers',
  'news'  => '../modules/news/controllers',
));
// Add a 'foo' module directory:
$front->addControllerDirectory('../modules/foo/controllers', 'foo');

Remarque : Si vous utilisez addControllerDirectory() sans nom de module, le répertoire sera défini pour le module par défaut ——Si le répertoire a été défini, écrasez-le.

Le paramètre actuel du répertoire du contrôleur peut être obtenu via getControllerDirectory(); il renverra un tableau associatif de paires module/répertoire.

addModuleDirectory() et getModuleDirectory()

Une fonctionnalité du contrôleur frontal est que vous pouvez définir une structure de répertoires de modules pour créer des composants indépendants, appelés « modules ».

Chaque module est situé dans son propre répertoire et a la même structure de répertoires que le module par défaut - par exemple, il a au moins un sous-répertoire "controllers" et un sous-répertoire "views" et d'autres sous-répertoires d'application.

addModuleDirectory() permet de passer le nom d'un répertoire contenant un ou plusieurs répertoires de modules. Ils sont ensuite analysés et ajoutés au contrôleur frontal en tant que répertoires de contrôleurs.

Ensuite, si vous souhaitez déterminer un module spécifique ou le chemin actuel du module, appelez getModuleDirectory(), en passant éventuellement le nom du module pour obtenir le répertoire du module.

dispatch()

dispatch(Zend_Controller_Request_Abstract $request = null, Zend_Controller_Response_Abstract $response = null) termine le travail le plus lourd du contrôleur frontal. Cette méthode prend des paramètres facultatifs : objet de demande et/ou objet de réponse, permettant au développeur de transmettre des objets personnalisés pour chacun.

Si aucun objet de requête ou de réponse n'est transmis, dispatch() vérifiera l'objet précédemment enregistré et l'utilisera, et créera la version d'objet par défaut si aucun n'est trouvé (les deux utilisent des objets HTTP par défaut).

De même, dispatch() vérifie d'abord les objets routeur et répartiteur enregistrés, et instancie leurs versions par défaut s'ils ne sont pas trouvés.

Le processus de distribution comporte trois événements différents : Routage, Dispatching et Response

Le routage ne se produit qu'une seule fois lorsque dispatch() est appelé, la valeur de la requête est utilisée. La distribution s'effectue en boucle ; une requête peut indiquer plusieurs actions à distribuer, ou un contrôleur ou un plugin peut réinitialiser l'objet de la requête, forçant la distribution d'actions supplémentaires. Lorsque tout est terminé, le contrôleur frontal renvoie l’objet de réponse.

run()

Zend_Controller_Front::run($path) est une méthode statique qui ne prend qu'un seul paramètre, qui est le chemin d'accès au répertoire contenant le contrôleur. Il obtient d'abord l'instance du contrôleur frontal via getInstance(), puis enregistre le chemin entrant via setControllerDirectory() et enfin le distribue.

Fondamentalement, s'il n'est pas nécessaire de personnaliser l'environnement du contrôleur frontal, run() est une méthode très pratique pour établir l'environnement du contrôleur frontal.

Zend_Controller_Front::run('../application/controllers');

Méthodes d'accès à l'environnement

En plus des méthodes répertoriées ci-dessus, il existe de nombreuses méthodes d'accès qui peuvent affecter l'environnement du contrôleur frontal. - affecte donc également l'environnement de la classe du délégué du contrôleur frontal.

La méthode resetInstance() efface tous les paramètres actuels. Principalement utilisé pour les tests, mais il peut également être utilisé dans les cas où vous souhaitez enchaîner plusieurs contrôleurs frontaux. La méthode

(set|get)DefaultControllerName() peut spécifier un autre nom pour le contrôleur par défaut (sinon, utilisez 'index') et obtenir la valeur actuelle. Ils mandateront le distributeur. La méthode

(set|get)DefaultAction() peut spécifier un autre nom pour l'action par défaut (sinon, utilisez 'index') et obtenir la valeur actuelle. Ils mandateront le distributeur. La méthode

(set|get)Request() spécifie la classe de requête ou l'objet utilisé dans le processus de distribution et obtient l'objet de requête actuel. Lors de la définition de l'objet de requête, vous pouvez transmettre le nom d'une classe de requête, et cette méthode chargera le fichier de classe et créera une instance. La méthode

(set|get)Router() spécifie la classe de routeur ou l'objet utilisé dans le processus de distribution et obtient l'objet actuel. Lors de la configuration d'un routeur, vous pouvez transmettre le nom d'une classe de routeur et cette méthode chargera le fichier de classe et créera une instance.

Lors de l'obtention d'un objet routeur, vérifiez d'abord s'il existe. Sinon, créez une instance de routeur par défaut (routeur de réécriture).

(set|get)BaseUrl()方法指定路由请求时剥离（strip）的基地址（base URL），以及获取当前值。这个值将在路由前提供给路由器。

(set|get)Dispatcher()方法指定分发过程中使用的分发器类或对象，以及获取当前对象。设定分发器对象时，可以传入一个分发器类的名字，该方法将加载类文件并创建实例。

获取分发器对象时，首先检查是否已有一个存在，如果没有，将创建一个默认的分发器实例。

(set|get)Response()方法指定分发过程中使用的响应类或对象，已经获取当前对象。设定响应对象时，可以传入一个响应类的名字，该方法将加载类文件并创建实例。

registerPlugin(Zend_Controller_Plugin_Abstract $plugin, $stackIndex = null)方法允许注册一个插件对象。通过设置可选参数$stackIndex，插件执行的顺序。

unregisterPlugin($plugin)方法移除插件对象。$plugin可以是一个插件对象或者代表移除插件类的字符串。

throwExceptions($flag)方法用来开启或者关闭分发过程中抛出异常的能力。默认的，异常引起并放置在响应对象中；开启throwExceptions()将覆盖这一行为。

returnResponse($flag)方法通知前端控制器是否从dispatch()中返回请求对象（true），否则自动发送响应对象（false—）。默认的，响应对象被自动发送（通过调用Zend_Controller_Response_Abstract::sendResponse()）；开启returnResponse()将覆盖这一行为。

返回响应对象的原因包括希望在发送响应前检查异常，记录响应的各种属性（例如消息头）等等。

前端控制器参数

介绍里曾提到前端控制器可以用作各种控制器组件的注册表。它通过一个"param"家族的方法来做到这些。这些方法允许通过前端控制器注册任意类型的数据 —— 对象和变量，可以在分发链中的任何时候获取。这些变量被传递到路由器，分发器，以及动作控制器。这些方法包括：

setParam($name, $value)方法设定值为$value的单个参数$name。
setParams(array $params)方法通过关联数组一次设定多个参数。
getParam($name)方法通过$name标识符获取单个参数。
getParams()方法一次获取整个参数列表。
clearParams()方法可以清空一个参数（传入单个字符串标识符），清空多个参数（传入字符串标识符数组），清空整个参数栈（不传入参数）。

有几个预定义的参数可供设定，它们在分发链中有特别的用途：

useDefaultControllerAlways用来提示 分发器遇到无法分发的请求时使用默认模块的默认控制器。这默认是关闭的。

阅读可能遭遇的MVC异常获得使用该设定的更详尽信息。

disableOutputBuffering用来提示 is used to hint to 分发器不使用输出缓冲来捕捉动作控制器产生的输出。默认的，分发器捕捉任何输出并追加到响应对象的主体内容。

noViewRenderer用来禁用ViewRenderer。设定该参数为true可以禁用该助手。

noErrorHandler 用来禁用错误处理器插件。设定该参数为true可以禁用该插件。

自定义前端控制器

要继承前端控制器，至少需要覆盖getInstance()方法：

class My_Controller_Front extends Zend_Controller_Front
{
  public static function getInstance()
  {
    if (null === self::$_instance) {
      self::$_instance = new self();
    }
    return self::$_instance;
  }
}

   

覆盖getInstance()保证后面调用Zend_Controller_Front::getInstance()会返回子类的实例，而不是Zend_Controller_Front实例，这对于一些可替换的路由器和视图助手非常有用。

通常不需要继承前端控制器，除非你需要增加新的功能（比如，一个插件自动加载器，或者一个方法来指定动作助手路径）。你想要改动的地方可能包括修改控制器目录的存储方式，使用的默认路由器以及分发器。

ZendFramewrok提供的默认前端控制器已经足够我们使用了，通过Bootstrap功能，完全没有必要手动编写代码改变Zend_Controller_Front的默认机制。所以通常情况下Zend_Controller_Front对于应用来说是不存在。如果需要使用Zend_Controller_Front提供的功能，通过Zend_Controller_Front::getInstance();获取实例即可。

希望本文所述对大家PHP程序设计有所帮助。

更多Zend Framework教程之前端控制器Zend_Controller_Front用法详解相关文章请关注PHP中文网！