symfony API

sfCommandManager 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:

Class to manage command line arguments and options.

Method Summary

Method Details

  • (sfCommandArgumentSet) getArgumentSet () Browse code

    Gets the argument set.

    returns A sfCommandArgumentSet object

  • (mixed) getArgumentValue ($name) Browse code

    $name The argument name

    Returns the argument value for a given argument name.

    returns The argument value

  • (array) getArgumentValues () Browse code

    Returns the argument values.

    returns An array of argument values

  • (array) getErrors () Browse code

    Gets the current errors.

    returns An array of errors

  • (sfCommandOptionSet) getOptionSet () Browse code

    Gets the option set.

    returns A sfCommandOptionSet object

  • (mixed) getOptionValue ($name) Browse code

    $name The option name

    Returns the option value for a given option name.

    returns The option value

  • (array) getOptionValues () Browse code

    Returns the options values.

    returns An array of option values

  • (true) isValid () Browse code

    Returns true if the current command line options validate the argument and option sets.

    returns if there are some validation errors, false otherwise

  • parseLongOption ($argument) Browse code

    $argument The option argument

    Parses a long option.

  • parseShortOption ($argument) Browse code

    $argument The option argument

    Parses a short option.

  • process ($arguments) Browse code

    $arguments A string or an array of command line parameters

    Processes command line arguments.

  • setArgumentSet ($argumentSet) Browse code

    $argumentSet A sfCommandArgumentSet object

    Sets the argument set.

  • setOption () Browse code

  • setOptionSet ($optionSet) Browse code

    $optionSet A sfCommandOptionSet object

    Sets the option set.

  • __construct ($argumentSet, $optionSet) Browse code

    $argumentSet A sfCommandArgumentSet object
    $optionSet A setOptionSet object

    Constructor.