Class HV_WDDX_Metadata

HV_WDDX_Metadata
public class HV_WDDX_Metadata

Manage data described in WDDX format.

Constructor Summary
HV_WDDX_Metadata(var $mode, var $options)
          Initiliase error handling.
 
Method Summary
 unknown HV_WDDX_Metadata_pregreplace(var $match)
          Converts <char code=""/> embedded in WDDX into characters for display.
 unknown parse(var $data, var $validate)
          Insert $data into config and optionally validate.
 unknown populate(var $data)
          Insert $data into WDDX config and grab options from database if specified.
 unknown setConfig(var $conf)
          Set WDDX configuration.
 unknown setOptionDatabase(var $db)
          Set database for populating option lists.
 

Constructor Detail

HV_WDDX_Metadata

public HV_WDDX_Metadata(var $mode,
                        var $options)
Initiliase error handling. Refer to PEAR documentation for information regarding error handling.
Parameters:
$mode - Default Value: PEAR_ERROR_TRIGGER
$options - Default Value: E_USER_ERROR
Method Detail

HV_WDDX_Metadata_pregreplace

public unknown HV_WDDX_Metadata_pregreplace(var $match)
Converts <char code=""/> embedded in WDDX into characters for display.

parse

public unknown parse(var $data,
                     var $validate)
Insert $data into config and optionally validate.
Parameters:
$validate - Default Value: HV_WDDX_METADATA_DO_VALIDATION

populate

public unknown populate(var $data)
Insert $data into WDDX config and grab options from database if specified.
Parameters:
$data - Default Value: NULL

setConfig

public unknown setConfig(var $conf)
Set WDDX configuration. Format follows WDDX specification - see www.openwddx.org.
Typical format is as follows: 
   <var name="{Name of field}"><struct>
     <var name="name"><string>{Name of field - same as above}</string></var>
      <var name="type"><string>{type of field}</string></var>
      <var name="description"><string>{Description of field}</string></var>
      <var name="node-attribute"><array>
      <struct>
        <var name="name"><string>{Display attribute name}</string></var>
        <var name="value"><string>{Display attribute value}</string></var>
     </struct>
     </array></var>
     <var name="validation-regexp"><string>{Regular expression for validation}</string></var>
     <var name="validation-message"><string>{Message if there is a validation error}</string></var>
   </struct></var>
Type of field includes:
text = text field
date = date picker
time = time picker
textbox = multiline text area
radio = radio buttons
popup = popup list
select = multiselect list
checkbox = checkbox
checklist = combination of multiselect list with checkbox

Refer to examples for more details of usage.

setOptionDatabase

public unknown setOptionDatabase(var $db)
Set database for populating option lists.
Parameters:
$db - is passed by reference