PHP Class Thruway\Authentication\AuthorizationManager

Inheritance: extends Thruway\Peer\Client, implements Thruway\Authentication\AuthorizationManagerInterface

Public Methods

Method	Description
__construct ( string $realm, null $loop = null )
addAuthorizationRule ( $args ) : string	rules look like (JSON) { "role": "some_role", "action": "publish", "uri": "some.uri", "allow": true }
flushAuthorizationRules ( boolean $allowByDefault = false ) : string
getAuthorizationRules ( ) : Result
getSubscribedEvents ( ) : array	Listen for Router events
getSubscribedRealmEvents ( ) : array
handleMessage ( MessageEvent $messageEvent )
handleNewRealm ( NewRealmEvent $newRealmEvent )
initModule ( Thruway\Peer\RouterInterface $router, React\EventLoop\LoopInterface $loop )	Gets called when the module is initialized in the router
isAuthorizedTo ( Session $session, Thruway\Message\ActionMessageInterface $actionMsg ) : boolean	Check to see if an action is authorized on a specific uri given the context of the session attempting the action
isReady ( ) : boolean
isValidAction ( $action ) : boolean
isValidRuleUri ( $uri ) : boolean
onSessionStart ( ClientSession $session, Thruway\Transport\TransportInterface $transport )
removeAuthorizationRule ( $args )
setReady ( boolean $ready )
testAuthorization ( $args ) : boolean \| mixed	Arguments need to be [["role1", "role2"], "publish\|subscribe\|register\|call", "my.uri"]

Method	Description
getRuleFromArgs ( $args ) : stdClass \| boolean
isAuthorizedByRolesActionAndUri ( $rolesToCheck, $action, $uri ) : boolean \| mixed

public __construct ( string $realm, null $loop = null )
$realm	string
$loop	null

Should be $args[0]

public addAuthorizationRule ( $args ) : string
$args
return	string

public flushAuthorizationRules ( boolean $allowByDefault = false ) : string
$allowByDefault	boolean
return	string

public getAuthorizationRules ( ) : Result
return	Thruway\Result

Listen for Router events

public static getSubscribedEvents ( ) : array
return	array

public getSubscribedRealmEvents ( ) : array
return	array

public handleMessage ( MessageEvent $messageEvent )
$messageEvent	Thruway\Event\MessageEvent

public handleNewRealm ( NewRealmEvent $newRealmEvent )
$newRealmEvent	Thruway\Event\NewRealmEvent

Gets called when the module is initialized in the router

public initModule ( Thruway\Peer\RouterInterface $router, React\EventLoop\LoopInterface $loop )
$router	Thruway\Peer\RouterInterface
$loop	React\EventLoop\LoopInterface

actionMsg should be an instance of: register, call, subscribe, or publish messages

public isAuthorizedTo ( Session $session, Thruway\Message\ActionMessageInterface $actionMsg ) : boolean
$session	Thruway\Session
$actionMsg	Thruway\Message\ActionMessageInterface
return	boolean

public isReady ( ) : boolean
return	boolean

public static isValidAction ( $action ) : boolean
$action
return	boolean

public static isValidRuleUri ( $uri ) : boolean
$uri
return	boolean

public onSessionStart ( ClientSession $session, Thruway\Transport\TransportInterface $transport )
$session	Thruway\ClientSession
$transport	Thruway\Transport\TransportInterface

public removeAuthorizationRule ( $args )
$args

public setReady ( boolean $ready )
$ready	boolean

Arguments need to be [["role1", "role2"], "publish|subscribe|register|call", "my.uri"]

public testAuthorization ( $args ) : boolean \| mixed
$args
return	boolean \| mixed