Class: I2CE CachedForm

This article desrcibes the class I2CE_CachedForm.

• Extends the class: I2CE_Fuzzy.
• Location: Part of the module CachedForms in the package I2CE
• Source: Defined in the file 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 string $form

$database

the database name (unquoted)

• Type: protected string $database

$table_name

the table name for this form.

• Type: protected string $table_name

$short_table_name

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

• Type: protected string $short_table_name

$last_entry_database

the database name (unquoted) where last_entry is

• Type: protected string $last_entry_database

$formObj

An instance of the form object

• Type: protected I2CE_Form $formObj

$formMech

An instance of the form storage mechansim for the form

• Type: protected I2CE_FormStorage_Mechanism $formMech

Methods

__construct()

The constructor

• 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

• Signature: protected function createCacheTable()
• Returns: boolean.
  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: 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:
  • boolean $check_stale
    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: 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.

• 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.

• Signature: public function getIDs()

isStale()

Checks to see if the cached table is stale

• Signature: public function isStale()
• Returns: 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: 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()