Skip to content

Commit

Permalink
Update docs for 0.6.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@dshafik
dshafik committed Dec 17, 2016
1 parent 2b4d2e8 commit b2eda5e
Show file tree
Hide file tree
Showing 14 changed files with 487 additions and 434 deletions.
2 changes: 2 additions & 0 deletions docs/class-Akamai.Open.EdgeGrid.Authentication.Exception.ConfigException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ <h1>Class ConfigException</h1>
<dl class="tree well">
<dd style="padding-left:0px">
Exception
implements
<span>Throwable</span>


</dd>
Expand Down
2 changes: 2 additions & 0 deletions ...amai.Open.EdgeGrid.Authentication.Exception.SignerException.InvalidSignDataException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ <h1>Class InvalidSignDataException</h1>
<dl class="tree well">
<dd style="padding-left:0px">
Exception
implements
<span>Throwable</span>


</dd>
Expand Down
2 changes: 2 additions & 0 deletions docs/class-Akamai.Open.EdgeGrid.Authentication.Exception.SignerException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ <h1>Class SignerException</h1>
<dl class="tree well">
<dd style="padding-left:0px">
Exception
implements
<span>Throwable</span>


</dd>
Expand Down
2 changes: 2 additions & 0 deletions docs/class-Akamai.Open.EdgeGrid.Authentication.Exception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,8 @@ <h1>Class Exception</h1>
<dl class="tree well">
<dd style="padding-left:0px">
Exception
implements
<span>Throwable</span>


</dd>
Expand Down
44 changes: 37 additions & 7 deletions docs/class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ <h1>Class Timestamp</h1>
<b>Namespace:</b> <a href="namespace-Akamai.html">Akamai</a>\<a href="namespace-Akamai.Open.html">Open</a>\<a href="namespace-Akamai.Open.EdgeGrid.html">EdgeGrid</a>\<a href="namespace-Akamai.Open.EdgeGrid.Authentication.html">Authentication</a><br>
<b>Package:</b> Akamai\Open\EdgeGrid\Authentication<br>

<b>Located at</b> <a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#14-74" title="Go to source code">Authentication/Timestamp.php</a>
<b>Located at</b> <a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#14-76" title="Go to source code">Authentication/Timestamp.php</a>
<br>
</div>

Expand All @@ -166,7 +166,7 @@ <h1>Class Timestamp</h1>

<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#31-37" title="Go to source code">__construct</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#33-39" title="Go to source code">__construct</a>( )</code>

<div class="description short">
<p>Signing Timestamp</p>
Expand Down Expand Up @@ -195,7 +195,7 @@ <h1>Class Timestamp</h1>

<td class="name"><div>
<a class="anchor" href="#_isValid">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#39-50" title="Go to source code">isValid</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#41-52" title="Go to source code">isValid</a>( )</code>

