Class: Application

Source Location: /sys/application.php.inc

Class Overview

The base class for all SiteFusion applications

The Application class is the parent class for all SiteFusion applications. Extending classes should always define an init($arguments) method. This method is called when the application process and root window have initialized, and thus is the place to construct your basic user interface.

The root element of all applications is the window object. This is an object of the class XULWindow and is pre-constructed and initialized before the init() function is called. Application->window contains a reference to this object, and all nodes added to the window and its child nodes will contain a reference to this window in the property Node->rootWindow, and to the application in the property Node->rootApplication.

property:	int $pid: PID for the application process
property:	XULWindow $window: Root window and node of the application
property:	string $applicationName: Name of the application
property:	Registry $registry: [INTERNAL] Node registry for the Comm layer
property:	array $globalEventHandlers: [INTERNAL] Contains references to handlers of global events
property:	array $handlerFor: [INTERNAL] Contains references to objects that this object is a handler for
property:	array $yielderFor: [INTERNAL] Contains references to objects that this object is a yielder for

Author(s):

Variables

Methods

mixed

Class Methods

constructor __construct() [line 192]

Application __construct(

$user, 
$ip, 
$ident, 
$app, 
$args)

[INTERNAL FUNCTION] This function initializes the Application class

access:

public

Parameters:

	$user
	$ip
	$ident
	$app
	$args

[ Top ]

method checkForUpdates() [line 518]

void checkForUpdates(
)

Checks for updates using the given preferences

access:

public

[ Top ]

method closeApplication() [line 483]

void closeApplication(
)

Calls the close method on the root window

access:

public

[ Top ]

method fireGlobalEvent() [line 374]

void fireGlobalEvent(
Event|string
$event, [array
$data = NULL])

Fires a global event

This method fires a global event that will reach all SiteFusion processes within the same application group.

access:

public

Parameters:

Event\|string	$event	Event name or object
array	$data	Event parameters

[ Top ]

method getEventGroups() [line 416]

array getEventGroups(
)

Get a list of joined Event Groups

Applications and services that have joined the same event groups will receive each other's global events

return:	List of group names
access:	public

[ Top ]

method getService() [line 474]

SiteFusionService getService(
string
$owner, string
$name)

Returns a reference to a service object

When supplied with a valid application group and service name, this method returns a Service object that can be used to operate a running service. Depending on the type of service specified in the SiteFusion Admin utility, the service process is created on demand or a connection is made to an existing service process. This function throws an SFException when the service is invalid or if there was a problem creating it or connecting to it.

return:	Service object
access:	public

Parameters:

string	$owner	Application group for the service
string	$name	Name of the service

[ Top ]

method handleGlobalEvent() [line 336]

Event handleGlobalEvent(
Event
$event, array
$data)

[INTERNAL FUNCTION] Handles incoming global events

This function is called by the ApplicationProcess when it receives a global event from the daemon.

return:	event object
access:	public

Parameters:

Event	$event	Event object
array	$data	Event parameters

[ Top ]

method joinEventGroup() [line 388]

void joinEventGroup(
string
$group)

Joins an Event Group

Applications and services that have joined the same event groups will receive each other's global events

access:

public

Parameters:

string

$group

Name of the group

[ Top ]

method onClientComponentsInit() [line 251]

void onClientComponentsInit(
Event
$event, array
$components)

[INTERNAL FUNCTION] This function handles the clientComponentsInit event

access:

public

Parameters:

Event	$event	Event object
array	$components	Components info assoc. array

[ Top ]

method onClientInit() [line 235]

void onClientInit(
Event
$event, object
$extensionInfo, object
$platformInfo, object
$appInfo, object
$cmdlineArgs)

[INTERNAL FUNCTION] This function handles the clientInit event and sets the Application::$client array.

access:

public

Parameters:

Event	$event	Event object
object	$extensionInfo	Extension information
object	$platformInfo	Platform info
object	$appInfo	Application info
object	$cmdlineArgs	Commandline arguments

[ Top ]

method onWindowClose() [line 492]

void onWindowClose(
)

[INTERNAL FUNCTION] Event handler for the root window's close event

access:

public

[ Top ]

method openAbout() [line 498]

void openAbout(
)

access:

public

[ Top ]

method openAboutMemory() [line 502]

void openAboutMemory(
)

access:

public

[ Top ]

method openErrorConsole() [line 510]

void openErrorConsole(
)

access:

public

[ Top ]

method openExtensions() [line 506]

void openExtensions(
)

access:

public

[ Top ]

method partEventGroup() [line 402]

void partEventGroup(
string
$group)

Parts an Event Group

Applications and services that have joined the same event groups will receive each other's global events

