PHP Class EmbeddedServer, ojs

Show file Open project: pkp/ojs Class Usage Examples

Public Methods

Method	Description
__construct ( )
_canExecScripts ( ) : boolean	Check whether script execution is enabled.
_getLogFileName ( ) : string	Get the embedded server log.
_getPluginDirectory ( ) : string	Find the plugin directory.
_getScriptDirectory ( ) : string	Find the script directory.
_getScriptPath ( $script ) : string	Get platform-specific script name with extension.
_runScript ( $script, $log = true, $parameters = '' ) : boolean	Run the given script.
isAvailable ( ) : boolean	Check whether an embedded server is installed and we can manipulate it through PHP.
isInstalled ( ) : boolean	Check whether the embedded server is installed.
isRunning ( ) : boolean	Check whether the embedded server is currently running.
start ( ) : boolean	Start the embedded server.
stop ( ) : boolean	Stop the embedded server.
stopAndWait ( ) : boolean	Stop the embedded server and wait until it actually exited.

Method Details

__construct() public method

public __construct ( )

_canExecScripts() public method

Check whether script execution is enabled.

public _canExecScripts ( ) : boolean
return	boolean

_getLogFileName() public method

Get the embedded server log.

public _getLogFileName ( ) : string
return	string

_getPluginDirectory() public method

Find the plugin directory.

public _getPluginDirectory ( ) : string
return	string

_getScriptDirectory() public method

Find the script directory.

public _getScriptDirectory ( ) : string
return	string

_getScriptPath() public method

Get platform-specific script name with extension.

public _getScriptPath ( $script ) : string
$script		string The script name without extension.
return	string	script name with platform specific extension.

_runScript() public method

Run the given script.

public _runScript ( $script, $log = true, $parameters = '' ) : boolean
$script		string The script to be executed (without platform specific extension).
$log		boolean Whether to log the script execution. Logging is NOT supported on Windows due to locking issues with the log file when being started through 'start /b'.
$parameters		string Optional script parameters.
return	boolean	true if the command executed successfully, otherwise false.

isAvailable() public method

Check whether an embedded server is installed and we can manipulate it through PHP.

public isAvailable ( ) : boolean
return	boolean

isInstalled() public method

Check whether the embedded server is installed.

public isInstalled ( ) : boolean
return	boolean

isRunning() public method

Check whether the embedded server is currently running.

public isRunning ( ) : boolean
return	boolean	true, if the server is running, otherwise false.

start() public method

NB: The web service can take quite a bit longer than the process to start. So if you want to be sure you should instantiate SolrWebService and wait until it's status is SOLR_STATUS_ONLINE.

public start ( ) : boolean
return	boolean	true if the server started, otherwise false.

stop() public method

Stop the embedded server.

public stop ( ) : boolean
return	boolean	true if the server stopped, otherwise false.

stopAndWait() public method

Stop the embedded server and wait until it actually exited.

public stopAndWait ( ) : boolean
return	boolean	true if the server stopped, otherwise false.