PHP Interface Sulu\Component\Websocket\ConnectionContext\ConnectionContextInterface

Show file Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
all ( ) : array Returns all parameters.
clear ( ) Clear all parameter.
get ( string $name ) : mixed Get parameter with given name.
getId ( ) : string Returns unique id for session.
getQuery ( ) : Guzzle\Http\QueryString Returns query of the upgrade request.
getRequest ( ) : Guzzle\Http\Message\RequestInterface Returns upgrade request.
getSession ( ) : Symfony\Component\HttpFoundation\Session\SessionInterface Returns session of the upgrade request.
getToken ( string $firewall ) : Symfony\Component\Security\Core\Authentication\Token\TokenInterface | null Returns token for given firewall.
getUser ( string $firewall ) : Sulu\Component\Security\Authentication\UserInterface | null Returns user for given firewall.
has ( string $name ) : boolean Get parameter with given name.
isValid ( ) : boolean Indicates that the context is valid.
set ( string $name, mixed $value ) Set parameter with given name.

Method Details

all() public method

Returns all parameters.
public all ( ) : array
return array

clear() public method

Clear all parameter.
public clear ( )

get() public method

Get parameter with given name.
public get ( string $name ) : mixed
$name string
return mixed

getId() public method

Returns unique id for session.
public getId ( ) : string
return string

getQuery() public method

Returns query of the upgrade request.
public getQuery ( ) : Guzzle\Http\QueryString
return Guzzle\Http\QueryString

getRequest() public method

Returns upgrade request.
public getRequest ( ) : Guzzle\Http\Message\RequestInterface
return Guzzle\Http\Message\RequestInterface

getSession() public method

Returns session of the upgrade request.
public getSession ( ) : Symfony\Component\HttpFoundation\Session\SessionInterface
return Symfony\Component\HttpFoundation\Session\SessionInterface

getToken() public method

Returns token for given firewall.
public getToken ( string $firewall ) : Symfony\Component\Security\Core\Authentication\Token\TokenInterface | null
$firewall string
return Symfony\Component\Security\Core\Authentication\Token\TokenInterface | null

getUser() public method

Returns user for given firewall.
public getUser ( string $firewall ) : Sulu\Component\Security\Authentication\UserInterface | null
$firewall string
return Sulu\Component\Security\Authentication\UserInterface | null

has() public method

Get parameter with given name.
public has ( string $name ) : boolean
$name string
return boolean

isValid() public method

Indicates that the context is valid.
public isValid ( ) : boolean
return boolean

set() public method

Set parameter with given name.
public set ( string $name, mixed $value )
$name string
$value mixed