Xinc-Build
[ class tree: Xinc-Build ] [ index: Xinc-Build ] [ all elements ]

Class: Xinc_Build_Interface

Source Location: /Xinc/Build/Interface.php

Interface Overview


Xinc - Continuous Integration.


Author(s):

Copyright:

  • 2007 Arno Schneider, Barcelona

Constants

Methods



Class Details



[ Top ]


Class Methods


static method unserialize [line 132]

static void &unserialize( Xinc_Project &$project, [ $buildTimestamp = null], [ $statusDir = null])

loads the build information



Tags:

access:  public


Parameters:

Xinc_Project   &$project  
   $buildTimestamp  
   $statusDir  

[ Top ]

method build [line 217]

void build( )

Build



Tags:

access:  public


[ Top ]

method debug [line 242]

void debug( $message)



Tags:

access:  public


Parameters:

   $message  

[ Top ]

method dequeue [line 260]

void dequeue( )

remove build from queue mode



Tags:

access:  public


[ Top ]

method enqueue [line 248]

void enqueue( )

Put build into queue mode



Tags:

access:  public


[ Top ]

method error [line 240]

void error( $message)



Tags:

access:  public


Parameters:

   $message  

[ Top ]

constructor __construct [line 49]

Xinc_Build_Interface __construct( Xinc_Engine_Interface &$engine, Xinc_Project &$project, [integer $buildTimestamp = null], Xinc_Engine_Interface $engine, Xinc_Project $project)

sets the project, engine and timestamp for the build



Tags:

access:  public


Parameters:

Xinc_Engine_Interface   $engine  
Xinc_Project   $project  
integer   $buildTimestamp  
Xinc_Engine_Interface   &$engine  
Xinc_Project   &$project  

[ Top ]

method getBuildTime [line 101]

integer getBuildTime( )

returns the timestamp of this build



Tags:

return:  Timestamp of build (unixtimestamp)
access:  public


[ Top ]

method getConfigDirective [line 275]

void getConfigDirective( string $name)



Tags:

access:  public


Parameters:

string   $name  

[ Top ]

method getEngine [line 120]

Xinc_Engine_Interface &getEngine( )



Tags:

access:  public


[ Top ]

method getInternalProperties [line 77]

Xinc_Build_Properties &getInternalProperties( )

returns the internal build properties



Tags:

access:  public


[ Top ]

method getLabel [line 192]

string getLabel( )

returns the label of this build



Tags:

access:  public


[ Top ]

method getLabeler [line 173]

Xinc_Build_Labeler_Interface getLabeler( )



Tags:

access:  public


[ Top ]

method getLastBuild [line 57]

Xinc_Build_Interface &getLastBuild( )

Returns the last build



Tags:

access:  public


[ Top ]

method getNextBuildTime [line 109]

void getNextBuildTime( )

Returns the next build time (unix timestamp)

for this build




Tags:

access:  public


[ Top ]

method getNumber [line 159]

integer getNumber( )

returns the build no for this build



Tags:

access:  public


[ Top ]

method getProject [line 114]

Xinc_Project &getProject( )



Tags:

access:  public


[ Top ]

method getProperties [line 70]

Xinc_Build_Properties &getProperties( )

returns the build properties



Tags:

access:  public


[ Top ]

method getScheduler [line 186]

Xinc_Build_Scheduler_Interface getScheduler( )



Tags:

access:  public


[ Top ]

method getStatistics [line 89]

Xinc_Build_Statistics &getStatistics( )

returns the build statistics



Tags:

access:  public


[ Top ]

method getStatus [line 138]

void getStatus( )

returns the status of this build



Tags:

access:  public


[ Top ]

method getStatusSubDir [line 231]

void getStatusSubDir( )

Returns the subdirectory inside the status directory

where the status information of the build is stored




Tags:

access:  public


[ Top ]

method getTaskRegistry [line 204]

Xinc_Build_Tasks_Registry getTaskRegistry( )



Tags:

access:  public


[ Top ]

method info [line 238]

void info( string $message)

Logs a message of severity info



Tags:

access:  public


Parameters:

string   $message  

[ Top ]

method init [line 83]

void init( )

called before a new build is executed



Tags:

access:  public


[ Top ]

method isQueued [line 254]

void isQueued( )

check if build is in queue mode



Tags:

access:  public


[ Top ]

method process [line 211]

void process( mixed $slot)

processes the tasks that are registered for the slot



Tags:

access:  public


Parameters:

mixed   $slot  

[ Top ]

method resetConfigDirective [line 270]

void resetConfigDirective( )



Tags:

access:  public


[ Top ]

method serialize [line 126]

void serialize( )

stores the build information



Tags:

access:  public


[ Top ]

method setBuildTime [line 95]

void setBuildTime( integer $buildTime)

sets the build time for this build



Tags:

access:  public


Parameters:

integer   $buildTime   unixtimestamp

[ Top ]

method setConfigDirective [line 268]

void setConfigDirective( string $name, string $value)

Sets custom config value for the current build



Tags:

access:  public


Parameters:

string   $name  
string   $value  

[ Top ]

method setLabeler [line 167]

void setLabeler( Xinc_Build_Labeler_Interface &$labeler, Xinc_Build_Labeler_Interface $labeler)

Sets the labeler that should be used for this build



Tags:

access:  public


Parameters:

Xinc_Build_Labeler_Interface   $labeler  
Xinc_Build_Labeler_Interface   &$labeler  

[ Top ]

method setLastBuild [line 63]

void setLastBuild( )

Moves the current build to _lastBuild



Tags:

access:  public


[ Top ]

method setNumber [line 152]

void setNumber( integer $no)

Sets the sequence number for this build



Tags:

access:  public


Parameters:

integer   $no  

[ Top ]

method setScheduler [line 181]

void setScheduler( Xinc_Build_Scheduler_Interface &$scheduler, Xinc_Build_Scheduler_Interface $scheduler)

Sets a build scheduler, which calculates the next build time based on the configuration



Tags:

access:  public


Parameters:

Xinc_Build_Scheduler_Interface   $scheduler  
Xinc_Build_Scheduler_Interface   &$scheduler  

[ Top ]

method setStatus [line 145]

void setStatus( integer $status)

Set the status of this build



Tags:

access:  public


Parameters:

integer   $status  

[ Top ]

method setTaskRegistry [line 198]

void setTaskRegistry( Xinc_Build_Tasks_Registry $taskRegistry)



Tags:

access:  public


Parameters:

Xinc_Build_Tasks_Registry   $taskRegistry  

[ Top ]

method updateTasks [line 224]

void updateTasks( )

Updates properties on tasks, after

a change in build status




Tags:

access:  public


[ Top ]

method warn [line 241]

void warn( $message)



Tags:

access:  public


Parameters:

   $message  

[ Top ]


Class Constants

FAILED =  0

[line 36]


[ Top ]

INITIALIZED =  -2

[line 35]


[ Top ]

MISCONFIGURED =  3

[line 39]


[ Top ]

PASSED =  1

[line 37]


[ Top ]

STOPPED =  -1

[line 38]


[ Top ]



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