<div class="description short">
<p>Return true is timestamp is less than 10s old</p>
Expand Down Expand Up @@ -228,7 +228,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setValidFor">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#52-63" title="Go to source code">setValidFor</a>( <span>string <var>$interval</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#54-65" title="Go to source code">setValidFor</a>( <span>string <var>$interval</var></span> )</code>

<div class="description short">
<p>Set how long the current timestamp is considered valid</p>
Expand Down Expand Up @@ -270,7 +270,7 @@ <h4>See</h4>

<td class="name"><div>
<a class="anchor" href="#___toString">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#65-73" title="Go to source code">__toString</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#67-75" title="Go to source code">__toString</a>( )</code>

<div class="description short">
<p>Return the timestamp when cast to string</p>
Expand Down Expand Up @@ -302,6 +302,36 @@ <h4>Returns</h4>



<div class="panel panel-default">
<div class="panel-heading"><h2>Constants summary</h2></div>
<table class="summary table table-bordered table-striped constants" id="constants">
<tr data-order="FORMAT" id="FORMAT">

<td class="attributes"><code>string</code></td>
<td class="name">
<code>
<a href="source-constant-FORMAT.html#21" title="Go to source code"><b>FORMAT</b></a>
</code>

<div class="description short">

</div>

<div class="description detailed hidden">


</div>
</td>
<td class="value">
<div>
<a href="#FORMAT" class="anchor">#</a>
<code><span class="php-quote">'Ymd\TH:i:sO'</span></code>
</div>
</td>
</tr>
</table>
</div>




Expand All @@ -315,7 +345,7 @@ <h4>Returns</h4>
</code></td>

<td class="name">
<a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#21-24" title="Go to source code"><var>$timestamp</var></a>
<a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#23-26" title="Go to source code"><var>$timestamp</var></a>

<div class="description short">
<p>Signing Timestamp</p>
Expand All @@ -340,7 +370,7 @@ <h4>Returns</h4>
</code></td>

<td class="name">
<a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#26-29" title="Go to source code"><var>$validFor</var></a>
<a href="source-class-Akamai.Open.EdgeGrid.Authentication.Timestamp.html#28-31" title="Go to source code"><var>$validFor</var></a>

<div class="description short">
<p>\DateInterval spec</p>
Expand Down
42 changes: 21 additions & 21 deletions docs/class-Akamai.Open.EdgeGrid.Authentication.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ <h1>Class Authentication</h1>
<b>Namespace:</b> <a href="namespace-Akamai.html">Akamai</a>\<a href="namespace-Akamai.Open.html">Open</a>\<a href="namespace-Akamai.Open.EdgeGrid.html">EdgeGrid</a><br>
<b>Package:</b> \Akamai\Open\EdgeGrid\Authentication<br>

<b>Located at</b> <a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#22-598" title="Go to source code">Authentication.php</a>
<b>Located at</b> <a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#22-603" title="Go to source code">Authentication.php</a>
<br>
</div>

Expand Down Expand Up @@ -535,7 +535,7 @@ <h4>Parameters</h4>

<td class="name"><div>
<a class="anchor" href="#_getBody">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#240-248" title="Go to source code">getBody</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#240-252" title="Go to source code">getBody</a>( <span> <var>$truncate</var> = <span class="php-keyword1">false</span></span> )</code>

<div class="description short">
<p>Get request body</p>
Expand Down Expand Up @@ -568,7 +568,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setHeaders">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#250-260" title="Go to source code">setHeaders</a>( <span>array <var>$headers</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#254-264" title="Go to source code">setHeaders</a>( <span>array <var>$headers</var></span> )</code>

<div class="description short">
<p>Set request headers</p>
Expand Down Expand Up @@ -606,7 +606,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_getHeaders">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#262-270" title="Go to source code">getHeaders</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#266-274" title="Go to source code">getHeaders</a>( )</code>

<div class="description short">
<p>Get request headers</p>
Expand Down Expand Up @@ -639,7 +639,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setPath">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#272-291" title="Go to source code">setPath</a>( <span>mixed <var>$path</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#276-295" title="Go to source code">setPath</a>( <span>mixed <var>$path</var></span> )</code>

<div class="description short">
<p>Set request path</p>
Expand Down Expand Up @@ -677,7 +677,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_getPath">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#293-301" title="Go to source code">getPath</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#297-305" title="Go to source code">getPath</a>( )</code>

<div class="description short">
<p>Get request path</p>
Expand Down Expand Up @@ -710,7 +710,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setTimestamp">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#303-316" title="Go to source code">setTimestamp</a>( <span>mixed <var>$timestamp</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#307-320" title="Go to source code">setTimestamp</a>( <span>mixed <var>$timestamp</var> = <span class="php-keyword1">null</span></span> )</code>

<div class="description short">
<p>Set signing timestamp</p>
Expand Down Expand Up @@ -748,7 +748,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setNonce">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#318-331" title="Go to source code">setNonce</a>( <span><code><a href="class-Akamai.Open.EdgeGrid.Authentication.Nonce.html">Akamai\Open\EdgeGrid\Authentication\Nonce</a></code> <var>$nonce</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#322-335" title="Go to source code">setNonce</a>( <span><code><a href="class-Akamai.Open.EdgeGrid.Authentication.Nonce.html">Akamai\Open\EdgeGrid\Authentication\Nonce</a></code> <var>$nonce</var> = <span class="php-keyword1">null</span></span> )</code>

<div class="description short">
<p>Set signing nonce</p>
Expand Down Expand Up @@ -786,7 +786,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setHeadersToSign">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#333-343" title="Go to source code">setHeadersToSign</a>( <span>array <var>$headers_to_sign</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#337-347" title="Go to source code">setHeadersToSign</a>( <span>array <var>$headers_to_sign</var></span> )</code>

<div class="description short">
<p>Set headers to sign</p>
Expand Down Expand Up @@ -824,7 +824,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setMaxBodySize">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#345-355" title="Go to source code">setMaxBodySize</a>( <span>integer <var>$max_body_size</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#349-359" title="Go to source code">setMaxBodySize</a>( <span>integer <var>$max_body_size</var></span> )</code>

<div class="description short">
<p>Set max body size to sign</p>
Expand Down Expand Up @@ -862,7 +862,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setAuth">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#357-369" title="Go to source code">setAuth</a>( <span>string <var>$client_token</var></span>, <span>string <var>$client_secret</var></span>, <span>string <var>$access_token</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#361-373" title="Go to source code">setAuth</a>( <span>string <var>$client_token</var></span>, <span>string <var>$client_secret</var></span>, <span>string <var>$access_token</var></span> )</code>

<div class="description short">
<p>Set Akamai EdgeGrid Authentication Tokens/Secret</p>
Expand Down Expand Up @@ -904,7 +904,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_createFromEdgeRcFile">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#371-408" title="Go to source code">createFromEdgeRcFile</a>( <span>string <var>$section</var> = <span class="php-quote">&quot;default&quot;</span></span>, <span>string|null <var>$path</var> = <span class="php-keyword1">null</span></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#375-412" title="Go to source code">createFromEdgeRcFile</a>( <span>string <var>$section</var> = <span class="php-quote">&quot;default&quot;</span></span>, <span>string|null <var>$path</var> = <span class="php-keyword1">null</span></span> )</code>

<div class="description short">
<p>Create instance using an .edgerc configuration file</p>
Expand Down Expand Up @@ -948,7 +948,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_canonicalizeHeaders">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#410-453" title="Go to source code">canonicalizeHeaders</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#414-457" title="Go to source code">canonicalizeHeaders</a>( )</code>

<div class="description short">
<p>Returns headers in normalized form</p>
Expand Down Expand Up @@ -981,7 +981,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeBase64HmacSha256">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#455-466" title="Go to source code">makeBase64HmacSha256</a>( <span>string <var>$data</var></span>, <span>string <var>$key</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#459-470" title="Go to source code">makeBase64HmacSha256</a>( <span>string <var>$data</var></span>, <span>string <var>$key</var></span> )</code>

<div class="description short">
<p>Returns Base64 encoded HMAC-SHA256 Hash</p>
Expand Down Expand Up @@ -1021,7 +1021,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeBase64Sha256">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#468-478" title="Go to source code">makeBase64Sha256</a>( <span>string <var>$data</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#472-482" title="Go to source code">makeBase64Sha256</a>( <span>string <var>$data</var></span> )</code>

<div class="description short">
<p>Returns Base64 encoded SHA256 Hash</p>
Expand Down Expand Up @@ -1059,7 +1059,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeContentHash">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#480-493" title="Go to source code">makeContentHash</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#484-497" title="Go to source code">makeContentHash</a>( )</code>

<div class="description short">
<p>Returns a hash of the HTTP POST body</p>
Expand Down Expand Up @@ -1092,7 +1092,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeDataToSign">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#495-524" title="Go to source code">makeDataToSign</a>( <span>string <var>$auth_header</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#499-528" title="Go to source code">makeDataToSign</a>( <span>string <var>$auth_header</var></span> )</code>

<div class="description short">
<p>Returns a string with all data that will be signed</p>
Expand Down Expand Up @@ -1130,7 +1130,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_makeSigningKey">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#526-535" title="Go to source code">makeSigningKey</a>( )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#530-539" title="Go to source code">makeSigningKey</a>( )</code>

<div class="description short">
<p>Creates a signing key based on the secret and timestamp</p>
Expand Down Expand Up @@ -1163,7 +1163,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_signRequest">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#537-549" title="Go to source code">signRequest</a>( <span>string <var>$auth_header</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#541-553" title="Go to source code">signRequest</a>( <span>string <var>$auth_header</var></span> )</code>

<div class="description short">
<p>Returns a signature of the given request, timestamp and auth_header</p>
Expand Down Expand Up @@ -1201,7 +1201,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_parseEdgeRcFile">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#551-584" title="Go to source code">parseEdgeRcFile</a>( <span> <var>$path</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#555-588" title="Go to source code">parseEdgeRcFile</a>( <span> <var>$path</var></span> )</code>

<div class="description short">
<p>Parse a .edgerc File</p>
Expand Down Expand Up @@ -1243,7 +1243,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_buildQueryString">#</a>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#586-597" title="Go to source code">buildQueryString</a>( <span> <var>$query</var></span> )</code>
<code><a href="source-class-Akamai.Open.EdgeGrid.Authentication.html#590-602" title="Go to source code">buildQueryString</a>( <span> <var>$query</var></span> )</code>

<div class="description short">

Expand Down
2 changes: 1 addition & 1 deletion docs/class-Akamai.Open.EdgeGrid.Client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1203,7 +1203,7 @@ <h4>Returns</h4>
<td class="value">
<div>
<a href="#VERSION" class="anchor">#</a>
<code><span class="php-quote">&quot;0.6.1&quot;</span></code>
<code><span class="php-quote">&quot;0.6.2&quot;</span></code>
</div>
</td>
</tr>
Expand Down
2 changes: 2 additions & 0 deletions docs/class-Akamai.Open.EdgeGrid.Exception.HandlerException.IOException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ <h1>Class IOException</h1>
<dl class="tree well">
<dd style="padding-left:0px">
Exception
implements
<span>Throwable</span>


</dd>
Expand Down
2 changes: 2 additions & 0 deletions docs/class-Akamai.Open.EdgeGrid.Exception.HandlerException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,8 @@ <h1>Class HandlerException</h1>
<dl class="tree well">
<dd style="padding-left:0px">
Exception
implements
<span>Throwable</span>


</dd>
Expand Down
2 changes: 2 additions & 0 deletions docs/class-Akamai.Open.EdgeGrid.Exception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ <h1>Class Exception</h1>
<dl class="tree well">
<dd style="padding-left:0px">
Exception
implements
<span>Throwable</span>


</dd>
Expand Down
Loading

0 comments on commit b2eda5e

Please sign in to comment.