PHPFUI/InstaDoc

Administration class for Git repositories.

author Alexandre Salomé

CloneableInstantiable

Methods

public static cloneBranchTo( $path, $url, $branch, $bare = true, $options = [])

Clone a repository branch to a local path.

return Gitonomy\Git\Repository

public static cloneRepository( $path, $url, array $args = [], array $options = [])

Internal method to launch effective `git clone` command.

return Gitonomy\Git\Repository

public static cloneTo( $path, $url, $bare = true, array $options = [])

Clone a repository to a local path.

return Gitonomy\Git\Repository

public static init( $path, $bare = true, array $options = [])

Initializes a repository and returns the instance.

throws RuntimeException Directory exists or not writable (only if debug=true)
return Gitonomy\Git\Repository

public static isValidRepository( $url, array $options = [])

Checks the validity of a git repository url without cloning it.

This will use the ls-remote command of git against the given url.
Usually, this command returns 0 when successful, and 128 when the
repository is not found.

return bool true if url is valid

public static mirrorTo( $path, $url, array $options = [])

Mirrors a repository (fetch all revisions, not only branches).

return Gitonomy\Git\Repository

Methods

private static getProcess( $command, array $args = [], array $options = [])

This internal method is used to create a process object.

Methods

public static cloneBranchTo( $path, $url, $branch, $bare = true, $options = [])

Clone a repository branch to a local path.

return Gitonomy\Git\Repository

public static cloneRepository( $path, $url, array $args = [], array $options = [])

Internal method to launch effective `git clone` command.

return Gitonomy\Git\Repository

public static cloneTo( $path, $url, $bare = true, array $options = [])

Clone a repository to a local path.

return Gitonomy\Git\Repository

private static getProcess( $command, array $args = [], array $options = [])

This internal method is used to create a process object.

public static init( $path, $bare = true, array $options = [])

Initializes a repository and returns the instance.

throws RuntimeException Directory exists or not writable (only if debug=true)
return Gitonomy\Git\Repository

public static isValidRepository( $url, array $options = [])

Checks the validity of a git repository url without cloning it.

This will use the ls-remote command of git against the given url.
Usually, this command returns 0 when successful, and 128 when the
repository is not found.

return bool true if url is valid

public static mirrorTo( $path, $url, array $options = [])

Mirrors a repository (fetch all revisions, not only branches).

return Gitonomy\Git\Repository