Overview

Namespaces

  • Cz
    • Git

Classes

  • GitRepository

Interfaces

  • IGit

Exceptions

  • GitException
  • Overview
  • Namespace
  • Class

Interface IGit

Direct known implementers

Cz\Git\GitRepository
Namespace: Cz\Git
Located at IGit.php
Methods summary
public
# createTag( string $name )

Creates a tag.

Creates a tag.

Parameters

$name

Throws

Cz\Git\GitException
public
# removeTag( string $name )

Removes tag.

Removes tag.

Parameters

$name

Throws

Cz\Git\GitException
public
# renameTag( string $oldName, string $newName )

Renames tag.

Renames tag.

Parameters

$oldName
$newName

Throws

Cz\Git\GitException
public string[]|null
# getTags( )

Returns list of tags in repo.

Returns list of tags in repo.

Returns

string[]|null
NULL => no tags
public
# merge( string $branch, array|null $options = NULL )

Merges branches.

Merges branches.

Parameters

$branch
$options

Throws

Cz\Git\GitException
public
# createBranch( string $name, boolean $checkout = FALSE )

Creates new branch.

Creates new branch.

Parameters

$name
$checkout

Throws

Cz\Git\GitException
public
# removeBranch( string $name )

Removes branch.

Removes branch.

Parameters

$name

Throws

Cz\Git\GitException
public string
# getCurrentBranchName( )

Gets name of current branch

Gets name of current branch

Returns

string

Throws

Cz\Git\GitException
public string[]|null
# getBranches( )

Returns list of branches in repo.

Returns list of branches in repo.

Returns

string[]|null
NULL => no branches
public string[]|null
# getLocalBranches( )

Returns list of local branches in repo.

Returns list of local branches in repo.

Returns

string[]|null
NULL => no branches
public
# checkout( string $name )

Checkout branch.

Checkout branch.

Parameters

$name

Throws

Cz\Git\GitException
public
# removeFile( string|string[] $file )

Removes file(s).

Removes file(s).

Parameters

$file

Throws

Cz\Git\GitException
public
# addFile( string|string[] $file )

Adds file(s).

Adds file(s).

Parameters

$file

Throws

Cz\Git\GitException
public
# addAllChanges( )

Adds all created, modified & removed files.

Adds all created, modified & removed files.

Throws

Cz\Git\GitException
public
# renameFile( string|string[] $file, string|null $to = NULL )

Renames file(s).

Renames file(s).

Parameters

$file
array('from' => 'to', ...) || (from, to)
$to

Throws

Cz\Git\GitException
public
# commit( string $message, string[] $params = NULL )

Commits changes

Commits changes

Parameters

$message
$params
=> value

Throws

Cz\Git\GitException
public boolean
# hasChanges( )

Exists changes?

Exists changes?

Returns

boolean
public Cz\Git\IGit
# pull( string|null $remote = NULL, array $params = NULL )

Pull changes from a remote

Pull changes from a remote

Parameters

$remote
$params

Returns

Cz\Git\IGit

Throws

Cz\Git\GitException
public Cz\Git\IGit
# push( string|null $remote = NULL, array $params = NULL )

Push changes to a remote

Push changes to a remote

Parameters

$remote
$params

Returns

Cz\Git\IGit

Throws

Cz\Git\GitException
public Cz\Git\IGit
# fetch( string|null $remote = NULL, array $params = NULL )

Run fetch command to get latest branches

Run fetch command to get latest branches

Parameters

$remote
$params

Returns

Cz\Git\IGit

Throws

Cz\Git\GitException
public Cz\Git\IGit
# addRemote( string $name, string $url, array $params = NULL )

Adds new remote repository

Adds new remote repository

Parameters

$name
$url
$params

Returns

Cz\Git\IGit
public Cz\Git\IGit
# renameRemote( string $oldName, string $newName )

Renames remote repository

Renames remote repository

Parameters

$oldName
$newName

Returns

Cz\Git\IGit
public Cz\Git\IGit
# removeRemote( string $name )

Removes remote repository

Removes remote repository

Parameters

$name

Returns

Cz\Git\IGit
public Cz\Git\IGit
# setRemoteUrl( string $name, string $url, array $params = NULL )

Changes remote repository URL

Changes remote repository URL

Parameters

$name
$url
$params

Returns

Cz\Git\IGit
public static Cz\Git\IGit
# init( string $directory, array $params = NULL )

Init repo in directory

Init repo in directory

Parameters

$directory
$params

Returns

Cz\Git\IGit

Throws

Cz\Git\GitException
public static Cz\Git\IGit
# cloneRepository( string $url, string|null $directory = NULL )

Clones GIT repository from $url into $directory

Clones GIT repository from $url into $directory

Parameters

$url
$directory

Returns

Cz\Git\IGit
czproject/git-php v3.10.0 API documentation API documentation generated by ApiGen