ControllerFile.php 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. <?php
  2. /**
  3. * Zend Framework
  4. *
  5. * LICENSE
  6. *
  7. * This source file is subject to the new BSD license that is bundled
  8. * with this package in the file LICENSE.txt.
  9. * It is also available through the world-wide-web at this URL:
  10. * http://framework.zend.com/license/new-bsd
  11. * If you did not receive a copy of the license and are unable to
  12. * obtain it through the world-wide-web, please send an email
  13. * to license@zend.com so we can send you a copy immediately.
  14. *
  15. * @category Zend
  16. * @package Zend_Tool
  17. * @subpackage Framework
  18. * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  19. * @license http://framework.zend.com/license/new-bsd New BSD License
  20. * @version $Id$
  21. */
  22. /**
  23. * This class is the front most class for utilizing Zend_Tool_Project
  24. *
  25. * A profile is a hierarchical set of resources that keep track of
  26. * items within a specific project.
  27. *
  28. * @category Zend
  29. * @package Zend_Tool
  30. * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  31. * @license http://framework.zend.com/license/new-bsd New BSD License
  32. */
  33. class Zend_Tool_Project_Context_Zf_ControllerFile extends Zend_Tool_Project_Context_Filesystem_File
  34. {
  35. /**
  36. * @var string
  37. */
  38. protected $_controllerName = 'index';
  39. /**
  40. * @var string
  41. */
  42. protected $_moduleName = null;
  43. /**
  44. * @var string
  45. */
  46. protected $_filesystemName = 'controllerName';
  47. /**
  48. * init()
  49. *
  50. */
  51. public function init()
  52. {
  53. $this->_controllerName = $this->_resource->getAttribute('controllerName');
  54. $this->_moduleName = $this->_resource->getAttribute('moduleName');
  55. $this->_filesystemName = ucfirst($this->_controllerName) . 'Controller.php';
  56. parent::init();
  57. }
  58. /**
  59. * getPersistentAttributes
  60. *
  61. * @return array
  62. */
  63. public function getPersistentAttributes()
  64. {
  65. return array(
  66. 'controllerName' => $this->getControllerName()
  67. );
  68. }
  69. /**
  70. * getName()
  71. *
  72. * @return string
  73. */
  74. public function getName()
  75. {
  76. return 'ControllerFile';
  77. }
  78. /**
  79. * getControllerName()
  80. *
  81. * @return string
  82. */
  83. public function getControllerName()
  84. {
  85. return $this->_controllerName;
  86. }
  87. /**
  88. * getContents()
  89. *
  90. * @return string
  91. */
  92. public function getContents()
  93. {
  94. $className = ($this->_moduleName) ? ucfirst($this->_moduleName) . '_' : '';
  95. $className .= ucfirst($this->_controllerName) . 'Controller';
  96. $codeGenFile = new Zend_CodeGenerator_Php_File(array(
  97. 'fileName' => $this->getPath(),
  98. 'classes' => array(
  99. new Zend_CodeGenerator_Php_Class(array(
  100. 'name' => $className,
  101. 'extendedClass' => 'Zend_Controller_Action',
  102. 'methods' => array(
  103. new Zend_CodeGenerator_Php_Method(array(
  104. 'name' => 'init',
  105. 'body' => '/* Initialize action controller here */',
  106. ))
  107. )
  108. ))
  109. )
  110. ));
  111. if ($className == 'ErrorController') {
  112. $codeGenFile = new Zend_CodeGenerator_Php_File(array(
  113. 'fileName' => $this->getPath(),
  114. 'classes' => array(
  115. new Zend_CodeGenerator_Php_Class(array(
  116. 'name' => $className,
  117. 'extendedClass' => 'Zend_Controller_Action',
  118. 'methods' => array(
  119. new Zend_CodeGenerator_Php_Method(array(
  120. 'name' => 'errorAction',
  121. 'body' => <<<EOS
  122. \$errors = \$this->_getParam('error_handler');
  123. switch (\$errors->type) {
  124. case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ROUTE:
  125. case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
  126. case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
  127. // 404 error -- controller or action not found
  128. \$this->getResponse()->setHttpResponseCode(404);
  129. \$this->view->message = 'Page not found';
  130. break;
  131. default:
  132. // application error
  133. \$this->getResponse()->setHttpResponseCode(500);
  134. \$this->view->message = 'Application error';
  135. break;
  136. }
  137. // Log exception, if logger available
  138. if (\$log = \$this->getLog()) {
  139. \$log->crit(\$this->view->message, \$errors->exception);
  140. }
  141. // conditionally display exceptions
  142. if (\$this->getInvokeArg('displayExceptions') == true) {
  143. \$this->view->exception = \$errors->exception;
  144. }
  145. \$this->view->request = \$errors->request;
  146. EOS
  147. )),
  148. new Zend_CodeGenerator_Php_Method(array(
  149. 'name' => 'getLog',
  150. 'body' => <<<EOS
  151. \$bootstrap = \$this->getInvokeArg('bootstrap');
  152. if (!\$bootstrap->hasPluginResource('Log')) {
  153. return false;
  154. }
  155. \$log = \$bootstrap->getResource('Log');
  156. return \$log;
  157. EOS
  158. )),
  159. )
  160. ))
  161. )
  162. ));
  163. }
  164. // store the generator into the registry so that the addAction command can use the same object later
  165. Zend_CodeGenerator_Php_File::registerFileCodeGenerator($codeGenFile); // REQUIRES filename to be set
  166. return $codeGenFile->generate();
  167. }
  168. /**
  169. * addAction()
  170. *
  171. * @param string $actionName
  172. */
  173. public function addAction($actionName)
  174. {
  175. $classCodeGen = $this->getCodeGenerator();
  176. $classCodeGen->setMethod(array('name' => $actionName . 'Action', 'body' => ' // action body here'));
  177. file_put_contents($this->getPath(), $classCodeGen->generate());
  178. }
  179. /**
  180. * getCodeGenerator()
  181. *
  182. * @return Zend_CodeGenerator_Php_Class
  183. */
  184. public function getCodeGenerator()
  185. {
  186. $codeGenFile = Zend_CodeGenerator_Php_File::fromReflectedFileName($this->getPath());
  187. $codeGenFileClasses = $codeGenFile->getClasses();
  188. $class = array_shift($codeGenFileClasses);
  189. return $class;
  190. }
  191. }