1. sfListTask.class.php
  2. /**
 * Lists tasks.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfListTask.class.php 21428 2009-08-25 11:24:13Z fabien $
 */
  3. class sfListTask extends sfCommandApplicationTask
  4. {
  5.   /**
  6.    * @see sfTask
  7.    */
  8.   protected function configure()
  9.   {
  10.     $this->addArguments(array(
  11.       new sfCommandArgument('namespace', sfCommandArgument::OPTIONAL, 'The namespace name'),
  12.     ));
  14.     $this->addOptions(array(
  15.       new sfCommandOption('xml', null, sfCommandOption::PARAMETER_NONE, 'To output help as XML'),
  16.     ));
  18.     $this->briefDescription = 'Lists tasks';
  20.     $this->detailedDescription = <<<EOF
  21. The [list|INFO] task lists all tasks:
  23.   [./symfony list|INFO]
  25. You can also display the tasks for a specific namespace:
  27.   [./symfony list test|INFO]
  29. You can also output the information as XML by using the [--xml|COMMENT] option:
  31.   [./symfony list --xml|INFO]
  32. EOF;
  33.   }
  35.   /**
  36.    * @see sfTask
  37.    */
  38.   protected function execute($arguments = array(), $options = array())
  39.   {
  40.     $tasks = array();
  41.     foreach ($this->commandApplication->getTasks() as $name => $task)
  42.     {
  43.       if ($arguments['namespace'] && $arguments['namespace'] != $task->getNamespace())
  44.       {
  45.         continue;
  46.       }
  48.       if ($name != $task->getFullName())
  49.       {
  50.         // it is an alias
  51.         continue;
  52.       }
  54.       if (!$task->getNamespace())
  55.       {
  56.         $name = '_default:'.$name;
  57.       }
  59.       $tasks[$name] = $task;
  60.     }
  62.     if ($options['xml'])
  63.     {
  64.       $this->outputAsXml($arguments['namespace'], $tasks);
  65.     }
  66.     else
  67.     {
  68.       $this->outputAsText($arguments['namespace'], $tasks);
  69.     }
  70.   }
  72.   protected function outputAsText($namespace, $tasks)
  73.   {
  74.     $this->commandApplication->help();
  75.     $this->log('');
  77.     $width = 0;
  78.     foreach ($tasks as $name => $task)
  79.     {
  80.       $width = strlen($task->getName()) > $width ? strlen($task->getName()) : $width;
  81.     }
  82.     $width += strlen($this->formatter->format('  ', 'INFO'));
  84.     $messages = array();
  85.     if ($namespace)
  86.     {
  87.       $messages[] = $this->formatter->format(sprintf("Available tasks for the \"%s\" namespace:", $namespace), 'COMMENT');
  88.     }
  89.     else
  90.     {
  91.       $messages[] = $this->formatter->format('Available tasks:', 'COMMENT');
  92.     }
  94.     // display tasks
  95.     ksort($tasks);
  96.     $currentNamespace = '';
  97.     foreach ($tasks as $name => $task)
  98.     {
  99.       if (!$namespace && $currentNamespace != $task->getNamespace())
  100.       {
  101.         $currentNamespace = $task->getNamespace();
  102.         $messages[] = $this->formatter->format($task->getNamespace(), 'COMMENT');
  103.       }
  105.       $aliases = $task->getAliases() ? $this->formatter->format(' ('.implode(', ', $task->getAliases()).')', 'COMMENT') : '';
  107.       $messages[] = sprintf("  %-${width}s %s%s", $this->formatter->format(':'.$task->getName(), 'INFO'), $task->getBriefDescription(), $aliases);
  108.     }
  110.     $this->log($messages);
  111.   }
  113.   protected function outputAsXml($namespace, $tasks)
  114.   {
  115.     $dom = new DOMDocument('1.0', 'UTF-8');
  116.     $dom->formatOutput = true;
  117.     $dom->appendChild($symfonyXML = $dom->createElement('symfony'));
  119.     $symfonyXML->appendChild($tasksXML = $dom->createElement('tasks'));
  121.     if ($namespace)
  122.     {
  123.       $tasksXML->setAttribute('namespace', $namespace);
  124.     }
  125.     else
  126.     {
  127.       $symfonyXML->appendChild($namespacesXML = $dom->createElement('namespaces'));
  128.     }
  130.     // display tasks
  131.     ksort($tasks);
  132.     $currentNamespace = 'foobar';
  133.     $namespaceArrayXML = array();
  134.     foreach ($tasks as $name => $task)
  135.     {
  136.       if (!$namespace && $currentNamespace != $task->getNamespace())
  137.       {
  138.         $currentNamespace = $task->getNamespace();
  139.         $namespacesXML->appendChild($namespaceArrayXML[$task->getNamespace()] = $dom->createElement('namespace'));
  141.         $namespaceArrayXML[$task->getNamespace()]->setAttribute('id', $task->getNamespace() ? $task->getNamespace() : '_global');
  142.       }
  144.       if (!$namespace)
  145.       {
  146.         $namespaceArrayXML[$task->getNamespace()]->appendChild($taskXML = $dom->createElement('task'));
  147.         $taskXML->appendChild($dom->createTextNode($task->getName()));
  148.       }
  150.       $taskXML = new DOMDocument('1.0', 'UTF-8');
  151.       $taskXML->formatOutput = true;
  152.       $taskXML->loadXML($task->asXml());
  153.       $node = $taskXML->getElementsByTagName('task')->item(0);
  154.       $node = $dom->importNode($node, true);
  156.       $tasksXML->appendChild($node);
  157.     }
  159.     echo $dom->saveXml();
  160.   }
  161. }
Debug toolbar