diff options
Diffstat (limited to 'server/doc/classes/genTokenOptions.html')
| -rw-r--r-- | server/doc/classes/genTokenOptions.html | 1082 |
1 files changed, 1082 insertions, 0 deletions
diff --git a/server/doc/classes/genTokenOptions.html b/server/doc/classes/genTokenOptions.html new file mode 100644 index 0000000..3643503 --- /dev/null +++ b/server/doc/classes/genTokenOptions.html @@ -0,0 +1,1082 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/> + <meta charset="utf-8"/> + <title>API Documentation</title> + <meta name="author" content=""/> + <meta name="description" content=""/> + + <link href="../css/bootstrap-combined.no-icons.min.css" rel="stylesheet"> + <link href="../css/font-awesome.min.css" rel="stylesheet"> + <link href="../css/prism.css" rel="stylesheet" media="all"/> + <link href="../css/template.css" rel="stylesheet" media="all"/> + + <!--[if lt IE 9]> + <script src="../js/html5.js"></script> + <![endif]--> + <script src="../js/jquery-1.11.0.min.js"></script> + <script src="../js/ui/1.10.4/jquery-ui.min.js"></script> + <script src="../js/bootstrap.min.js"></script> + <script src="../js/jquery.smooth-scroll.js"></script> + <script src="../js/prism.min.js"></script> + <!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit--> + <script type="text/javascript"> + function loadExternalCodeSnippets() { + Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) { + var src = pre.getAttribute('data-src'); + var extension = (src.match(/\.(\w+)$/) || [, ''])[1]; + var language = 'php'; + + var code = document.createElement('code'); + code.className = 'language-' + language; + + pre.textContent = ''; + + code.textContent = 'Loading…'; + + pre.appendChild(code); + + var xhr = new XMLHttpRequest(); + + xhr.open('GET', src, true); + + xhr.onreadystatechange = function () { + if (xhr.readyState == 4) { + + if (xhr.status < 400 && xhr.responseText) { + code.textContent = xhr.responseText; + + Prism.highlightElement(code); + } + else if (xhr.status >= 400) { + code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText; + } + else { + code.textContent = '✖ Error: File does not exist or is empty'; + } + } + }; + + xhr.send(null); + }); + } + + $(document).ready(function(){ + loadExternalCodeSnippets(); + }); + $('#source-view').on('shown', function () { + loadExternalCodeSnippets(); + }) +</script> + + <link rel="shortcut icon" href="../images/favicon.ico"/> + <link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/> + <link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/> + <link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/> +</head> +<body> + +<div class="navbar navbar-fixed-top"> + <div class="navbar-inner"> + <div class="container"> + <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> + <i class="icon-ellipsis-vertical"></i> + </a> + <a class="brand" href="../index.html">API Documentation</a> + + <div class="nav-collapse"> + <ul class="nav pull-right"> + <li class="dropdown" id="charts-menu"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown"> + Charts <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li> + <a href="../graphs/class.html"> + <i class="icon-list-alt"></i> Class hierarchy diagram + </a> + </li> + </ul> + </li> + <li class="dropdown" id="reports-menu"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown"> + Reports <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li> + <a href="../reports/errors.html"> + <i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">5</span> + </a> + </li> + <li> + <a href="../reports/markers.html"> + <i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">62</span> + </a> + </li> + <li> + <a href="../reports/deprecated.html"> + <i class="icon-list-alt"></i> Deprecated <span class="label label-info pull-right">0</span> + </a> + </li> + </ul> + </li> + </ul> + </div> + </div> + </div> + <!--<div class="go_to_top">--> + <!--<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>--> + <!--</div>--> +</div> + +<div id="___" class="container-fluid"> + <section class="row-fluid"> + <div class="span2 sidebar"> + <div class="accordion" style="margin-bottom: 0"> + <div class="accordion-group"> + <div class="accordion-heading"> + <a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1662057252"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-1662057252" class="accordion-body collapse in"> + <div class="accordion-inner"> + + + <ul> + <li class="interface"><a href="../classes/Core.html">Core</a></li> + <li class="class"><a href="../classes/App.html">App</a></li> + <li class="class"><a href="../classes/automating.html">automating</a></li> + <li class="class"><a href="../classes/compute.html">compute</a></li> + <li class="class"><a href="../classes/errorManagement.html">errorManagement</a></li> + <li class="class"><a href="../classes/genTokenOptions.html">genTokenOptions</a></li> + <li class="class"><a href="../classes/image.html">image</a></li> + <li class="class"><a href="../classes/network.html">network</a></li> + <li class="class"><a href="../classes/networkLayer3.html">networkLayer3</a></li> + </ul> + </div> + </div> + </div> + </div> + + </div> + </section> + <section class="row-fluid"> + <div class="span10 offset2"> + <div class="row-fluid"> + <div class="span8 content class"> + <nav> + <a href="../namespaces/default.html">\</a> <i class="icon-level-up"></i> + </nav> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a> + + <h1><small>\</small>genTokenOptions</h1> + <p><em>genTokenOptions Class</em></p> + <p>This class allow the generation of tokens for openstack, and to inject +those tokens into the library. Which allow to do a proper login only once +and not for each request</p> + + + <section id="summary"> + <h2>Summary</h2> + <section class="row-fluid heading"> + <section class="span4"> + <a href="#methods">Methods</a> + </section> + <section class="span4"> + <a href="#properties">Properties</a> + </section> + <section class="span4"> + <a href="#constants">Constants</a> + </section> + </section> + <section class="row-fluid public"> + <section class="span4"> + <a href="../classes/genTokenOptions.html#method___construct" class="">__construct()</a><br /> + <a href="../classes/genTokenOptions.html#method_checkToken" class="">checkToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_genIdentityToken" class="">genIdentityToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_revokeIdentityToken" class="">revokeIdentityToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_loadIdentityBackup" class="">loadIdentityBackup()</a><br /> + <a href="../classes/genTokenOptions.html#method_genImageToken" class="">genImageToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_revokeImageToken" class="">revokeImageToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_loadImageBackup" class="">loadImageBackup()</a><br /> + <a href="../classes/genTokenOptions.html#method_genNetworkToken" class="">genNetworkToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_revokeNetworkToken" class="">revokeNetworkToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_loadNetworkBackup" class="">loadNetworkBackup()</a><br /> + <a href="../classes/genTokenOptions.html#method_genComputeToken" class="">genComputeToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_revokeComputeToken" class="">revokeComputeToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_loadComputeBackup" class="">loadComputeBackup()</a><br /> + <a href="../classes/genTokenOptions.html#method_getBackup" class="">getBackup()</a><br /> + <a href="../classes/genTokenOptions.html#method_loadBackup" class="">loadBackup()</a><br /> + <a href="../classes/genTokenOptions.html#method_getOptions" class="">getOptions()</a><br /> + </section> + <section class="span4"> + <em>No public properties found</em> + </section> + <section class="span4"> + <em>No constants found</em> + </section> + </section> + <section class="row-fluid protected"> + <section class="span4"> + <em>No protected methods found</em> + </section> + <section class="span4"> + <em>No protected properties found</em> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span4"> + <a href="../classes/genTokenOptions.html#method_addDebugMiddleware" class="">addDebugMiddleware()</a><br /> + <a href="../classes/genTokenOptions.html#method_saveBackup" class="">saveBackup()</a><br /> + <a href="../classes/genTokenOptions.html#method_serializeToken" class="">serializeToken()</a><br /> + <a href="../classes/genTokenOptions.html#method_unserializeToken" class="">unserializeToken()</a><br /> + </section> + <section class="span4"> + <a href="../classes/genTokenOptions.html#property_optionsGlobal" class="">$optionsGlobal</a><br /> + <a href="../classes/genTokenOptions.html#property_backup" class="">$backup</a><br /> + <a href="../classes/genTokenOptions.html#property_httpClient" class="">$httpClient</a><br /> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + </section> + </div> + <aside class="span4 detailsbar"> + + + <dl> + <dt>File</dt> + <dd><a href="../files/core.LibOverride.genTokenOptions.html"><div class="path-wrapper">core/LibOverride/genTokenOptions.php</div></a></dd> + <dt>Package</dt> + <dd><div class="namespace-wrapper">Default</div></dd> + <dt>Class hierarchy</dt> + <dd class="hierarchy"> + <div class="namespace-wrapper">\genTokenOptions</div> + </dd> + + + + + + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + + <a id="properties" name="properties"></a> + <div class="row-fluid"> + <div class="span8 content class"> + <h2>Properties</h2> + </div> + <aside class="span4 detailsbar"></aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_optionsGlobal" name="property_optionsGlobal" class="anchor"></a> + <article class="property"> + <h3 class="private ">$optionsGlobal</h3> + <pre class="signature">$optionsGlobal : Array</pre> + <p><em></em></p> + + + <h4>Type</h4> + Array + — private, contains the options common for the different tokens </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_backup" name="property_backup" class="anchor"></a> + <article class="property"> + <h3 class="private ">$backup</h3> + <pre class="signature">$backup : Array</pre> + <p><em></em></p> + + + <h4>Type</h4> + Array + — private, contains all the informations about the different tokens. It contains the information send to the clients </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_httpClient" name="property_httpClient" class="anchor"></a> + <article class="property"> + <h3 class="private ">$httpClient</h3> + <pre class="signature">$httpClient : \GuzzleHttp\Client</pre> + <p><em></em></p> + + + <h4>Type</h4> + \GuzzleHttp\Client + — private, contains a default Client to construct some OpenStack library object </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + + <a id="methods" name="methods"></a> + <div class="row-fluid"> + <div class="span8 content class"><h2>Methods</h2></div> + <aside class="span4 detailsbar"></aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method___construct" name="method___construct" class="anchor"></a> + <article class="method"> + <h3 class="public ">__construct()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">__construct(Array <span class="argument">$options</span>) : \genTokenOptions</pre> + <p><em>genTokenOptions constructor</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>Array</td> + <td>$options </td> + <td><p>Options to create the objects in the library +AuthUrl is the main options required</p></td> + </tr> + </table> + + + <h4>Returns</h4> + <a href="../classes/genTokenOptions.html">\genTokenOptions</a> + — <p>Object</p> + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_checkToken" name="method_checkToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">checkToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">checkToken() : boolean</pre> + <p><em>Check the expiration time of a token</em></p> + + + + + <h4>Returns</h4> + boolean + — <p>if the token is not expired</p> + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_genIdentityToken" name="method_genIdentityToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">genIdentityToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">genIdentityToken() : void</pre> + <p><em>Generate a new token for the Identity service</em></p> + + + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_revokeIdentityToken" name="method_revokeIdentityToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">revokeIdentityToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">revokeIdentityToken() : void</pre> + <p><em>Revoke the token for the Identity Service</em></p> + + + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_loadIdentityBackup" name="method_loadIdentityBackup" class="anchor"></a> + <article class="method"> + <h3 class="public ">loadIdentityBackup()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">loadIdentityBackup(String <span class="argument">$opt</span>) : void</pre> + <p><em>Load a token for the Identity Service</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$opt </td> + <td><p>serialized token</p></td> + </tr> + </table> + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_genImageToken" name="method_genImageToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">genImageToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">genImageToken() : void</pre> + <p><em>Generate a new token for the Image service</em></p> + + + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_revokeImageToken" name="method_revokeImageToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">revokeImageToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">revokeImageToken() : void</pre> + <p><em>Revoke the token for the Image Service</em></p> + + + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_loadImageBackup" name="method_loadImageBackup" class="anchor"></a> + <article class="method"> + <h3 class="public ">loadImageBackup()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">loadImageBackup(String <span class="argument">$opt</span>) : void</pre> + <p><em>Load a token for the Image Service</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$opt </td> + <td><p>serialized token</p></td> + </tr> + </table> + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_genNetworkToken" name="method_genNetworkToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">genNetworkToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">genNetworkToken() : void</pre> + <p><em>Generate a new token for the Metwork service</em></p> + + + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_revokeNetworkToken" name="method_revokeNetworkToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">revokeNetworkToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">revokeNetworkToken() : void</pre> + <p><em>Revoke the token for the Network Service</em></p> + + + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_loadNetworkBackup" name="method_loadNetworkBackup" class="anchor"></a> + <article class="method"> + <h3 class="public ">loadNetworkBackup()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">loadNetworkBackup(String <span class="argument">$opt</span>) : void</pre> + <p><em>Load a token for the Network Service</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$opt </td> + <td><p>serialized token</p></td> + </tr> + </table> + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_genComputeToken" name="method_genComputeToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">genComputeToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">genComputeToken() : void</pre> + <p><em>Generate a new token for the Compute service</em></p> + + + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_revokeComputeToken" name="method_revokeComputeToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">revokeComputeToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">revokeComputeToken() : void</pre> + <p><em>Revoke the token for the Compute Service</em></p> + + + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_loadComputeBackup" name="method_loadComputeBackup" class="anchor"></a> + <article class="method"> + <h3 class="public ">loadComputeBackup()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">loadComputeBackup(String <span class="argument">$opt</span>) : void</pre> + <p><em>Load a token for the Compute Service</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$opt </td> + <td><p>serialized token</p></td> + </tr> + </table> + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_getBackup" name="method_getBackup" class="anchor"></a> + <article class="method"> + <h3 class="public ">getBackup()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">getBackup() : String</pre> + <p><em>Retrieve the tokens saved</em></p> + + + + + <h4>Returns</h4> + String + — <p>tokens serialized</p> + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_loadBackup" name="method_loadBackup" class="anchor"></a> + <article class="method"> + <h3 class="public ">loadBackup()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">loadBackup(String <span class="argument">$back</span>) : void</pre> + <p><em>Load tokens into the library</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$back </td> + <td><p>tokens serialized</p></td> + </tr> + </table> + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_getOptions" name="method_getOptions" class="anchor"></a> + <article class="method"> + <h3 class="public ">getOptions()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">getOptions(String <span class="argument">$service</span>) : array</pre> + <p><em>Retrieve the common options for a service</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$service </td> + <td><p>name of the service</p></td> + </tr> + </table> + + + <h4>Returns</h4> + array + — <p>Options to create the library class corresponding to this service</p> + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_addDebugMiddleware" name="method_addDebugMiddleware" class="anchor"></a> + <article class="method"> + <h3 class="private ">addDebugMiddleware()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">addDebugMiddleware(array <span class="argument">$options</span>, \OpenCloud\Common\Transport\HandlerStack <span class="argument">$stack</span>) : void</pre> + <p><em>Add a debug for the library</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>array</td> + <td>$options </td> + <td><p>Debug options, cf library</p></td> + </tr> + <tr> + <td>\OpenCloud\Common\Transport\HandlerStack</td> + <td>$stack </td> + <td><p>pointer to a HandlerStack object</p></td> + </tr> + </table> + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_saveBackup" name="method_saveBackup" class="anchor"></a> + <article class="method"> + <h3 class="private ">saveBackup()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">saveBackup(String <span class="argument">$name</span>, Array <span class="argument">$data</span>) : void</pre> + <p><em>Save the token given a service name</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$name </td> + <td><p>name of the service to save</p></td> + </tr> + <tr> + <td>Array</td> + <td>$data </td> + <td><p>token and baseUrl for the service</p></td> + </tr> + </table> + + + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_serializeToken" name="method_serializeToken" class="anchor"></a> + <article class="method"> + <h3 class="private ">serializeToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">serializeToken(Array <span class="argument">$token</span>) : String</pre> + <p><em>Serialize a given token</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>Array</td> + <td>$token </td> + <td><p>token to be serialized</p></td> + </tr> + </table> + + + <h4>Returns</h4> + String + — <p>token serialized</p> + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="method_unserializeToken" name="method_unserializeToken" class="anchor"></a> + <article class="method"> + <h3 class="private ">unserializeToken()</h3> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a> + <pre class="signature" style="margin-right: 54px;">unserializeToken(String <span class="argument">$tokenSerialized</span>) : \OpenCloud\Common\Auth\Token</pre> + <p><em>Unserialize a token</em></p> + <p>Unserialize a token and recreate the architecture of the library token</p> + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$tokenSerialized </td> + <td><p>the token to be unserialized</p></td> + </tr> + </table> + + + <h4>Returns</h4> + \OpenCloud\Common\Auth\Token + — <p>the token unserialized</p> + + </article> + </div> + <aside class="span4 detailsbar"> + <h1><i class="icon-arrow-down"></i></h1> + <dl> + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr><td colspan="2"><em>None found</em></td></tr> + </table> + </aside> + </div> + + </div> + </section> + + <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true"> + <div class="modal-header"> + <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> + <h3 id="source-view-label">genTokenOptions.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/LibOverride/genTokenOptions.php.txt" class="language-php line-numbers"></pre> + </div> + </div> + + <footer class="row-fluid"> + <section class="span10 offset2"> + <section class="row-fluid"> + <section class="span10 offset1"> + <section class="row-fluid footer-sections"> + <section class="span4"> + <h1><i class="icon-code"></i></h1> + <div> + <ul> + </ul> + </div> + </section> + <section class="span4"> + <h1><i class="icon-bar-chart"></i></h1> + <div> + <ul> + <li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li> + </ul> + </div> + </section> + <section class="span4"> + <h1><i class="icon-pushpin"></i></h1> + <div> + <ul> + <li><a href="../reports/errors.html">Errors</a></li> + <li><a href="../reports/markers.html">Markers</a></li> + </ul> + </div> + </section> + </section> + </section> + </section> + <section class="row-fluid"> + <section class="span10 offset1"> + <hr /> + Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored + on April 27th, 2016 at 20:51. + </section> + </section> + </section> + </footer> +</div> + +</body> +</html> |