PHP Class CampSite

Inheritance: extends CampSystem
Mostrar archivo Open project: sourcefabric/newscoop Class Usage Examples

Public Methods

Method Description
GetConfigInstance ( ) : object Returns a CampConfig instance.
GetHTMLDocumentInstance ( ) : object Returns a CampHTMLDocument instance.
GetSessionInstance ( ) : object Returns a CampSession instance.
GetURIInstance ( ) : CampURI Returns the appropiate URI instance.
__construct ( ) Class constructor
dispatch ( ) : void Dispatches the site.
event ( string $p_eventName )
init ( ) : void Initialises the context.
initSession ( ) Initialises the session.
loadConfiguration ( string $p_configFile = null ) Loads the configuration options.
render ( ) : void Displays the site.

Method Details

GetConfigInstance() public static method

Returns a CampConfig instance.
public static GetConfigInstance ( ) : object
return object A CampConfig instance

GetHTMLDocumentInstance() public static method

Returns a CampHTMLDocument instance.
public static GetHTMLDocumentInstance ( ) : object
return object The CampHTMLDocument instance.

GetSessionInstance() public static method

Returns a CampSession instance.
public static GetSessionInstance ( ) : object
return object A CampSession instance

GetURIInstance() public static method

Returns the appropiate URI instance.
public static GetURIInstance ( ) : CampURI
return CampURI

__construct() final public method

Class constructor
final public __construct ( )

dispatch() public method

Sets attribute values from site configuration to the document to be displayed.
public dispatch ( ) : void
return void

event() public method

public event ( string $p_eventName )
$p_eventName string

init() public method

After load the session, the application parse the current URI and starts the context from the request parameters.
public init ( ) : void
return void

initSession() public method

Initialises the session.
public initSession ( )

loadConfiguration() public method

Loads the configuration options.
public loadConfiguration ( string $p_configFile = null )
$p_configFile string The path to the config file

render() public method

Displays the site.
public render ( ) : void
return void