Properties

$name

$name : string

Type

string

$hgPath

$hgPath : string

Type

string

$command

$command : string

Type

string

$options

$options : mixed

Command specific options.

Type

mixed

$globalOptions

$globalOptions : array

Type

array

$arguments

$arguments : array

Available arguments for this command.

Type

array

Methods

getHgPath()

getHgPath() : string

Get hg path.

Returns

string

setHgPath()

setHgPath(string  $path) : $this

Set path to hg executable.

Parameters

string $path

Returns

$this

__toString()

__toString() : string

Returns a string representation for the mercurial shell command.

Returns

string

__construct()

__construct(mixed  $options = array()) 

Standard constructor.

  • sets the concrete commands name
  • merges the global options with the concrete commands options

Parameters

mixed $options

execute()

execute() : string

Execute mercurial command.

Returns

string

asString()

asString() : string

Returns the string representation of the command.

Returns

string

__call()

__call(string  $name, array  $arguments) : boolean|array|string|self

Magic method to get option entries with a getter/setter method.

Parameters

string $name
array $arguments

Throws

\InvalidArgumentException

Returns

boolean|array|string|self

getName()

getName() : array

Returns

array

addName()

addName(string  $name) : void

Parameters

string $name

getForce()

getForce() : boolean

Returns

boolean

setForce()

setForce(boolean  $flag) : void

Parameters

boolean $flag

getRev()

getRev() : string

Returns

string

setRev()

setRev(string  $revision) : void

Parameters

string $revision

getDelete()

getDelete() : boolean

Returns

boolean

setDelete()

setDelete(boolean  $flag) : void

Parameters

boolean $flag

getRename()

getRename() : string

Returns

string

setRename()

setRename(string  $name) : void

Parameters

string $name

getInactive()

getInactive() : boolean

Returns

boolean

setInactive()

setInactive(boolean  $flag) : void

Parameters

boolean $flag

getVerbose()

getVerbose() : boolean

Returns

boolean

setVerbose()

setVerbose(boolean  $flag) : void

Parameters

boolean $flag

getQuiet()

getQuiet() : boolean

Returns

boolean

setQuiet()

setQuiet(boolean  $flag) : void

Parameters

boolean $flag

getNoninteractive()

getNoninteractive() : boolean

Returns

boolean

setNoninteractive()

setNoninteractive(boolean  $flag) : void

Parameters

boolean $flag

getCwd()

getCwd() : boolean

Returns

boolean

setCwd()

setCwd(string  $directory) : void

Parameters

string $directory

getDebug()

getDebug() : boolean

Returns

boolean

setDebug()

setDebug(boolean  $flag) : void

Parameters

boolean $flag

getDebugger()

getDebugger() : boolean

Returns

boolean

setDebugger()

setDebugger(boolean  $flag) : void

Parameters

boolean $flag

getEncoding()

getEncoding() : string

Returns

string

setEncoding()

setEncoding(string  $encoding) : void

Parameters

string $encoding

getEncodingmode()

getEncodingmode() : string

Returns

string

setEncodingmode()

setEncodingmode(string  $mode) : void

Parameters

string $mode

getTraceback()

getTraceback() : boolean

Returns

boolean

setTraceback()

setTraceback(boolean  $flag) : void

Parameters

boolean $flag

getTime()

getTime() : boolean

Returns

boolean

setTime()

setTime(boolean  $flag) : void

Parameters

boolean $flag

getProfile()

getProfile() : boolean

Returns

boolean

setProfile()

setProfile(boolean  $flag) : void

Parameters

boolean $flag

getVersion()

getVersion() : boolean

Returns

boolean

setVersion()

setVersion(boolean  $flag) : void

Parameters

boolean $flag

getHelp()

getHelp() : boolean

Returns

boolean

setHelp()

setHelp(boolean  $flag) : void

Parameters

boolean $flag

getHidden()

getHidden() : boolean

Returns

boolean

setHidden()

setHidden(boolean  $flag) : void

Parameters

boolean $flag

getConfig()

getConfig() : array

Returns

array

addConfig()

addConfig(string  $config) : void

Parameters

string $config

assembleOptionString()

assembleOptionString() : string

Concatinates string options.

Returns

string

doesPropertyExist()

doesPropertyExist(string  $property) 

Does property exist check.

Parameters

string $property

Throws

\InvalidArgumentException

getCommandName()

getCommandName() : string

Returns the concrete commands name.

Returns

string