1. sfGenerateTaskTask.class.php
  2. /**
 * Creates a task skeleton
 *
 * @package    symfony
 * @subpackage task
 * @author     Francois Zaninotto 
 */
  3. class sfGenerateTaskTask extends sfBaseTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function configure()
  9.   {
  10.     $this->addArguments(array(
  11.       new sfCommandArgument('task_name', sfCommandArgument::REQUIRED, 'The task name (can contain namespace)'),
  12.     ));
  14.     $this->addOptions(array(
  15.       new sfCommandOption('dir', null, sfCommandOption::PARAMETER_REQUIRED, 'The directory to create the task in', 'lib/task'),
  16.       new sfCommandOption('use-database', null, sfCommandOption::PARAMETER_REQUIRED, 'Whether the task needs model initialization to access database', 'doctrine'),
  17.       new sfCommandOption('brief-description', null, sfCommandOption::PARAMETER_REQUIRED, 'A brief task description (appears in task list)'),
  18.     ));
  20.     $this->namespace = 'generate';
  21.     $this->name = 'task';
  22.     $this->briefDescription = 'Creates a skeleton class for a new task';
  24.     $this->detailedDescription = <<<EOF
  25. The [generate:task|INFO] creates a new sfTask class based on the name passed as
  26. argument:
  28.   [./symfony generate:task namespace:name|INFO]
  30. The [namespaceNameTask.class.php|COMMENT] skeleton task is created under the [lib/task/|COMMENT]
  31. directory. Note that the namespace is optional.
  33. If you want to create the file in another directory (relative to the project
  34. root folder), pass it in the [--dir|COMMENT] option. This directory will be created
  35. if it does not already exist.
  37.   [./symfony generate:task namespace:name --dir=plugins/myPlugin/lib/task|INFO]
  39. If you want the task to default to a connection other than [doctrine|COMMENT], provide
  40. the name of this connection with the [--use-database|COMMENT] option:
  42.   [./symfony generate:task namespace:name --use-database=main|INFO]
  44. The [--use-database|COMMENT] option can also be used to disable database
  45. initialization in the generated task:
  47.   [./symfony generate:task namespace:name --use-database=false|INFO]
  49. You can also specify a description:
  51.   [./symfony generate:task namespace:name --brief-description="Does interesting things"|INFO]
  52. EOF;
  53.   }
  55.   /**
  56.    * @see sfTask
  57.    */
  58.   protected function execute($arguments = array(), $options = array())
  59.   {
  60.     $taskName = $arguments['task_name'];
  61.     $taskNameComponents = explode(':', $taskName);
  62.     $namespace = isset($taskNameComponents[1]) ? $taskNameComponents[0] : '';
  63.     $name = isset($taskNameComponents[1]) ? $taskNameComponents[1] : $taskNameComponents[0];
  64.     $taskClassName = str_replace('-', '', ($namespace ? $namespace.ucfirst($name) : $name)).'Task';
  66.     // Validate the class name
  67.     if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $taskClassName))
  68.     {
  69.       throw new sfCommandException(sprintf('The task class name "%s" is invalid.', $taskClassName));
  70.     }
  72.     $briefDescription = $options['brief-description'];
  73.     $detailedDescription = <<<HED
  74. The [$taskName|INFO] task does things.
  75. Call it with:
  77.   [php symfony $taskName|INFO]
  78. HED;
  80.     $useDatabase = sfToolkit::literalize($options['use-database']);
  81.     $defaultConnection = is_string($useDatabase) ? $useDatabase : 'doctrine';
  83.     if ($useDatabase)
  84.     {
  85.       $content = <<<HED
  86. <?php
  88. class $taskClassName extends sfBaseTask
  89. {
  90.   protected function configure()
  91.   {
  92.     // // add your own arguments here
  93.     // \$this->addArguments(array(
  94.     //   new sfCommandArgument('my_arg', sfCommandArgument::REQUIRED, 'My argument'),
  95.     // ));
  97.     \$this->addOptions(array(
  98.       new sfCommandOption('application', null, sfCommandOption::PARAMETER_REQUIRED, 'The application name'),
  99.       new sfCommandOption('env', null, sfCommandOption::PARAMETER_REQUIRED, 'The environment', 'dev'),
  100.       new sfCommandOption('connection', null, sfCommandOption::PARAMETER_REQUIRED, 'The connection name', '$defaultConnection'),
  101.       // add your own options here
  102.     ));
  104.     \$this->namespace        = '$namespace';
  105.     \$this->name             = '$name';
  106.     \$this->briefDescription = '$briefDescription';
  107.     \$this->detailedDescription = <<<EOF
  108. $detailedDescription
  109. EOF;
  110.   }
  112.   protected function execute(\$arguments = array(), \$options = array())
  113.   {
  114.     // initialize the database connection
  115.     \$databaseManager = new sfDatabaseManager(\$this->configuration);
  116.     \$connection = \$databaseManager->getDatabase(\$options['connection'] ? \$options['connection'] : null)->getConnection();
  118.     // add your code here
  119.   }
  120. }
  122. HED;
  123.     }
  124.     else
  125.     {
  126.       $content = <<<HED
  127. <?php
  129. class $taskClassName extends sfBaseTask
  130. {
  131.   protected function configure()
  132.   {
  133.     // // add your own arguments here
  134.     // \$this->addArguments(array(
  135.     //   new sfCommandArgument('my_arg', sfCommandArgument::REQUIRED, 'My argument'),
  136.     // ));
  138.     // // add your own options here
  139.     // \$this->addOptions(array(
  140.     //   new sfCommandOption('my_option', null, sfCommandOption::PARAMETER_REQUIRED, 'My option'),
  141.     // ));
  143.     \$this->namespace        = '$namespace';
  144.     \$this->name             = '$name';
  145.     \$this->briefDescription = '$briefDescription';
  146.     \$this->detailedDescription = <<<EOF
  147. $detailedDescription
  148. EOF;
  149.   }
  151.   protected function execute(\$arguments = array(), \$options = array())
  152.   {
  153.     // add your code here
  154.   }
  155. }
  157. HED;
  158.     }
  160.     // check that the task directory exists and that the task file doesn't exist
  161.     if (!is_readable(sfConfig::get('sf_root_dir').'/'.$options['dir']))
  162.     {
  163.       $this->getFilesystem()->mkdirs($options['dir']);
  164.     }
  166.     $taskFile = sfConfig::get('sf_root_dir').'/'.$options['dir'].'/'.$taskClassName.'.class.php';
  167.     if (is_readable($taskFile))
  168.     {
  169.       throw new sfCommandException(sprintf('A "%s" task already exists in "%s".', $taskName, $taskFile));
  170.     }
  172.     $this->logSection('task', sprintf('Creating "%s" task file', $taskFile));
  173.     file_put_contents($taskFile, $content);
  174.   }
  175. }
Debug toolbar