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

Class: Xinc_Plugin_Repos_ModificationSet_Svn_Task

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

Class Overview

Xinc_Plugin_Task_Base
   |
   --Xinc_Plugin_Repos_ModificationSet_AbstractTask
      |
      --Xinc_Plugin_Repos_ModificationSet_Svn_Task



Methods


Inherited Constants

Inherited Variables

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

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

string getDirectory( )

Gets the SVN checkout directory.



Tags:

return:  Directory which was set.
access:  public


[ Top ]

method getName [line 63]

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 getPassword [line 151]

string getPassword( )

Gets the password



Tags:

return:  Password which was set.
access:  public


[ Top ]

method getRepository [line 107]

string getRepository( )

Gets the remote repository url.



Tags:

return:  Repository url which was set.
access:  public


[ Top ]

method getUpdate [line 174]

boolean getUpdate( )

Get if git should be automaticaly updated.



Tags:

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


[ Top ]

method getUsername [line 129]

string getUsername( )

Gets the user name



Tags:

return:  Username which was set.
access:  public


[ Top ]

method setDirectory [line 75]

void setDirectory( string $strDirectory)

Sets the git checkout directory.



Tags:

access:  public


Parameters:

string   $strDirectory   Directory for git checkout.

[ Top ]

method setPassword [line 141]

void setPassword( string $strPassword)

Sets the password for the svn commands



Tags:

access:  public


Parameters:

string   $strPassword   Password for svn

[ Top ]

method setRepository [line 97]

void setRepository( string $strRepository)

Sets the remote repository.



Tags:

access:  public


Parameters:

string   $strRepository   The remote repository.

[ Top ]

method setUpdate [line 164]

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 setUsername [line 119]

void setUsername( string $strUsername)

Sets the username for the svn commands



Tags:

access:  public


Parameters:

string   $strUsername   Username for svn.

[ Top ]

method validateTask [line 197]

boolean validateTask( )

Validates if a task can run by checking configs, directries 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