symfony API

sfCommandApplicationTask Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.3 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.3 version. Switch to:

Base class for tasks that depends on a sfCommandApplication object.

Inheritence

sfHelpTask, sfListTask, sfBaseTask  <  sfCommandApplicationTask  <  sfTask

Method Summary

Methods inherited from sfTask

addArgument , addArguments , addOption , addOptions , ask , askAndValidate , askConfirmation , asXml , configure , doRun , execute , getAliases , getArguments , getBriefDescription , getDetailedDescription , getFormatter , getFullName , getName , getNamespace , getOptions , getSynopsis , initialize , log , logBlock , logSection , process , run , runFromCLI , setFormatter , strlen , __construct

Method Details

  • (sfTask) createTask ($name) Browse code

    $name The name of the task

    Creates a new task object.

    throws LogicException If the current task has no command application

  • (sfMailer) getMailer () Browse code

    Returns a mailer instance.


    Notice that your task should accept an application option.
    The mailer configuration is read from the current configuration
    instance, which is automatically created according to the current
    --application option.

    returns A sfMailer instance

  • (sfRouting) getRouting () Browse code

    Returns a routing instance.


    Notice that your task should accept an application option.
    The routing configuration is read from the current configuration
    instance, which is automatically created according to the current
    --application option.

    returns A sfRouting instance

  • initializeMailer () Browse code

  • initializeRouting () Browse code

  • log () Browse code

    @see sfTask

  • logSection () Browse code

    @see sfTask

  • (Boolean) runTask ($name, $arguments, $options) Browse code

    $name The name of the task to execute
    $arguments An array of arguments to pass to the task
    $options An array of options to pass to the task

    Executes another task in the context of the current one.

    returns The returned value of the task run() method

  • setCommandApplication ($commandApplication) Browse code

    $commandApplication A sfCommandApplication instance

    Sets the command application instance for this task.