PHP Class Thruway\RealmManager

Show file Open project: voryx/thruway Class Usage Examples

Public Methods

Method	Description
__construct ( )	Constructor
addRealm ( Realm $realm )	Add new realm
getAllowRealmAutocreate ( ) : boolean	Get option allow auto create realm
getRealm ( string $realmName ) : Realm	Get Realm by realm name
getRealms ( ) : array	Get list realms
getSubscribedEvents ( ) : array	Events on the Router's dispatcher
getSubscribedRealmEvents ( ) : array	Events on the Session's dispatcher
handleConnectionClose ( ConnectionCloseEvent $event )
handleConnectionOpen ( ConnectionOpenEvent $event )
handlePreHelloMessage ( MessageEvent $event )
setAllowRealmAutocreate ( boolean $allowRealmAutocreate )	Set option allow auto create realm if not exist
validRealmName ( string $name ) : boolean	Validate realm name

Method Details

__construct() public method

Constructor

public __construct ( )

addRealm() public method

Add new realm

public addRealm ( Realm $realm )
$realm	Realm

getAllowRealmAutocreate() public method

Get option allow auto create realm

public getAllowRealmAutocreate ( ) : boolean
return	boolean

getRealm() public method

Get Realm by realm name

public getRealm ( string $realmName ) : Realm
$realmName	string
return	Realm

getRealms() public method

Get list realms

public getRealms ( ) : array
return	array

getSubscribedEvents() public static method

Events on the Router's dispatcher

public static getSubscribedEvents ( ) : array
return	array

getSubscribedRealmEvents() public method

Events on the Session's dispatcher

public getSubscribedRealmEvents ( ) : array
return	array

handleConnectionClose() public method

public handleConnectionClose ( ConnectionCloseEvent $event )
$event	Thruway\Event\ConnectionCloseEvent

handleConnectionOpen() public method

public handleConnectionOpen ( ConnectionOpenEvent $event )
$event	Thruway\Event\ConnectionOpenEvent

handlePreHelloMessage() public method

public handlePreHelloMessage ( MessageEvent $event )
$event	Thruway\Event\MessageEvent

setAllowRealmAutocreate() public method

Set option allow auto create realm if not exist

public setAllowRealmAutocreate ( boolean $allowRealmAutocreate )
$allowRealmAutocreate	boolean

validRealmName() public static method

Validate realm name

public static validRealmName ( string $name ) : boolean
$name	string
return	boolean