symfony API

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

Represent a set of command line arguments.

Method Summary

Method Details

  • addArgument ($argument) Browse code

    $argument A sfCommandArgument object

    Add a sfCommandArgument objects.

  • addArguments ($arguments) Browse code

    $arguments An array of sfCommandArgument objects

    Add an array of sfCommandArgument objects.

  • (sfCommandArgument) getArgument ($name) Browse code

    $name The argument name

    Returns an argument by name.

    returns A sfCommandArgument object

  • (integer) getArgumentCount () Browse code

    Returns the number of arguments.

    returns The number of arguments

  • (integer) getArgumentRequiredCount () Browse code

    Returns the number of required arguments.

    returns The number of required arguments

  • (array) getArguments () Browse code

    Gets the array of sfCommandArgument objects.

    returns An array of sfCommandArgument objects

  • (array) getDefaults () Browse code

    Gets the default values.

    returns An array of default values

  • (Boolean) hasArgument ($name) Browse code

    $name The argument name

    Returns true if an argument object exists by name.

    returns true if the argument object exists, false otherwise

  • setArguments ($arguments) Browse code

    $arguments An array of sfCommandArgument objects

    Sets the sfCommandArgument objects.

  • __construct ($arguments) Browse code

    $arguments An array of sfCommandArgument objects

    Constructor.