\LobbyModule

A module's base class.

All modules extend from this class

Summary

Methods

Properties

Constants

__construct()
addScript()
addStyle()
init()

$dir
$url
$app

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: Lobby/Module.php
Package: Default
Class hierarchy: \Lobby\Module

Properties

$dir

$dir :

The full location to contents/modules/module

Type

$url

$url :

The HTTP URL to contents/modules/module

Type

$app

$app :

If it's an App Module, add App instance

Type

Methods

__construct()

__construct(string  $vars, \Lobby\Lobby\App  $app = null)

Set up properties of this object

Parameters

string	$vars	Basic info about this module
\Lobby\Lobby\App	$app	If it's an App module, app's object is passed

addScript()

addScript(string  $fileName)

Load a JS file from module's "js" directory

Parameters

string

$fileName

Path to JS file

addStyle()

addStyle(string  $fileName) : string

Load a stylesheet from module's "css" directory

Parameters

string

$fileName

Returns

string

init()

init() : string

Initialize Module.

When module is loaded, this is called.

Returns

string