Phing API Documentation
Back to top  

GitCheckoutTask

Extends \GitBaseTask

Wrapper around git-checkout

Use {@link Project#createTask} to register a new Task.

author

Victor Farazdagi simple.square@gmail.com
version

$Id: e53afe6034fcf9626effd77d6a2b84fed0c41c7e $
package

phing.tasks.ext.git
see
since 2.4.3

Methods

Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.

main()
inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

setBranchname

setBranchname($branchname)

Arguments

$branchname

getBranchname

getBranchname()

setStartPoint

setStartPoint($startPoint)

Arguments

$startPoint

getStartPoint

getStartPoint()

setForce

setForce($flag)

Arguments

$flag

getForce

getForce()

isForce

isForce()

setQuiet

setQuiet($flag)

Arguments

$flag

getQuiet

getQuiet()

isQuiet

isQuiet()

setTrack

setTrack($flag)

Arguments

$flag

getTrack

getTrack()

isTrack

isTrack()

setNoTrack

setNoTrack($flag)

Arguments

$flag

getNoTrack

getNoTrack()

isNoTrack

isNoTrack()

setCreate

setCreate($flag)

Arguments

$flag

getCreate

getCreate()

isCreate

isCreate()

setForceCreate

setForceCreate($flag)

Arguments

$flag

getForceCreate

getForceCreate()

isForceCreate

isForceCreate()

setMerge

setMerge($flag)

Arguments

$flag

getMerge

getMerge()

isMerge

isMerge()

Called by the parser to let the task initialize properly.

init()
inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

throws

Set repository directory

setRepository(string $repository) : \GitBaseTask
inherited

Arguments

$repository

string

Repo directory

Response

\GitBaseTask

Get repository directory

getRepository() : string
inherited

Response

string

Set path to git executable

setGitPath(string $gitPath) : \GitBaseTask
inherited

Arguments

$gitPath

string

New path to git repository

Response

\GitBaseTask

Get path to git executable

getGitPath() : string
inherited

Response

string

getGitClient

getGitClient($reset = false, $repository = null)
inherited

Arguments

$reset

$repository

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)
inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

Sets the type of the task. Usually this is the name of the XML tag

setTaskType($name)
inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)
inherited

Arguments

$slotName

string

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO)
inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a textual description of the task

setDescription(string $desc)
inherited

Arguments

$desc

string

The text describing the task

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location
inherited

Response

\Location

The location object describing the position of this task within the buildfile.

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

setLocation(\Location $location)
inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Configure this task if it hasn't been done already.

maybeConfigure()
inherited

Perfrom this task

perform()
inherited

References the project to the current component.

setProject(\Project $project)
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Properties

Branch name

branchname : string
var

Type(s)

string

If not HEAD, specify starting point

startPoint : string
var

Type(s)

string

--force, -f key to git-checkout

force : boolean
var

Type(s)

boolean

--quiet, -q key to git-checkout

quiet : boolean
var

Type(s)

boolean

When creating a new branch, set up "upstream" configuration.

track : boolean

--track key to git-checkout

var

Type(s)

boolean

Do not set up "upstream" configuration --no-track key to git-checkout

noTrack : boolean
var

Type(s)

boolean

-b, -B, -m options to git-checkout Respective task options: create, forceCreate, merge

extraOptions : array
var

Type(s)

array

Bath to git binary

gitPath : string
inherited
var

Type(s)

string

gitClient

gitClient : \VersionControl_Git
inherited
var

Type(s)

\VersionControl_Git

Current repository directory

repository : string
inherited
var

Type(s)

string

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project