Property | Type | Description | |
---|---|---|---|
$git | The Git binary |
Method | Description | |
---|---|---|
add ( array $file = null, boolean $force = false ) | Adds one or more files to the staging area | |
commit ( string $commitMsg, array $file = null, string | null $author = null, array $extraArgs = [] ) | Commits the currently staged changes into the repository | |
createDirectory ( string $path, string | null $commitMsg = null, integer | null $dirMode = null, boolean $recursive = true, string | null $author = null ) : string | Writes data to a file and commit the changes immediately | |
findRepositoryRoot ( string $path ) : string | null | Tries to find the root directory for a given repository path | |
getBranches ( integer $which = self::BRANCHES_LOCAL ) : array | Returns a list of the branches in the repository | |
getCurrentBranch ( ) : string | Returns the name of the current branch | |
getCurrentCommit ( ) : string | Returns the current commit hash | |
getCurrentRemote ( ) : array | Returns the remote info | |
getGit ( ) : |
Returns the Git binary | |
getLog ( integer | null $limit = null, integer | null $skip = null ) : array | Returns the current repository log | |
getObjectInfo ( string $path, string $ref = 'HEAD' ) : array | Returns information about an object at a given version | |
getStatus ( ) : array | Returns the current status of the working directory and the staging area | |
isDirty ( ) : boolean | Returns true if there are uncommitted changes in the working directory and/or the staging area | |
listDirectory ( string $directory = '.', string $ref = 'HEAD' ) : array | List the directory at a given version | |
move ( string $fromPath, string $toPath, boolean $force = false ) | Renames a file but does not commit the changes | |
open ( string $repositoryPath, |
Opens a Git repository on the file system, optionally creates and initializes a new repository | |
remove ( array $file, boolean $recursive = false, boolean $force = false ) | Removes one or more files from the repository but does not commit the changes | |
removeFile ( string $path, string | null $commitMsg = null, boolean $recursive = false, boolean $force = false, string | null $author = null ) : string | Removes a file and commit the changes immediately | |
renameFile ( string $fromPath, string $toPath, string | null $commitMsg = null, boolean $force = false, string | null $author = null ) : string | Renames a file and commit the changes immediately | |
reset ( integer $what = self::RESET_ALL ) | Resets the working directory and/or the staging area and discards all changes | |
showCommit ( string $hash ) : string | Returns a string containing information about the given commit | |
showFile ( string $file, string $ref = 'HEAD' ) : string | Returns the content of a file at a given version | |
writeFile ( string $path, string | array $data, string | null $commitMsg = null, integer | null $fileMode = null, integer | null $dirMode = null, boolean $recursive = true, string | null $author = null ) : string | Writes data to a file and commit the changes immediately |
Method | Description | |
---|---|---|
__construct ( string $repositoryPath, |
Creates a new repository instance - use {@see open()} instead | |
_parseNamedArguments ( array $regularStyleArguments, array $namedStyleArguments, array $arguments, integer $skipNamedTo ) : array | _parseNamedArguments | |
_prepareNamedArgumentsForCLI ( array $namedArguments ) : array | Prepares a list of named arguments for use as command-line arguments. | |
initRepository ( |
Initializes a path to be used as a Git repository |
protected __construct ( string $repositoryPath, |
||
$repositoryPath | string | |
$git |
protected _parseNamedArguments ( array $regularStyleArguments, array $namedStyleArguments, array $arguments, integer $skipNamedTo ) : array | ||
$regularStyleArguments | array | An ordered list of the names of regular-style arguments that should be accepted. |
$namedStyleArguments | array | An associative array of named arguments to their default value, or null where no default is desired. |
$arguments | array | The result of func_get_args() in the original function call we're helping. |
$skipNamedTo | integer | Index to which array arguments should be assumed NOT to be named arguments. |
return | array | A filtered associative array of the resulting arguments. |
protected _prepareNamedArgumentsForCLI ( array $namedArguments ) : array | ||
$namedArguments | array | Named argument list to format |
return | array |
public commit ( string $commitMsg, array $file = null, string | null $author = null, array $extraArgs = [] ) | ||
$commitMsg | string | The commit message |
$file | array | Restrict commit to the given files or NULL to commit all staged changes |
$author | string | null | The author |
$extraArgs | array | Allow the user to pass extra args eg array('-i') |
public createDirectory ( string $path, string | null $commitMsg = null, integer | null $dirMode = null, boolean $recursive = true, string | null $author = null ) : string | ||
$path | string | The directory path |
$commitMsg | string | null | The commit message used when committing the changes |
$dirMode | integer | null | The mode for creating the intermediate directories |
$recursive | boolean | Create intermediate directories recursively if required |
$author | string | null | The author |
return | string | The current commit hash |
public getBranches ( integer $which = self::BRANCHES_LOCAL ) : array | ||
$which | integer | Which branches to retrieve (all, local or remote-tracking) |
return | array |
public getCurrentBranch ( ) : string | ||
return | string |
public getCurrentCommit ( ) : string | ||
return | string |
public getCurrentRemote ( ) : array | ||
return | array |
protected static initRepository ( |
||
$git | The Git binary | |
$path | string | The repository path |
$initArguments | array | Arguments to pass to git-init when initializing the repository |
public static open ( string $repositoryPath, |
||
$repositoryPath | string | The full path to the repository |
$git | The Git binary | |
$createIfNotExists | boolean | integer | False to fail on non-existing repositories, directory creation mode, such as 0755 if the command should create the directory and init the repository instead |
$initArguments | array | null | Arguments to be passed to git-init if initializing a repository |
$findRepositoryRoot | boolean | False to use the repository path as the root directory. |
return |
public removeFile ( string $path, string | null $commitMsg = null, boolean $recursive = false, boolean $force = false, string | null $author = null ) : string | ||
$path | string | The file path |
$commitMsg | string | null | The commit message used when committing the changes |
$recursive | boolean | True to recursively remove subdirectories |
$force | boolean | True to continue even though Git reports a possible conflict |
$author | string | null | The author |
return | string | The current commit hash |
public renameFile ( string $fromPath, string $toPath, string | null $commitMsg = null, boolean $force = false, string | null $author = null ) : string | ||
$fromPath | string | The source path |
$toPath | string | The destination path |
$commitMsg | string | null | The commit message used when committing the changes |
$force | boolean | True to continue even though Git reports a possible conflict |
$author | string | null | The author |
return | string | The current commit hash |
public showCommit ( string $hash ) : string | ||
$hash | string | The commit ref |
return | string |
public writeFile ( string $path, string | array $data, string | null $commitMsg = null, integer | null $fileMode = null, integer | null $dirMode = null, boolean $recursive = true, string | null $author = null ) : string | ||
$path | string | The file path |
$data | string | array | The data to write to the file |
$commitMsg | string | null | The commit message used when committing the changes |
$fileMode | integer | null | The mode for creating the file |
$dirMode | integer | null | The mode for creating the intermediate directories |
$recursive | boolean | Create intermediate directories recursively if required |
$author | string | null | The author |
return | string | The current commit hash |