From 4a77dbec06bf7812fa6326cb103dce52144e49c3 Mon Sep 17 00:00:00 2001 From: piernov Date: Tue, 10 May 2016 23:12:04 +0200 Subject: Update phpdoc --- doc/phpdoc/classes.svg | 22 +- doc/phpdoc/classes/Inventory.html | 2 +- doc/phpdoc/classes/Item.html | 2 +- doc/phpdoc/classes/Monster.html | 33 ++- doc/phpdoc/deprecated.html | 2 +- doc/phpdoc/errors.html | 93 +++++-- doc/phpdoc/graph_class.html | 2 +- doc/phpdoc/index.html | 6 +- doc/phpdoc/markers.html | 85 +++--- doc/phpdoc/namespaces/default.html | 188 ++++++++++++-- doc/phpdoc/packages/Default.html | 2 +- doc/phpdoc/packages/default.html | 399 ++++++++++++++++------------- doc/phpdoc/packages/inc.Inventory.inc.html | 2 +- doc/phpdoc/packages/inc.Item.inc.html | 2 +- doc/phpdoc/packages/inc.Monster.inc.html | 2 +- doc/phpdoc/packages/inc.account.inc.html | 2 +- doc/phpdoc/packages/inc.craftmine.inc.html | 2 +- doc/phpdoc/packages/inc.dungeon.inc.html | 2 +- doc/phpdoc/packages/inc.guild.inc.html | 9 +- doc/phpdoc/packages/inc.html | 399 ++++++++++++++++------------- doc/phpdoc/packages/inc.messages.inc.html | 2 +- doc/phpdoc/packages/inc.mine.inc.html | 8 +- doc/phpdoc/packages/inc.perso.inc.html | 26 +- doc/phpdoc/packages/inc.savegame.inc.html | 2 +- doc/phpdoc/packages/inc.shop.inc.html | 2 +- 25 files changed, 792 insertions(+), 504 deletions(-) diff --git a/doc/phpdoc/classes.svg b/doc/phpdoc/classes.svg index 7422c49..e64f82f 100644 --- a/doc/phpdoc/classes.svg +++ b/doc/phpdoc/classes.svg @@ -13,20 +13,20 @@ Global + +\\Monster + +Monster + -\\Inventory - -Inventory +\\Inventory + +Inventory -\\Item - -Item - - -\\Monster - -Monster +\\Item + +Item diff --git a/doc/phpdoc/classes/Inventory.html b/doc/phpdoc/classes/Inventory.html index 18149d5..d8918b9 100644 --- a/doc/phpdoc/classes/Inventory.html +++ b/doc/phpdoc/classes/Inventory.html @@ -554,7 +554,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor and
- generated on Mon, 09 May 2016 14:01:23 +0200.
+ generated on Tue, 10 May 2016 23:11:53 +0200.
diff --git a/doc/phpdoc/classes/Item.html b/doc/phpdoc/classes/Item.html index eab07f2..210ae23 100644 --- a/doc/phpdoc/classes/Item.html +++ b/doc/phpdoc/classes/Item.html @@ -477,7 +477,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor and
- generated on Mon, 09 May 2016 14:01:23 +0200.
+ generated on Tue, 10 May 2016 23:11:53 +0200.
diff --git a/doc/phpdoc/classes/Monster.html b/doc/phpdoc/classes/Monster.html index 859dead..cc6417e 100644 --- a/doc/phpdoc/classes/Monster.html +++ b/doc/phpdoc/classes/Monster.html @@ -187,7 +187,7 @@

Monster's constructor

- 
__construct(string $name, integer $level, integer $hp, integer $xp, string $icon) : void
+ 
__construct(string $name, integer $level, integer $hp, integer $xp, integer $power, string $icon) : void
@@ -215,6 +215,10 @@

$xp

integer

Exp given by the Monster

+
+
+

$power

+ integer

Monster's power

$icon

@@ -383,6 +387,31 @@ integer
+ + +
+

power

+ 
power :
+
+
+
+
+
+ + + + + + +
+ + +
+ +

Type(s)

