symfony API

sfCommandApplication Class

« Back to API menu

action

addon

autoload

cache

command

config

controller

creole

database

debug

exception

filter

form

generator

helper

i18n

log

plugin

propel

request

response

routing

storage

task

test

user

util

validator

view

widget

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

sfCommandApplication manages the lifecycle of a CLI application.

Inheritence

sfSymfonyCommandApplication  <  sfCommandApplication

Method Summary

  • fixCgi()
    Fixes php behavior if using cgi php.
  • array getTasks()
    Returns all registered tasks.
  • __construct($dispatcher, $formatter, $options = array())
    Constructor.
  • setName($name)
    Sets the application name.
  • Boolean withTrace()
    Returns whether the application must activate the trace.
  • object The getFormatter()
    Returns the formatter instance.
  • setVersion($version)
    Sets the application version.
  • string getVersion()
    Gets the application version.
  • string getName()
    Gets the name of the application.
  • isDryrun()
  • strlen($string)
  • registerTask($task)
    Registers a task object.
  • configure()
    Configures the current command application.
  • run($options = null)
    Runs the current application.
  • getAbbreviations($names)
    Returns an array of possible abbreviations given a set of names.
  • getTaskToExecute($name)
    Gets a task from a task name or a shortcut.
  • registerTasks($tasks = null)
    Registers an array of task objects.
  • getTask($name)
    Returns a registered task by name or alias.
  • Boolean isVerbose()
    Returns whether the application must be verbose.
  • mixed getOption($name)
    Returns the value of a given option.
  • renderException((Exception) $e)
    Renders an exception.
  • help()
    Outputs a help message for the current application.
  • handleOptions($options = null)
    Parses and handles command line options.
  • string getLongVersion()
    Returns the long version of the application.

Method Details

  • fixCgi ()

    Fixes php behavior if using cgi php.

  • (array) getTasks ()

    Returns all registered tasks.

    returns An array of sfTask objects

  • __construct ($dispatcher, $formatter, $options = array())

    $dispatcher A sfEventDispatcher instance
    $formatter A sfFormatter instance
    $options An array of options

    Constructor.

  • setName ($name)

    $name The application name

    Sets the application name.

  • (Boolean) withTrace ()

    Returns whether the application must activate the trace.

    returns true if the application must activate the trace, false otherwise

  • (object The) getFormatter ()

    Returns the formatter instance.

    returns formatter instance

  • setVersion ($version)

    $version The application version

    Sets the application version.

  • (string) getVersion ()

    Gets the application version.

    returns The application version

  • (string) getName ()

    Gets the name of the application.

    returns The application name

  • isDryrun ()

  • strlen ($string)

  • registerTask ($task)

    $task An sfTask object

    Registers a task object.

  • configure ()

    Configures the current command application.

  • run ($options = null)

    $options The command line options

    Runs the current application.

  • getAbbreviations ($names)

    Returns an array of possible abbreviations given a set of names.

  • getTaskToExecute ($name)

    $name The task name or a task shortcut

    Gets a task from a task name or a shortcut.

    returns A sfTask object

  • registerTasks ($tasks = null)

    $tasks An array of tasks

    Registers an array of task objects.

    If you pass null, this method will register all available tasks.

  • getTask ($name)

    $name The task name or alias

    Returns a registered task by name or alias.

    returns An sfTask object

  • (Boolean) isVerbose ()

    Returns whether the application must be verbose.

    returns true if the application must be verbose, false otherwise

  • (mixed) getOption ($name)

    $name The option name

    Returns the value of a given option.

    returns The option value

  • renderException ((Exception) $e)

    $e An exception object

    Renders an exception.

  • help ()

    Outputs a help message for the current application.

  • handleOptions ($options = null)

    $options The command line options

    Parses and handles command line options.

  • (string) getLongVersion ()

    Returns the long version of the application.

    returns The long application version