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

Class: Xinc_Engine_Sunrise

Source Location: /Xinc/Engine/Sunrise.php

Class Overview




Implements interfaces:

Variables

Constants

Methods



Class Details

[line 35]


[ Top ]


Class Variables

$build =

[line 46]

The current build



Tags:

access:  public



[ Top ]



Class Methods


constructor __construct [line 52]

Xinc_Engine_Sunrise __construct( )

constructor, registering a shutdown function



Tags:

access:  public


[ Top ]

method build [line 124]

void build( Xinc_Build_Interface &$build, Xinc_Build_Interface $build)

Process a build



Tags:

access:  public



Implementation of:
Xinc_Engine_Interface::build()
process the build

Parameters:

Xinc_Build_Interface   $build  
Xinc_Build_Interface   &$build  

[ Top ]

method getHeartBeat [line 276]

integer getHeartBeat( )

returns the interval in seconds in which the engine checks for new builds



Tags:

access:  public



Implementation of:
Xinc_Engine_Interface::getHeartBeat()
returns the interval in seconds in which the engine checks for new builds
[ Top ]

method getName [line 62]

string getName( )

get the name of this engine



Tags:

access:  public



Implementation of:
Xinc_Engine_Interface::getName()
get the name of the engine
[ Top ]

method parseProjects [line 259]

Xinc_Build_Iterator parseProjects( Xinc_Project_Iterator $projects)

Parses Project-Xml and returns



Tags:

throws:  Xinc_Build_Exception_Invalid
access:  public



Implementation of:
Xinc_Engine_Interface::parseProjects()
Parses Project-Xml and returns

Parameters:

Xinc_Project_Iterator   $projects  

[ Top ]

method setHeartBeat [line 290]

void setHeartBeat( unknown_type $seconds)

Set the interal in which the engine checks for modified builds, necessary builds etc

see <xinc engine="name" heartbeat="10"/>




Tags:

access:  public



Implementation of:
Xinc_Engine_Interface::setHeartBeat()
Set the interal in which the engine checks for modified builds, necessary builds etc

Parameters:

unknown_type   $seconds  

[ Top ]

method shutdown [line 74]

void shutdown( )

serializes the build before shutting down



Tags:

throws:  Xinc_Build_Exception_NotRun
throws:  Xinc_Build_Exception_Serialization
throws:  Xinc_Build_History_Exception_Storage
access:  public


[ Top ]

method validate [line 300]

boolean validate( )

Validate if the engine can run properly on this system



Tags:

return:  Returns always true.
access:  public



Implementation of:
Xinc_Engine_Interface::validate()
Validate if the engine can run properly on this system
[ Top ]

method _serializeBuild [line 104]

void _serializeBuild( Xinc_Build_Interface &$build, Xinc_Build_Interface $build)

Serializes a build an catches the exceptions



Tags:

access:  protected


Parameters:

Xinc_Build_Interface   $build  
Xinc_Build_Interface   &$build  

[ Top ]


Class Constants

NAME =  'Sunrise'

[line 37]


[ Top ]



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