|
|
| (19 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class ''I2CE_CachedForm''.
| | #REDIRECT [[Class: I2CE_CachedForm (4.1.12)]] |
| *Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
| |
| *Location: Part of the module [[iHRIS Module List#CachedForms|CachedForms]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_CachedForm | |
| ==Variables==
| |
| ===$form===
| |
| The form we are caching
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| | |
| ===$database===
| |
| the database name (unquoted)
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $database
| |
| | |
| ===$table_name===
| |
| the table name for this form.
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $table_name
| |
| | |
| ===$short_table_name===
| |
| the table name for this form without quotes and without the databse
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $short_table_name
| |
| | |
| ===$last_entry_database===
| |
| the database name (unquoted) where last_entry is
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $last_entry_database
| |
| | |
| ===$formObj===
| |
| An instance of the form object
| |
| *Type: protected [[Class: I2CE_Form | I2CE_Form]] $formObj
| |
| | |
| ===$formMech===
| |
| An instance of the form storage mechansim for the form
| |
| *Type: protected [[Class: I2CE_FormStorage_Mechanism | I2CE_FormStorage_Mechanism]] $formMech
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| The constructor
| |
| *Signature: public function __construct($form)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>The form we wish to cash into a table
| |
| ===createCacheTable()===
| |
| setup of the queries used to create and populate the cached table
| |
| *Signature: protected function createCacheTable()
| |
| *Returns: boolean.<br/>True on success, false on error
| |
| ===createTable()===
| |
| Create the cached table if does not exist and does not have the correct columns
| |
| *Signature: protected function createTable()
| |
| ===dropTable()===
| |
| Drops the existing cached table from the database
| |
| *Signature: public function dropTable()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===fastPopulate()===
| |
| Method used to populate the cache table in case the form storage mechanism is DB like
| |
| *Signature: protected function fastPopulate()
| |
| ===generateCachedTable()===
| |
| Generates the cahced table for the form
| |
| *Signature: public function generateCachedTable($check_stale)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $check_stale <br/>Defaults to true. If false, it skips the staleness check
| |
| ***Default Value: true
| |
| ===getCacheDatabase()===
| |
| Get the name of the database that the cached tables are stored in.
| |
| *Signature: static public function getCacheDatabase()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The string may be empty meaning that we are using the database for the DB connection
| |
| ===getCachedTableName()===
| |
| Get the name of the cached table for the specfiied form.
| |
| *Signature: static public function getCachedTableName($form,$withDB,$table_prefix)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $withDB <br/>defaults to true. If true we return the table in the form `database_name`.`table_name`. Otherwise we return simplt table_name
| |
| ***Default Value: true
| |
| **$table_prefix
| |
| ***Default Value: ''
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getIDs()===
| |
| Get the id's of the cached forms.
| |
| *Signature: public function getIDs()
| |
| ===isStale()===
| |
| Checks to see if the cached table is stale
| |
| *Signature: public function isStale()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===slowPopulate()===
| |
| Method used to populate the cache table in case the form storage mechanism is not DB like
| |
| *Signature: protected function slowPopulate()
| |
| ===tableExists()===
| |
| Check to see if the cached table for this table exists and has the the proper fields for its columns. If it is invalud, it will drop the table.
| |
| *Signature: public function tableExists()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ==Inherited Methods==
| |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
