Generates variable keys for need of PVFREE. More...

Inheritance diagram for Pvfree_Variable_Key_Generator:

Public Member Functions
	generate ($identificator)
	Generated variable key from given member ID.
	errorCheck ($var_key)
	If errorCheckAvailable() is TRUE that this method may be used for error detection.
	errorCheckAvailable ()
	Is generator capable of error checking.
	errorCorrectionAvailable ()
	Is generator capable of error correction.
Public Member Functions inherited from Variable_Key_Generator
	errorCorrection ($var_key)
	If errorCorrectionAvaiable() is TRUE than this method may be used for error correction of the variable symbol.

Additional Inherited Members
Static Public Member Functions inherited from Variable_Key_Generator
static	factory ($driver=NULL)
	Factory for Variable key drivers.
static	get_driver_name ($driver)
	Gets name of driver.
static	get_drivers ()
	Gets drivers array.
static	get_drivers_for_dropdown ()
	Gets drivers array for dropdown.
static	get_active_driver ()
	Gets list of active drivers for selectboxes.
Public Attributes inherited from Variable_Key_Generator
const	DIR = 'variable_key_generators'
	Dir with classes.

Detailed Description

Generates variable keys for need of PVFREE.

To a given ID (member ID) is appended a hashed version of this ID.

Member Function Documentation

Pvfree_Variable_Key_Generator::errorCheck ( $var_key )

If errorCheckAvailable() is TRUE that this method may be used for error detection.

It is only capable of detection, no correction is available here.

Override this method in a subclass in order to implement error detection for your generator.

Parameters

string $var_key Variable key

Returns: boolean TRUE is the given variable key is without errors or FALSE otherwise

Pvfree_Variable_Key_Generator::errorCheckAvailable ( )

Is generator capable of error checking.

Pvfree_Variable_Key_Generator::errorCorrectionAvailable ( )

Is generator capable of error correction.

Pvfree_Variable_Key_Generator::generate ( $identificator )

Generated variable key from given member ID.

Parameters

mixed $identificator Indentificator for generate from

The documentation for this class was generated from the following file: