# tasks/ext/git/GitLogTask.php

## \GitLogTask
jump to top

Package: phing\tasks\ext\git

Wrapper aroung git-log

Parent(s)
  \GitBaseTask < \Task < \ProjectComponent
See
  \VersionControl_Git
Author
  Evan Kaufman
Author
  Victor Farazdagi
Since
  2.4.5
Version
  $Id: GitLogTask.php 1047 2011-03-02 16:54:32Z victor $

### Properties

`string $date= ''`

Date format. See --date of git-log

Details

Type
  string

`string $format= ''medium''`

Commit format. See --format of git-log

Default value`'medium'`Details

Type
  string

`\VersionControl_Git $gitClient= 'null'`
inherited

Inherited from: \GitBaseTask::$$gitClient
Default value `null` Details

Type
  \VersionControl_Git
Inherited_from
  \GitBaseTask::$$gitClient

`string $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

`integer $maxCount= ''`

Number of commits to show. See -<n>|-n|--max-count of git-log

Details

Type
  integer

`boolean $nameStatus= 'false'`

Names + status of changed files. See --name-status of git-log

Default value `false` Details

Type
  boolean

`boolean $noMerges= 'false'`

Don't show commits with more than one parent. See --no-merges of git-log

Default value `false` Details

Type
  boolean

`string $outputProperty= ''`

Property name to set with output value from git-log

Details

Type
  string

`string $paths= ''`

<path> arguments to git-log Accepts one or more paths delimited by PATH_SEPARATOR

Details

Type
  string

`string $repository= ''`
inherited

Current repository directory

Inherited from: \GitBaseTask::$$repository
Details

Type
  string
Inherited_from
  \GitBaseTask::$$repository

`string $sinceCommit= ''`

<since> argument to git-log

Details

Type
  string

`string|boolean $stat= 'false'`

Generate a diffstat. See --stat of git-log

Default value `false` Details

Type
  string | boolean

`string $untilCommit= ''HEAD''`

<until> argument to git-log

Default value`'HEAD'`Details

Type
  string

### Methods

`getDate( ) : void`

`getDescription( ) : void`
inherited

Inherited from: Task::getDescription()\GitBaseTask::getDescription()
`getFormat( ) : void`

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

Inherited from: \GitBaseTask::getGitClient()
Parameters

Name | Type | Description
--- | --- | ---
$reset |  |
$repository |  |

`getGitPath( ) : string`
inherited

Get path to git executable

Inherited from: \GitBaseTask::getGitPath()
Returns

Type | Description
--- | ---
string |

`getLocation( ) : void`
inherited

Inherited from: Task::getLocation()\GitBaseTask::getLocation()
`getMaxCount( ) : void`

`getNameStatus( ) : void`

`getNoMerges( ) : void`

`getOwningTarget( ) : void`
inherited

Inherited from: Task::getOwningTarget()\GitBaseTask::getOwningTarget()
`getPaths( ) : void`

`getProject( ) : void`
inherited

Inherited from: ProjectComponent::getProject()\GitBaseTask::getProject()
`getRegisterSlot( ) : void`
inherited

Inherited from: Task::getRegisterSlot()\GitBaseTask::getRegisterSlot()
`getRepository( ) : string`
inherited

Get repository directory

Inherited from: \GitBaseTask::getRepository()
Returns

Type | Description
--- | ---
string |

`getRuntimeConfigurableWrapper( ) : void`
inherited

Inherited from: Task::getRuntimeConfigurableWrapper()\GitBaseTask::getRuntimeConfigurableWrapper()
`getSince( ) : void`

`getStat( ) : void`

`getTaskName( ) : void`
inherited

Inherited from: Task::getTaskName()\GitBaseTask::getTaskName()
`getTaskType( ) : void`
inherited

Inherited from: Task::getTaskType()\GitBaseTask::getTaskType()
`getUntil( ) : void`

`init( ) : void`
inherited

Initialize Task.

Inherited from: \GitBaseTask::init()

Check and include necessary libraries.

`isNameStatus( ) : void`

`isNoMerges( ) : void`

`log( ) : void`
inherited

Inherited from: Task::log()\GitBaseTask::log()
`main( ) : void`

The main entry point for the task

`maybeConfigure( ) : void`
inherited

Inherited from: Task::maybeConfigure()\GitBaseTask::maybeConfigure()
`perform( ) : void`
inherited

Inherited from: Task::perform()\GitBaseTask::perform()
`setAfter( $after ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$after |  |

`setBefore( $before ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$before |  |

`setDate( $date ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$date |  |

`setDescription( ) : void`
inherited

Inherited from: Task::setDescription()\GitBaseTask::setDescription()
`setFormat( $format ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$format |  |

`setGitPath( 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 |

`setLocation( ) : void`
inherited

Inherited from: Task::setLocation()\GitBaseTask::setLocation()
`setMaxCount( $count ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$count |  |

`setNameStatus( $flag ) : void`

Parameters

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

`setNoMerges( $flag ) : void`

Parameters

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

`setOutputProperty( $prop ) : void`

Parameters

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

`setOwningTarget( ) : void`
inherited

Inherited from: Task::setOwningTarget()\GitBaseTask::setOwningTarget()
`setPaths( $paths ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$paths |  |

`setProject( ) : void`
inherited

Inherited from: ProjectComponent::setProject()\GitBaseTask::setProject()
`setRepository( string $repository ) : \GitBaseTask`
inherited

Set repository directory

Inherited from: \GitBaseTask::setRepository()
Parameters

Name | Type | Description
--- | --- | ---
$repository | string | Repo directory

Returns

Type | Description
--- | ---
\GitBaseTask |

`setRuntimeConfigurableWrapper( ) : void`
inherited

Inherited from: Task::setRuntimeConfigurableWrapper()\GitBaseTask::setRuntimeConfigurableWrapper()
`setSince( $since ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$since |  |

`setStat( $stat ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$stat |  |

`setTaskName( ) : void`
inherited

Inherited from: Task::setTaskName()\GitBaseTask::setTaskName()
`setTaskType( ) : void`
inherited

Inherited from: Task::setTaskType()\GitBaseTask::setTaskType()
`setUntil( $until ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$until |  |

Documentation was generated by DocBlox 0.17.1.