Xinc-Plugin-Repos-ModificationSet
[ class tree: Xinc-Plugin-Repos-ModificationSet ] [ index: Xinc-Plugin-Repos-ModificationSet ] [ all elements ]

Class: Xinc_Plugin_Repos_ModificationSet_AbstractTask

Source Location: /Xinc/Plugin/Repos/ModificationSet/AbstractTask.php

Class Overview

Xinc_Plugin_Task_Base
   |
   --Xinc_Plugin_Repos_ModificationSet_AbstractTask



Author(s):

Constants

Methods


Child classes:

Inherited Variables

Inherited Methods

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 32]


Tags:

abstract:  


[ Top ]


Class Methods


method checkModified [line 73]

Xinc_Plugin_Repos_ModificationSet_Result checkModified( Xinc_Build_Interface $build)

Check if this modification set has been modified



Tags:

abstract:  
access:  public


Overridden in child classes as:

Xinc_Contrib_Warko_Plugin_ModificationSet_SvnTag_Task::checkModified()
Check if this modification set has been modified
Xinc_Plugin_Repos_ModificationSet_Git_Task::checkModified()
Check if this modification set has been modified
Xinc_Plugin_Repos_ModificationSet_BuildAlways_Task::checkModified()
Check if this modification set has been modified
Xinc_Plugin_Repos_ModificationSet_Svn_Task::checkModified()
Check if this modification set has been modified

Parameters:

Xinc_Build_Interface   $build  

[ Top ]

method getPluginSlot [line 80]

integer getPluginSlot( )

Returns the slot of this task inside a build.



Tags:

return:  The slot number.
access:  public


[ Top ]

method process [line 50]

void process( Xinc_Build_Interface $build)

abstract process of a modification set



Tags:

access:  public


Parameters:

Xinc_Build_Interface   $build   The running build.

[ Top ]

method validate [line 90]

void validate( )

Check necessary variables are set



Tags:

throws:  Xinc_Exception_MalformedConfig
access:  public


[ Top ]

method validateTask [line 106]

boolean validateTask( )

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



Tags:

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


Overridden in child classes as:

Xinc_Contrib_Warko_Plugin_ModificationSet_SvnTag_Task::validateTask()
Validates if a task can run by checking configs, directries and so on.
Xinc_Plugin_Repos_ModificationSet_Git_Task::validateTask()
Validates if a task can run by checking configs, directories and so on.
Xinc_Plugin_Repos_ModificationSet_BuildAlways_Task::validateTask()
Validates if a task can run by checking configs, directries and so on.
Xinc_Plugin_Repos_ModificationSet_Svn_Task::validateTask()
Validates if a task can run by checking configs, directries and so on.

[ Top ]


Class Constants

CHANGED =  1

[line 39]


[ Top ]

ERROR =  0

[line 41]


[ Top ]

FAILED =  -2

[line 37]


[ Top ]

STOPPED =  -1

[line 35]


[ Top ]



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