Class: Xinc_Plugin_Repos_ModificationSet_Git_Task

Source Location: /Xinc/Plugin/Repos/ModificationSet/Git/Task.php

Class Overview

Xinc_Plugin_Task_Base
   |
   --Xinc_Plugin_Repos_ModificationSet_AbstractTask
      |
      --Xinc_Plugin_Repos_ModificationSet_Git_Task

Methods

Inherited Constants

Class: Xinc_Plugin_Repos_ModificationSet_AbstractTask

Xinc_Plugin_Repos_ModificationSet_AbstractTask::CHANGED
Xinc_Plugin_Repos_ModificationSet_AbstractTask::ERROR
Xinc_Plugin_Repos_ModificationSet_AbstractTask::FAILED
Xinc_Plugin_Repos_ModificationSet_AbstractTask::STOPPED

Inherited Variables

Class: Xinc_Plugin_Task_Base

Xinc_Plugin_Task_Base::$arSubtasks
Xinc_Plugin_Task_Base::$_plugin
Xinc_Plugin_Task_Base::$_xml

Inherited Methods

Class: Xinc_Plugin_Repos_ModificationSet_AbstractTask

Xinc_Plugin_Repos_ModificationSet_AbstractTask::checkModified(): Check if this modification set has been modified
Xinc_Plugin_Repos_ModificationSet_AbstractTask::getPluginSlot(): Returns the slot of this task inside a build.
Xinc_Plugin_Repos_ModificationSet_AbstractTask::process(): abstract process of a modification set
Xinc_Plugin_Repos_ModificationSet_AbstractTask::validate(): Check necessary variables are set
Xinc_Plugin_Repos_ModificationSet_AbstractTask::validateTask(): Validates if a task can run by checking configs, directries and so on.

Class: Xinc_Plugin_Task_Base

Xinc_Plugin_Task_Base::__construct(): Constructor, stores a reference to the plugin for usage of functionality
Xinc_Plugin_Task_Base::getName(): Returns name of task by lowercasing class name.
Xinc_Plugin_Task_Base::getTasks()
Xinc_Plugin_Task_Base::getXml()
Xinc_Plugin_Task_Base::init()
Xinc_Plugin_Task_Base::registerTask(): Support for subtasks, empty by default.
Xinc_Plugin_Task_Base::setXml()

Class Details

[line 33]

[ Top ]

Class Methods

method checkModified [line 125]

Xinc_Plugin_Repos_ModificationSet_Result checkModified(
Xinc_Build_Interface
$build)

Check if this modification set has been modified

Tags:

return:	The result of the check.
access:	public

Overrides Xinc_Plugin_Repos_ModificationSet_AbstractTask::checkModified() (Check if this modification set has been modified)

Parameters:

Xinc_Build_Interface

$build

The running build.

[ Top ]

method getDirectory [line 78]

string getDirectory(
)

Gets the git checkout directory.

Tags:

return:	Directory which was set.
access:	public

[ Top ]

method getName [line 56]

string getName(
)

Returns name of task.

Tags:

return:	Name of task.
access:	public

Overrides Xinc_Plugin_Task_Base::getName() (Returns name of task by lowercasing class name.)

[ Top ]

method getUpdate [line 113]

boolean getUpdate(
)

Get if git should be automaticaly updated.

Tags:

return:	True if git repos should be updated.
access:	public

[ Top ]

method setDirectory [line 68]

void setDirectory(
string
$strDirectory)

Sets the git checkout directory.

Tags:

access:

public

Parameters:

string

$strDirectory

Directory for git checkout.

[ Top ]

method setRepository [line 90]

void setRepository(
string
$strRepository)

Sets the remote repository.

Tags:

access:

public

Parameters:

string

$strRepository

The remote repository.

[ Top ]

method setUpdate [line 103]

void setUpdate(
string
$strUpdate)

Tells whether to update the working copy directly here or not

Tags:

access:

public

Parameters:

string

$strUpdate

"true" or "1" as string to set update otherwise it is interpreted as false.

[ Top ]

method validateTask [line 135]

boolean validateTask(
)

Validates if a task can run by checking configs, directories and so on.

Tags:

return:	Is true if task can run.
access:	public

Overrides Xinc_Plugin_Repos_ModificationSet_AbstractTask::validateTask() (Validates if a task can run by checking configs, directries and so on.)

[ Top ]

Documentation generated on Sun, 09 Dec 2012 21:49:35 +0100 by phpDocumentor 1.4.4