diff options
Diffstat (limited to 'doc/phpdoc/classes/Inventory.html')
| -rw-r--r-- | doc/phpdoc/classes/Inventory.html | 625 |
1 files changed, 625 insertions, 0 deletions
diff --git a/doc/phpdoc/classes/Inventory.html b/doc/phpdoc/classes/Inventory.html new file mode 100644 index 0000000..48730e5 --- /dev/null +++ b/doc/phpdoc/classes/Inventory.html @@ -0,0 +1,625 @@ +<!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 » \Inventory +</title> + <meta name="author" content=""/> + <meta name="description" content=""/> + + <link href="../css/template.css" rel="stylesheet" media="all"/> + + <!--[if lt IE 9]> + <script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script> + <![endif]--> + <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script> + <script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script> + <script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script> + <script src="../js/bootstrap.js" type="text/javascript"></script> + <script src="../js/template.js" type="text/javascript"></script> + <script src="../js/prettify/prettify.min.js" type="text/javascript"></script> + + <link rel="shortcut icon" href="../img/favicon.ico"/> + <link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/> + <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/> + <link rel="apple-touch-icon" sizes="114x114" href="../img/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"> + <span class="icon-bar"></span> <span class="icon-bar"></span> + <span class="icon-bar"></span> </a> + <a class="brand" href="../index.html">API Documentation</a> + + <div class="nav-collapse"> + <ul class="nav"> + <li class="dropdown"> + <a href="#api" class="dropdown-toggle" data-toggle="dropdown"> + API Documentation <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + </ul> + </li> + <li class="dropdown" id="charts-menu"> + <a href="#charts" class="dropdown-toggle" data-toggle="dropdown"> + Charts <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li> + <a href="../graph_class.html"> + <i class="icon-list-alt"></i> Class hierarchy diagram + </a> + </li> + </ul> + </li> + <li class="dropdown" id="reports-menu"> + <a href="#reports" class="dropdown-toggle" data-toggle="dropdown"> + Reports <b class="caret"></b> + </a> + <ul class="dropdown-menu"> + <li> + <a href="../errors.html"> + <i class="icon-list-alt"></i> Errors + </a> + </li> + <li> + <a href="../markers.html"> + <i class="icon-list-alt"></i> Markers + </a> + </li> + <li> + <a href="../deprecated.html"> + <i class="icon-list-alt"></i> Deprecated + </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"> + <noscript> + <div class="alert alert-warning"> + Javascript is disabled; several features are only available if Javascript is enabled. + </div> + </noscript> + + + <style> + .deprecated h2 { + text-decoration: line-through; + } + </style> + <div class="row"> + <div class="span4"> + <div class="btn-group view pull-right" data-toggle="buttons-radio"> + <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button> + <button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button> + </div> + <div class="btn-group visibility" data-toggle="buttons-checkbox"> + <button class="btn public active" title="Show public elements">Public</button> + <button class="btn protected" title="Show protected elements">Protected</button> + <button class="btn private" title="Show private elements">Private</button> + <button class="btn inherited active" title="Show inherited elements">Inherited</button> + </div> + + <ul class="side-nav nav nav-list"> + <li class="nav-header"> + <i class="icon-custom icon-method"></i> Methods + <ul> + <li class="method public"> + <a href="#method_addItem" title="addItem :: Adds an Item object to the singleton's Inventory from session."> + <span class="description">Adds an Item object to the singleton's Inventory from session.</span><pre>addItem</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_addToXML" title="addToXML :: "> + <span class="description"></span><pre>addToXML</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_created" title="created :: Checks if the Inventory was already created in the session"> + <span class="description">Checks if the Inventory was already created in the session</span><pre>created</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_get" title="get :: Returns the Inventory from the session."> + <span class="description">Returns the Inventory from the session.</span><pre>get</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_removeItem" title="removeItem :: "> + <span class="description"></span><pre>removeItem</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_sendContent" title="sendContent :: Returns the Inventory's content from the session."> + <span class="description">Returns the Inventory's content from the session.</span><pre>sendContent</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_useItem" title="useItem :: "> + <span class="description"></span><pre>useItem</pre> + </a> + </li> + + </ul> + </li> + <li class="nav-header protected">» Protected + <ul> + </ul> + </li> + <li class="nav-header private">» Private + <ul> + <li class="method private"> + <a href="#method__addItem" title="_addItem :: Adds an Item object to the Inventory, incrementing the Item's count if it was already present."> + <span class="description">Adds an Item object to the Inventory, incrementing the Item's count if it was already present.</span><pre>_addItem</pre> + </a> + </li> + <li class="method private"> + <a href="#method__removeItem" title="_removeItem :: "> + <span class="description"></span><pre>_removeItem</pre> + </a> + </li> + <li class="method private"> + <a href="#method__useItem" title="_useItem :: "> + <span class="description"></span><pre>_useItem</pre> + </a> + </li> + </ul> + </li> + <li class="nav-header"> + <i class="icon-custom icon-constant"></i> Constants + <ul> + </ul> + </li> + </ul> + + + </div> + + <div class="span8"> + <div class="element class"> + <h1>Inventory</h1> + <small style="display: block; text-align: right"> + </small> + <p class="short_description">Represent the player's Inventory.</p> + <div class="details"> + <div class="long_description"> + <p>Implemented as a singleton in the session.</p> + </div> + <table class="table table-bordered"> + <tr> + <th> + package + </th> + <td> + + <p>inc\Inventory.inc</p> + </td> + </tr> + <tr> + <th> + author + </th> + <td> + + <p>Alexandre Renoux</p> + </td> + </tr> + <tr> + <th> + author + </th> + <td> + + <p>Pierre-Emmanuel Novac</p> + </td> + </tr> + </table> + + <h3><i class="icon-custom icon-method"></i> Methods</h3> + <a id="method__addItem"></a> + <div class="element clickable method private method__addItem" data-toggle="collapse" data-target=".method__addItem .collapse"> + <h2>Adds an Item object to the Inventory, incrementing the Item's count if it was already present.</h2> + <pre>_addItem(\Item $item) : array</pre> + <div class="labels"> + </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + </table> + + <h3>Arguments</h3> + <div class="subelement argument"> + <h4>$item</h4> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to add to the Inventory</p></p> + </div> + + <h3>Response</h3> + <code>array</code><p><p>Item and Item's count</p></p> + </div> + </div> + + </div> + <a id="method__removeItem"></a> + <div class="element clickable method private method__removeItem" data-toggle="collapse" data-target=".method__removeItem .collapse"> + <h2>_removeItem</h2> + <pre>_removeItem( $item) </pre> + <div class="labels"> + </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + <h3>Arguments</h3> + <div class="subelement argument"> + <h4>$item</h4> + <code></code><p></p> + </div> + + </div> + </div> + + </div> + <a id="method__useItem"></a> + <div class="element clickable method private method__useItem" data-toggle="collapse" data-target=".method__useItem .collapse"> + <h2>_useItem</h2> + <pre>_useItem( $item) </pre> + <div class="labels"> + </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + <h3>Arguments</h3> + <div class="subelement argument"> + <h4>$item</h4> + <code></code><p></p> + </div> + + </div> + </div> + + </div> + <a id="method_addItem"></a> + <div class="element clickable method public method_addItem" data-toggle="collapse" data-target=".method_addItem .collapse"> + <h2>Adds an Item object to the singleton's Inventory from session.</h2> + <pre>addItem(\Item $item) : array</pre> + <div class="labels"> + <span class="label">static</span> </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + </table> + + <h3>Arguments</h3> + <div class="subelement argument"> + <h4>$item</h4> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to add to the Inventory</p></p> + </div> + + <h3>Response</h3> + <code>array</code><p><p>Item and Item's count</p></p> + </div> + </div> + + </div> + <a id="method_addToXML"></a> + <div class="element clickable method public method_addToXML" data-toggle="collapse" data-target=".method_addToXML .collapse"> + <h2>addToXML</h2> + <pre>addToXML( $root) </pre> + <div class="labels"> + </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + <h3>Arguments</h3> + <div class="subelement argument"> + <h4>$root</h4> + <code></code><p></p> + </div> + + </div> + </div> + + </div> + <a id="method_created"></a> + <div class="element clickable method public method_created" data-toggle="collapse" data-target=".method_created .collapse"> + <h2>Checks if the Inventory was already created in the session</h2> + <pre>created() : boolean</pre> + <div class="labels"> + <span class="label">static</span> </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + + <h3>Response</h3> + <code>boolean</code><p><p>true if Inventory was already created, false otherwise</p></p> + </div> + </div> + + </div> + <a id="method_get"></a> + <div class="element clickable method public method_get" data-toggle="collapse" data-target=".method_get .collapse"> + <h2>Returns the Inventory from the session.</h2> + <pre>get() : \Inventory</pre> + <div class="labels"> + <span class="label">static</span> </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"><p>Implements the singleton pattern.</p></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + + <h3>Response</h3> + <code><a href="../classes/Inventory.html">\Inventory</a></code><p><p>the Inventory object</p></p> + </div> + </div> + + </div> + <a id="method_removeItem"></a> + <div class="element clickable method public method_removeItem" data-toggle="collapse" data-target=".method_removeItem .collapse"> + <h2>removeItem</h2> + <pre>removeItem( $item) </pre> + <div class="labels"> + <span class="label">static</span> </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + <h3>Arguments</h3> + <div class="subelement argument"> + <h4>$item</h4> + <code></code><p></p> + </div> + + </div> + </div> + + </div> + <a id="method_sendContent"></a> + <div class="element clickable method public method_sendContent" data-toggle="collapse" data-target=".method_sendContent .collapse"> + <h2>Returns the Inventory's content from the session.</h2> + <pre>sendContent() : array</pre> + <div class="labels"> + <span class="label">static</span> </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + + <h3>Response</h3> + <code>array</code><p><p>array of Items and number</p></p> + </div> + </div> + + </div> + <a id="method_useItem"></a> + <div class="element clickable method public method_useItem" data-toggle="collapse" data-target=".method_useItem .collapse"> + <h2>useItem</h2> + <pre>useItem( $item) </pre> + <div class="labels"> + <span class="label">static</span> </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + <h3>Arguments</h3> + <div class="subelement argument"> + <h4>$item</h4> + <code></code><p></p> + </div> + + </div> + </div> + + </div> + + + <h3><i class="icon-custom icon-property"></i> Properties</h3> + <a id="property_items"> </a> + <div class="element clickable property public property_items" data-toggle="collapse" data-target=".property_items .collapse"> + <h2>Arrays of array with Item and Item's count</h2> + <pre>items : </pre> + <div class="labels"> + </div> + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + <h3>Type(s)</h3> + <code></code> + </div> + </div> + </div> + </div> + </div> + <a id="\Inventory"></a> + <ul class="breadcrumb"> + <li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li> + + + <li><span class="divider">\</span><a href="../namespaces/default.html">\</a></li> + + <li class="active"><span class="divider">\</span><a href="../classes/Inventory.html">Inventory</a></li> + </ul> + </div> + </div> + + </div> + + <footer class="span12"> + Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by + <a href="http://glyphicons.com/">Glyphicons</a>.<br/> + Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/> + generated on Sun, 08 May 2016 20:44:21 +0200.<br/> + </footer> + </body> +</html> |