Form.php 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  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-2015 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. * @category Zend
  24. * @package Zend_Tool
  25. * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  26. * @license http://framework.zend.com/license/new-bsd New BSD License
  27. */
  28. class Zend_Tool_Project_Provider_Form extends Zend_Tool_Project_Provider_Abstract
  29. {
  30. public static function createResource(Zend_Tool_Project_Profile $profile, $formName, $moduleName = null)
  31. {
  32. if (!is_string($formName)) {
  33. throw new Zend_Tool_Project_Provider_Exception('Zend_Tool_Project_Provider_Form::createResource() expects \"formName\" is the name of a form resource to create.');
  34. }
  35. if (!($formsDirectory = self::_getFormsDirectoryResource($profile, $moduleName))) {
  36. if ($moduleName) {
  37. $exceptionMessage = 'A form directory for module "' . $moduleName . '" was not found.';
  38. } else {
  39. $exceptionMessage = 'A form directory was not found.';
  40. }
  41. throw new Zend_Tool_Project_Provider_Exception($exceptionMessage);
  42. }
  43. $newForm = $formsDirectory->createResource(
  44. 'formFile',
  45. array('formName' => $formName, 'moduleName' => $moduleName)
  46. );
  47. return $newForm;
  48. }
  49. /**
  50. * hasResource()
  51. *
  52. * @param Zend_Tool_Project_Profile $profile
  53. * @param string $formName
  54. * @param string $moduleName
  55. * @return Zend_Tool_Project_Profile_Resource
  56. */
  57. public static function hasResource(Zend_Tool_Project_Profile $profile, $formName, $moduleName = null)
  58. {
  59. if (!is_string($formName)) {
  60. throw new Zend_Tool_Project_Provider_Exception('Zend_Tool_Project_Provider_Form::createResource() expects \"formName\" is the name of a form resource to check for existence.');
  61. }
  62. $formsDirectory = self::_getFormsDirectoryResource($profile, $moduleName);
  63. return (($formsDirectory->search(array('formFile' => array('formName' => $formName)))) instanceof Zend_Tool_Project_Profile_Resource);
  64. }
  65. /**
  66. * _getFormsDirectoryResource()
  67. *
  68. * @param Zend_Tool_Project_Profile $profile
  69. * @param string $moduleName
  70. * @return Zend_Tool_Project_Profile_Resource
  71. */
  72. protected static function _getFormsDirectoryResource(Zend_Tool_Project_Profile $profile, $moduleName = null)
  73. {
  74. $profileSearchParams = array();
  75. if ($moduleName != null && is_string($moduleName)) {
  76. $profileSearchParams = array('modulesDirectory', 'moduleDirectory' => array('moduleName' => $moduleName));
  77. }
  78. $profileSearchParams[] = 'formsDirectory';
  79. return $profile->search($profileSearchParams);
  80. }
  81. public function enable($module = null)
  82. {
  83. $this->_loadProfile(self::NO_PROFILE_THROW_EXCEPTION);
  84. // determine if testing is enabled in the project
  85. $testingEnabled = Zend_Tool_Project_Provider_Test::isTestingEnabled($this->_loadedProfile);
  86. $formDirectoryResource = self::_getFormsDirectoryResource($this->_loadedProfile, $module);
  87. if ($formDirectoryResource->isEnabled()) {
  88. throw new Zend_Tool_Project_Provider_Exception('This project already has forms enabled.');
  89. } else {
  90. if ($this->_registry->getRequest()->isPretend()) {
  91. $this->_registry->getResponse()->appendContent('Would enable forms directory at ' . $formDirectoryResource->getContext()->getPath());
  92. } else {
  93. $this->_registry->getResponse()->appendContent('Enabling forms directory at ' . $formDirectoryResource->getContext()->getPath());
  94. $formDirectoryResource->setEnabled(true);
  95. $formDirectoryResource->create();
  96. $this->_storeProfile();
  97. }
  98. }
  99. }
  100. /**
  101. * Create a new form
  102. *
  103. * @param string $name
  104. * @param string $module
  105. */
  106. public function create($name, $module = null)
  107. {
  108. $this->_loadProfile(self::NO_PROFILE_THROW_EXCEPTION);
  109. // determine if testing is enabled in the project
  110. $testingEnabled = Zend_Tool_Project_Provider_Test::isTestingEnabled($this->_loadedProfile);
  111. if (self::hasResource($this->_loadedProfile, $name, $module)) {
  112. throw new Zend_Tool_Project_Provider_Exception('This project already has a form named ' . $name);
  113. }
  114. // Check that there is not a dash or underscore, return if doesnt match regex
  115. if (preg_match('#[_-]#', $name)) {
  116. throw new Zend_Tool_Project_Provider_Exception('Form names should be camel cased.');
  117. }
  118. $name = ucwords($name);
  119. try {
  120. $formResource = self::createResource($this->_loadedProfile, $name, $module);
  121. if ($testingEnabled) {
  122. $testFormResource = null;
  123. // $testFormResource = Zend_Tool_Project_Provider_Test::createApplicationResource($this->_loadedProfile, $name, 'index', $module);
  124. }
  125. } catch (Exception $e) {
  126. $response = $this->_registry->getResponse();
  127. $response->setException($e);
  128. return;
  129. }
  130. // do the creation
  131. if ($this->_registry->getRequest()->isPretend()) {
  132. $this->_registry->getResponse()->appendContent('Would create a form at ' . $formResource->getContext()->getPath());
  133. if ($testFormResource) {
  134. $this->_registry->getResponse()->appendContent('Would create a form test file at ' . $testFormResource->getContext()->getPath());
  135. }
  136. } else {
  137. $this->_registry->getResponse()->appendContent('Creating a form at ' . $formResource->getContext()->getPath());
  138. $formResource->create();
  139. if ($testFormResource) {
  140. $this->_registry->getResponse()->appendContent('Creating a form test file at ' . $testFormResource->getContext()->getPath());
  141. $testFormResource->create();
  142. }
  143. $this->_storeProfile();
  144. }
  145. }
  146. }