# \Siad007\VersionControl\HG\CommandRenameCommand

Simple OO implementation for Mercurial.

This class maintains all global options and take care about getters and setters.

## Summary

Methods
Properties
Constants
getHgPath()
setHgPath()
__toString()
__construct()
execute()
asString()
__call()
getSource()
addSource()
getDestination()
setDestination()
getAfter()
setAfter()
getForce()
setForce()
getInclude()
addInclude()
getExclude()
addExclude()
getDryRun()
setDryRun()
getVerbose()
setVerbose()
getQuiet()
setQuiet()
getNoninteractive()
setNoninteractive()
getCwd()
setCwd()
getDebug()
setDebug()
getDebugger()
setDebugger()
getEncoding()
setEncoding()
getEncodingmode()
setEncodingmode()
getTraceback()
setTraceback()
getTime()
setTime()
getProfile()
setProfile()
getVersion()
setVersion()
getHelp()
setHelp()
getHidden()
setHidden()
getConfig()
addConfig()
No public properties found
No constants found
assembleOptionString()
$name
$hgPath
$command
$options
$globalOptions
$arguments
N/A
doesPropertyExist()
getCommandName()
No private properties found
N/A

File
  Command\RenameCommand.php
Package
  Default
Class hierarchy
  \Siad007\VersionControl\HG\Command\AbstractCommand
  \Siad007\VersionControl\HG\Command\RenameCommand

## Tags

author | Siad Ardroumli siad.ardroumli@gmail.com

## Properties

### $name

    $name : string

#### Type

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### $hgPath

    $hgPath : string

#### Type

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### $command

    $command : string

#### Type

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### $options

    $options : mixed

Command specific options.

#### Type

mixed

#

## Tags

None found

### $globalOptions

    $globalOptions : array

#### Type

array

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### $arguments

    $arguments : array

Available arguments for this command.

#### Type

array

#

## Tags

None found

## Methods

### getHgPath()

    getHgPath() : string

Get hg path.

#### Returns

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setHgPath()

    setHgPath(string  $path) : $this

Set path to hg executable.

#### Parameters

string | $path |

#### Returns

$this

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### __toString()

    __toString() : string

Returns a string representation for the mercurial shell command.

#### Returns

string

#

## Tags

None found

### __construct()

    __construct(mixed  $options = array())

Standard constructor.

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

#### Parameters

mixed | $options |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### execute()

    execute() : string

Execute mercurial command.

#### Returns

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### asString()

    asString() : string

Returns the string representation of the command.

#### Returns

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### __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

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getSource()

    getSource() : array

#### Returns

array

#

## Tags

None found

### addSource()

    addSource(string  $source) : void

#### Parameters

string | $source |

#

## Tags

None found

### getDestination()

    getDestination() : string

#### Returns

string

#

## Tags

None found

### setDestination()

    setDestination(string  $destination) : void

#### Parameters

string | $destination |

#

## Tags

None found

### getAfter()

    getAfter() : boolean

#### Returns

boolean

#

## Tags

None found

### setAfter()

    setAfter(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

## Tags

None found

### getForce()

    getForce() : boolean

#### Returns

boolean

#

## Tags

None found

### setForce()

    setForce(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

## Tags

None found

### getInclude()

    getInclude() : array

#### Returns

array

#

## Tags

None found

### addInclude()

    addInclude(string  $pattern) : void

#### Parameters

string | $pattern |

#

## Tags

None found

### getExclude()

    getExclude() : array

#### Returns

array

#

## Tags

None found

### addExclude()

    addExclude(string  $pattern) : void

#### Parameters

string | $pattern |

#

## Tags

None found

### getDryRun()

    getDryRun() : boolean

#### Returns

boolean

#

## Tags

None found

### setDryRun()

    setDryRun(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

## Tags

None found

### getVerbose()

    getVerbose() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setVerbose()

    setVerbose(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getQuiet()

    getQuiet() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setQuiet()

    setQuiet(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getNoninteractive()

    getNoninteractive() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setNoninteractive()

    setNoninteractive(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getCwd()

    getCwd() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setCwd()

    setCwd(string  $directory) : void

#### Parameters

string | $directory |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getDebug()

    getDebug() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setDebug()

    setDebug(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getDebugger()

    getDebugger() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setDebugger()

    setDebugger(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getEncoding()

    getEncoding() : string

#### Returns

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setEncoding()

    setEncoding(string  $encoding) : void

#### Parameters

string | $encoding |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getEncodingmode()

    getEncodingmode() : string

#### Returns

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setEncodingmode()

    setEncodingmode(string  $mode) : void

#### Parameters

string | $mode |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getTraceback()

    getTraceback() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setTraceback()

    setTraceback(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getTime()

    getTime() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setTime()

    setTime(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getProfile()

    getProfile() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setProfile()

    setProfile(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getVersion()

    getVersion() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setVersion()

    setVersion(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getHelp()

    getHelp() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setHelp()

    setHelp(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getHidden()

    getHidden() : boolean

#### Returns

boolean

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### setHidden()

    setHidden(boolean  $flag) : void

#### Parameters

boolean | $flag |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getConfig()

    getConfig() : array

#### Returns

array

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### addConfig()

    addConfig(string  $config) : void

#### Parameters

string | $config |

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### assembleOptionString()

    assembleOptionString() : string

Concatinates string options.

#### Returns

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### doesPropertyExist()

    doesPropertyExist(string  $property)

Does property exist check.

#### Parameters

string | $property |

#### Throws

\InvalidArgumentException

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### getCommandName()

    getCommandName() : string

Returns the concrete commands name.

#### Returns

string

#

Inherited from
  \Siad007\VersionControl\HG\Command\AbstractCommand

## Tags

None found

### RenameCommand.php