模型逻辑
首先,值得一提的是,控制器应该只需要功能测试,尽管所有逻辑都属于模型。
我的实现
以下是我的操作控制器实现的摘录,它解决了以下问题:
- 允许将任何依赖项注入到操作中
- 验证操作参数,例如,当期望整数时,您可能无法传入数组
$_GET
我的完整代码还允许生成基于或必需或已处理的操作参数的规范URL(用于SEO或统计信息的唯一页面哈希)。为此,我使用此抽象操作控制器和自定义请求对象,但这不是我们在这里讨论的情况。
显然,我使用反射来自动确定操作参数和依赖项对象。
这是一个巨大的优势,简化了代码,但也对性能有影响(在我的应用程序和服务器的情况下,这是最小的,并不重要),但你可以实现一些缓存来加快它。计算优点和缺点,然后决定。
DocBlock注释正在成为一个非常知名的行业标准,并且出于评估目的对其进行解析变得更加流行(例如,Doctrine 2)。我在许多应用程序中都使用了这种技术,并且效果很好。
写这门课时,我受到了行动的启发,现在有参数!和Jani Hartikainen的博客文章。
所以,这是代码:
<?php
/**
* Enchanced action controller
*
* Map request parameters to action method
*
* Important:
* When you declare optional arguments with default parameters,
* they may not be perceded by optional arguments,
* e.g.
* @example
* indexAction($username = 'tom', $pageid); // wrong
* indexAction($pageid, $username = 'tom'); // OK
*
* Each argument must have @param DocBlock
* Order of @param DocBlocks *is* important
*
* Allows to inject object dependency on actions:
* @example
* * @param int $pageid
* * @param Default_Form_Test $form
* public function indexAction($pageid, Default_Form_Test $form = null)
*
*/
abstract class Your_Controller_Action extends Zend_Controller_Action
{
/**
*
* @var array
*/
protected $_basicTypes = array(
'int', 'integer', 'bool', 'boolean',
'string', 'array', 'object',
'double', 'float'
);
/**
* Detect whether dispatched action exists
*
* @param string $action
* @return bool
*/
protected function _hasAction($action)
{
if ($this->getInvokeArg('useCaseSensitiveActions')) {
trigger_error(
'Using case sensitive actions without word separators' .
'is deprecated; please do not rely on this "feature"'
);
return true;
}
if (method_exists($this, $action)) {
return true;
}
return false;
}
/**
*
* @param string $action
* @return array of Zend_Reflection_Parameter objects
*/
protected function _actionReflectionParams($action)
{
$reflMethod = new Zend_Reflection_Method($this, $action);
$parameters = $reflMethod->getParameters();
return $parameters;
}
/**
*
* @param Zend_Reflection_Parameter $parameter
* @return string
* @throws Your_Controller_Action_Exception when required @param is missing
*/
protected function _getParameterType(Zend_Reflection_Parameter $parameter)
{
// get parameter type
$reflClass = $parameter->getClass();
if ($reflClass instanceof Zend_Reflection_Class) {
$type = $reflClass->getName();
} else if ($parameter->isArray()) {
$type = 'array';
} else {
$type = $parameter->getType();
}
if (null === $type) {
throw new Your_Controller_Action_Exception(
sprintf(
"Required @param DocBlock not found for '%s'", $parameter->getName()
)
);
}
return $type;
}
/**
*
* @param Zend_Reflection_Parameter $parameter
* @return mixed
* @throws Your_Controller_Action_Exception when required argument is missing
*/
protected function _getParameterValue(Zend_Reflection_Parameter $parameter)
{
$name = $parameter->getName();
$requestValue = $this->getRequest()->getParam($name);
if (null !== $requestValue) {
$value = $requestValue;
} else if ($parameter->isDefaultValueAvailable()) {
$value = $parameter->getDefaultValue();
} else {
if (!$parameter->isOptional()) {
throw new Your_Controller_Action_Exception(
sprintf("Missing required value for argument: '%s'", $name));
}
$value = null;
}
return $value;
}
/**
*
* @param mixed $value
*/
protected function _fixValueType($value, $type)
{
if (in_array($type, $this->_basicTypes)) {
settype($value, $type);
}
return $value;
}
/**
* Dispatch the requested action
*
* @param string $action Method name of action
* @return void
*/
public function dispatch($action)
{
$request = $this->getRequest();
// Notify helpers of action preDispatch state
$this->_helper->notifyPreDispatch();
$this->preDispatch();
if ($request->isDispatched()) {
// preDispatch() didn't change the action, so we can continue
if ($this->_hasAction($action)) {
$requestArgs = array();
$dependencyObjects = array();
$requiredArgs = array();
foreach ($this->_actionReflectionParams($action) as $parameter) {
$type = $this->_getParameterType($parameter);
$name = $parameter->getName();
$value = $this->_getParameterValue($parameter);
if (!in_array($type, $this->_basicTypes)) {
if (!is_object($value)) {
$value = new $type($value);
}
$dependencyObjects[$name] = $value;
} else {
$value = $this->_fixValueType($value, $type);
$requestArgs[$name] = $value;
}
if (!$parameter->isOptional()) {
$requiredArgs[$name] = $value;
}
}
// handle canonical URLs here
$allArgs = array_merge($requestArgs, $dependencyObjects);
// dispatch the action with arguments
call_user_func_array(array($this, $action), $allArgs);
} else {
$this->__call($action, array());
}
$this->postDispatch();
}
$this->_helper->notifyPostDispatch();
}
}
要使用它,只需:
Your_FineController extends Your_Controller_Action {}
并像往常一样为操作提供注释(至少您应该;)。
例如:
/**
* @param int $id Mandatory parameter
* @param string $sorting Not required parameter
* @param Your_Model_Name $model Optional dependency object
*/
public function indexAction($id, $sorting = null, Your_Model_Name $model = null)
{
// model has been already automatically instantiated if null
$entry = $model->getOneById($id, $sorting);
}
(DocBlock是必需的,但是我使用Netbeans IDE,因此DocBlock是根据操作参数自动生成的)