<!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>