diff options
Diffstat (limited to 'server/doc/classes')
| -rw-r--r-- | server/doc/classes/App.html | 844 | ||||
| -rw-r--r-- | server/doc/classes/Core.html | 346 | ||||
| -rw-r--r-- | server/doc/classes/automating.html | 548 | ||||
| -rw-r--r-- | server/doc/classes/compute.html | 881 | ||||
| -rw-r--r-- | server/doc/classes/errorManagement.html | 560 | ||||
| -rw-r--r-- | server/doc/classes/genTokenOptions.html | 1082 | ||||
| -rw-r--r-- | server/doc/classes/image.html | 824 | ||||
| -rw-r--r-- | server/doc/classes/network.html | 1191 | ||||
| -rw-r--r-- | server/doc/classes/networkLayer3.html | 743 |
9 files changed, 7019 insertions, 0 deletions
diff --git a/server/doc/classes/App.html b/server/doc/classes/App.html new file mode 100644 index 0000000..c0e8568 --- /dev/null +++ b/server/doc/classes/App.html @@ -0,0 +1,844 @@ +<!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-601373720"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-601373720" 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>App</h1> + <p><em>App Class of the back-end application</em></p> + <p>This class allow the communication between the front-end application and +the library which allow to send requests to an Openstack instance.</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/App.html#method___construct" class="">__construct()</a><br /> + <a href="../classes/App.html#method_setToken" class="">setToken()</a><br /> + <a href="../classes/App.html#method_checkToken" class="">checkToken()</a><br /> + <a href="../classes/App.html#method_getLibClass" class="">getLibClass()</a><br /> + <a href="../classes/App.html#method_authenticate" class="">authenticate()</a><br /> + <a href="../classes/App.html#method_deauthenticate" class="">deauthenticate()</a><br /> + <a href="../classes/App.html#method_getPostParam" class="">getPostParam()</a><br /> + <a href="../classes/App.html#method_setPostParam" class="">setPostParam()</a><br /> + <a href="../classes/App.html#method_setOutput" class="">setOutput()</a><br /> + <a href="../classes/App.html#method_getErrorInstance" class="">getErrorInstance()</a><br /> + <a href="../classes/App.html#method_show" class="">show()</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"> + <a href="../classes/App.html#property_openstack" class="">$openstack</a><br /> + <a href="../classes/App.html#property_postParams" class="">$postParams</a><br /> + <a href="../classes/App.html#property_tokenClass" class="">$tokenClass</a><br /> + <a href="../classes/App.html#property_tokenPost" class="">$tokenPost</a><br /> + <a href="../classes/App.html#property_errorClass" class="">$errorClass</a><br /> + <a href="../classes/App.html#property_output" class="">$output</a><br /> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span4"> + <em>No private methods found</em> + </section> + <section class="span4"> + <em>No private properties found</em> + </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.App.html"><div class="path-wrapper">core/App.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">\App</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_openstack" name="property_openstack" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$openstack</h3> + <pre class="signature">$openstack : \OpenStack\OpenStack</pre> + <p><em></em></p> + + + <h4>Type</h4> + \OpenStack\OpenStack + — protected, contains the main 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_postParams" name="property_postParams" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$postParams</h3> + <pre class="signature">$postParams : Array</pre> + <p><em></em></p> + + + <h4>Type</h4> + Array + — protected, contains the post parameters </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_tokenClass" name="property_tokenClass" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$tokenClass</h3> + <pre class="signature">$tokenClass : \genTokenOptions</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/genTokenOptions.html">\genTokenOptions</a> + — protected, contains the class object for the authentication override of the library </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_tokenPost" name="property_tokenPost" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$tokenPost</h3> + <pre class="signature">$tokenPost : String</pre> + <p><em></em></p> + + + <h4>Type</h4> + String + — protected, contains the token given in parameter </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_errorClass" name="property_errorClass" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$errorClass</h3> + <pre class="signature">$errorClass : \errorManagement</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/errorManagement.html">\errorManagement</a> + — protected, contains the errorManagement 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_output" name="property_output" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$output</h3> + <pre class="signature">$output : Array</pre> + <p><em></em></p> + + + <h4>Type</h4> + Array + — protected, contains the result for the API call </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">$args</span>) : \App</pre> + <p><em>App constructor</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>Array</td> + <td>$args </td> + <td><p>Args for the OpenStack Library</p></td> + </tr> + </table> + + + <h4>Returns</h4> + <a href="../classes/App.html">\App</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_setToken" name="method_setToken" class="anchor"></a> + <article class="method"> + <h3 class="public ">setToken()</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;">setToken(String <span class="argument">$token</span>) </pre> + <p><em>Set the class var $tokenPost and load the token +into the genTokenOptions Class</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$token </td> + <td><p>token to be set</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_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 of the 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_getLibClass" name="method_getLibClass" class="anchor"></a> + <article class="method"> + <h3 class="public ">getLibClass()</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;">getLibClass(String <span class="argument">$service</span>) : \Core</pre> + <p><em>Get the service Class given the name in parameter</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> + <a href="../classes/Core.html">\Core</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_authenticate" name="method_authenticate" class="anchor"></a> + <article class="method"> + <h3 class="public ">authenticate()</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;">authenticate() : void</pre> + <p><em>Generate the token for the different services in OpenStack</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_deauthenticate" name="method_deauthenticate" class="anchor"></a> + <article class="method"> + <h3 class="public ">deauthenticate()</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;">deauthenticate() : void</pre> + <p><em>Revoke the openstack services' token</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_getPostParam" name="method_getPostParam" class="anchor"></a> + <article class="method"> + <h3 class="public ">getPostParam()</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;">getPostParam(String <span class="argument">$name</span>) : Object</pre> + <p><em>Retrieve a post parameter given its name</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$name </td> + <td><p>Expected post parameter's name</p></td> + </tr> + </table> + + + <h4>Returns</h4> + Object + — <p>Post value</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_setPostParam" name="method_setPostParam" class="anchor"></a> + <article class="method"> + <h3 class="public ">setPostParam()</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;">setPostParam(String <span class="argument">$param</span>, Object <span class="argument">$value</span>) : void</pre> + <p><em>Set a post parameter for automating task</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$param </td> + <td><p>Name for the Post entry</p></td> + </tr> + <tr> + <td>Object</td> + <td>$value </td> + <td><p>Value for the Post entry</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_setOutput" name="method_setOutput" class="anchor"></a> + <article class="method"> + <h3 class="public ">setOutput()</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;">setOutput(String <span class="argument">$key</span>, Array <span class="argument">$out</span>) : void</pre> + <p><em>Set a new output message</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$key </td> + <td><p>Array key for the message</p></td> + </tr> + <tr> + <td>Array</td> + <td>$out </td> + <td><p>Message's value</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_getErrorInstance" name="method_getErrorInstance" class="anchor"></a> + <article class="method"> + <h3 class="public ">getErrorInstance()</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;">getErrorInstance() : \errorManagement</pre> + <p><em>Retrieve the errorManagement instance Object</em></p> + + + + + <h4>Returns</h4> + <a href="../classes/errorManagement.html">\errorManagement</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_show" name="method_show" class="anchor"></a> + <article class="method"> + <h3 class="public ">show()</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;">show() : void</pre> + <p><em>Output the messages to be send to the client</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> + </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">App.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/App.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> diff --git a/server/doc/classes/Core.html b/server/doc/classes/Core.html new file mode 100644 index 0000000..47095dc --- /dev/null +++ b/server/doc/classes/Core.html @@ -0,0 +1,346 @@ +<!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-1728349003"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-1728349003" 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> + </nav> + <a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a> + + <h1><small>\</small>Core</h1> + <p><em>Interface for the main classes of the API</em></p> + + + <section id="summary"> + <h2>Summary</h2> + <section class="row-fluid heading"> + <section class="span6"> + <a href="#methods">Methods</a> + </section> + <section class="span6"> + <a href="#constants">Constants</a> + </section> + </section> + <section class="row-fluid public"> + <section class="span6"> + <a href="../classes/Core.html#method_action">action()</a><br /> + </section> + <section class="span6"> + <em>No constants found</em> + </section> + </section> + <section class="row-fluid protected"> + <section class="span6"> + <em>No protected methods found</em> + </section> + <section class="span6"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span6"> + <em>No private methods found</em> + </section> + <section class="span6"> + <em>N/A</em> + </section> + </section> + </section> + </div> + <aside class="span4 detailsbar"> + <dl> + <dt>File</dt> + <dd> + <a href="../files/core.CoreInterface.html"><div class="path-wrapper">core/CoreInterface.php</div></a> + </dd> + <dt>Package</dt> + <dd><div class="namespace-wrapper">\Default</div></dd> + + </dl> + <h2>Tags</h2> + <table class="table table-condensed"> + <tr> + <th>version</th> + <td> + <p>Initialisation of this file</p> + </td> + </tr> + <tr> + <th>since</th> + <td> + <p>Core application's file</p> + </td> + </tr> + <tr> + <th>author</th> + <td> + <p>Eole 'eoledev at outlook . fr'</p> + </td> + </tr> + </table> + </aside> + </div> + + + <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_action" name="method_action" class="anchor"></a> + <article class="method"> + <h3 class="public ">action()</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;">action(String <span class="argument">$action</span>) : void</pre> + <p><em>Execute an action in the class</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$action </td> + <td><p>Function to be called</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> + </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">CoreInterface.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/CoreInterface.php.txt" class="language-php"></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> diff --git a/server/doc/classes/automating.html b/server/doc/classes/automating.html new file mode 100644 index 0000000..e8e88b7 --- /dev/null +++ b/server/doc/classes/automating.html @@ -0,0 +1,548 @@ +<!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-1335688154"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-1335688154" 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>automating</h1> + <p><em>automating Class of the back-end application</em></p> + <p>Contains the different function to automate some action</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/automating.html#method___construct" class="">__construct()</a><br /> + <a href="../classes/automating.html#method_action" class="">action()</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"> + <a href="../classes/automating.html#property_compute" class="">$compute</a><br /> + <a href="../classes/automating.html#property_image" class="">$image</a><br /> + <a href="../classes/automating.html#property_network" class="">$network</a><br /> + <a href="../classes/automating.html#property_networkLayer3" class="">$networkLayer3</a><br /> + <a href="../classes/automating.html#property_app" class="">$app</a><br /> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span4"> + <a href="../classes/automating.html#method_createPublicServer" class="">createPublicServer()</a><br /> + </section> + <section class="span4"> + <em>No private properties found</em> + </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.Automating.html"><div class="path-wrapper">core/Automating.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">\automating</div> + </dd> + + <dt>Implements</dt> + <dd><a href="../classes/Core.html"><div class="namespace-wrapper">\Core</div></a></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_compute" name="property_compute" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$compute</h3> + <pre class="signature">$compute : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains a Core compute 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_image" name="property_image" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$image</h3> + <pre class="signature">$image : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains a Core image 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_network" name="property_network" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$network</h3> + <pre class="signature">$network : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains a Core network 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_networkLayer3" name="property_networkLayer3" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$networkLayer3</h3> + <pre class="signature">$networkLayer3 : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains a Core networkLayer3 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_app" name="property_app" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$app</h3> + <pre class="signature">$app : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains the main app 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(\App <span class="argument">$app</span>) : \automating</pre> + <p><em>automating class constructor</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td><a href="../classes/App.html">\App</a></td> + <td>$app </td> + <td><p>the main app object</p></td> + </tr> + </table> + + + <h4>Returns</h4> + <a href="../classes/automating.html">\automating</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_action" name="method_action" class="anchor"></a> + <article class="method"> + <h3 class="public ">action()</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;">action(String <span class="argument">$action</span>) : void</pre> + <p><em>Execute an action</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$action </td> + <td><p>name of another function of this class</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_createPublicServer" name="method_createPublicServer" class="anchor"></a> + <article class="method"> + <h3 class="private ">createPublicServer()</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;">createPublicServer() : void</pre> + <p><em>create a new server and associate a public ip</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> + </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">Automating.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/Automating.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> diff --git a/server/doc/classes/compute.html b/server/doc/classes/compute.html new file mode 100644 index 0000000..e6bd0ed --- /dev/null +++ b/server/doc/classes/compute.html @@ -0,0 +1,881 @@ +<!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-423504642"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-423504642" 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>compute</h1> + <p><em>Compute Class of the back-end application</em></p> + <p>Management of Servers</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/compute.html#method___construct" class="">__construct()</a><br /> + <a href="../classes/compute.html#method_action" class="">action()</a><br /> + <a href="../classes/compute.html#method_listServers" class="">listServers()</a><br /> + <a href="../classes/compute.html#method_listFlavors" class="">listFlavors()</a><br /> + <a href="../classes/compute.html#method_listImages" class="">listImages()</a><br /> + <a href="../classes/compute.html#method_getServer" class="">getServer()</a><br /> + <a href="../classes/compute.html#method_getFlavor" class="">getFlavor()</a><br /> + <a href="../classes/compute.html#method_getImage" class="">getImage()</a><br /> + <a href="../classes/compute.html#method_createServer" class="">createServer()</a><br /> + <a href="../classes/compute.html#method_updateServer" class="">updateServer()</a><br /> + <a href="../classes/compute.html#method_deleteServer" class="">deleteServer()</a><br /> + <a href="../classes/compute.html#method_changePassword" class="">changePassword()</a><br /> + <a href="../classes/compute.html#method_reboot" class="">reboot()</a><br /> + <a href="../classes/compute.html#method_rebuild" class="">rebuild()</a><br /> + <a href="../classes/compute.html#method_resize" class="">resize()</a><br /> + <a href="../classes/compute.html#method_confirmResize" class="">confirmResize()</a><br /> + <a href="../classes/compute.html#method_revertResize" class="">revertResize()</a><br /> + <a href="../classes/compute.html#method_listAddresses" class="">listAddresses()</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"> + <a href="../classes/compute.html#property_app" class="">$app</a><br /> + <a href="../classes/compute.html#property_libClass" class="">$libClass</a><br /> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span4"> + <em>No private methods found</em> + </section> + <section class="span4"> + <em>No private properties found</em> + </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.Compute.html"><div class="path-wrapper">core/Compute.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">\compute</div> + </dd> + + <dt>Implements</dt> + <dd><a href="../classes/Core.html"><div class="namespace-wrapper">\Core</div></a></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_app" name="property_app" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$app</h3> + <pre class="signature">$app : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains the main app 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_libClass" name="property_libClass" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$libClass</h3> + <pre class="signature">$libClass : \OpenStack\Compute</pre> + <p><em></em></p> + + + <h4>Type</h4> + \OpenStack\Compute + — protected, contains the library Compute 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( <span class="argument">$app</span>) : \compute</pre> + <p><em>Compute constructor</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td></td> + <td>$app </td> + <td></td> + </tr> + </table> + + + <h4>Returns</h4> + <a href="../classes/compute.html">\compute</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_action" name="method_action" class="anchor"></a> + <article class="method"> + <h3 class="public ">action()</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;">action(String <span class="argument">$action</span>) : void</pre> + <p><em>Execute an action</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$action </td> + <td><p>name of another function of this class</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_listServers" name="method_listServers" class="anchor"></a> + <article class="method"> + <h3 class="public ">listServers()</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;">listServers() : void</pre> + <p><em>List servers.</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_listFlavors" name="method_listFlavors" class="anchor"></a> + <article class="method"> + <h3 class="public ">listFlavors()</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;">listFlavors() : void</pre> + <p><em>List flavors.</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_listImages" name="method_listImages" class="anchor"></a> + <article class="method"> + <h3 class="public ">listImages()</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;">listImages() : void</pre> + <p><em>List images.</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_getServer" name="method_getServer" class="anchor"></a> + <article class="method"> + <h3 class="public ">getServer()</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;">getServer() : void</pre> + <p><em>Get server details.</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_getFlavor" name="method_getFlavor" class="anchor"></a> + <article class="method"> + <h3 class="public ">getFlavor()</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;">getFlavor() : void</pre> + <p><em>Get flavor details.</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_getImage" name="method_getImage" class="anchor"></a> + <article class="method"> + <h3 class="public ">getImage()</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;">getImage() : array</pre> + <p><em>Get image details.</em></p> + + + + + <h4>Returns</h4> + array + + </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_createServer" name="method_createServer" class="anchor"></a> + <article class="method"> + <h3 class="public ">createServer()</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;">createServer() : void</pre> + <p><em>Create server.</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_updateServer" name="method_updateServer" class="anchor"></a> + <article class="method"> + <h3 class="public ">updateServer()</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;">updateServer() : void</pre> + <p><em>update a server</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_deleteServer" name="method_deleteServer" class="anchor"></a> + <article class="method"> + <h3 class="public ">deleteServer()</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;">deleteServer() : void</pre> + <p><em>Delete a server</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_changePassword" name="method_changePassword" class="anchor"></a> + <article class="method"> + <h3 class="public ">changePassword()</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;">changePassword() : void</pre> + <p><em>Change the password of a server</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_reboot" name="method_reboot" class="anchor"></a> + <article class="method"> + <h3 class="public ">reboot()</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;">reboot() : void</pre> + <p><em>Reboot a server</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_rebuild" name="method_rebuild" class="anchor"></a> + <article class="method"> + <h3 class="public ">rebuild()</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;">rebuild() : void</pre> + <p><em>Rebuild a server</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_resize" name="method_resize" class="anchor"></a> + <article class="method"> + <h3 class="public ">resize()</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;">resize() : void</pre> + <p><em>Resize a server</em></p> + <p>A call to this method has to be followed by either confirmResize or revertResize</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_confirmResize" name="method_confirmResize" class="anchor"></a> + <article class="method"> + <h3 class="public ">confirmResize()</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;">confirmResize() : void</pre> + <p><em>Confirm resize operation on a server</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_revertResize" name="method_revertResize" class="anchor"></a> + <article class="method"> + <h3 class="public ">revertResize()</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;">revertResize() : void</pre> + <p><em>Revert resize operation on a server</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_listAddresses" name="method_listAddresses" class="anchor"></a> + <article class="method"> + <h3 class="public ">listAddresses()</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;">listAddresses() : void</pre> + <p><em>List private and public addresses of a server</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> + </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">Compute.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/Compute.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> diff --git a/server/doc/classes/errorManagement.html b/server/doc/classes/errorManagement.html new file mode 100644 index 0000000..ca73563 --- /dev/null +++ b/server/doc/classes/errorManagement.html @@ -0,0 +1,560 @@ +<!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-336569403"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-336569403" 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>errorManagement</h1> + <p><em>errorManagement Class of the back-end application</em></p> + <p>Management of error</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/errorManagement.html#method___construct" class="">__construct()</a><br /> + <a href="../classes/errorManagement.html#method_BaseErrorHandler" class="">BaseErrorHandler()</a><br /> + <a href="../classes/errorManagement.html#method_BadResponseHandler" class="">BadResponseHandler()</a><br /> + <a href="../classes/errorManagement.html#method_NotImplementedHandler" class="">NotImplementedHandler()</a><br /> + <a href="../classes/errorManagement.html#method_UserInputHandler" class="">UserInputHandler()</a><br /> + <a href="../classes/errorManagement.html#method_OtherException" class="">OtherException()</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"> + <a href="../classes/errorManagement.html#property_app" class="">$app</a><br /> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span4"> + <em>No private methods found</em> + </section> + <section class="span4"> + <em>No private properties found</em> + </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.ErrorManagement.html"><div class="path-wrapper">core/ErrorManagement.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">\errorManagement</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_app" name="property_app" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$app</h3> + <pre class="signature">$app : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains the main app 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(\App <span class="argument">$args</span>) : \ErrorManagement</pre> + <p><em>ErrorManagemement constructor</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td><a href="../classes/App.html">\App</a></td> + <td>$args </td> + <td><p>the main app object</p></td> + </tr> + </table> + + + <h4>Returns</h4> + \ErrorManagement + — <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_BaseErrorHandler" name="method_BaseErrorHandler" class="anchor"></a> + <article class="method"> + <h3 class="public ">BaseErrorHandler()</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;">BaseErrorHandler(\Exception <span class="argument">$error</span>) : void</pre> + <p><em>Put an error message corresponding to a base error in the output</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>\Exception</td> + <td>$error </td> + <td><p>the exception triggered</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_BadResponseHandler" name="method_BadResponseHandler" class="anchor"></a> + <article class="method"> + <h3 class="public ">BadResponseHandler()</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;">BadResponseHandler(\Exception <span class="argument">$error</span>) : void</pre> + <p><em>Put an error message corresponding to a bad response in function of the status code in the output</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>\Exception</td> + <td>$error </td> + <td><p>the exception triggered</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_NotImplementedHandler" name="method_NotImplementedHandler" class="anchor"></a> + <article class="method"> + <h3 class="public ">NotImplementedHandler()</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;">NotImplementedHandler(\Exception <span class="argument">$error</span>) : void</pre> + <p><em>Put an error message corresponding to a not implemented yet error in the output</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>\Exception</td> + <td>$error </td> + <td><p>the exception triggered</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_UserInputHandler" name="method_UserInputHandler" class="anchor"></a> + <article class="method"> + <h3 class="public ">UserInputHandler()</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;">UserInputHandler(\Exception <span class="argument">$error</span>) : void</pre> + <p><em>Put an error message corresponding to a user input error in the output</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>\Exception</td> + <td>$error </td> + <td><p>the exception triggered</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_OtherException" name="method_OtherException" class="anchor"></a> + <article class="method"> + <h3 class="public ">OtherException()</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;">OtherException(\Exception <span class="argument">$error</span>) : void</pre> + <p><em>Put an error message corresponding to an other error in the output</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>\Exception</td> + <td>$error </td> + <td><p>the exception triggered</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> + </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">ErrorManagement.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/ErrorManagement.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> 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> diff --git a/server/doc/classes/image.html b/server/doc/classes/image.html new file mode 100644 index 0000000..872d453 --- /dev/null +++ b/server/doc/classes/image.html @@ -0,0 +1,824 @@ +<!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-283550759"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-283550759" 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>image</h1> + <p><em>Image Class of the back-end application</em></p> + <p>Management of images</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/image.html#method___construct" class="">__construct()</a><br /> + <a href="../classes/image.html#method_action" class="">action()</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"> + <a href="../classes/image.html#property_app" class="">$app</a><br /> + <a href="../classes/image.html#property_libClass" class="">$libClass</a><br /> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span4"> + <a href="../classes/image.html#method_createImage" class="">createImage()</a><br /> + <a href="../classes/image.html#method_listImage" class="">listImage()</a><br /> + <a href="../classes/image.html#method_detailsImage" class="">detailsImage()</a><br /> + <a href="../classes/image.html#method_updateImage" class="">updateImage()</a><br /> + <a href="../classes/image.html#method_deleteImage" class="">deleteImage()</a><br /> + <a href="../classes/image.html#method_reactivateImage" class="">reactivateImage()</a><br /> + <a href="../classes/image.html#method_desactivateImage" class="">desactivateImage()</a><br /> + <a href="../classes/image.html#method_uploadImage" class="">uploadImage()</a><br /> + <a href="../classes/image.html#method_downloadImage" class="">downloadImage()</a><br /> + <a href="../classes/image.html#method_addMemberImage" class="">addMemberImage()</a><br /> + <a href="../classes/image.html#method_listMemberImage" class="">listMemberImage()</a><br /> + <a href="../classes/image.html#method_detailMemberImage" class="">detailMemberImage()</a><br /> + <a href="../classes/image.html#method_removeMemberImage" class="">removeMemberImage()</a><br /> + <a href="../classes/image.html#method_updateMemberImage" class="">updateMemberImage()</a><br /> + </section> + <section class="span4"> + <em>No private properties found</em> + </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.Image.html"><div class="path-wrapper">core/Image.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">\image</div> + </dd> + + <dt>Implements</dt> + <dd><a href="../classes/Core.html"><div class="namespace-wrapper">\Core</div></a></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_app" name="property_app" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$app</h3> + <pre class="signature">$app : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains the main app 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_libClass" name="property_libClass" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$libClass</h3> + <pre class="signature">$libClass : \OpenStack\Image</pre> + <p><em></em></p> + + + <h4>Type</h4> + \OpenStack\Image + — protected, contains the library Image 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(\App <span class="argument">$app</span>) : \image</pre> + <p><em>Image constructor</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td><a href="../classes/App.html">\App</a></td> + <td>$app </td> + <td><p>the main app object</p></td> + </tr> + </table> + + + <h4>Returns</h4> + <a href="../classes/image.html">\image</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_action" name="method_action" class="anchor"></a> + <article class="method"> + <h3 class="public ">action()</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;">action(String <span class="argument">$action</span>) : void</pre> + <p><em>Execute an action</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$action </td> + <td><p>name of another function of this class</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_createImage" name="method_createImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">createImage()</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;">createImage() : void</pre> + <p><em>Create a new image</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_listImage" name="method_listImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">listImage()</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;">listImage() : void</pre> + <p><em>List the images of the server</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_detailsImage" name="method_detailsImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">detailsImage()</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;">detailsImage() : void</pre> + <p><em>Details about an image</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_updateImage" name="method_updateImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">updateImage()</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;">updateImage() : void</pre> + <p><em>Update informations about an image</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_deleteImage" name="method_deleteImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">deleteImage()</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;">deleteImage() : void</pre> + <p><em>Delete an image</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_reactivateImage" name="method_reactivateImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">reactivateImage()</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;">reactivateImage() : void</pre> + <p><em>Reactive an image</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_desactivateImage" name="method_desactivateImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">desactivateImage()</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;">desactivateImage() : void</pre> + <p><em>Desactivaate an image</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_uploadImage" name="method_uploadImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">uploadImage()</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;">uploadImage() : void</pre> + <p><em>Upload an image</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_downloadImage" name="method_downloadImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">downloadImage()</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;">downloadImage() : void</pre> + <p><em>Download an image</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_addMemberImage" name="method_addMemberImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">addMemberImage()</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;">addMemberImage() : void</pre> + <p><em>Add a member to image</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_listMemberImage" name="method_listMemberImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">listMemberImage()</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;">listMemberImage() : void</pre> + <p><em>List members of an image</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_detailMemberImage" name="method_detailMemberImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">detailMemberImage()</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;">detailMemberImage() : void</pre> + <p><em>Show details of a member of an image</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_removeMemberImage" name="method_removeMemberImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">removeMemberImage()</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;">removeMemberImage() : void</pre> + <p><em>Remove a member of an image</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_updateMemberImage" name="method_updateMemberImage" class="anchor"></a> + <article class="method"> + <h3 class="private ">updateMemberImage()</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;">updateMemberImage() : void</pre> + <p><em>Update a member of an image</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> + </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">Image.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/Image.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> diff --git a/server/doc/classes/network.html b/server/doc/classes/network.html new file mode 100644 index 0000000..ab4d845 --- /dev/null +++ b/server/doc/classes/network.html @@ -0,0 +1,1191 @@ +<!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-904181732"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-904181732" 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>network</h1> + <p><em>Network Class of the back-end application</em></p> + <p>Management of Networks</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/network.html#method___construct" class="">__construct()</a><br /> + <a href="../classes/network.html#method_action" class="">action()</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"> + <a href="../classes/network.html#property_app" class="">$app</a><br /> + <a href="../classes/network.html#property_libClass" class="">$libClass</a><br /> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span4"> + <a href="../classes/network.html#method_create_network" class="">create_network()</a><br /> + <a href="../classes/network.html#method_create_subnet" class="">create_subnet()</a><br /> + <a href="../classes/network.html#method_list_network_ids" class="">list_network_ids()</a><br /> + <a href="../classes/network.html#method_list_network_names" class="">list_network_names()</a><br /> + <a href="../classes/network.html#method_list_cidr" class="">list_cidr()</a><br /> + <a href="../classes/network.html#method_getNetwork" class="">getNetwork()</a><br /> + <a href="../classes/network.html#method_getNetworkP" class="">getNetworkP()</a><br /> + <a href="../classes/network.html#method_getSubnet" class="">getSubnet()</a><br /> + <a href="../classes/network.html#method_getSubnetP" class="">getSubnetP()</a><br /> + <a href="../classes/network.html#method_updateNetwork" class="">updateNetwork()</a><br /> + <a href="../classes/network.html#method_updateSubnet" class="">updateSubnet()</a><br /> + <a href="../classes/network.html#method_deleteNetwork" class="">deleteNetwork()</a><br /> + <a href="../classes/network.html#method_deleteSubnet" class="">deleteSubnet()</a><br /> + <a href="../classes/network.html#method_createPort" class="">createPort()</a><br /> + <a href="../classes/network.html#method_listPorts" class="">listPorts()</a><br /> + <a href="../classes/network.html#method_getPort" class="">getPort()</a><br /> + <a href="../classes/network.html#method_getPortP" class="">getPortP()</a><br /> + <a href="../classes/network.html#method_updatePort" class="">updatePort()</a><br /> + <a href="../classes/network.html#method_deletePort" class="">deletePort()</a><br /> + <a href="../classes/network.html#method_createSecurityGroup" class="">createSecurityGroup()</a><br /> + <a href="../classes/network.html#method_createSecurityGroupRule" class="">createSecurityGroupRule()</a><br /> + <a href="../classes/network.html#method_listSecurityGroupe" class="">listSecurityGroupe()</a><br /> + <a href="../classes/network.html#method_listSecurityGroupeRule" class="">listSecurityGroupeRule()</a><br /> + <a href="../classes/network.html#method_getSecurityGroupe" class="">getSecurityGroupe()</a><br /> + <a href="../classes/network.html#method_getSecurityGroupeP" class="">getSecurityGroupeP()</a><br /> + <a href="../classes/network.html#method_deleteSecurityGroupe" class="">deleteSecurityGroupe()</a><br /> + </section> + <section class="span4"> + <em>No private properties found</em> + </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.Network.html"><div class="path-wrapper">core/Network.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">\network</div> + </dd> + + <dt>Implements</dt> + <dd><a href="../classes/Core.html"><div class="namespace-wrapper">\Core</div></a></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_app" name="property_app" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$app</h3> + <pre class="signature">$app : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains the main app 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_libClass" name="property_libClass" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$libClass</h3> + <pre class="signature">$libClass : \OpenStack\Network</pre> + <p><em></em></p> + + + <h4>Type</h4> + \OpenStack\Network + — protected, contains the library Network 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(\App <span class="argument">$app</span>) : \network</pre> + <p><em>Network constructor</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td><a href="../classes/App.html">\App</a></td> + <td>$app </td> + <td><p>the main app object</p></td> + </tr> + </table> + + + <h4>Returns</h4> + <a href="../classes/network.html">\network</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_action" name="method_action" class="anchor"></a> + <article class="method"> + <h3 class="public ">action()</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;">action(String <span class="argument">$action</span>) : void</pre> + <p><em>Execute an action</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$action </td> + <td><p>name of another function of this class</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_create_network" name="method_create_network" class="anchor"></a> + <article class="method"> + <h3 class="private ">create_network()</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;">create_network() : void</pre> + <p><em>Create a new network</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_create_subnet" name="method_create_subnet" class="anchor"></a> + <article class="method"> + <h3 class="private ">create_subnet()</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;">create_subnet() : void</pre> + <p><em>Create a new subnet</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_list_network_ids" name="method_list_network_ids" class="anchor"></a> + <article class="method"> + <h3 class="private ">list_network_ids()</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;">list_network_ids() : void</pre> + <p><em>List the ID of the NETWORKS</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_list_network_names" name="method_list_network_names" class="anchor"></a> + <article class="method"> + <h3 class="private ">list_network_names()</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;">list_network_names() : \List</pre> + <p><em>List the name of the NETWORKS</em></p> + + + + + <h4>Returns</h4> + \List + — <p>of Networks name</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_list_cidr" name="method_list_cidr" class="anchor"></a> + <article class="method"> + <h3 class="private ">list_cidr()</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;">list_cidr() : void</pre> + <p><em>List the CIDR of the SUBNETS</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_getNetwork" name="method_getNetwork" class="anchor"></a> + <article class="method"> + <h3 class="private ">getNetwork()</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;">getNetwork() : void</pre> + <p><em>retrieve a specific network</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_getNetworkP" name="method_getNetworkP" class="anchor"></a> + <article class="method"> + <h3 class="private ">getNetworkP()</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;">getNetworkP( <span class="argument">$netId</span>) : \OpenStack\Network</pre> + <p><em>internal function</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td></td> + <td>$netId </td> + <td></td> + </tr> + </table> + + + <h4>Returns</h4> + \OpenStack\Network + + </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_getSubnet" name="method_getSubnet" class="anchor"></a> + <article class="method"> + <h3 class="private ">getSubnet()</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;">getSubnet() : void</pre> + <p><em>retrieve a specific subnet</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_getSubnetP" name="method_getSubnetP" class="anchor"></a> + <article class="method"> + <h3 class="private ">getSubnetP()</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;">getSubnetP( <span class="argument">$subnetId</span>) : \OpenStack\Subnet</pre> + <p><em>internal function</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td></td> + <td>$subnetId </td> + <td></td> + </tr> + </table> + + + <h4>Returns</h4> + \OpenStack\Subnet + + </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_updateNetwork" name="method_updateNetwork" class="anchor"></a> + <article class="method"> + <h3 class="private ">updateNetwork()</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;">updateNetwork() : void</pre> + <p><em>Update a network given</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_updateSubnet" name="method_updateSubnet" class="anchor"></a> + <article class="method"> + <h3 class="private ">updateSubnet()</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;">updateSubnet() : void</pre> + <p><em>Update a subnet given</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_deleteNetwork" name="method_deleteNetwork" class="anchor"></a> + <article class="method"> + <h3 class="private ">deleteNetwork()</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;">deleteNetwork() : void</pre> + <p><em>Delete a network given</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_deleteSubnet" name="method_deleteSubnet" class="anchor"></a> + <article class="method"> + <h3 class="private ">deleteSubnet()</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;">deleteSubnet() : void</pre> + <p><em>Delete a subnet given</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_createPort" name="method_createPort" class="anchor"></a> + <article class="method"> + <h3 class="private ">createPort()</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;">createPort() : void</pre> + <p><em>Create a new port</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_listPorts" name="method_listPorts" class="anchor"></a> + <article class="method"> + <h3 class="private ">listPorts()</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;">listPorts() : void</pre> + <p><em>List the of ports</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_getPort" name="method_getPort" class="anchor"></a> + <article class="method"> + <h3 class="private ">getPort()</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;">getPort() : void</pre> + <p><em>retrieve a specific port given</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_getPortP" name="method_getPortP" class="anchor"></a> + <article class="method"> + <h3 class="private ">getPortP()</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;">getPortP( <span class="argument">$portId</span>) : \port</pre> + <p><em>internal function</em></p> + <p>retrieve a specific port given</p> + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td></td> + <td>$portId </td> + <td></td> + </tr> + </table> + + + <h4>Returns</h4> + \port + + </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_updatePort" name="method_updatePort" class="anchor"></a> + <article class="method"> + <h3 class="private ">updatePort()</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;">updatePort() : void</pre> + <p><em>Update port given</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_deletePort" name="method_deletePort" class="anchor"></a> + <article class="method"> + <h3 class="private ">deletePort()</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;">deletePort() : void</pre> + <p><em>Delete a port given</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_createSecurityGroup" name="method_createSecurityGroup" class="anchor"></a> + <article class="method"> + <h3 class="private ">createSecurityGroup()</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;">createSecurityGroup() : void</pre> + <p><em>Create a new security groupe</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_createSecurityGroupRule" name="method_createSecurityGroupRule" class="anchor"></a> + <article class="method"> + <h3 class="private ">createSecurityGroupRule()</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;">createSecurityGroupRule() : void</pre> + <p><em>Create a new security groupe</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_listSecurityGroupe" name="method_listSecurityGroupe" class="anchor"></a> + <article class="method"> + <h3 class="private ">listSecurityGroupe()</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;">listSecurityGroupe() : void</pre> + <p><em>List of Security Groupes</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_listSecurityGroupeRule" name="method_listSecurityGroupeRule" class="anchor"></a> + <article class="method"> + <h3 class="private ">listSecurityGroupeRule()</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;">listSecurityGroupeRule() : void</pre> + <p><em>List of Security Groupe Rules</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_getSecurityGroupe" name="method_getSecurityGroupe" class="anchor"></a> + <article class="method"> + <h3 class="private ">getSecurityGroupe()</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;">getSecurityGroupe() : void</pre> + <p><em>retrieve a specific Security Groupe given</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_getSecurityGroupeP" name="method_getSecurityGroupeP" class="anchor"></a> + <article class="method"> + <h3 class="private ">getSecurityGroupeP()</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;">getSecurityGroupeP( <span class="argument">$securityGroupeId</span>) : \securityGroup</pre> + <p><em>internal function</em></p> + <p>retrieve a specific Security Groupe given</p> + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td></td> + <td>$securityGroupeId </td> + <td></td> + </tr> + </table> + + + <h4>Returns</h4> + \securityGroup + + </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_deleteSecurityGroupe" name="method_deleteSecurityGroupe" class="anchor"></a> + <article class="method"> + <h3 class="private ">deleteSecurityGroupe()</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;">deleteSecurityGroupe() : void</pre> + <p><em>Delete a specific Security Groupe given</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> + </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">Network.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/Network.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> diff --git a/server/doc/classes/networkLayer3.html b/server/doc/classes/networkLayer3.html new file mode 100644 index 0000000..2b36a19 --- /dev/null +++ b/server/doc/classes/networkLayer3.html @@ -0,0 +1,743 @@ +<!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-242015172"></a> + <a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a> + </div> + <div id="namespace-242015172" 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>networkLayer3</h1> + <p><em>networkLayer3 Class of the back-end application</em></p> + <p>Management of networkLayer3</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/networkLayer3.html#method___construct" class="">__construct()</a><br /> + <a href="../classes/networkLayer3.html#method_action" class="">action()</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"> + <a href="../classes/networkLayer3.html#property_app" class="">$app</a><br /> + <a href="../classes/networkLayer3.html#property_libClass" class="">$libClass</a><br /> + </section> + <section class="span4"> + <em>N/A</em> + </section> + </section> + <section class="row-fluid private"> + <section class="span4"> + <a href="../classes/networkLayer3.html#method_listFloatingIp" class="">listFloatingIp()</a><br /> + <a href="../classes/networkLayer3.html#method_createFloatingIp" class="">createFloatingIp()</a><br /> + <a href="../classes/networkLayer3.html#method_getFloatingIp" class="">getFloatingIp()</a><br /> + <a href="../classes/networkLayer3.html#method_updateFloatingIp" class="">updateFloatingIp()</a><br /> + <a href="../classes/networkLayer3.html#method_deleteFloatingIp" class="">deleteFloatingIp()</a><br /> + <a href="../classes/networkLayer3.html#method_retrieveFloatingIp" class="">retrieveFloatingIp()</a><br /> + <a href="../classes/networkLayer3.html#method_createRouter" class="">createRouter()</a><br /> + <a href="../classes/networkLayer3.html#method_listRouters" class="">listRouters()</a><br /> + <a href="../classes/networkLayer3.html#method_getRouter" class="">getRouter()</a><br /> + <a href="../classes/networkLayer3.html#method_deleteRouter" class="">deleteRouter()</a><br /> + <a href="../classes/networkLayer3.html#method_updateRouter" class="">updateRouter()</a><br /> + </section> + <section class="span4"> + <em>No private properties found</em> + </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.NetworkLayer3.html"><div class="path-wrapper">core/NetworkLayer3.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">\networkLayer3</div> + </dd> + + <dt>Implements</dt> + <dd><a href="../classes/Core.html"><div class="namespace-wrapper">\Core</div></a></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_app" name="property_app" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$app</h3> + <pre class="signature">$app : \App</pre> + <p><em></em></p> + + + <h4>Type</h4> + <a href="../classes/App.html">\App</a> + — protected, contains the main app 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> + + <div class="row-fluid"> + <div class="span8 content class"> + <a id="property_libClass" name="property_libClass" class="anchor"></a> + <article class="property"> + <h3 class="protected ">$libClass</h3> + <pre class="signature">$libClass : \OpenStack\NetworkLayer3</pre> + <p><em></em></p> + + + <h4>Type</h4> + \OpenStack\NetworkLayer3 + — protected, contains the library NetworkLayer3 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(\App <span class="argument">$app</span>) : \networkLayer3</pre> + <p><em>networkLayer3 constructor</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td><a href="../classes/App.html">\App</a></td> + <td>$app </td> + <td><p>the main app object</p></td> + </tr> + </table> + + + <h4>Returns</h4> + <a href="../classes/networkLayer3.html">\networkLayer3</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_action" name="method_action" class="anchor"></a> + <article class="method"> + <h3 class="public ">action()</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;">action(String <span class="argument">$action</span>) : void</pre> + <p><em>Execute an action</em></p> + + + <h4>Parameters</h4> + <table class="table table-condensed table-hover"> + <tr> + <td>String</td> + <td>$action </td> + <td><p>name of another function of this class</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_listFloatingIp" name="method_listFloatingIp" class="anchor"></a> + <article class="method"> + <h3 class="private ">listFloatingIp()</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;">listFloatingIp() : void</pre> + <p><em>List floatingip</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_createFloatingIp" name="method_createFloatingIp" class="anchor"></a> + <article class="method"> + <h3 class="private ">createFloatingIp()</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;">createFloatingIp() : void</pre> + <p><em>Create a new floating IP adress</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_getFloatingIp" name="method_getFloatingIp" class="anchor"></a> + <article class="method"> + <h3 class="private ">getFloatingIp()</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;">getFloatingIp() : void</pre> + <p><em>Show floatingip details</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_updateFloatingIp" name="method_updateFloatingIp" class="anchor"></a> + <article class="method"> + <h3 class="private ">updateFloatingIp()</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;">updateFloatingIp() : void</pre> + <p><em>Update floating ip</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_deleteFloatingIp" name="method_deleteFloatingIp" class="anchor"></a> + <article class="method"> + <h3 class="private ">deleteFloatingIp()</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;">deleteFloatingIp() : void</pre> + <p><em>Delete a floating ip</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_retrieveFloatingIp" name="method_retrieveFloatingIp" class="anchor"></a> + <article class="method"> + <h3 class="private ">retrieveFloatingIp()</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;">retrieveFloatingIp() : void</pre> + <p><em>Retrieve a floating ip</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_createRouter" name="method_createRouter" class="anchor"></a> + <article class="method"> + <h3 class="private ">createRouter()</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;">createRouter() : void</pre> + <p><em>Create a new router</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_listRouters" name="method_listRouters" class="anchor"></a> + <article class="method"> + <h3 class="private ">listRouters()</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;">listRouters() : void</pre> + <p><em>List routers</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_getRouter" name="method_getRouter" class="anchor"></a> + <article class="method"> + <h3 class="private ">getRouter()</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;">getRouter() : void</pre> + <p><em>Show router details</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_deleteRouter" name="method_deleteRouter" class="anchor"></a> + <article class="method"> + <h3 class="private ">deleteRouter()</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;">deleteRouter() : void</pre> + <p><em>Delete a router</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_updateRouter" name="method_updateRouter" class="anchor"></a> + <article class="method"> + <h3 class="private ">updateRouter()</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;">updateRouter() : void</pre> + <p><em>Update router</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> + </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">NetworkLayer3.php</h3> + </div> + <div class="modal-body"> + <pre data-src="../files/core/NetworkLayer3.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> |