tasks/ext/git/GitCloneTask.php

Show:

inherited

Classes
- \GitCloneTask

Table of Contents

\GitCloneTask
jump to top

Package: phing\tasks\ext\git

Wrapper around git-clone

Use {@link Project#createTask} to register a new Task.

Parent(s): \GitBaseTask < \Task < \ProjectComponent
See: \VersionControl_Git
Author: Victor Farazdagi
Copyright: 2001,2002 THYRELL. All rights reserved
Since: 2.4.3
Version: $Id: GitCloneTask.php 904 2010-10-05 09:15:19Z victor $

Properties

string
                 $description= ''

inherited

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

Details

Type: string
Inherited_from: \Task::$description

string
                 $isBare= 'false'

Whether --bare key should be set for git-init

Default valuefalseDetails

Type: string

\Location
                 $location= ''

inherited

stored buildfile locationInherited from: \Task::$location

Details

Type: \Location
Inherited_from: \Task::$location

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

Type: \Project
Inherited_from: \ProjectComponent::$project

\Target
                 $target= ''

inherited

owning Target objectInherited from: \Task::$target

Details

Type: \Target
Inherited_from: \Task::$target

string
                 $targetPath= ''

Path to target directory

Details

Type: string

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

\RuntimeConfigurable
                 $wrapper= ''

inherited

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

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$wrapper

Methods

getBare(
          
          )
        
        :
          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

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.

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

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

getTargetPath(
          
          )
        
        :
          string

Get path to target direcotry repo

Returns

Type	Description
string

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)

inherited

Initialize Task.

Inherited from: \GitBaseTask::init()

Check and include necessary libraries.

Throws

Exception	Description
\BuildException

isBare(
          
          )
        
        :
          string

Alias @see getBare()

Returns

Type	Description
string

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

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()

setBare(
           $flag
          )
        
        :
          void

Parameters

Name	Type	Description
$flag

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

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.

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

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

setTargetPath(
          string $targetPath
          )
        
        :
          void

Set path to source repo

Parameters

Name	Type	Description
$targetPath	string	Path to repository used as source

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)

tasks/ext/git/GitCloneTask.php

\GitCloneTaskjump to top

Properties

Methods

\GitCloneTask
jump to top