Class VersionControl_Hg_Command

Description

Wraps each Mercurial command to centralize global options and command execution.

It is passed into the constructor of each command.

implements the following global options: -I --include include names matching the given patterns -X --exclude exclude names matching the given patterns

PHP version 5

Located in /Hg/Command.php (line 36)


	
			
Direct descendents
Class Description
VersionControl_Hg_Command_Version PHP version 5
VersionControl_Hg_Repository_Command Wraps each Mercurial command to centralize global options and command execution.
Variable Summary
Method Summary
boolean addOption ($name $name, [$value $value = NULL])
void addOptions ( $options)
void changeset ( $first,  $last)
Command excluding ($filter $filter)
void forDir ()
void forFiles ()
void from ()
void getOptions ()
void getTemplate ()
Command including ($filter $filter)
void parseOutput ( $fields,  $commandOutput)
unknown_type prepareCommand ()
Command setTemplate ([$style $template = 'xml'])
void to ( $directory)
void unsetOption ( $option)
Command verbose ($boolean $boolean)
mixed __call (string $method, mixed $args)
Variables
unknown_type $allowed_commands = array(
'version',
)
(line 50)

Implemented commands pertaining to the Hg executable.

  • access: protected

Redefined in descendants as:
mixed $allowed_options = array() (line 77)

Possible options a command may have

  • access: protected

Redefined in descendants as:
string $command (line 43)

Defines the mercurial command to implement

  • access: protected

Redefined in descendants as:
VersionControl_Hg $container (line 84)

Object representing the container the command operated upon

  • access: protected

Redefined in descendants as:
mixed $global_options = array(
'encoding',
'quiet',
'verbose',
)
(line 59)

Options which all commands in the package may have

  • access: protected
array $options = array() (line 112)

Manages the options for the Hg executable.

  • access: protected
mixed $required_options = array() (line 70)

Required options this command needs

  • access: protected

Redefined in descendants as:
Methods
Constructor __construct (line 128)

Constructor

  • access: public
void __construct (VersionControl_Hg $hg)

Redefined in descendants as:
addOption (line 257)
  • access: protected
boolean addOption ($name $name, [$value $value = NULL])
  • $name $name: is the name of the option which Mercurial recognizes
  • $value $value: is optional since not all Hg options need a value
addOptions (line 269)
  • access: protected
void addOptions ( $options)
  • array $options
changeset (line 355)
  • access: public
void changeset ( $first,  $last)
  • $first
  • $last
excluding (line 309)
  • access: public
Command excluding ($filter $filter)
  • $filter $filter: string
forDir (line 325)
  • access: public
void forDir ()
forFiles (line 324)
  • access: public
void forFiles ()
from (line 326)
  • access: public
void from ()
getOptions (line 282)
  • access: public
void getOptions ()
getTemplate (line 227)
  • access: public
void getTemplate ()
including (line 339)
  • access: public
Command including ($filter $filter)
  • $filter $filter: string
parseOutput (line 185)
  • access: protected
void parseOutput ( $fields,  $commandOutput)
  • mixed $commandOutput
  • mixed $fields: array holds the labels of the fields
prepareCommand (line 173)
  • access: protected
unknown_type prepareCommand ()
setTemplate (line 221)
  • access: public
Command setTemplate ([$style $template = 'xml'])
  • $style $template: defaults to xml
to (line 327)
  • access: public
void to ( $directory)
  • $directory

Redefined in descendants as:
unsetOption (line 289)
  • access: public
void unsetOption ( $option)
  • $option
verbose (line 366)

Implements the option for the Mercurial executable.

  • access: public
Command verbose ($boolean $boolean)
  • $boolean $boolean
__call (line 140)

Executes the actual mercurial command

  • access: public
mixed __call (string $method, mixed $args)
  • string $method
  • mixed $args

Redefined in descendants as:

Documentation generated on Tue, 18 Aug 2009 23:53:14 -0600 by phpDocumentor 1.4.2