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

Class: Xinc_Plugin_Repos_ModificationSet_Git

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

Class Overview

Xinc_Plugin_Base
   |
   --Xinc_Plugin_Repos_ModificationSet_Git



Methods


Inherited Methods

Class: Xinc_Plugin_Base

Xinc_Plugin_Base::getApiModules()
Xinc_Plugin_Base::getGuiWidgets()
Xinc_Plugin_Base::getTaskDefinitions()
Returns the defined tasks of the plugin
Xinc_Plugin_Base::validate()
Validate if the plugin can run properly on this system

Class Details

[line 38]


[ Top ]


Class Methods


constructor __construct [line 54]

Xinc_Plugin_Repos_ModificationSet_Git __construct( )

Constructor



Tags:

access:  public


[ Top ]

method checkModified [line 82]

Xinc_Plugin_Repos_ModificationSet_Result checkModified( Xinc_Build_Interface $build, Xinc_Plugin_Repos_ModificationSet_Git_Task $task)

Check if this modification set has been modified



Tags:

return:  The result of the check.
access:  public


Parameters:

Xinc_Build_Interface   $build   The running build.
Xinc_Plugin_Repos_ModificationSet_Git_Task   $task   The configured task

[ Top ]

method fetch [line 159]

void fetch( )

Fetches remote branch state.



Tags:

access:  protected


[ Top ]

method getChangeLog [line 302]

void getChangeLog( Xinc_Plugin_Repos_ModificationSet_Result $result)

Gets the changelog data between two revisions from git and puts this info into the ModificationSet_Result. (This are author, date and commit message.)



Tags:

access:  protected


Parameters:

Xinc_Plugin_Repos_ModificationSet_Result   $result   The Result to get Hash ids from and set change log data.

[ Top ]

method getLocalHash [line 216]

string getLocalHash( string $strBranchName)

Gets local hash for branch.



Tags:

return:  The local hash for given branch.
access:  protected


Parameters:

string   $strBranchName   Name of branch to get hash.

[ Top ]

method getLogEntry [line 339]

string|integer getLogEntry( string $strType, array &$arLogEntries)

Analiezes the log entry data from the git command line call.



Tags:

return:  The value of the log entry.
access:  protected


Parameters:

string   $strType   Type to handle next.
array   &$arLogEntries   The entries from the command line call. Processed ones will be shifted out.

[ Top ]

method getModifiedFiles [line 246]

void getModifiedFiles( Xinc_Plugin_Repos_ModificationSet_Result $result)

Gets the modified files between two revisions from git and puts this info into the ModificationSet_Result.



Tags:

access:  protected


Parameters:

Xinc_Plugin_Repos_ModificationSet_Result   $result   The Result to get Hash ids from and set modified files.

[ Top ]

method getRemoteHash [line 182]

string getRemoteHash( string $strBranchName)

Gets remote hash for branch.



Tags:

return:  The remote hash for given branch.
access:  protected


Parameters:

string   $strBranchName   Name of branch to get hash.

[ Top ]

method getTaskDefinitions [line 68]

array getTaskDefinitions( )

Returns definition of task.



Tags:

return:  Array of definition.
access:  public


Overrides Xinc_Plugin_Base::getTaskDefinitions() (Returns the defined tasks of the plugin)

[ Top ]

method update [line 137]

void update( )

Update local copy of git.



Tags:

access:  protected


[ Top ]

method validate [line 369]

boolean validate( )

Validate if the plugin can run properly on this system



Tags:

return:  True if plugin can run properly otherwise false.
access:  public


Overrides Xinc_Plugin_Base::validate() (Validate if the plugin can run properly on this system)

[ Top ]


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