tasks/ext/git/GitLogTask.php

Show: inherited
Table of Contents

\GitLogTask

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

Propertyprivatestring  $date= ''

Date format. See --date of git-log

Details
Type
string
Propertyprivatestring  $format= ''medium''

Commit format. See --format of git-log

Default value'medium'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  
Propertyprivateinteger  $maxCount= ''

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

Details
Type
integer
Propertyprivateboolean  $nameStatus= 'false'

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

Default valuefalseDetails
Type
boolean
Propertyprivateboolean  $noMerges= 'false'

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

Default valuefalseDetails
Type
boolean
Propertyprivatestring  $outputProperty= ''

Property name to set with output value from git-log

Details
Type
string
Propertyprivatestring  $paths= ''

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

Details
Type
string
Propertyprivatestring  $repository= ''
inherited

Current repository directory

Inherited from: \GitBaseTask::$$repository
Details
Type
string
Inherited_from
\GitBaseTask::$$repository  
Propertyprivatestring  $sinceCommit= ''

<since> argument to git-log

Details
Type
string
Propertyprivatestring|boolean  $stat= 'false'

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

Default valuefalseDetails
Type
string | boolean
Propertyprivatestring  $untilCommit= ''HEAD''

<until> argument to git-log

Default value'HEAD'Details
Type
string

Methods

methodpublicgetDate( ) : void

methodpublicgetDescription( ) : void
methodpublicgetFormat( ) : 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( ) : void
methodpublicgetMaxCount( ) : void

methodpublicgetNameStatus( ) : void

methodpublicgetNoMerges( ) : void

methodpublicgetOwningTarget( ) : void
methodpublicgetPaths( ) : void

methodpublicgetProject( ) : void
methodprotectedgetRegisterSlot( ) : void
methodpublicgetRepository( ) : string
inherited

Get repository directory

Inherited from: \GitBaseTask::getRepository()
Returns
Type Description
string
methodpublicgetRuntimeConfigurableWrapper( ) : void
methodpublicgetSince( ) : void

methodpublicgetStat( ) : void

methodpublicgetTaskName( ) : void
methodpublicgetTaskType( ) : void
methodpublicgetUntil( ) : void

methodpublicinit( ) : void
inherited

Initialize Task.

Inherited from: \GitBaseTask::init()

Check and include necessary libraries.

methodpublicisNameStatus( ) : void

methodpublicisNoMerges( ) : void

methodpubliclog( ) : void
inherited

Inherited from: Task::log()\GitBaseTask::log()
methodpublicmain( ) : void

The main entry point for the task

methodpublicmaybeConfigure( ) : void
methodpublicperform( ) : void
inherited

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

Parameters
Name Type Description
$after
methodpublicsetBefore(  $before ) : void

Parameters
Name Type Description
$before
methodpublicsetDate(  $date ) : void

Parameters
Name Type Description
$date
methodpublicsetDescription( ) : void
methodpublicsetFormat(  $format ) : void

Parameters
Name Type Description
$format
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( ) : void
methodpublicsetMaxCount(  $count ) : void

Parameters
Name Type Description
$count
methodpublicsetNameStatus(  $flag ) : void

Parameters
Name Type Description
$flag
methodpublicsetNoMerges(  $flag ) : void

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

Parameters
Name Type Description
$prop
methodpublicsetOwningTarget( ) : void
methodpublicsetPaths(  $paths ) : void

Parameters
Name Type Description
$paths
methodpublicsetProject( ) : void
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( ) : void
methodpublicsetSince(  $since ) : void

Parameters
Name Type Description
$since
methodpublicsetStat(  $stat ) : void

Parameters
Name Type Description
$stat
methodpublicsetTaskName( ) : void
methodpublicsetTaskType( ) : void
methodpublicsetUntil(  $until ) : void

Parameters
Name Type Description
$until
Documentation was generated by DocBlox 0.17.1.