Code Coverage
	Classes and Traits			Functions and Methods				Lines
Total							CRAP

1	<?php
2	/**
3	* OAuth 2.0 Session storage interface
4	*
5	* @package     league/oauth2-server
6	* @author      Alex Bilbie <hello@alexbilbie.com>
7	* @copyright   Copyright (c) Alex Bilbie
8	* @license     http://mit-license.org/
9	* @link        https://github.com/thephpleague/oauth2-server
10	*/
11
12	namespace League\OAuth2\Server\Storage;
13
14	use League\OAuth2\Server\Entity\AccessTokenEntity;
15	use League\OAuth2\Server\Entity\AuthCodeEntity;
16	use League\OAuth2\Server\Entity\ScopeEntity;
17	use League\OAuth2\Server\Entity\SessionEntity;
18
19	/**
20	* Session storage interface
21	*/
22	interface SessionInterface extends StorageInterface
23	{
24	/**
25	* Get a session from an access token
26	*
27	* @param \League\OAuth2\Server\Entity\AccessTokenEntity $accessToken The access token
28	*
29	* @return \League\OAuth2\Server\Entity\SessionEntity
30	*/
31	public function getByAccessToken(AccessTokenEntity $accessToken);
32
33	/**
34	* Get a session from an auth code
35	*
36	* @param \League\OAuth2\Server\Entity\AuthCodeEntity $authCode The auth code
37	*
38	* @return \League\OAuth2\Server\Entity\SessionEntity
39	*/
40	public function getByAuthCode(AuthCodeEntity $authCode);
41
42	/**
43	* Get a session's scopes
44	*
45	* @param  \League\OAuth2\Server\Entity\SessionEntity
46	*
47	* @return array Array of \League\OAuth2\Server\Entity\ScopeEntity
48	*/
49	public function getScopes(SessionEntity $session);
50
51	/**
52	* Create a new session
53	*
54	* @param string $ownerType         Session owner's type (user, client)
55	* @param string $ownerId           Session owner's ID
56	* @param string $clientId          Client ID
57	* @param string $clientRedirectUri Client redirect URI (default = null)
58	*
59	* @return integer The session's ID
60	*/
61	public function create($ownerType, $ownerId, $clientId, $clientRedirectUri = null);
62
63	/**
64	* Associate a scope with a session
65	*
66	* @param \League\OAuth2\Server\Entity\SessionEntity $session The session
67	* @param \League\OAuth2\Server\Entity\ScopeEntity   $scope   The scope
68	*
69	* @return void
70	*/
71	public function associateScope(SessionEntity $session, ScopeEntity $scope);
72	}