tasks/ext/git/GitCommitTask.php

Show: inherited
Table of Contents

Wrapper around git-commit

Author
Jonathan Creasy  
Package
Phing.tasks.ext.git  
See
\VersionControl_Git  
Since
2.4.3  

\GitCommitTask

Package: Phing\tasks\ext\git

Wrapper around git-commit

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

Parent(s)
\GitBaseTask < \Task < \ProjectComponent
See
\VersionControl_Git  
Author
Jonathan Creasy  
Copyright
2001,2002 THYRELL. All rights reserved  
Since
2.4.3  
Version
$Id: 5ffc8c9c51dfa9bd0d691a88db670cdeb5f985c1 $  

Properties

Propertyprivate  $allFiles= ''
Details
Type
n/a
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description\GitBaseTask::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Inherited_from
\GitBaseTask::$$description  
Propertyprivate  $files= ''
Details
Type
n/a
Propertyprivate\VersionControl_Git  $gitClient= 'null'
inherited

Inherited from: \GitBaseTask::$$gitClient
Default valuenullDetails
Type
\VersionControl_Git
Inherited_from
\GitBaseTask::$$gitClient  
Propertyprivatestring  $gitPath= ''/usr/bin/git''
inherited

Bath to git binary

Inherited from: \GitBaseTask::$$gitPath
Default value'/usr/bin/git'Details
Type
string
Inherited_from
\GitBaseTask::$$gitPath  
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location\GitBaseTask::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Inherited_from
\GitBaseTask::$$location  
Propertyprivate  $message= ''
Details
Type
n/a
Propertyprotected\Project  $project= 'null'
inherited

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

A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$project\GitBaseTask::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Inherited_from
\GitBaseTask::$$project  
Propertyprivatestring  $repository= ''
inherited

Current repository directory

Inherited from: \GitBaseTask::$$repository
Details
Type
string
Inherited_from
\GitBaseTask::$$repository  
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target\GitBaseTask::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Inherited_from
\GitBaseTask::$$target  
Propertyprivatestring  $targetPath= ''

Path to target directory

Details
Type
string
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName\GitBaseTask::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Inherited_from
\GitBaseTask::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType\GitBaseTask::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Inherited_from
\GitBaseTask::$$taskType  
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper\GitBaseTask::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  
Inherited_from
\GitBaseTask::$$wrapper  

Methods

methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()\GitBaseTask::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetFiles( ) : void

methodprotectedgetGitClient(  $reset = false,  $repository = null ) : void
inherited

Inherited from: \GitBaseTask::getGitClient()
Parameters
Name Type Description
$reset
$repository
methodpublicgetGitPath( ) : string
inherited

Get path to git executable

Inherited from: \GitBaseTask::getGitPath()
Returns
Type Description
string
methodpublicgetLocation( ) : \Location
inherited

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

Inherited from: \Task::getLocation()\GitBaseTask::getLocation()
Returns
Type Description
\Location The location object describing the position of this task within the buildfile.
methodpublicgetMessage( ) : void

methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()\GitBaseTask::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()\GitBaseTask::getProject()
Returns
Type Description
\Project Reference to current porject object
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()\GitBaseTask::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRepository( ) : string
inherited

Get repository directory

Inherited from: \GitBaseTask::getRepository()
Returns
Type Description
string
methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()\GitBaseTask::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetTargetPath( ) : string

Get path to target direcotry repo

Returns
Type Description
string
methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()\GitBaseTask::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : string
inherited

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

Inherited from: \Task::getTaskType()\GitBaseTask::getTaskType()
Returns
Type Description
string The type of this task (XML Tag)
methodpublicgetallFiles( ) : void

methodpublicinit( ) : void
inherited

Initialize Task.

Inherited from: \GitBaseTask::init()

Check and include necessary libraries.

Throws
Exception Description
\BuildException
methodpublicisallFiles( ) : string

Alias @see getAllFiles()

Returns
Type Description
string
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()\GitBaseTask::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : void

The main entry point for the task

Should throw a BuildException if someting goes wrong with the build

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

methodpublicmaybeConfigure( ) : void
inherited

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

Inherited from: \Task::maybeConfigure()\GitBaseTask::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()\GitBaseTask::perform()
methodpublicsetDescription( string $desc ) : void
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()\GitBaseTask::setDescription()
Parameters
Name Type Description
$desc string

The text describing the task

methodpublicsetFiles(  $files ) : void

Parameters
Name Type Description
$files
methodpublicsetGitPath( string $gitPath ) : \GitBaseTask
inherited

Set path to git executable

Inherited from: \GitBaseTask::setGitPath()
Parameters
Name Type Description
$gitPath string

New path to git repository

Returns
Type Description
\GitBaseTask
methodpublicsetLocation( \Location $location ) : void
inherited

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

Inherited from: \Task::setLocation()\GitBaseTask::setLocation()
Parameters
Name Type Description
$location \Location

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

methodpublicsetMessage(  $message ) : void

Parameters
Name Type Description
$message
methodpublicsetOwningTarget( \Target $target ) : void
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()\GitBaseTask::setOwningTarget()
Parameters
Name Type Description
$target \Target

Reference to owning target

methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()\GitBaseTask::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRepository( string $repository ) : \GitBaseTask
inherited

Set repository directory

Inherited from: \GitBaseTask::setRepository()
Parameters
Name Type Description
$repository string

Repo directory

Returns
Type Description
\GitBaseTask
methodpublicsetRuntimeConfigurableWrapper( \RuntimeConfigurable $wrapper ) : void
inherited

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

Inherited from: \Task::setRuntimeConfigurableWrapper()\GitBaseTask::setRuntimeConfigurableWrapper()
Parameters
Name Type Description
$wrapper \RuntimeConfigurable

The wrapper object this task should use

methodpublicsetTargetPath( string $targetPath ) : void

Set path to source repo

Parameters
Name Type Description
$targetPath string

Path to repository used as source

methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()\GitBaseTask::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( string $name ) : void
inherited

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

Inherited from: \Task::setTaskType()\GitBaseTask::setTaskType()
Parameters
Name Type Description
$name string

The type of this task (XML Tag)

methodpublicsetallFiles(  $flag ) : void

Parameters
Name Type Description
$flag
Documentation was generated by DocBlox 0.18.1.