# tasks/ext/git/GitTagTask.php

## \GitTagTask
jump to top

Package: phing\tasks\ext\git

Wrapper around git-tag

Parent(s)
  \GitBaseTask < \Task < \ProjectComponent
See
  \VersionControl_Git
Author
  Evan Kaufman
Author
  Victor Farazdagi
Since
  2.4.5
Version
  $Id: GitTagTask.php 1052 2011-03-02 20:33:54Z victor $

### Properties

`boolean $annotate= 'false'`

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

Default value `false` Details

Type
  boolean

`string $commit= ''`

<commit> argument to git-tag

Details

Type
  string

`string $contains= ''`

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

Details

Type
  string

`boolean $delete= 'false'`

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

Default value `false` Details

Type
  boolean

`string $file= ''`

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

Details

Type
  string

`string $keySign= ''`

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

Details

Type
  string

`boolean $list= 'false'`

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

Default value `false` Details

Type
  boolean

`string $message= ''`

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

Details

Type
  string

`string $name= ''`

<tagname> argument to git-tag

Details

Type
  string

`int $num= ''`

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

Details

Type
  int

`string $object= ''`

<object> argument to git-tag

Details

Type
  string

`string $outputProperty= ''`

Property name to set with output value from git-tag

Details

Type
  string

`string $pattern= ''`

<pattern> argument to git-tag

Details

Type
  string

`boolean $replace= 'false'`

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

Default value `false` Details

Type
  boolean

`boolean $sign= 'false'`

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

Default value `false` Details

Type
  boolean

`boolean $verify= 'false'`

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

Default value `false` Details

Type
  boolean

### Methods

`getAnnotate( ) : void`

`getCommit( ) : void`

`getContains( ) : void`

`getDelete( ) : void`

`getDescription( ) : void`

`getFile( ) : void`

`getGitClient( ) : void`

`getGitPath( ) : void`

`getKeySign( ) : void`

`getList( ) : void`

`getLocation( ) : void`

`getMessage( ) : void`

`getName( ) : void`

`getNum( ) : void`

`getObject( ) : void`

`getOwningTarget( ) : void`

`getPattern( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getReplace( ) : void`

`getRepository( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getSign( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`getVerify( ) : void`

`init( ) : void`

`isAnnotate( ) : void`

`isDelete( ) : void`

`isList( ) : void`

`isReplace( ) : void`

`isSign( ) : void`

`isVerify( ) : void`

`log( ) : void`

`main( ) : void`

The main entry point for the task

`maybeConfigure( ) : void`

`perform( ) : void`

`setAnnotate( $flag ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$flag |  |

`setCommit( $commit ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$commit |  |

`setContains( $commit ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$commit |  |

`setDelete( $flag ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$flag |  |

`setDescription( ) : void`

`setFile( $file ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$file |  |

`setForce( $flag ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$flag |  |

`setGitPath( ) : void`

`setKeySign( $keyId ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$keyId |  |

`setList( $flag ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$flag |  |

`setLocation( ) : void`

`setMessage( $msg ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$msg |  |

`setName( $name ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$name |  |

`setNum( $num ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$num |  |

`setObject( $object ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$object |  |

`setOutputProperty( $prop ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$prop |  |

`setOwningTarget( ) : void`

`setPattern( $pattern ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$pattern |  |

`setProject( ) : void`

`setReplace( $flag ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$flag |  |

`setRepository( ) : void`

`setRuntimeConfigurableWrapper( ) : void`

`setSign( $flag ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$flag |  |

`setTaskName( ) : void`

`setTaskType( ) : void`

`setVerify( $flag ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$flag |  |

Documentation was generated by DocBlox 0.17.1.