Define the WormUtils class which holds the utility functions.
More...
Static Public Member Functions |
static function | ListToTableEntry (table, table_entry, list) |
| Convert an AIList to an array then store that in a table.
|
static function | TableEntryToList (table, table_entry, list) |
| Convert a table entry containing an array to an AIList.
|
Detailed Description
Define the WormUtils class which holds the utility functions.
Member Function Documentation
function WormUtils::ListToTableEntry |
( |
table |
, |
|
|
table_entry |
, |
|
|
list |
|
|
) |
| |
|
static |
Convert an AIList to an array then store that in a table.
If the AIList is null nothing is stored.
- Parameters
-
table | The table to store the AIList in. |
table_entry | The string representation of the row in the table where the AIList should be saved to. |
list | The AIList to be stored. |
- Returns
- Boolean: true when the AIList was stored in the table, otherwise false.
- Precondition
- table should be a valid table, table_entry should be a valid non empty string.
function WormUtils::TableEntryToList |
( |
table |
, |
|
|
table_entry |
, |
|
|
list |
|
|
) |
| |
|
static |
Convert a table entry containing an array to an AIList.
- Parameters
-
table | The table to load the AIList from. |
table_entry | The string representation of the row in the table where the AIList was stored. |
list | The AIList where the data from the table entry should be saved to. |
- Returns
- Boolean: true when table_entry was found in table, otherwise false.
- Precondition
- table should be a valid table, table_entry should be a valid non empty string, list should be a valid AIList.
The documentation for this class was generated from the following file: