1. sfCommandApplicationTask.class.php
  2. /**
 * Base class for tasks that depends on a sfCommandApplication object.
 *
 * @package    symfony
 * @subpackage task
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfCommandApplicationTask.class.php 23651 2009-11-06 08:08:54Z fabien $
 */
  3. abstract class sfCommandApplicationTask extends sfTask
  4. {
  5.   protected
  6.     $mailer = null,
  7.     $routing = null,
  8.     $commandApplication = null;
  10.   /**
  11.    * Sets the command application instance for this task.
  12.    *
  13.    * @param sfCommandApplication $commandApplication A sfCommandApplication instance
  14.    */
  15.   public function setCommandApplication(sfCommandApplication $commandApplication = null)
  16.   {
  17.     $this->commandApplication = $commandApplication;
  18.   }
  20.   /**
  21.    * @see sfTask
  22.    */
  23.   public function log($messages)
  24.   {
  25.     if (null === $this->commandApplication || $this->commandApplication->isVerbose())
  26.     {
  27.       parent::log($messages);
  28.     }
  29.   }
  31.   /**
  32.    * @see sfTask
  33.    */
  34.   public function logSection($section, $message, $size = null, $style = 'INFO')
  35.   {
  36.     if (null === $this->commandApplication || $this->commandApplication->isVerbose())
  37.     {
  38.       parent::logSection($section, $message, $size, $style);
  39.     }
  40.   }
  42.   /**
  43.    * Creates a new task object.
  44.    *
  45.    * @param  string $name The name of the task
  46.    *
  47.    * @return sfTask
  48.    *
  49.    * @throws LogicException If the current task has no command application
  50.    */
  51.   protected function createTask($name)
  52.   {
  53.     if (null === $this->commandApplication)
  54.     {
  55.       throw new LogicException('Unable to create a task as no command application is associated with this task yet.');
  56.     }
  58.     $task = $this->commandApplication->getTaskToExecute($name);
  60.     if ($task instanceof sfCommandApplicationTask)
  61.     {
  62.       $task->setCommandApplication($this->commandApplication);
  63.     }
  65.     return $task;
  66.   }
  68.   /**
  69.    * Executes another task in the context of the current one.
  70.    *
  71.    * @param  string  $name      The name of the task to execute
  72.    * @param  array   $arguments An array of arguments to pass to the task
  73.    * @param  array   $options   An array of options to pass to the task
  74.    *
  75.    * @return Boolean The returned value of the task run() method
  76.    *
  77.    * @see createTask()
  78.    */
  79.   protected function runTask($name, $arguments = array(), $options = array())
  80.   {
  81.     return $this->createTask($name)->run($arguments, $options);
  82.   }
  84.   /**
  85.    * Returns a mailer instance.
  86.    *
  87.    * Notice that your task should accept an application option.
  88.    * The mailer configuration is read from the current configuration
  89.    * instance, which is automatically created according to the current
  90.    * --application option.
  91.    *
  92.    * @return sfMailer A sfMailer instance
  93.    */
  94.   protected function getMailer()
  95.   {
  96.     if (!$this->mailer)
  97.     {
  98.       $this->mailer = $this->initializeMailer();
  99.     }
  101.     return $this->mailer;
  102.   }
  104.   protected function initializeMailer()
  105.   {
  106.     require_once sfConfig::get('sf_symfony_lib_dir').'/vendor/swiftmailer/classes/Swift.php';
  107.     Swift::registerAutoload();
  108.     sfMailer::initialize();
  110.     $config = sfFactoryConfigHandler::getConfiguration($this->configuration->getConfigPaths('config/factories.yml'));
  112.     return new $config['mailer']['class']($this->dispatcher, $config['mailer']['param']);
  113.   }
  115.   /**
  116.    * Returns a routing instance.
  117.    *
  118.    * Notice that your task should accept an application option.
  119.    * The routing configuration is read from the current configuration
  120.    * instance, which is automatically created according to the current
  121.    * --application option.
  122.    *
  123.    * @return sfRouting A sfRouting instance
  124.    */
  125.   protected function getRouting()
  126.   {
  127.     if (!$this->routing)
  128.     {
  129.       $this->routing = $this->initializeRouting();
  130.     }
  132.     return $this->routing;
  133.   }
  135.   protected function initializeRouting()
  136.   {
  137.     $config = sfFactoryConfigHandler::getConfiguration($this->configuration->getConfigPaths('config/factories.yml'));
  138.     $params = array_merge($config['routing']['param'], array('load_configuration' => false, 'logging' => false));
  140.     $handler = new sfRoutingConfigHandler();
  141.     $routes = $handler->evaluate($this->configuration->getConfigPaths('config/routing.yml'));
  143.     $routing = new $config['routing']['class']($this->dispatcher, null, $params);
  144.     $routing->setRoutes($routes);
  146.     $this->dispatcher->notify(new sfEvent($routing, 'routing.load_configuration'));
  148.     return $routing;
  149.   }
  150. }
Debug toolbar