Docs For Class VersionControl_Git_Util

$arguments = array()

[line 50]

An array of arguments

Access: protected

Type:

array

[ Top ]

$doubleDash = false

[line 68]

Flag to add "--" before the end of command

If this is true, command is executed with "--". It is need by some Git command for understanding the specified object is not a path.

Access: protected

Type:

bool

[ Top ]

$options = array()

[line 57]

An array of options

Access: protected

Type:

array

[ Top ]

$subCommand = ''

[line 43]

The subcommand name

Access: protected

Type:

string

[ Top ]

addArgument [line 136]

VersionControl_Git_Util_Command addArgument(
string
$value)

Add an argument

Return: The "$this" object for method chain
Access: public

Parameters:

string $value — A value of argument

[ Top ]

addDoubleDash [line 150]

VersionControl_Git_Util_Command addDoubleDash(
string
$isAdding)

Add / Remove a double-dash

Return: The "$this" object for method chain
Access: public

Parameters:

string $isAdding — Whether to add double-dash

[ Top ]

createCommandString [line 165]

string createCommandString(
[array
$arguments = array()], [array
$options = array()])

Create a command string to execute

Access: public

Parameters:

array	`$arguments`	—	An array of arguments
array	`$options`	—	An array of options

[ Top ]

execute [line 213]

string execute(
[array
$arguments = array()], [array
$options = array()])

Execute a created command and get result

Access: public

Parameters:

array	`$arguments`	—	An array of arguments
array	`$options`	—	An array of options

[ Top ]

setArguments [line 105]

VersionControl_Git_Util_Command setArguments(
array
$arguments)

Set the arguments

Return: The "$this" object for method chain
Access: public

Parameters:

array $arguments — An array of new arguments

[ Top ]

setOption [line 122]

VersionControl_Git_Util_Command setOption(
string
$name, [string|bool
$value = true])

Set a option

Return: The "$this" object for method chain
Access: public

Parameters:

string	`$name`	—	A name of option
string\|bool	`$value`	—	A value of option. If it is "true", this option doesn't have a value. If it is "false", this option will be not used

[ Top ]

setOptions [line 91]

VersionControl_Git_Util_Command setOptions(
array
$options)

Set the options

Return: The "$this" object for method chain
Access: public

Parameters:

array $options — An array of new options

[ Top ]

setSubCommand [line 77]

VersionControl_Git_Util_Command setSubCommand(
string
$command)

Set the subcommand name

Return: The "$this" object for method chain
Access: public

Parameters:

string $command — The subcommand name

[ Top ]

stripEscapeSequence [line 250]

string stripEscapeSequence(
string
$string)

Strip terminal escape sequences from the specified string

Access: public

Parameters:

string $string — The string that will be trimmed

[ Top ]

Class: VersionControl_Git_Util_Command

Class Overview

Author(s):

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: VersionControl_Git_Component

Inherited Methods

Class: VersionControl_Git_Component

Class Details

Class Variables

$arguments = array()

$doubleDash = false

$options = array()

$subCommand = ''

Method Detail

addArgument [line 136]

Parameters:

addDoubleDash [line 150]

Parameters:

createCommandString [line 165]

Parameters:

execute [line 213]

Parameters:

setArguments [line 105]

Parameters:

setOption [line 122]

Parameters:

setOptions [line 91]

Parameters:

setSubCommand [line 77]

Parameters:

stripEscapeSequence [line 250]

Parameters: