PHP Class eZ\Publish\Core\REST\Server\Controller\SessionController

Inheritance: extends eZ\Publish\Core\REST\Server\Controller
Show file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Public Methods

Method Description
__construct ( eZ\Publish\Core\MVC\Symfony\Security\Authentication\AuthenticatorInterface $authenticator, $tokenIntention, Symfony\Component\Security\Csrf\CsrfTokenManager $csrfTokenManager = null, Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface $csrfTokenStorage = null )
createSessionAction ( Request $request ) : UserSession | eZ\Publish\Core\REST\Server\Values\Conflict Creates a new session based on the credentials provided as POST parameters.
deleteSessionAction ( string $sessionId, Request $request ) : DeletedUserSession Deletes given session.
refreshSessionAction ( string $sessionId, Request $request ) : UserSession Refresh given session.

Private Methods

Method Description
checkCsrfToken ( Request $request ) Checks the presence / validity of the CSRF token.
getCsrfToken ( ) : string Returns the csrf token for REST. The token is generated if it doesn't exist.
hasStoredCsrfToken ( ) : boolean Tests if a CSRF token is stored.

Method Details

__construct() public method

public __construct ( eZ\Publish\Core\MVC\Symfony\Security\Authentication\AuthenticatorInterface $authenticator, $tokenIntention, Symfony\Component\Security\Csrf\CsrfTokenManager $csrfTokenManager = null, Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface $csrfTokenStorage = null )
$authenticator eZ\Publish\Core\MVC\Symfony\Security\Authentication\AuthenticatorInterface
$csrfTokenManager Symfony\Component\Security\Csrf\CsrfTokenManager
$csrfTokenStorage Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface

createSessionAction() public method

Creates a new session based on the credentials provided as POST parameters.
public createSessionAction ( Request $request ) : UserSession | eZ\Publish\Core\REST\Server\Values\Conflict
$request Symfony\Component\HttpFoundation\Request
return eZ\Publish\Core\REST\Server\Values\UserSession | eZ\Publish\Core\REST\Server\Values\Conflict

deleteSessionAction() public method

Deletes given session.
public deleteSessionAction ( string $sessionId, Request $request ) : DeletedUserSession
$sessionId string
$request Symfony\Component\HttpFoundation\Request
return eZ\Publish\Core\REST\Server\Values\DeletedUserSession

refreshSessionAction() public method

Refresh given session.
public refreshSessionAction ( string $sessionId, Request $request ) : UserSession
$sessionId string
$request Symfony\Component\HttpFoundation\Request
return eZ\Publish\Core\REST\Server\Values\UserSession