mirror of
https://github.com/elyby/oauth2-server.git
synced 2024-11-02 00:43:11 +05:30
180 lines
21 KiB
HTML
180 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>Code Coverage for /home/travis/build/thephpleague/oauth2-server/src/Storage/SessionInterface.php</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<link href="../css/bootstrap.min.css" rel="stylesheet">
|
|
<link href="../css/style.css" rel="stylesheet">
|
|
<!--[if lt IE 9]>
|
|
<script src="../js/html5shiv.min.js"></script>
|
|
<script src="../js/respond.min.js"></script>
|
|
<![endif]-->
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-md-12">
|
|
<ol class="breadcrumb">
|
|
<li><a href="../index.html">/home/travis/build/thephpleague/oauth2-server/src</a></li>
|
|
<li><a href="index.html">Storage</a></li>
|
|
<li class="active">SessionInterface.php</li>
|
|
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container">
|
|
<table class="table table-bordered">
|
|
<thead>
|
|
<tr>
|
|
<td> </td>
|
|
<td colspan="10"><div align="center"><strong>Code Coverage</strong></div></td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td colspan="3"><div align="center"><strong>Classes and Traits</strong></div></td>
|
|
<td colspan="4"><div align="center"><strong>Functions and Methods</strong></div></td>
|
|
<td colspan="3"><div align="center"><strong>Lines</strong></div></td>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="None">Total</td>
|
|
<td class="None big"> </td>
|
|
<td class="None small"><div align="right"></div></td>
|
|
<td class="None small"><div align="right"> </div></td>
|
|
<td class="None big"> </td>
|
|
<td class="None small"><div align="right"></div></td>
|
|
<td class="None small"><div align="right"> </div></td>
|
|
<td class="None small"><abbr title="Change Risk Anti-Patterns (CRAP) Index">CRAP</abbr></td>
|
|
<td class="None big"> </td>
|
|
<td class="None small"><div align="right"></div></td>
|
|
<td class="None small"><div align="right"> </div></td>
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
</table>
|
|
<table id="code" class="table table-borderless table-condensed">
|
|
<tbody>
|
|
<tr><td><div align="right"><a name="1"></a><a href="#1">1</a></div></td><td class="codeLine"><span class="default"><?php</span></td></tr>
|
|
<tr><td><div align="right"><a name="2"></a><a href="#2">2</a></div></td><td class="codeLine"><span class="comment">/**</span></td></tr>
|
|
<tr><td><div align="right"><a name="3"></a><a href="#3">3</a></div></td><td class="codeLine"><span class="comment"> * OAuth 2.0 Session storage interface</span></td></tr>
|
|
<tr><td><div align="right"><a name="4"></a><a href="#4">4</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="5"></a><a href="#5">5</a></div></td><td class="codeLine"><span class="comment"> * @package league/oauth2-server</span></td></tr>
|
|
<tr><td><div align="right"><a name="6"></a><a href="#6">6</a></div></td><td class="codeLine"><span class="comment"> * @author Alex Bilbie <hello@alexbilbie.com></span></td></tr>
|
|
<tr><td><div align="right"><a name="7"></a><a href="#7">7</a></div></td><td class="codeLine"><span class="comment"> * @copyright Copyright (c) Alex Bilbie</span></td></tr>
|
|
<tr><td><div align="right"><a name="8"></a><a href="#8">8</a></div></td><td class="codeLine"><span class="comment"> * @license http://mit-license.org/</span></td></tr>
|
|
<tr><td><div align="right"><a name="9"></a><a href="#9">9</a></div></td><td class="codeLine"><span class="comment"> * @link https://github.com/thephpleague/oauth2-server</span></td></tr>
|
|
<tr><td><div align="right"><a name="10"></a><a href="#10">10</a></div></td><td class="codeLine"><span class="comment"> */</span></td></tr>
|
|
<tr><td><div align="right"><a name="11"></a><a href="#11">11</a></div></td><td class="codeLine"></td></tr>
|
|
<tr><td><div align="right"><a name="12"></a><a href="#12">12</a></div></td><td class="codeLine"><span class="keyword">namespace</span><span class="default"> </span><span class="default">League</span><span class="default">\</span><span class="default">OAuth2</span><span class="default">\</span><span class="default">Server</span><span class="default">\</span><span class="default">Storage</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="13"></a><a href="#13">13</a></div></td><td class="codeLine"></td></tr>
|
|
<tr><td><div align="right"><a name="14"></a><a href="#14">14</a></div></td><td class="codeLine"><span class="keyword">use</span><span class="default"> </span><span class="default">League</span><span class="default">\</span><span class="default">OAuth2</span><span class="default">\</span><span class="default">Server</span><span class="default">\</span><span class="default">Entity</span><span class="default">\</span><span class="default">AccessTokenEntity</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="15"></a><a href="#15">15</a></div></td><td class="codeLine"><span class="keyword">use</span><span class="default"> </span><span class="default">League</span><span class="default">\</span><span class="default">OAuth2</span><span class="default">\</span><span class="default">Server</span><span class="default">\</span><span class="default">Entity</span><span class="default">\</span><span class="default">AuthCodeEntity</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="16"></a><a href="#16">16</a></div></td><td class="codeLine"><span class="keyword">use</span><span class="default"> </span><span class="default">League</span><span class="default">\</span><span class="default">OAuth2</span><span class="default">\</span><span class="default">Server</span><span class="default">\</span><span class="default">Entity</span><span class="default">\</span><span class="default">ScopeEntity</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="17"></a><a href="#17">17</a></div></td><td class="codeLine"><span class="keyword">use</span><span class="default"> </span><span class="default">League</span><span class="default">\</span><span class="default">OAuth2</span><span class="default">\</span><span class="default">Server</span><span class="default">\</span><span class="default">Entity</span><span class="default">\</span><span class="default">SessionEntity</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="18"></a><a href="#18">18</a></div></td><td class="codeLine"></td></tr>
|
|
<tr><td><div align="right"><a name="19"></a><a href="#19">19</a></div></td><td class="codeLine"><span class="comment">/**</span></td></tr>
|
|
<tr><td><div align="right"><a name="20"></a><a href="#20">20</a></div></td><td class="codeLine"><span class="comment"> * Session storage interface</span></td></tr>
|
|
<tr><td><div align="right"><a name="21"></a><a href="#21">21</a></div></td><td class="codeLine"><span class="comment"> */</span></td></tr>
|
|
<tr><td><div align="right"><a name="22"></a><a href="#22">22</a></div></td><td class="codeLine"><span class="keyword">interface</span><span class="default"> </span><span class="default">SessionInterface</span><span class="default"> </span><span class="keyword">extends</span><span class="default"> </span><span class="default">StorageInterface</span></td></tr>
|
|
<tr><td><div align="right"><a name="23"></a><a href="#23">23</a></div></td><td class="codeLine"><span class="keyword">{</span></td></tr>
|
|
<tr><td><div align="right"><a name="24"></a><a href="#24">24</a></div></td><td class="codeLine"><span class="default"> </span><span class="comment">/**</span></td></tr>
|
|
<tr><td><div align="right"><a name="25"></a><a href="#25">25</a></div></td><td class="codeLine"><span class="comment"> * Get a session from an access token</span></td></tr>
|
|
<tr><td><div align="right"><a name="26"></a><a href="#26">26</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="27"></a><a href="#27">27</a></div></td><td class="codeLine"><span class="comment"> * @param \League\OAuth2\Server\Entity\AccessTokenEntity $accessToken The access token</span></td></tr>
|
|
<tr><td><div align="right"><a name="28"></a><a href="#28">28</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="29"></a><a href="#29">29</a></div></td><td class="codeLine"><span class="comment"> * @return \League\OAuth2\Server\Entity\SessionEntity</span></td></tr>
|
|
<tr><td><div align="right"><a name="30"></a><a href="#30">30</a></div></td><td class="codeLine"><span class="comment"> */</span></td></tr>
|
|
<tr><td><div align="right"><a name="31"></a><a href="#31">31</a></div></td><td class="codeLine"><span class="default"> </span><span class="keyword">public</span><span class="default"> </span><span class="keyword">function</span><span class="default"> </span><span class="default">getByAccessToken</span><span class="keyword">(</span><span class="default">AccessTokenEntity</span><span class="default"> </span><span class="default">$accessToken</span><span class="keyword">)</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="32"></a><a href="#32">32</a></div></td><td class="codeLine"></td></tr>
|
|
<tr><td><div align="right"><a name="33"></a><a href="#33">33</a></div></td><td class="codeLine"><span class="default"> </span><span class="comment">/**</span></td></tr>
|
|
<tr><td><div align="right"><a name="34"></a><a href="#34">34</a></div></td><td class="codeLine"><span class="comment"> * Get a session from an auth code</span></td></tr>
|
|
<tr><td><div align="right"><a name="35"></a><a href="#35">35</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="36"></a><a href="#36">36</a></div></td><td class="codeLine"><span class="comment"> * @param \League\OAuth2\Server\Entity\AuthCodeEntity $authCode The auth code</span></td></tr>
|
|
<tr><td><div align="right"><a name="37"></a><a href="#37">37</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="38"></a><a href="#38">38</a></div></td><td class="codeLine"><span class="comment"> * @return \League\OAuth2\Server\Entity\SessionEntity</span></td></tr>
|
|
<tr><td><div align="right"><a name="39"></a><a href="#39">39</a></div></td><td class="codeLine"><span class="comment"> */</span></td></tr>
|
|
<tr><td><div align="right"><a name="40"></a><a href="#40">40</a></div></td><td class="codeLine"><span class="default"> </span><span class="keyword">public</span><span class="default"> </span><span class="keyword">function</span><span class="default"> </span><span class="default">getByAuthCode</span><span class="keyword">(</span><span class="default">AuthCodeEntity</span><span class="default"> </span><span class="default">$authCode</span><span class="keyword">)</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="41"></a><a href="#41">41</a></div></td><td class="codeLine"></td></tr>
|
|
<tr><td><div align="right"><a name="42"></a><a href="#42">42</a></div></td><td class="codeLine"><span class="default"> </span><span class="comment">/**</span></td></tr>
|
|
<tr><td><div align="right"><a name="43"></a><a href="#43">43</a></div></td><td class="codeLine"><span class="comment"> * Get a session's scopes</span></td></tr>
|
|
<tr><td><div align="right"><a name="44"></a><a href="#44">44</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="45"></a><a href="#45">45</a></div></td><td class="codeLine"><span class="comment"> * @param \League\OAuth2\Server\Entity\SessionEntity</span></td></tr>
|
|
<tr><td><div align="right"><a name="46"></a><a href="#46">46</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="47"></a><a href="#47">47</a></div></td><td class="codeLine"><span class="comment"> * @return array Array of \League\OAuth2\Server\Entity\ScopeEntity</span></td></tr>
|
|
<tr><td><div align="right"><a name="48"></a><a href="#48">48</a></div></td><td class="codeLine"><span class="comment"> */</span></td></tr>
|
|
<tr><td><div align="right"><a name="49"></a><a href="#49">49</a></div></td><td class="codeLine"><span class="default"> </span><span class="keyword">public</span><span class="default"> </span><span class="keyword">function</span><span class="default"> </span><span class="default">getScopes</span><span class="keyword">(</span><span class="default">SessionEntity</span><span class="default"> </span><span class="default">$session</span><span class="keyword">)</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="50"></a><a href="#50">50</a></div></td><td class="codeLine"></td></tr>
|
|
<tr><td><div align="right"><a name="51"></a><a href="#51">51</a></div></td><td class="codeLine"><span class="default"> </span><span class="comment">/**</span></td></tr>
|
|
<tr><td><div align="right"><a name="52"></a><a href="#52">52</a></div></td><td class="codeLine"><span class="comment"> * Create a new session</span></td></tr>
|
|
<tr><td><div align="right"><a name="53"></a><a href="#53">53</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="54"></a><a href="#54">54</a></div></td><td class="codeLine"><span class="comment"> * @param string $ownerType Session owner's type (user, client)</span></td></tr>
|
|
<tr><td><div align="right"><a name="55"></a><a href="#55">55</a></div></td><td class="codeLine"><span class="comment"> * @param string $ownerId Session owner's ID</span></td></tr>
|
|
<tr><td><div align="right"><a name="56"></a><a href="#56">56</a></div></td><td class="codeLine"><span class="comment"> * @param string $clientId Client ID</span></td></tr>
|
|
<tr><td><div align="right"><a name="57"></a><a href="#57">57</a></div></td><td class="codeLine"><span class="comment"> * @param string $clientRedirectUri Client redirect URI (default = null)</span></td></tr>
|
|
<tr><td><div align="right"><a name="58"></a><a href="#58">58</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="59"></a><a href="#59">59</a></div></td><td class="codeLine"><span class="comment"> * @return integer The session's ID</span></td></tr>
|
|
<tr><td><div align="right"><a name="60"></a><a href="#60">60</a></div></td><td class="codeLine"><span class="comment"> */</span></td></tr>
|
|
<tr><td><div align="right"><a name="61"></a><a href="#61">61</a></div></td><td class="codeLine"><span class="default"> </span><span class="keyword">public</span><span class="default"> </span><span class="keyword">function</span><span class="default"> </span><span class="default">create</span><span class="keyword">(</span><span class="default">$ownerType</span><span class="keyword">,</span><span class="default"> </span><span class="default">$ownerId</span><span class="keyword">,</span><span class="default"> </span><span class="default">$clientId</span><span class="keyword">,</span><span class="default"> </span><span class="default">$clientRedirectUri</span><span class="default"> </span><span class="keyword">=</span><span class="default"> </span><span class="default">null</span><span class="keyword">)</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="62"></a><a href="#62">62</a></div></td><td class="codeLine"></td></tr>
|
|
<tr><td><div align="right"><a name="63"></a><a href="#63">63</a></div></td><td class="codeLine"><span class="default"> </span><span class="comment">/**</span></td></tr>
|
|
<tr><td><div align="right"><a name="64"></a><a href="#64">64</a></div></td><td class="codeLine"><span class="comment"> * Associate a scope with a session</span></td></tr>
|
|
<tr><td><div align="right"><a name="65"></a><a href="#65">65</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="66"></a><a href="#66">66</a></div></td><td class="codeLine"><span class="comment"> * @param \League\OAuth2\Server\Entity\SessionEntity $session The session</span></td></tr>
|
|
<tr><td><div align="right"><a name="67"></a><a href="#67">67</a></div></td><td class="codeLine"><span class="comment"> * @param \League\OAuth2\Server\Entity\ScopeEntity $scope The scope</span></td></tr>
|
|
<tr><td><div align="right"><a name="68"></a><a href="#68">68</a></div></td><td class="codeLine"><span class="comment"> *</span></td></tr>
|
|
<tr><td><div align="right"><a name="69"></a><a href="#69">69</a></div></td><td class="codeLine"><span class="comment"> * @return void</span></td></tr>
|
|
<tr><td><div align="right"><a name="70"></a><a href="#70">70</a></div></td><td class="codeLine"><span class="comment"> */</span></td></tr>
|
|
<tr><td><div align="right"><a name="71"></a><a href="#71">71</a></div></td><td class="codeLine"><span class="default"> </span><span class="keyword">public</span><span class="default"> </span><span class="keyword">function</span><span class="default"> </span><span class="default">associateScope</span><span class="keyword">(</span><span class="default">SessionEntity</span><span class="default"> </span><span class="default">$session</span><span class="keyword">,</span><span class="default"> </span><span class="default">ScopeEntity</span><span class="default"> </span><span class="default">$scope</span><span class="keyword">)</span><span class="keyword">;</span></td></tr>
|
|
<tr><td><div align="right"><a name="72"></a><a href="#72">72</a></div></td><td class="codeLine"><span class="keyword">}</span></td></tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
<footer>
|
|
<hr/>
|
|
<h4>Legend</h4>
|
|
<p>
|
|
<span class="success"><strong>Executed</strong></span>
|
|
<span class="danger"><strong>Not Executed</strong></span>
|
|
<span class="warning"><strong>Dead Code</strong></span>
|
|
</p>
|
|
<p>
|
|
<small>Generated by <a href="http://github.com/sebastianbergmann/php-code-coverage" target="_top">PHP_CodeCoverage 2.0.14</a> using <a href="http://php.net/" target="_top">PHP 5.5.19</a> and <a href="http://phpunit.de/">PHPUnit 4.3.5</a> at Wed Jan 14 23:16:50 UTC 2015.</small>
|
|
</p>
|
|
<a title="Back to the top" id="toplink" href="#"><span class="glyphicon glyphicon-arrow-up"></span></a>
|
|
</footer>
|
|
</div>
|
|
<script src="../js/jquery.min.js" type="text/javascript"></script>
|
|
<script src="../js/bootstrap.min.js" type="text/javascript"></script>
|
|
<script src="../js/holder.js" type="text/javascript"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
var $window = $(window)
|
|
, $top_link = $('#toplink')
|
|
, $body = $('body, html')
|
|
, offset = $('#code').offset().top;
|
|
|
|
$top_link.hide().click(function(event) {
|
|
event.preventDefault();
|
|
$body.animate({scrollTop:0}, 800);
|
|
});
|
|
|
|
$window.scroll(function() {
|
|
if($window.scrollTop() > offset) {
|
|
$top_link.fadeIn();
|
|
} else {
|
|
$top_link.fadeOut();
|
|
}
|
|
}).scroll();
|
|
|
|
$('.popin').popover({trigger: 'hover'});
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|