tasks/ext/git/GitTagTask.php

Show: inherited
Table of Contents

Wrapper around git-tag

Author
Evan Kaufman  
Author
Victor Farazdagi  
Package
phing.tasks.ext.git  
See
\VersionControl_Git  
Since
2.4.5  
Version
$Id: 127d4af12e159083935466773d1af788e46acd4e $  

\GitTagTask

Package: phing\tasks\ext\git

Wrapper around git-tag

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

Parent(s)
\GitBaseTask < \Task < \ProjectComponent
See
\VersionControl_Git  
Author
Evan Kaufman  
Author
Victor Farazdagi  
Copyright
2001,2002 THYRELL. All rights reserved  
Since
2.4.5  
Version
$Id: 127d4af12e159083935466773d1af788e46acd4e $  

Properties

Propertyprivateboolean  $annotate= 'false'

Make unsigned, annotated tag object. See -a of git-tag

Default valuefalseDetails
Type
boolean
Propertyprivatestring  $commit= ''

<commit> argument to git-tag

Details
Type
string
Propertyprivatestring  $contains= ''

Only list tags containing specified commit. See --contains of git-tag

Details
Type
string
Propertyprivateboolean  $delete= 'false'

Delete existing tags with given names. See -d of git-tag

Default valuefalseDetails
Type
boolean
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description\GitBaseTask::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Inherited_from
\GitBaseTask::$$description  
Propertyprivatestring  $file= ''

Take tag message from given file. See -F of git-tag

Details
Type
string
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  
Propertyprivatestring  $keySign= ''

Make GPG-signed tag, using given key. See -u of git-tag

Details
Type
string
Propertyprivateboolean  $list= 'false'

List tags with names matching given pattern. See -l of git-tag

Default valuefalseDetails
Type
boolean
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location\GitBaseTask::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Inherited_from
\GitBaseTask::$$location  
Propertyprivatestring  $message= ''

Use given tag message. See -m of git-tag

Details
Type
string
Propertyprivatestring  $name= ''

<tagname> argument to git-tag

Details
Type
string
Propertyprivateint  $num= ''

<num> specifies how many lines from the annotation, if any, are printed when using -l. See -n of git-tag

Details
Type
int
Propertyprivatestring  $object= ''

<object> argument to git-tag

Details
Type
string
Propertyprivatestring  $outputProperty= ''

Property name to set with output value from git-tag

Details
Type
string
Propertyprivatestring  $pattern= ''

<pattern> argument to git-tag

Details
Type
string
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  
Propertyprivateboolean  $replace= 'false'

Replace existing tag with given name. See -f of git-tag

Default valuefalseDetails
Type
boolean
Propertyprivatestring  $repository= ''
inherited

Current repository directory

Inherited from: \GitBaseTask::$$repository
Details
Type
string
Inherited_from
\GitBaseTask::$$repository  
Propertyprivateboolean  $sign= 'false'

Make GPG-signed tag. See -s of git-tag

Default valuefalseDetails
Type
boolean
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target\GitBaseTask::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Inherited_from
\GitBaseTask::$$target  
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  
Propertyprivateboolean  $verify= 'false'

Verify gpg signature of given tag names. See -v of git-tag

Default valuefalseDetails
Type
boolean
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

methodpublicgetAnnotate( ) : void

methodpublicgetCommit( ) : void

methodpublicgetContains( ) : void

methodpublicgetDelete( ) : void

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
methodpublicgetFile( ) : 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
methodpublicgetKeySign( ) : void

methodpublicgetList( ) : void

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

methodpublicgetName( ) : void

methodpublicgetNum( ) : void

methodpublicgetObject( ) : 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
methodpublicgetPattern( ) : void

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
methodpublicgetReplace( ) : void

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
methodpublicgetSign( ) : void

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)
methodpublicgetVerify( ) : void

methodpublicinit( ) : void
inherited

Initialize Task.

Inherited from: \GitBaseTask::init()

Check and include necessary libraries.

Throws
Exception Description
\BuildException
methodpublicisAnnotate( ) : void

methodpublicisDelete( ) : void

methodpublicisList( ) : void

methodpublicisReplace( ) : void

methodpublicisSign( ) : void

methodpublicisVerify( ) : void

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()
methodpublicsetAnnotate(  $flag ) : void

Parameters
Name Type Description
$flag
methodpublicsetCommit(  $commit ) : void

Parameters
Name Type Description
$commit
methodpublicsetContains(  $commit ) : void

Parameters
Name Type Description
$commit
methodpublicsetDelete(  $flag ) : void

Parameters
Name Type Description
$flag
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

methodpublicsetFile(  $file ) : void

Parameters
Name Type Description
$file
methodpublicsetForce(  $flag ) : void

Parameters
Name Type Description
$flag
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
methodpublicsetKeySign(  $keyId ) : void

Parameters
Name Type Description
$keyId
methodpublicsetList(  $flag ) : void

Parameters
Name Type Description
$flag
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(  $msg ) : void

Parameters
Name Type Description
$msg
methodpublicsetName(  $name ) : void

Parameters
Name Type Description
$name
methodpublicsetNum(  $num ) : void

Parameters
Name Type Description
$num
methodpublicsetObject(  $object ) : void

Parameters
Name Type Description
$object
methodpublicsetOutputProperty(  $prop ) : void

Parameters
Name Type Description
$prop
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

methodpublicsetPattern(  $pattern ) : void

Parameters
Name Type Description
$pattern
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

methodpublicsetReplace(  $flag ) : void

Parameters
Name Type Description
$flag
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

methodpublicsetSign(  $flag ) : void

Parameters
Name Type Description
$flag
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)

methodpublicsetVerify(  $flag ) : void

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