From 1e52affe15fb13e920f8942de998073238be6d01 Mon Sep 17 00:00:00 2001 From: piernov Date: Mon, 9 May 2016 14:05:50 +0200 Subject: Finish Inventory PHPDoc --- doc/phpdoc/classes/Inventory.html | 135 ++++++++++---------------------------- 1 file changed, 35 insertions(+), 100 deletions(-) (limited to 'doc/phpdoc/classes/Inventory.html') diff --git a/doc/phpdoc/classes/Inventory.html b/doc/phpdoc/classes/Inventory.html index 48730e5..18149d5 100644 --- a/doc/phpdoc/classes/Inventory.html +++ b/doc/phpdoc/classes/Inventory.html @@ -124,8 +124,8 @@
  • - - 
    addToXML
    +     + Generates an XML tree describing the Inventory
    addToXML
    • @@ -142,8 +142,8 @@
  • - - 
    removeItem
    +     + Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count.
    removeItem
    • @@ -154,8 +154,8 @@
  • - - 
    useItem
    +     + Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0.
    useItem
    • @@ -173,13 +173,13 @@
  • - - 
    _removeItem
    +     + Removes an Item object from the Inventory, not taking into account the Item's count.
    _removeItem
  • - - 
    _useItem
    +     + Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0.
    _useItem
    • @@ -264,8 +264,8 @@
    -

    _removeItem

    - 
    _removeItem( $item)
    +

    Removes an Item object from the Inventory, not taking into account the Item's count.

    + 
    _removeItem(\Item $item) : void
    @@ -275,26 +275,12 @@
    - - - - - - - -
    - - -
    - - -

    Arguments

    $item

    -

    + \Item

    Item to remove from the Inventory

    @@ -303,8 +289,8 @@
    -

    _useItem

    - 
    _useItem( $item)
    +

    Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0.

    + 
    _useItem(\Item $item) : array|false
    @@ -314,28 +300,16 @@
    - - - - - - - -
    - - -
    - - -

    Arguments

    $item

    -

    + \Item

    Item to consume from the Inventory

    +

    Response

    + array|false

    Item and updated Item's count, false if it was not found

    @@ -369,8 +343,8 @@
    -

    addToXML

    - 
    addToXML( $root)
    +

    Generates an XML tree describing the Inventory

    + 
    addToXML(\SimpleXMLElement $root) : void
    @@ -380,26 +354,12 @@
    - - - - - - - -
    - - -
    - - -

    Arguments

    $root

    -

    + \SimpleXMLElement

    root XML element to add the Inventory's Items to

    @@ -466,8 +426,8 @@
    -

    removeItem

    - 
    removeItem( $item)
    +

    Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count.

    + 
    removeItem(\Item $item) : void
    static
    @@ -477,26 +437,12 @@
    - - - - - - - -
    - - -
    - - -

    Arguments

    $item

    -

    + \Item

    Item to remove from the Inventory

    @@ -534,8 +480,8 @@
    -

    useItem

    - 
    useItem( $item)
    +

    Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0.

    + 
    useItem(\Item $item) : array|false
    static
    @@ -545,28 +491,16 @@
    - - - - - - - -
    - - -
    - - -

    Arguments

    $item

    -

    + \Item

    Item to consume from the Inventory

    +

    Response

    + array|false

    Item and updated Item's count, false if it was not found

    @@ -576,8 +510,8 @@

    Properties

    -

    Arrays of array with Item and Item's count

    - 
    items :
    +

    Arrays of array with Item object and Item's count as int

    + 
    items : array
    @@ -587,15 +521,16 @@
    - + var +

    Arrays of array with Item object and Item's count as int

    Type(s)

    - + array
    @@ -619,7 +554,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Sun, 08 May 2016 20:44:21 +0200.
    + generated on Mon, 09 May 2016 14:01:23 +0200.
    -- cgit v1.2.3-54-g00ecf