Docs For Class Xinc

static method getCurrentBuild [line 757]

static void &getCurrentBuild(
)

Tags:

access:

public

[ Top ]

static method getInstance [line 173]

static Xinc getInstance(
)

Tags:

access:

public

[ Top ]

static method getVersion [line 866]

static string getVersion(
)

Returns the Version of Xinc

Tags:

access:

public

[ Top ]

static method handleArguments [line 601]

static array handleArguments(
[
$commandLine = null])

Handles command line arguments.

Tags:

return:	The array of parsed arguments.
throws:	Xinc_Config_Exception_GetOpt
access:	public

Parameters:

$commandLine

[ Top ]

static method main [line 496]

static void main(
[$args
$args = ''])

Static main function called by bin script

Tags:

access:

public

Parameters:

$args

$args

string argument string handled by Xinc_Config_GetOpt

[ Top ]

static method printVersion [line 856]

static void printVersion(
)

Prints the version of xinc

Tags:

access:

public

[ Top ]

static method setCurrentBuild [line 767]

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

Sets the build that is currently being processed

Tags:

access:

public

Parameters:

Xinc_Build_Interface	$build
Xinc_Build_Interface	&$build

[ Top ]

static method showHelp [line 836]

static void showHelp(
)

prints help message, describing different parameters to run xinc

Tags:

access:

public

[ Top ]

method checkDirectory [line 285]

string checkDirectory(
string
$strDirectory)

Checks if the directory is available otherwise tries to create it.

Returns the realpath of the directory afterwards.

Tags:

return:	The realpath of given directory.
throws:	Xinc_Exception_IO
access:	protected

Parameters:

string

$strDirectory

Directory to check for.

[ Top ]

method checkShutdown [line 792]

void checkShutdown(
)

Checks if a special shutdown file exists

and exits if it does

Tags:

access:

public

[ Top ]

method getBuiltinProperties [line 778]

array getBuiltinProperties(
)

returns the builtin properties that can be used in all xinc config files

Tags:

access:

public

[ Top ]

method getConfigDirective [line 252]

void getConfigDirective(

$name)

Tags:

access:

public

Parameters:

$name

[ Top ]

method getLongOptions [line 468]

array getLongOptions(
)

Returns Long options of xinc parameters

Tags:

access:

public

[ Top ]

method getProjectDir [line 444]

string getProjectDir(
)

Tags:

access:

public

[ Top ]

method getShortOptions [line 458]

void getShortOptions(
)

Tags:

access:

public

[ Top ]

method getStatusDir [line 318]

string getStatusDir(
)

Returns the Directory for the status files.

Tags:

return:	Directory for the status files.
access:	public

[ Top ]

method getSystemTimezone [line 182]

void getSystemTimezone(
)

Tags:

access:

public

[ Top ]

method getWorkingDir [line 453]

string getWorkingDir(
)

Tags:

access:

public

[ Top ]

method processBuildsDaemon [line 369]

void processBuildsDaemon(
)

Processes the projects that have been configured

in the config-file and executes each project if the scheduled time has expired

Tags:

access:

public

[ Top ]

method processBuildsRunOnce [line 330]

void processBuildsRunOnce(
)

Processes the projects that have been configured

in the config-file and executes each project if the scheduled time has expired

Tags:

access:

public

[ Top ]

method restoreConfigDirectives [line 239]

void restoreConfigDirectives(
)

Tags:

access:

public

[ Top ]

method setPidFile [line 257]

void setPidFile(

$pidFile)

Tags:

access:

public

Parameters:

$pidFile

[ Top ]

method setProjectDir [line 434]

void setProjectDir(
string
$strProjectDir)

Set the directory in which to project files lies.

Tags:

throws:	Xinc_Exception_IO
access:	public

Parameters:

string

$strProjectDir

Directory of the project files.

[ Top ]

method setStatusDir [line 269]

void setStatusDir(
string
$strStatusDir)

Set the directory in which to save project status files

Tags:

throws:

Xinc_Exception_IO

Parameters:

string

$strStatusDir

Directory for the status files.

[ Top ]

method setSystemConfigFile [line 193]

void setSystemConfigFile(
string
$fileName)

Specify a config file to be parsed for project definitions.

Tags:

throws:

Xinc_Exception_MalformedConfig

Parameters:

string

$fileName

[ Top ]

method setWorkingDir [line 421]

void setWorkingDir(
string
$strWorkingDir)

Sets the working directory.

Tags:

throws:	Xinc_Exception_IO
access:	public

Parameters:

string

$strWorkingDir

The working directory.

[ Top ]

method start [line 476]

void start(

$daemon)

Starts the continuous loop.

Tags:

access:

protected

Parameters:

$daemon

[ Top ]

Class: Xinc

Class Overview

Variables

Constants

Methods

Class Details

Class Variables

$buildActive = false

Tags:

Class Methods

static method getCurrentBuild [line 757]

Tags:

static method getInstance [line 173]

Tags:

static method getVersion [line 866]

Tags:

static method handleArguments [line 601]

Tags:

Parameters:

static method main [line 496]

Tags:

Parameters:

static method printVersion [line 856]

Tags:

static method setCurrentBuild [line 767]

Tags:

Parameters:

static method showHelp [line 836]

Tags:

method checkDirectory [line 285]

Tags:

Parameters:

method checkShutdown [line 792]

Tags:

method getBuiltinProperties [line 778]

Tags:

method getConfigDirective [line 252]

Tags:

Parameters:

method getLongOptions [line 468]

Tags:

method getProjectDir [line 444]

Tags:

method getShortOptions [line 458]

Tags:

method getStatusDir [line 318]

Tags:

method getSystemTimezone [line 182]

Tags:

method getWorkingDir [line 453]

Tags:

method processBuildsDaemon [line 369]

Tags:

method processBuildsRunOnce [line 330]

Tags:

method restoreConfigDirectives [line 239]

Tags:

method setPidFile [line 257]

Tags:

Parameters:

method setProjectDir [line 434]

Tags:

Parameters:

method setStatusDir [line 269]

Tags:

Parameters:

method setSystemConfigFile [line 193]

Tags:

Parameters:

method setWorkingDir [line 421]

Tags:

Parameters:

method start [line 476]

Tags:

Parameters:

Class Constants

DEFAULT_PROJECT_DIR = 'projects'

DEFAULT_STATUS_DIR = 'status'

VERSION = '@VERSION@'