access:

public

Parameters:

string

$group

Name of the group

[ Top ]

method preinit() [line 213]

void preinit(

$args)

access:

public

Parameters:

$args

[ Top ]

method removeGlobalEventHandler() [line 311]

void removeGlobalEventHandler(
string
$event, object|string
$obj, string
$method)

Remove a handler for a global event

Removes a handler for the given global event with the same syntax as setGlobalEventHandler

access:

public

Parameters:

string	$event	The event name
object\|string	$obj	Handler object or class
string	$method	Name of the handler method on the handler object or class

[ Top ]

method sendCommand() [line 265]

void sendCommand(
mixed
$javaScript)

Send raw JavaScript to the client

You can supply a raw JavaScript string or array(s) of strings as parameters, and the code will be executed in the client.

access:

public

Parameters:

mixed

$javaScript

String or array(s) of strings of JavaScript

[ Top ]

method setDefaultEventGroup() [line 218]

void setDefaultEventGroup(

$event)

access:

public

Parameters:

$event

[ Top ]

method setGlobalEventHandler() [line 293]

void setGlobalEventHandler(
string
$event, object|string
$obj, string
$method)

Set a handler for a global event

Global events originate from other SiteFusion processes. A global event will only reach your application when it was fired from an application or service in the same application group. Global events are similar to local events, and can also carry additional data inside the Event object. The handler will receive the event object as the first argument, and event parameters as additional arguments.

access:

public

Parameters:

string	$event	The event name
object\|string	$obj	Handler object or class
string	$method	Name of the method to call on the handler object or class

[ Top ]

method setInterval() [line 454]

SiteFusionTimer setInterval(
int
$timeout, object|string
$obj, string
$func)

Sets a server-based interval callback

This function is similar to the JavaScript window.setInterval() function. It dispatches a timer for a certain amount of milliseconds, and fires the handler method when the timer expires. The timer then resets and recycles, until it is cancelled by calling the cancel() method on the returned timer object.

return:	Timer object created
access:	public

Parameters:

int	$timeout	Timeout in milliseconds
object\|string	$obj	Object or class name
string	$func	Method to call on the object or class when the timer expires

[ Top ]

method setTimeout() [line 435]

SiteFusionTimer setTimeout(
int
$timeout, object|string
$obj, string
$func)

Sets a server-based timeout callback

This function is similar to the JavaScript window.setTimeout() function. It dispatches a timer for a certain amount of milliseconds, and fires the handler method when the timer expires. The timer can be cancelled by calling the cancel() method on the returned timer object.

return:	Timer object created
access:	public

Parameters:

int	$timeout	Timeout in milliseconds
object\|string	$obj	Object or class name
string	$func	Method to call on the object or class when the timer expires

[ Top ]

method setWakeMessage() [line 525]

void setWakeMessage(

$msg, [
$title = "Sleep"])

Sets the message that is displayed by the client before after-wake-shutdown

access:

public

Parameters:

	$msg
	$title

[ Top ]

Documentation generated on Sun, 29 Aug 2010 01:26:33 +0200 by phpDocumentor 1.4.3

Packages

API

Classes

Files

Class: Application

Class Overview

Author(s):

Variables

Methods

Class Variables

$alwaysLowered = FALSE

$alwaysRaised = FALSE

$applicationArguments =

$applicationName =

$centerscreen = FALSE

$commandBuffer = array()

$globalEventHandlers = array()

$handlerFor = array()

$height = NULL

$pid =

$registry =

$resizable = TRUE

$width = NULL

$window =

$yielderFor = array()

Class Methods

constructor __construct() [line 192]

Parameters:

method checkForUpdates() [line 518]

method closeApplication() [line 483]

method fireGlobalEvent() [line 374]

Parameters:

method getEventGroups() [line 416]

method getService() [line 474]

Parameters:

method handleGlobalEvent() [line 336]

Parameters:

method joinEventGroup() [line 388]

Parameters:

method onClientComponentsInit() [line 251]

Parameters:

method onClientInit() [line 235]

Parameters:

method onWindowClose() [line 492]

method openAbout() [line 498]

method openAboutMemory() [line 502]

method openErrorConsole() [line 510]

method openExtensions() [line 506]

method partEventGroup() [line 402]

Parameters:

method preinit() [line 213]

Parameters:

method removeGlobalEventHandler() [line 311]

Parameters:

method sendCommand() [line 265]

Parameters:

method setDefaultEventGroup() [line 218]

Parameters:

method setGlobalEventHandler() [line 293]

Parameters:

method setInterval() [line 454]

Parameters:

method setTimeout() [line 435]

Parameters:

method setWakeMessage() [line 525]

Parameters: