# tasks/ext/git/GitLogTask.php

## \GitLogTask
jump to top

Package: phing\tasks\ext\git

Wrapper aroung git-log

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: GitLogTask.php 1047 2011-03-02 16:54:32Z victor $

### Properties

`string $date= ''`

Date format. See --date of git-log

Details

Type
  string

`string $description= ''`
inherited

description of the taskInherited from: \Task::$description
Details

Type
  string
Inherited_from
  \Task::$description

`string $format= ''medium''`

Commit format. See --format of git-log

Default value`'medium'`Details

Type
  string

`\Location $location= ''`
inherited

stored buildfile locationInherited from: \Task::$location
Details

Type
  \Location
Inherited_from
  \Task::$location

`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

`\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
Default value `null` Details

Type
  \Project
Inherited_from
  \ProjectComponent::$project

`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
  stringboolean

`\Target $target= ''`
inherited

owning Target objectInherited from: \Task::$target
Details

Type
  \Target
Inherited_from
  \Task::$target

`string $taskName= ''`
inherited

Taskname for loggerInherited from: \Task::$taskName
Details

Type
  string
Inherited_from
  \Task::$taskName

`string $taskType= ''`
inherited

internal taskname (req)Inherited from: \Task::$taskType
Details

Type
  string
Inherited_from
  \Task::$taskType

`string $untilCommit= ''HEAD''`

<until> argument to git-log

Default value`'HEAD'`Details

Type
  string

`\RuntimeConfigurable $wrapper= ''`
inherited

wrapper of the taskInherited from: \Task::$wrapper
Details

Type
  \RuntimeConfigurable
Inherited_from
  \Task::$wrapper

### Methods

`getDate( ) : void`

`getDescription( ) : string`
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns

Type | Description
--- | ---
string | The text description of the task

`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( ) : \Location`
inherited

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

Inherited from: \Task::getLocation()
Returns

Type | Description
--- | ---
\Location | The location object describing the position of this task within the buildfile.

`getMaxCount( ) : void`

`getNameStatus( ) : void`

`getNoMerges( ) : void`

`getOwningTarget( ) : \Target`
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns

Type | Description
--- | ---
\Target | The target object that owns this task

`getPaths( ) : void`

`getProject( ) : \Project`
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()
Returns

Type | Description
--- | ---
\Project | Reference to current porject object

`getRegisterSlot( $slotName ) : void`
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters

Name | Type | Description
--- | --- | ---
$slotName |  |

`getRepository( ) : string`
inherited

Get repository directory

Inherited from: \GitBaseTask::getRepository()
Returns

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

`getRuntimeConfigurableWrapper( ) : \RuntimeConfigurable`
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns

Type | Description
--- | ---
\RuntimeConfigurable | The wrapper object used by this task

`getSince( ) : void`

`getStat( ) : void`

`getTaskName( ) : string`
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns

Type | Description
--- | ---
string | Name of this task

`getTaskType( ) : string`
inherited

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

Inherited from: \Task::getTaskType()
Returns

Type | Description
--- | ---
string | The type of this task (XML Tag)

`getUntil( ) : void`

`init( ) : void`
inherited

Initialize Task.

Inherited from: \GitBaseTask::init()

Check and include necessary libraries.

Throws

Exception | Description
--- | ---
\BuildException |

`isNameStatus( ) : void`

`isNoMerges( ) : void`

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

Provides a project level log event to the task.

Inherited from: \Task::log()

@param string $msg The message to be logged.

Parameters

Name | Type | Description
--- | --- | ---
$msg | string | The message to log
$level | integer | The priority of the message

Details

See
  \BuildEvent
See
  \BuildListener

`main( ) : 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.

`maybeConfigure( ) : void`
inherited

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

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

Perfrom this task

Inherited from: \Task::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( string $desc ) : void`
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters

Name | Type | Description
--- | --- | ---
$desc | string | The text describing the task

`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( \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()
Parameters

Name | Type | Description
--- | --- | ---
$location | \Location | The location object describing the position of this task within the buildfile.

`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( \Target $target ) : void`
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters

Name | Type | Description
--- | --- | ---
$target | \Target | Reference to owning target

`setPaths( $paths ) : void`

Parameters

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

`setProject( \Project $project ) : void`
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | The reference to the current project

`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( \RuntimeConfigurable $wrapper ) : void`
inherited

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

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters

Name | Type | Description
--- | --- | ---
$wrapper | \RuntimeConfigurable | The wrapper object this task should use

`setSince( $since ) : void`

Parameters

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

`setStat( $stat ) : void`

Parameters

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

`setTaskName( $name ) : string`
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters

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

Returns

Type | Description
--- | ---
string | A string representing the name of this task for log

`setTaskType( string $name ) : void`
inherited

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

Inherited from: \Task::setTaskType()
Parameters

Name | Type | Description
--- | --- | ---
$name | string | The type of this task (XML Tag)

`setUntil( $until ) : void`

Parameters

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

Documentation was generated by DocBlox 0.15.1.