Class: I2CE CachedForm (4.1.12)

For other versions, see Class: I2CE_CachedForm (versions) .

This article describes the class I2CE_CachedForm .

• Extends the class: I2CE_Fuzzy.
• Location: Part of the module CachedForms in the package I2CE 4.1.12-release
• Source: Defined in the file modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 29
• Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_CachedForm

Variables

$form

The form we are caching

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 33
• Type: protected string $form

$database

the database name (unquoted)

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 38
• Type: protected string $database

$table_name

the table name for this form.

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 42
• Type: protected string $table_name

$short_table_name

the table name for this form without quotes and without the databse

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 46
• Type: protected string $short_table_name

$last_entry_database

the database name (unquoted) where last_entry is

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 50
• Type: protected string $last_entry_database

$formObj

An instance of the form object

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 56
• Type: protected I2CE_Form $formObj

$formMech

An instance of the form storage mechansim for the form

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 61
• Type: protected I2CE_FormStorage_Mechanism $formMech

Methods

__construct()

The constructor

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 68
• Signature: public function __construct($form)
• Parameters:
  • string $form
    The form we wish to cash into a table

createCacheTable()

setup of the queries used to create and populate the cached table

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 562
• Signature: protected function createCacheTable()
• Returns: boolean.
  True on success, false on error

dropTable()

Drops the existing cached table from the database

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 248
• Signature: public function dropTable()
• Returns: boolean

fastPopulate()

Method used to populate the cache table in case the form storage mechanism is DB like

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 407
• Signature: protected function fastPopulate($check_mod,$id)
• Parameters:
  • boolean $check_mod
    Defaults to true. If false, it skips the mod time check
    • Default Value: true
  • mixed $id
    The id to limit for the caching
    • Default Value: null

generateCachedTable()

Generates the cahced table for the form

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 368
• Signature: public function generateCachedTable($check_stale,$check_dirty)
• Parameters:
  • boolean $check_stale
    Defaults to true. If false, it skips the staleness check
    • Default Value: true
  • boolean $check_dirty
    Defaults to true. If false, it skips the dirtiness check
    • Default Value: true

getCacheDatabase()

Get the name of the database that the cached tables are stored in.

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 116
• Signature: static public function getCacheDatabase()
• Returns: string
  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.

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 132
• Signature: static public function getCachedTableName($form,$withDB,$table_prefix)
• Parameters:
  • string $form
  • boolean $withDB
    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: string

getIDs()

Get the id's of the cached forms.

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 99
• Signature: public function getIDs()

getLastCachedTime()

Get the last time that this form was chached

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 161
• Signature: public function getLastCachedTime()

getStaleTime()

Get the time the cached form is considered stale

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 176
• Signature: public function getStaleTime()
• Returns: int
  the number of seconds for this form to be considered stale. if 0 it is considered to be always stale

isStale()

Checks to see if the cached table is stale

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 217
• Signature: public function isStale()
• Returns: boolean

slowPopulate()

Method used to populate the cache table in case the form storage mechanism is not DB like

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 476
• Signature: protected function slowPopulate($check_mod,$id)
• Parameters:
  • boolean $check_mod
    Defaults to true. If false, it skips the mod time check
    • Default Value: true
  • mixed $id
    The id to limit for the caching
    • Default Value: null

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.

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 267
• Signature: public function tableExists()
• Returns: boolean

updateCachedTable()

Updates the cached table if it exists with a given record.

• Defined in i2ce/modules/Forms/modules/CachedForms/lib/I2CE_CachedForm.php on line 345
• Signature: public function updateCachedTable($id,$check_mod)
• Parameters:
  • mixed $id
    The id of the form to be updated in the cache.
  • boolean $check_mod
    Also only update based on the last modified time for the entire form cache. Defaults to false.
    • Default Value: false
• Returns: boolean

Inherited Methods

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()