# tasks/ext/git/GitPullTask.php

## \GitPullTask
jump to top

Package: phing\tasks\ext\git

Wrapper aroung git-pull

Parent(s)
  \GitBaseTask < \Task < \ProjectComponent
See
  \VersionControl_Git
Author
  Victor Farazdagi
Since
  2.4.3
Version
  $Id: GitPullTask.php 1084 2011-05-06 09:55:25Z mrook $

### Properties

`boolean $allRemotes= 'false'`

Fetch all remotes --all key to git-pull

Default value `false` Details

Type
  boolean

`boolean $append= 'false'`

--append key to git-pull

Default value `false` Details

Type
  boolean

`boolean $force= 'false'`

--force, -f key to git-pull

Default value `false` Details

Type
  boolean

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

`boolean $keepFiles= 'false'`

Keep downloaded pack --keep key to git-pull

Default value `false` Details

Type
  boolean

`boolean $noRebase= 'false'`

--no-rebase key to git-pull Allow to override --rebase (if set to default true in configuration)

Default value `false` Details

Type
  boolean

`boolean $noTags= 'false'`

Disable/enable automatic tag following --no-tags key to git-pull

Default value `false` Details

Type
  boolean

`boolean $quiet= 'true'`

--quiet, -q key to git-pull

Default value `true` Details

Type
  boolean

`boolean $rebase= 'false'`

--rebase key to git-pull

Default value `false` Details

Type
  boolean

`string $refspec= ''`

<refspec> argument to git-pull

Details

Type
  string

`string $repository= ''`
inherited

Current repository directory

Inherited from: \GitBaseTask::$$repository
Details

Type
  string
Inherited_from
  \GitBaseTask::$$repository

`string $source= ''origin''`

<repository> argument to git-pull

Default value`'origin'`Details

Type
  string

`string $strategy= ''`

Merge strategy. See -s <strategy> of git-pull

Details

Type
  string

`string $strategyOption= ''`

-X or --strategy-option of git-pull

Details

Type
  string

`boolean $tags= 'false'`

Fetch all tags (even not reachable from branch heads) --tags key to git-pull

Default value `false` Details

Type
  boolean

`array $validStrategies= 'array( 'octopus''`

Valid merge strategies

Default value `array( 'octopus'`Details

Type
  array

### Methods

`getAll( ) : void`

`getAppend( ) : void`

`getDescription( ) : void`
inherited

Inherited from: Task::getDescription()\GitBaseTask::getDescription()
`getForce( ) : 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 |

`getKeep( ) : void`

`getLocation( ) : void`
inherited

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

`getNoTags( ) : void`

`getOwningTarget( ) : void`
inherited

Inherited from: Task::getOwningTarget()\GitBaseTask::getOwningTarget()
`getProject( ) : void`
inherited

Inherited from: ProjectComponent::getProject()\GitBaseTask::getProject()
`getQuiet( ) : void`

`getRebase( ) : void`

`getRefspec( ) : void`

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

`getStrategy( ) : void`

`getStrategyOption( ) : void`

`getTags( ) : void`

`getTaskName( ) : void`
inherited

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

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

Initialize Task.

Inherited from: \GitBaseTask::init()

Check and include necessary libraries.

`isAllRemotes( ) : void`

`isAppend( ) : void`

`isForce( ) : void`

`isKeepFiles( ) : void`

`isNoRebase( ) : void`

`isNoTags( ) : void`

`isQuiet( ) : void`

`isRebase( ) : void`

`isTags( ) : 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()
`setAll( $flag ) : void`

Parameters

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

`setAppend( $flag ) : void`

Parameters

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

`setDescription( ) : void`
inherited

Inherited from: Task::setDescription()\GitBaseTask::setDescription()
`setForce( $flag ) : void`

Parameters

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

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

`setKeep( $flag ) : void`

Parameters

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

`setLocation( ) : void`
inherited

Inherited from: Task::setLocation()\GitBaseTask::setLocation()
`setNoRebase( $flag ) : void`

Parameters

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

`setNoTags( $flag ) : void`

Parameters

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

`setOwningTarget( ) : void`
inherited

Inherited from: Task::setOwningTarget()\GitBaseTask::setOwningTarget()
`setProject( ) : void`
inherited

Inherited from: ProjectComponent::setProject()\GitBaseTask::setProject()
`setQuiet( $flag ) : void`

Parameters

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

`setRebase( $flag ) : void`

Parameters

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

`setRefspec( $spec ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$spec |  |

`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()
`setSource( $source ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$source |  |

`setStrategy( $strategy ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$strategy |  |

`setStrategyOption( $strategyOption ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$strategyOption |  |

`setTags( $flag ) : void`

Parameters

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

`setTaskName( ) : void`
inherited

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

Inherited from: Task::setTaskType()\GitBaseTask::setTaskType()
Documentation was generated by DocBlox 0.17.1.