1. sfGenerateModuleTask.class.php
  2. /**
 * Generates a new module.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfGenerateModuleTask.class.php 23922 2009-11-14 14:58:38Z fabien $
 */
  3. class sfGenerateModuleTask extends sfGeneratorBaseTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function configure()
  9.   {
  10.     $this->addArguments(array(
  11.       new sfCommandArgument('application', sfCommandArgument::REQUIRED, 'The application name'),
  12.       new sfCommandArgument('module', sfCommandArgument::REQUIRED, 'The module name'),
  13.     ));
  15.     $this->namespace = 'generate';
  16.     $this->name = 'module';
  18.     $this->briefDescription = 'Generates a new module';
  20.     $this->detailedDescription = <<<EOF
  21. The [generate:module|INFO] task creates the basic directory structure
  22. for a new module in an existing application:
  24.   [./symfony generate:module frontend article|INFO]
  26. The task can also change the author name found in the [actions.class.php|COMMENT]
  27. if you have configure it in [config/properties.ini|COMMENT]:
  29.   [[symfony]
  30.     name=blog
  31.     author=Fabien Potencier <fabien.potencier@sensio.com>|INFO]
  33. You can customize the default skeleton used by the task by creating a
  34. [%sf_data_dir%/skeleton/module|COMMENT] directory.
  36. The task also creates a functional test stub named
  37. [%sf_test_dir%/functional/%application%/%module%ActionsTest.class.php|COMMENT]
  38. that does not pass by default.
  40. If a module with the same name already exists in the application,
  41. it throws a [sfCommandException|COMMENT].
  42. EOF;
  43.   }
  45.   /**
  46.    * @see sfTask
  47.    */
  48.   protected function execute($arguments = array(), $options = array())
  49.   {
  50.     $app    = $arguments['application'];
  51.     $module = $arguments['module'];
  53.     // Validate the module name
  54.     if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $module))
  55.     {
  56.       throw new sfCommandException(sprintf('The module name "%s" is invalid.', $module));
  57.     }
  59.     $moduleDir = sfConfig::get('sf_app_module_dir').'/'.$module;
  61.     if (is_dir($moduleDir))
  62.     {
  63.       throw new sfCommandException(sprintf('The module "%s" already exists in the "%s" application.', $moduleDir, $app));
  64.     }
  66.     $properties = parse_ini_file(sfConfig::get('sf_config_dir').'/properties.ini', true);
  68.     $constants = array(
  69.       'PROJECT_NAME' => isset($properties['symfony']['name']) ? $properties['symfony']['name'] : 'symfony',
  70.       'APP_NAME'     => $app,
  71.       'MODULE_NAME'  => $module,
  72.       'AUTHOR_NAME'  => isset($properties['symfony']['author']) ? $properties['symfony']['author'] : 'Your name here',
  73.     );
  75.     if (is_readable(sfConfig::get('sf_data_dir').'/skeleton/module'))
  76.     {
  77.       $skeletonDir = sfConfig::get('sf_data_dir').'/skeleton/module';
  78.     }
  79.     else
  80.     {
  81.       $skeletonDir = dirname(__FILE__).'/skeleton/module';
  82.     }
  84.     // create basic application structure
  85.     $finder = sfFinder::type('any')->discard('.sf');
  86.     $this->getFilesystem()->mirror($skeletonDir.'/module', $moduleDir, $finder);
  88.     // create basic test
  89.     $this->getFilesystem()->copy($skeletonDir.'/test/actionsTest.php', sfConfig::get('sf_test_dir').'/functional/'.$app.'/'.$module.'ActionsTest.php');
  91.     // customize test file
  92.     $this->getFilesystem()->replaceTokens(sfConfig::get('sf_test_dir').'/functional/'.$app.DIRECTORY_SEPARATOR.$module.'ActionsTest.php', '##', '##', $constants);
  94.     // customize php and yml files
  95.     $finder = sfFinder::type('file')->name('*.php', '*.yml');
  96.     $this->getFilesystem()->replaceTokens($finder->in($moduleDir), '##', '##', $constants);
  97.   }
  98. }
Debug toolbar