inPhorm

Table of Contents

1. Introduction
2. Public Methods

Introduction

The main phorm class implements several methods that are made available to you to get information about the state of your form.

Public Methods

function phorm ($values = NULL)

This is the constructor for the phorm class. This should always be called from the constructor of your child class. It optionally takes an associative array of default values for your form where the array keys are the names of your components. This array of default values takes precedence over any default values specified in your form definition.

function add_comp($name, $comp)

This method allows you to add components to your form at run time. The add_comp method takes two arguments, the name of the component to add, and an array containing the configuration for the component. This method returns TRUE if the add succeeds or FALSE if a component with the given name already exists.

function remove_comp($name)

This method allows you to remove components at run time and takes the name of the component to remove as it's only argument. This method returns TRUE if a component is removed or FALSE if the component you tried to remove doesn't exist.

function edit_comp($comp_name, $key, $value)

This method allows you to edit a component's configuration. The three arguments are the component's name, the configuration key, and the value. This method will return TRUE if the component's value is successfully changed or return FALSE if the component whose configuration you tried to change doesn't exist.

function conf ($name, $value = NULL)

This method allows you to get and set configuration values for the form, such as the language and template style. The value argument is optional. If no value is supplied, the method will return the value of the configuration setting. If a value is supplied, the method will set the value of the configuration setting.

function data ($name)

This method returns the entire definiton array for the given component name, or for all components if no name is given. Generally, you won't need to make use of this method (it's mainly for internal use).

function display ()

This method displays your form.

function template ($name)

Returns the template file name for a given component, or all components if no name is specified. Like the data() method, this is mainly for internal use.

function to_string ($name)

This attempts to represent the value of a component as a simple, human readable string. If no component name is specified, it will return an associative array containing the to_string values for all of the components. Do NOT use this to get the value of a component - for that, use the value() method.

function validate ()

Attempts to validate all of the components. Returns TRUE if all of the components validated without error, or FALSE if there was an error.

function value ($name)

Returns the value of a given component (which could be a simple scalar0 or an array, depending on the component), or an array of name => value pairs if no component name is specified.

Powered By