+ +
+
@@ -404,7 +433,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor and
- generated on Mon, 09 May 2016 14:01:23 +0200.
+ generated on Tue, 10 May 2016 23:11:53 +0200.
diff --git a/doc/phpdoc/deprecated.html b/doc/phpdoc/deprecated.html index 9aaf18f..8772708 100644 --- a/doc/phpdoc/deprecated.html +++ b/doc/phpdoc/deprecated.html @@ -120,7 +120,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
Documentation is powered by phpDocumentor and
- generated on Mon, 09 May 2016 14:01:23 +0200.
+ generated on Tue, 10 May 2016 23:11:53 +0200.
diff --git a/doc/phpdoc/errors.html b/doc/phpdoc/errors.html index 6d6d671..c382529 100644 --- a/doc/phpdoc/errors.html +++ b/doc/phpdoc/errors.html @@ -108,14 +108,15 @@
  • Navigation
    • -
  • upload.php
    • -
  • craftmine.php
    • -
  • inc/Inventory.inc
    • -
  • inc/shop.inc
    • -
  • inc/perso.inc
    • -
  • inc/Item.inc
    • +
  • craftmine.php
    • +
  • upload.php
  • inc/Monster.inc
    • - +
  • inc/Inventory.inc
    • +
  • inc/shop.inc
    • +
  • inc/perso.inc
    • +
  • inc/Item.inc
    • +
  • inc/guild.inc
    • +
    @@ -125,6 +126,32 @@ +
    + +

    + + craftmine.php + 1 +

    +
    + + + + + + + + + + + + + + + +
    TypeLineDescription
    error0No summary was found for this file
    +
    +

    @@ -152,11 +179,11 @@

    - +

    - craftmine.php - 1 + inc/Monster.inc + 2

    @@ -172,11 +199,20 @@ + + + + +
    error 0 No summary was found for this file
    error39No summary for property $power
    +
    +
    +
    +

    @@ -209,8 +245,6 @@

    -
    -

    @@ -237,18 +271,12 @@

    -
    -
    -
    -
    -
    -

    inc/perso.inc - 1 + 4

    @@ -264,6 +292,21 @@ + + + + + + + + + + + + + + +
    error 27 Argument $num is missing from the Docblock of increasePerso
    error43Argument $item is missing from the Docblock of limitUse
    error60No summary for function \initUsedItem()
    error69No summary for function \reusable()
    @@ -296,10 +339,10 @@
    - +

    - inc/Monster.inc + inc/guild.inc 1

    @@ -314,13 +357,15 @@ error - 0 - No summary was found for this file + 19 + No summary for function \initMinersIfNeeded()
    +
    +
    @@ -329,7 +374,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/graph_class.html b/doc/phpdoc/graph_class.html index 068a2e8..4b4374a 100644 --- a/doc/phpdoc/graph_class.html +++ b/doc/phpdoc/graph_class.html @@ -121,7 +121,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/index.html b/doc/phpdoc/index.html index 1c76dcf..735f4d4 100644 --- a/doc/phpdoc/index.html +++ b/doc/phpdoc/index.html @@ -129,7 +129,7 @@
  • Reports
  • - Errors 7 + Errors 12
    • @@ -141,7 +141,7 @@
  • - Markers 7 + Markers 6
    • @@ -155,7 +155,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/markers.html b/doc/phpdoc/markers.html index 4765760..5a397b1 100644 --- a/doc/phpdoc/markers.html +++ b/doc/phpdoc/markers.html @@ -99,11 +99,10 @@
    +
  • inc/Monster.inc
    • +
  • inc/dungeon.inc
    • +
  • inc/shop.inc
    • +
    @@ -115,12 +114,12 @@
    -
    - +
    +

    - inc/dungeon.inc - 3 + inc/Monster.inc + 1

    @@ -131,28 +130,18 @@ - - - - - - - - - - - - + +
    TODO21again, cost is a string?
    TODO42is the $_SESSION["dungeon"] array useful (and created beforehand)?
    TODO69Account was already debited23unused
    -
    - +
    +

    - inc/shop.inc - 2 + inc/dungeon.inc + 3

    @@ -164,44 +153,27 @@ - + - - + + -
    TODO 22handle errorsagain, cost is a string?
    TODO23cost is a string?44is the $_SESSION["dungeon"] array useful (and created beforehand)?
    -
    -
    -
    - -

    - - inc/Item.inc - 1 -

    -
    - - - - - - - - + +
    TypeLineDescription
    TODO66do something with power71Account was already debited
    -
    - +
    +

    - inc/Monster.inc - 1 + inc/shop.inc + 2

    @@ -212,13 +184,18 @@ + + + + + - +
    TODO22handle errors
    TODO 23unusedcost is a string?
    -
    +
    @@ -227,7 +204,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/namespaces/default.html b/doc/phpdoc/namespaces/default.html index 87e1895..4e502d4 100644 --- a/doc/phpdoc/namespaces/default.html +++ b/doc/phpdoc/namespaces/default.html @@ -700,8 +700,42 @@ « More » -
    -

    initCraftMine

    +
    +

    initDungeon

    +

    Marks the dungeon as accessible in the session.

    +
    + +
    +
    +
    + + + + + + + + + + +
    + package + + +

    inc\dungeon.inc

    +
    + + +
    + + +
    +
    +
    + « More »
    + +
    +

    initMineIfNeeded

    Initializes the gold amount and miners count in the session.

    @@ -732,11 +766,11 @@
    - « More » + « More » -
    -

    initDungeon

    -

    Marks the dungeon as accessible in the session.

    +
    +

    initMinersIfNeeded

    +

    @@ -750,7 +784,7 @@ -

    inc\dungeon.inc

    +

    inc\guild.inc

    @@ -766,7 +800,7 @@
    - « More »
    + « More »

    initPerso

    @@ -836,6 +870,40 @@
    « More » +
    +

    initUsedItem

    +

    +
    + +
    +
    +
    + + + + + + + + + + +
    + package + + +

    inc\perso.inc

    +
    + + +
    + + +
    +
    +
    + « More »
    +

    launchDungeon

    Sends monsters for a specific floor as specified by the floor POST parameter to the client.

    @@ -870,6 +938,48 @@
    « More » +
    +

    limitUse

    +

    traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1

    +
    + +
    +
    +
    + + + + + + + + + + +
    + package + + +

    inc\perso.inc

    +
    + + +
    + +

    Arguments

    +
    +

    $item

    +

    +
    + +
    +
    +
    + « More »
    +

    listSaves

    Sends the list of available saves to the client.

    @@ -1044,6 +1154,40 @@
    « More » +
    +

    reusable

    +

    +
    + +
    +
    +
    + + + + + + + + + + +
    + package + + +

    inc\perso.inc

    +
    + + +
    + + +
    +
    +
    + « More »
    +

    saveGame

    Save the XML save tree as an XML file named after the results of genFilename in SAVEDIR.

    @@ -1580,6 +1724,19 @@ XML errors are simply ignored and an error is sent to the client if something wr

    Constants

    +
    +

    SAVEDIR

    +

    Directory to save to and load from.

    +
    +

    The PHP/Apache user must have write permission on this directory. +Use the following commands to give write permissions to the http group:

    + +sudo chown :http data/save +sudo chmod g+w data/save + +
    + « More »
    +

    GUILD_COST

    Amount of gold required to build the miners guild.

    @@ -1596,19 +1753,6 @@ XML errors are simply ignored and an error is sent to the client if something wr
    « More »
    -
    -

    SAVEDIR

    -

    Directory to save to and load from.

    -
    -

    The PHP/Apache user must have write permission on this directory. -Use the following commands to give write permissions to the http group:

    - -sudo chown :http data/save -sudo chmod g+w data/save - -
    - « More »
    -
    @@ -1650,7 +1794,7 @@ sudo chmod g+w data/save Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/Default.html b/doc/phpdoc/packages/Default.html index 0caa25c..dd17cc6 100644 --- a/doc/phpdoc/packages/Default.html +++ b/doc/phpdoc/packages/Default.html @@ -154,7 +154,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/default.html b/doc/phpdoc/packages/default.html index 5b519ce..f49f437 100644 --- a/doc/phpdoc/packages/default.html +++ b/doc/phpdoc/packages/default.html @@ -308,7 +308,7 @@
  • - \Inventory.inc + \Monster.inc
    • @@ -320,11 +320,11 @@

    Classes, interfaces and traits

    -
    -

    Inventory

    -

    Represent the player's Inventory.

    -
    Implemented as a singleton in the session.
    - « More » +
    +

    Monster

    +

    Represent an Item in the shop or in the Inventory.

    +
    + « More »
    @@ -342,7 +342,7 @@
  • - \dungeon.inc + \craftmine.inc
    • @@ -350,53 +350,11 @@

    Functions

    -
    -

    generateMonster

    -

    Loads all the dungeon's monsters from the XML file data/monsters.xml.

    -
    - « More » -
    - -
    -

    initDungeon

    -

    Marks the dungeon as accessible in the session.

    -
    - « More » -
    - -
    -

    sendDungeon

    -

    Returns the dungeon array if it was created.

    -
    - « More » -
    - -
    -

    buildDungeon

    -

    Allows acces to the dungeon in the session and sends it to the client.

    -
    Debits the dungeon's ticket cost from the player's gold.
    - « More » -
    - -
    -

    launchDungeon

    -

    Sends monsters for a specific floor as specified by the floor POST parameter to the client.

    -
    - « More » -
    - -
    -

    sendDungeonProgress

    -

    Updates floor and monster number from the POST parameters in the session.

    -
    - « More » -
    - -
    -

    exitDungeon

    -

    Marks the dungeon as not accessible in the session.

    -
    - « More » +
    +

    sendCraftMine

    +

    Sends all data from previous session on page load.

    +
    All data from the different modules are packed in an array.
    + « More »
    @@ -462,55 +420,26 @@
  • - \guild.inc + \Inventory.inc
    • -
    -

    Functions

    -
    -

    createGuild

    -

    Create the miners guild in the session.

    -
    Debits GUILD_COST from the player's gold.
    - « More » -
    - -
    -

    hireMiner

    -

    Hire one miner.

    -
    Debits MINER_COST from the player's gold.
    - « More » -
    - -
    -

    sendMiners

    -

    Returns the number of miners currently in the guild.

    -
    - « More » -
    - -
    +
    -

    Constants

    -
    -

    GUILD_COST

    -

    Amount of gold required to build the miners guild.

    -
    - « More » -
    - -
    -

    MINER_COST

    -

    Amount of gold required to hire a miner.

    -
    - « More » +

    Classes, interfaces and traits

    + + +
    +

    Inventory

    +

    Represent the player's Inventory.

    +
    Implemented as a singleton in the session.
    + « More »
    - @@ -637,7 +566,7 @@ sudo chmod g+w data/save
  • - \shop.inc + \dungeon.inc
    • @@ -645,53 +574,53 @@ sudo chmod g+w data/save

    Functions

    -
    -

    loadShop

    -

    Loads all the shop's items from the XML file data/items.xml.

    +
    +

    generateMonster

    +

    Loads all the dungeon's monsters from the XML file data/monsters.xml.

    - « More » + « More »
    -
    -

    getItem

    -

    Gets an Item object from the shop from its name.

    +
    +

    initDungeon

    +

    Marks the dungeon as accessible in the session.

    - « More » + « More »
    -
    -

    initShop

    -

    Marks the shop as created in the session.

    +
    +

    sendDungeon

    +

    Returns the dungeon array if it was created.

    - « More » + « More »
    -
    -

    sendShop

    -

    Returns the shop array if it was created.

    -
    - « More » +
    +

    buildDungeon

    +

    Allows acces to the dungeon in the session and sends it to the client.

    +
    Debits the dungeon's ticket cost from the player's gold.
    + « More »
    -
    -

    buildShop

    -

    Creates the shop in the session and sends it to the client.

    -
    Debits the shop's cost from the player's gold.
    - « More » +
    +

    launchDungeon

    +

    Sends monsters for a specific floor as specified by the floor POST parameter to the client.

    +
    + « More »
    -
    -

    buyItem

    -

    Debits the item's cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.

    +
    +

    sendDungeonProgress

    +

    Updates floor and monster number from the POST parameters in the session.

    - « More » + « More »
    -
    -

    useItem

    -

    Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.

    +
    +

    exitDungeon

    +

    Marks the dungeon as not accessible in the session.

    - « More » + « More »
    @@ -711,7 +640,7 @@ sudo chmod g+w data/save
  • - \mine.inc + \account.inc
    • @@ -719,25 +648,18 @@ sudo chmod g+w data/save

    Functions

    -
    -

    initCraftMine

    -

    Initializes the gold amount and miners count in the session.

    -
    - « More » -
    - -
    -

    withdrawMine

    -

    Transfers all gold from the mine to the player's account.

    +
    +

    debitAccount

    +

    Debits the account of a certain amount of gold.

    - « More » + « More »
    -
    -

    sendMine

    -

    Returns the amount of gold currently owned by the player.

    +
    +

    creditAccount

    +

    Credits the account of a certain amount of gold.

    - « More » + « More »
    @@ -757,7 +679,7 @@ sudo chmod g+w data/save
  • - \craftmine.inc + \shop.inc
    • @@ -765,50 +687,53 @@ sudo chmod g+w data/save

    Functions

    -
    -

    sendCraftMine

    -

    Sends all data from previous session on page load.

    -
    All data from the different modules are packed in an array.
    - « More » +
    +

    loadShop

    +

    Loads all the shop's items from the XML file data/items.xml.

    +
    + « More »
    -
    - - - - - -
      -
      • - - - -
    • - \inc -
      • +
      +

      getItem

      +

      Gets an Item object from the shop from its name.

      +
      + « More » +
      - -
    • - \account.inc -
      • +
      +

      initShop

      +

      Marks the shop as created in the session.

      +
      + « More » +
      -
    +
    +

    sendShop

    +

    Returns the shop array if it was created.

    +
    + « More » +
    - -
    -

    Functions

    -
    -

    debitAccount

    -

    Debits the account of a certain amount of gold.

    +
    +

    buildShop

    +

    Creates the shop in the session and sends it to the client.

    +
    Debits the shop's cost from the player's gold.
    + « More » +
    + +
    +

    buyItem

    +

    Debits the item's cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.

    - « More » + « More »
    -
    -

    creditAccount

    -

    Credits the account of a certain amount of gold.

    +
    +

    useItem

    +

    Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.

    - « More » + « More »
    @@ -850,6 +775,30 @@ sudo chmod g+w data/save « More »
    +
    +

    limitUse

    +

    traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1

    +
    + « More » +
    + +
    +

    initUsedItem

    +

    +
    + « More » +
    + +
    +

    reusable

    +

    +
    + « More » +
    +

    updatePerso

    Copies stats given in POST request to session.

    @@ -915,26 +864,108 @@ sudo chmod g+w data/save
  • - \Monster.inc + \guild.inc
    • - +
    +

    Functions

    +
    +

    initMinersIfNeeded

    +

    +
    + « More » +
    + +
    +

    createGuild

    +

    Create the miners guild in the session.

    +
    Debits GUILD_COST from the player's gold.
    + « More » +
    + +
    +

    hireMiner

    +

    Hire one miner.

    +
    Debits MINER_COST from the player's gold.
    + « More » +
    + +
    +

    sendMiners

    +

    Returns the number of miners currently in the guild.

    +
    + « More » +
    + +
    -

    Classes, interfaces and traits

    +

    Constants

    +
    +

    GUILD_COST

    +

    Amount of gold required to build the miners guild.

    +
    + « More » +
    + +
    +

    MINER_COST

    +

    Amount of gold required to hire a miner.

    +
    + « More » +
    + +
    + + + +
      +
      • + -
      -

      Monster

      -

      Represent an Item in the shop or in the Inventory.

      + +
    • + \inc +
      • + + +
    • + \mine.inc +
      • + +
    + + +
    +

    Functions

    +
    +

    initMineIfNeeded

    +

    Initializes the gold amount and miners count in the session.

    - « More » + « More » +
    + +
    +

    withdrawMine

    +

    Transfers all gold from the mine to the player's account.

    +
    + « More » +
    + +
    +

    sendMine

    +

    Returns the amount of gold currently owned by the player.

    +
    + « More »
    + + @@ -947,7 +978,7 @@ sudo chmod g+w data/save Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.Inventory.inc.html b/doc/phpdoc/packages/inc.Inventory.inc.html index 4cc9b21..3d981d1 100644 --- a/doc/phpdoc/packages/inc.Inventory.inc.html +++ b/doc/phpdoc/packages/inc.Inventory.inc.html @@ -162,7 +162,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.Item.inc.html b/doc/phpdoc/packages/inc.Item.inc.html index bea2d41..e77eca2 100644 --- a/doc/phpdoc/packages/inc.Item.inc.html +++ b/doc/phpdoc/packages/inc.Item.inc.html @@ -162,7 +162,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.Monster.inc.html b/doc/phpdoc/packages/inc.Monster.inc.html index 234a20d..9253f84 100644 --- a/doc/phpdoc/packages/inc.Monster.inc.html +++ b/doc/phpdoc/packages/inc.Monster.inc.html @@ -162,7 +162,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.account.inc.html b/doc/phpdoc/packages/inc.account.inc.html index b77b8f4..ebe8672 100644 --- a/doc/phpdoc/packages/inc.account.inc.html +++ b/doc/phpdoc/packages/inc.account.inc.html @@ -167,7 +167,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.craftmine.inc.html b/doc/phpdoc/packages/inc.craftmine.inc.html index 3d98bbd..7d7ee1c 100644 --- a/doc/phpdoc/packages/inc.craftmine.inc.html +++ b/doc/phpdoc/packages/inc.craftmine.inc.html @@ -160,7 +160,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.dungeon.inc.html b/doc/phpdoc/packages/inc.dungeon.inc.html index a6c2668..de7994a 100644 --- a/doc/phpdoc/packages/inc.dungeon.inc.html +++ b/doc/phpdoc/packages/inc.dungeon.inc.html @@ -202,7 +202,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.guild.inc.html b/doc/phpdoc/packages/inc.guild.inc.html index ed8ab9b..d61d019 100644 --- a/doc/phpdoc/packages/inc.guild.inc.html +++ b/doc/phpdoc/packages/inc.guild.inc.html @@ -140,6 +140,13 @@

    Functions

    +
    +

    initMinersIfNeeded

    +

    +
    + « More » +
    +

    createGuild

    Create the miners guild in the session.

    @@ -191,7 +198,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.html b/doc/phpdoc/packages/inc.html index b1e32db..ad993d1 100644 --- a/doc/phpdoc/packages/inc.html +++ b/doc/phpdoc/packages/inc.html @@ -252,7 +252,7 @@
  • - \Inventory.inc + \Monster.inc
    • @@ -264,11 +264,11 @@

    Classes, interfaces and traits

    -
    -

    Inventory

    -

    Represent the player's Inventory.

    -
    Implemented as a singleton in the session.
    - « More » +
    +

    Monster

    +

    Represent an Item in the shop or in the Inventory.

    +
    + « More »
    @@ -286,7 +286,7 @@
  • - \dungeon.inc + \craftmine.inc
    • @@ -294,53 +294,11 @@

    Functions

    -
    -

    generateMonster

    -

    Loads all the dungeon's monsters from the XML file data/monsters.xml.

    -
    - « More » -
    - -
    -

    initDungeon

    -

    Marks the dungeon as accessible in the session.

    -
    - « More » -
    - -
    -

    sendDungeon

    -

    Returns the dungeon array if it was created.

    -
    - « More » -
    - -
    -

    buildDungeon

    -

    Allows acces to the dungeon in the session and sends it to the client.

    -
    Debits the dungeon's ticket cost from the player's gold.
    - « More » -
    - -
    -

    launchDungeon

    -

    Sends monsters for a specific floor as specified by the floor POST parameter to the client.

    -
    - « More » -
    - -
    -

    sendDungeonProgress

    -

    Updates floor and monster number from the POST parameters in the session.

    -
    - « More » -
    - -
    -

    exitDungeon

    -

    Marks the dungeon as not accessible in the session.

    -
    - « More » +
    +

    sendCraftMine

    +

    Sends all data from previous session on page load.

    +
    All data from the different modules are packed in an array.
    + « More »
    @@ -406,55 +364,26 @@
  • - \guild.inc + \Inventory.inc
    • -
    -

    Functions

    -
    -

    createGuild

    -

    Create the miners guild in the session.

    -
    Debits GUILD_COST from the player's gold.
    - « More » -
    - -
    -

    hireMiner

    -

    Hire one miner.

    -
    Debits MINER_COST from the player's gold.
    - « More » -
    - -
    -

    sendMiners

    -

    Returns the number of miners currently in the guild.

    -
    - « More » -
    - -
    +
    -

    Constants

    -
    -

    GUILD_COST

    -

    Amount of gold required to build the miners guild.

    -
    - « More » -
    - -
    -

    MINER_COST

    -

    Amount of gold required to hire a miner.

    -
    - « More » +

    Classes, interfaces and traits

    + + +
    +

    Inventory

    +

    Represent the player's Inventory.

    +
    Implemented as a singleton in the session.
    + « More »
    - @@ -581,7 +510,7 @@ sudo chmod g+w data/save
  • - \shop.inc + \dungeon.inc
    • @@ -589,53 +518,53 @@ sudo chmod g+w data/save

    Functions

    -
    -

    loadShop

    -

    Loads all the shop's items from the XML file data/items.xml.

    +
    +

    generateMonster

    +

    Loads all the dungeon's monsters from the XML file data/monsters.xml.

    - « More » + « More »
    -
    -

    getItem

    -

    Gets an Item object from the shop from its name.

    +
    +

    initDungeon

    +

    Marks the dungeon as accessible in the session.

    - « More » + « More »
    -
    -

    initShop

    -

    Marks the shop as created in the session.

    +
    +

    sendDungeon

    +

    Returns the dungeon array if it was created.

    - « More » + « More »
    -
    -

    sendShop

    -

    Returns the shop array if it was created.

    -
    - « More » +
    +

    buildDungeon

    +

    Allows acces to the dungeon in the session and sends it to the client.

    +
    Debits the dungeon's ticket cost from the player's gold.
    + « More »
    -
    -

    buildShop

    -

    Creates the shop in the session and sends it to the client.

    -
    Debits the shop's cost from the player's gold.
    - « More » +
    +

    launchDungeon

    +

    Sends monsters for a specific floor as specified by the floor POST parameter to the client.

    +
    + « More »
    -
    -

    buyItem

    -

    Debits the item's cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.

    +
    +

    sendDungeonProgress

    +

    Updates floor and monster number from the POST parameters in the session.

    - « More » + « More »
    -
    -

    useItem

    -

    Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.

    +
    +

    exitDungeon

    +

    Marks the dungeon as not accessible in the session.

    - « More » + « More »
    @@ -655,7 +584,7 @@ sudo chmod g+w data/save
  • - \mine.inc + \account.inc
    • @@ -663,25 +592,18 @@ sudo chmod g+w data/save

    Functions

    -
    -

    initCraftMine

    -

    Initializes the gold amount and miners count in the session.

    -
    - « More » -
    - -
    -

    withdrawMine

    -

    Transfers all gold from the mine to the player's account.

    +
    +

    debitAccount

    +

    Debits the account of a certain amount of gold.

    - « More » + « More »
    -
    -

    sendMine

    -

    Returns the amount of gold currently owned by the player.

    +
    +

    creditAccount

    +

    Credits the account of a certain amount of gold.

    - « More » + « More »
    @@ -701,7 +623,7 @@ sudo chmod g+w data/save
  • - \craftmine.inc + \shop.inc
    • @@ -709,50 +631,53 @@ sudo chmod g+w data/save

    Functions

    -
    -

    sendCraftMine

    -

    Sends all data from previous session on page load.

    -
    All data from the different modules are packed in an array.
    - « More » +
    +

    loadShop

    +

    Loads all the shop's items from the XML file data/items.xml.

    +
    + « More »
    -
    - - - - - -
      -
      • - - - -
    • - \inc -
      • +
      +

      getItem

      +

      Gets an Item object from the shop from its name.

      +
      + « More » +
      - -
    • - \account.inc -
      • +
      +

      initShop

      +

      Marks the shop as created in the session.

      +
      + « More » +
      -
    +
    +

    sendShop

    +

    Returns the shop array if it was created.

    +
    + « More » +
    - -
    -

    Functions

    -
    -

    debitAccount

    -

    Debits the account of a certain amount of gold.

    +
    +

    buildShop

    +

    Creates the shop in the session and sends it to the client.

    +
    Debits the shop's cost from the player's gold.
    + « More » +
    + +
    +

    buyItem

    +

    Debits the item's cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.

    - « More » + « More »
    -
    -

    creditAccount

    -

    Credits the account of a certain amount of gold.

    +
    +

    useItem

    +

    Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.

    - « More » + « More »
    @@ -794,6 +719,30 @@ sudo chmod g+w data/save « More »
    +
    +

    limitUse

    +

    traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1

    +
    + « More » +
    + +
    +

    initUsedItem

    +

    +
    + « More » +
    + +
    +

    reusable

    +

    +
    + « More » +
    +

    updatePerso

    Copies stats given in POST request to session.

    @@ -859,26 +808,108 @@ sudo chmod g+w data/save
  • - \Monster.inc + \guild.inc
    • - +
    +

    Functions

    +
    +

    initMinersIfNeeded

    +

    +
    + « More » +
    + +
    +

    createGuild

    +

    Create the miners guild in the session.

    +
    Debits GUILD_COST from the player's gold.
    + « More » +
    + +
    +

    hireMiner

    +

    Hire one miner.

    +
    Debits MINER_COST from the player's gold.
    + « More » +
    + +
    +

    sendMiners

    +

    Returns the number of miners currently in the guild.

    +
    + « More » +
    + +
    -

    Classes, interfaces and traits

    +

    Constants

    +
    +

    GUILD_COST

    +

    Amount of gold required to build the miners guild.

    +
    + « More » +
    + +
    +

    MINER_COST

    +

    Amount of gold required to hire a miner.

    +
    + « More » +
    + +
    + + + +
      +
      • + -
      -

      Monster

      -

      Represent an Item in the shop or in the Inventory.

      + +
    • + \inc +
      • + + +
    • + \mine.inc +
      • + +
    + + +
    +

    Functions

    +
    +

    initMineIfNeeded

    +

    Initializes the gold amount and miners count in the session.

    - « More » + « More » +
    + +
    +

    withdrawMine

    +

    Transfers all gold from the mine to the player's account.

    +
    + « More » +
    + +
    +

    sendMine

    +

    Returns the amount of gold currently owned by the player.

    +
    + « More »
    + + @@ -890,7 +921,7 @@ sudo chmod g+w data/save Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.messages.inc.html b/doc/phpdoc/packages/inc.messages.inc.html index 23ce6ad..9c8e376 100644 --- a/doc/phpdoc/packages/inc.messages.inc.html +++ b/doc/phpdoc/packages/inc.messages.inc.html @@ -174,7 +174,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.mine.inc.html b/doc/phpdoc/packages/inc.mine.inc.html index 734a429..a650551 100644 --- a/doc/phpdoc/packages/inc.mine.inc.html +++ b/doc/phpdoc/packages/inc.mine.inc.html @@ -140,11 +140,11 @@

    Functions

    -
    -

    initCraftMine

    +
    +

    initMineIfNeeded

    Initializes the gold amount and miners count in the session.

    - « More » + « More »
    @@ -174,7 +174,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.perso.inc.html b/doc/phpdoc/packages/inc.perso.inc.html index 8c471aa..a06aac3 100644 --- a/doc/phpdoc/packages/inc.perso.inc.html +++ b/doc/phpdoc/packages/inc.perso.inc.html @@ -154,6 +154,30 @@ « More »
    +
    +

    limitUse

    +

    traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1

    +
    + « More » +
    + +
    +

    initUsedItem

    +

    +
    + « More » +
    + +
    +

    reusable

    +

    +
    + « More » +
    +

    updatePerso

    Copies stats given in POST request to session.

    @@ -181,7 +205,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.savegame.inc.html b/doc/phpdoc/packages/inc.savegame.inc.html index 2ec1e2d..80fb2f5 100644 --- a/doc/phpdoc/packages/inc.savegame.inc.html +++ b/doc/phpdoc/packages/inc.savegame.inc.html @@ -240,7 +240,7 @@ sudo chmod g+w data/save Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    diff --git a/doc/phpdoc/packages/inc.shop.inc.html b/doc/phpdoc/packages/inc.shop.inc.html index 6908e0f..70efa52 100644 --- a/doc/phpdoc/packages/inc.shop.inc.html +++ b/doc/phpdoc/packages/inc.shop.inc.html @@ -202,7 +202,7 @@ Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    -- cgit v1.2.3-54-g00ecf