apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: DB_DataObject_FormBuilder

Source Location: /DB_DataObject_FormBuilder-0.10.2/FormBuilder.php

Class Overview




Variables

Methods


Child classes:

Inherited Variables

Inherited Methods


Class Details

[line 276]


[ Top ]


Class Variables

$addFormHeader =  true

[line 324]

Add a header to the form - if set to true, the form will have a header element as the first element in the form.
  • See: formHeaderText
  • Access: public

Type:   mixed


[ Top ]

$clientRules =

[line 609]

If set to true, validation rules will also be client side.

Type:   mixed


[ Top ]

$createSubmit =  true

[line 435]

If set to false, no submit button will be created for your forms. Useful when used together with QuickForm_Controller when you already have submit buttons for next/previous page. By default, a button is being generated.

Type:   mixed


[ Top ]

$crossLinks =

[line 590]

Holds cross link data.

The crossLinks array holds data pertaining to many-many links. If you have a table which links two tables together, you can use this to automatically create a set of checkboxes on your form. The simplest way of using this is:

  1.     $crossLinks = array(array('table' => 'crossLinkTable'));
Where crossLinkTable is the name of the linking table. You can have as many cross-link entries as you want. Try it with just the table ewntry first. If it doesn't work, you can specify the fields to use as well.
  1.     'fromField' => 'linkFieldToCurrentTable' //This is the field which links to the current (from) table
  2.     'toField' => 'linkFieldToLinkedTable' //This is the field which links to the "other" (to) table


Type:   mixed


[ Top ]

$crossLinkSeparator =  '<br/>'

[line 561]

The text to put between crosslink elements.

Type:   mixed


[ Top ]

$dateElementFormat =  'd-m-Y'

[line 392]

A format string that represents the display settings for QuickForm date elements.

Example: "d-m-Y". See QuickForm documentation for details on format strings. Legal letters to use in the format string that work with FormBuilder are: d,m,Y,H,i,s


Type:   mixed


[ Top ]

$dateFieldLanguage =  'en'

[line 370]

The language used in date fields. See documentation of HTML_Quickform's date element for more information.
  • See: HTML_QuickForm_date

Type:   mixed


[ Top ]

$dateFields = array()

[line 514]

A simple array of field names indicating which of the fields in a particular table/class are actually to be treated date fields. This is an unfortunate workaround that is neccessary because the DataObject generator script does not make a difference between any other datatypes than string and integer.

When it does, this can be dropped.


Type:   mixed


[ Top ]

$dateFromDatabaseCallback = array('DB_DataObject_FormBuilder','_date2array')

[line 377]

Callback method to convert a date from the format it is stored in the database to the format used by the QuickForm element that handles date values. Must have a format usable with call_user_func().

Type:   mixed


[ Top ]

$dateToDatabaseCallback = array('DB_DataObject_FormBuilder','_array2date')

[line 384]

Callback method to convert a date from the format used by the QuickForm element that handles date values to the format the database can store it in.

Must have a format usable with call_user_func().


Type:   mixed


[ Top ]

$elementTypeMap = array('shorttext' => 'text',
                                'longtext'  => 'textarea',
                                'date'      => 'date',
                                'time'      => 'time',
                                'integer'   => 'text',
                                'float'     => 'text')

[line 408]

Array to determine what QuickForm element types are being used for which

general field types. If you configure FormBuilder using arrays, the format is: array('nameOfFieldType' => 'QuickForm_Element_name', ...); If configured via .ini file, the format looks like this: elementTypeMap = shorttext:text,date:date,...

Allowed field types:

  • shorttext
  • longtext</
  • date
  • integer
  • float


Type:   mixed


[ Top ]

$enumFields = array()

[line 542]

A simple array of fields names which should be treated as ENUMs. A select box will be created with the enum options. If you add this field to the linkElementTypes array and give it a 'radio' type, you will get radio buttons instead.

The default handler for enums is only tested in mysql. If you are using a different DB backend, use enumOptionsCallback or enumOptions.


Type:   mixed


[ Top ]

$enumOptions = array()

[line 556]

An array which holds enum options for specific fields. Each key should be a field in the current table and each value holds a an array of strings which are the possible values for the enum. This will only be used if the field is listed in enumFields.

Type:   mixed


[ Top ]

$enumOptionsCallback = array()

[line 548]

A valid callback which will return the options in a simple array of strings for an enum field given the table and field names.

Type:   mixed


[ Top ]

$fieldLabels =

[line 442]

Array of field labels. The key of the element is the field name. Use this if you want to keep the auto-generated elements, but still define your own labels for them.

Type:   mixed


[ Top ]

$fieldsToRender =

[line 449]

Array of fields to render elements for. If a field is not given, it will not be rendered. If empty, all fields will be rendered (except, normally, the primary key).

Type:   mixed


[ Top ]

$formHeaderText =  null

[line 333]

Text for the form header. If not set, the name of the database table this form represents will be used.
  • See: addFormHeader
  • Access: public

Type:   mixed


[ Top ]

$hidePrimaryKey =  true

[line 496]

By default, hidden fields are generated for the primary key of a DataObject. This behaviour can be deactivated by setting this option to false.

Type:   mixed


[ Top ]

$linkDisplayFields =

[line 418]

An array of the default fields to display when creating a select box

Type:   mixed


[ Top ]

$linkDisplayLevel =  0

[line 572]

If this is set to 1 or above, links will be followed in the display fields and the display fields of the record linked to will be used for display.

If this is set to 2, links will be followed in the linked record as well. This can be set to any number of links you wish but could easily slow down your application if set to more than 1 or 2 (but only if you have links in your display fields that go that far ;-)). For a more in-depth example, see the docs for linkDisplayFields.


Type:   mixed


[ Top ]

$linkElementTypes = array()

[line 531]

Array to configure the type of the link elements. By default, a select box will be used. The key is the name of the link element. The value is 'radio' or 'select'. If you choose 'radio', radio buttons will be made instead of a select box.

Type:   mixed


[ Top ]

$linkOrderFields =

[line 423]

An array of the default fields to order records by when creating a select box

Type:   mixed


[ Top ]

$preDefElements =

[line 482]

Array of user-defined QuickForm elements that will be used for the field

matching the array key. If no match is found, the element for that field will be auto-generated. Make your element objects either in the preGenerateForm() method or in the getForm() method. Use HTML_QuickForm::createElement() to do this.

If you wish to put in a group of elements in place of a single element, you can put an array in preDefElements instead of a single element. The name of the group will be the name of the replaced element.


Type:   mixed


[ Top ]

$preDefGroups =

[line 461]

Array of groups to put certain elements in. The key is an element name, the value is the group to put the element in.

Type:   mixed


[ Top ]

$preDefOrder =

[line 469]

Indexed array of element names. If defined, this will determine the order in which the form elements are being created. This is useful if you're using QuickForm's default renderer or dynamic templates and the order of the fields in the database doesn't match your needs.

Type:   mixed


[ Top ]

$requiredRuleMessage =  'The field %s is required.'

[line 351]

Text that is displayed as an error message if a required field is left empty. Use %s to insert the field name.
  • See: ruleViolationMessage
  • Access: public

Type:   mixed


[ Top ]

$ruleViolationMessage =  '%s: The value you have entered is not valid.'

[line 342]

Text that is displayed as an error message if a validation rule is violated by the user's input. Use %s to insert the field name.
  • See: requiredRuleMessage
  • Access: public

Type:   mixed


[ Top ]

$selectAddEmpty =

[line 489]

An array of the link fields which should have an empty option added to the select box. This is only a valid option for fields which link to another table.

Type:   mixed


[ Top ]

$submitText =  'Submit'

[line 428]

Text for submit button

Type:   mixed


[ Top ]

$textFields = array()

[line 505]

A simple array of field names indicating which of the fields in a particular table/class are actually to be treated as textareas. This is an unfortunate workaround that is neccessary because the DataObject generator script does not make a difference between any other datatypes than string and integer.

When it does, this can be dropped.


Type:   mixed


[ Top ]

$timeFields = array()

[line 523]

A simple array of field names indicating which of the fields in a particular table/class are actually to be treated time fields. This is an unfortunate workaround that is neccessary because the DataObject generator script does not make a difference between any other datatypes than string and integer.

When it does, this can be dropped.


Type:   mixed


[ Top ]

$tripleLinks =

[line 604]

Holds triple link data.

The tripleLinks array can be used to display checkboxes for "triple-links". A triple link is set up with a table which links to three different tables. These will show up as a table of checkboxes The initial setting (table) is the same as for crossLinks. The field configuration keys (if you need them) are:

  1.     'fromField'
  2.     'toField1'
  3.     'toField2'


Type:   mixed


[ Top ]

$userEditableFields =

[line 455]

Array of fields which the user can edit. If a field is rendered but not specified in this array, it will be frozen. Ignored if not given.

Type:   mixed


[ Top ]

$validateOnProcess =  false

[line 362]

If set to TRUE, the current DataObject's validate method is being called before the form data is processed. If errors occur, no insert/update operation will be made on the database. Use getValidationErrors() to retrieve the reasons for a failure.

Defaults to FALSE.

  • Access: public

Type:   mixed


[ Top ]

$_appendForm =  false

[line 312]

If false, FormBuilder will use the form object from $_form as a basis for the new form: It will just add elements to the existing form object, not generate a new one.

If true, FormBuilder will generate a new form object, create all elements as needed for the given DataObject, then strip the elements from the exiting form object in $_form and add it to the newly generated form object.

  • Access: protected

Type:   mixed


[ Top ]

$_form =  false

[line 287]

If you want to use the generator on an existing form object, pass it to the factory method within the options array, element name: 'form' (who would have guessed?)
  • See: DB_DataObject_Formbuilder()
  • Access: protected

Type:   mixed


[ Top ]

$_queryType =  DB_DATAOBJECT_FORMBUILDER_QUERY_AUTODETECT

[line 301]

Used to determine which action to perform with the submitted data in processForm()
  • Access: protected

Type:   mixed


[ Top ]

$_validationErrors =  false

[line 294]

Contains the last validation errors, if validation checking is enabled.
  • Access: protected

Type:   mixed


[ Top ]



Method Detail

DB_DataObject_FormBuilder (Constructor)   [line 667]

DB_DataObject_FormBuilder DB_DataObject_FormBuilder( &$do, [array $options = false], object $do)

DB_DataObject_FormBuilder::DB_DataObject_FormBuilder()

The class constructor.

  • Access: public

Parameters:

object   $do   —  The DB_DataObject-derived object for which a form shall be built
array   $options   —  An optional associative array of options.
   &$do   — 

[ Top ]

create   [line 638]

object DB_DataObject_FormBuilder &create( &$do, [array $options = false], [string $driver = 'QuickForm'], object $do)

DB_DataObject_FormBuilder::create()

Factory method. As this is meant as an abstract class, it is the only supported method to make a new object instance. Pass the DataObject-derived class you want to build a form from as the first parameter. Use the second to pass additional options.

Options can be:

  • 'ruleViolationMessage' : See description of similarly-named class property
  • 'requiredRuleMessage' : See description of similarly-named class property
  • 'addFormHeader' : See description of similarly-named class property
  • 'formHeaderText' : See description of similarly-named class property
The third parameter is the name of a driver class. A driver class will take care of the actual form generation. This way it's possible to have FormBuilder build different forms for different types of output media from the same set of DataObjects.

Currently available driver classes:

  • QuickForm (stable)
  • XUL (experimental!)

  • Return: or PEAR_Error object
  • Access: public

Parameters:

object   $do   —  The DB_DataObject-derived object for which a form shall be built
array   $options   —  An optional associative array of options.
string   $driver   —  Optional: Name of the driver class for constructing the form object. Default: QuickForm.
   &$do   — 

[ Top ]

debug   [line 2036]

void debug( string $message)

DB_DataObject_FormBuilder::debug()

Outputs a debug message, if the debug setting in the DataObject.ini file is set to 1 or higher.

  • See: DB_DataObject::debugLevel()
  • Access: public

Parameters:

string   $message   —  The message to printed to the browser

[ Top ]

forceQueryType   [line 2010]

boolean forceQueryType( [integer $queryType = DB_DATAOBJECT_FORMBUILDER_QUERY_AUTODETECT])

DB_DataObject_FormBuilder::forceQueryType()

You can force the behaviour of the processForm() method by passing one of the following constants to this method:

  • DB_DATAOBJECT_FORMBUILDER_QUERY_FORCEINSERT: The submitted data will always be INSERTed into the database
  • DB_DATAOBJECT_FORMBUILDER_QUERY_FORCEUPDATE: The submitted data will always be used to perform an UPDATE on the database
  • DB_DATAOBJECT_FORMBUILDER_QUERY_FORCENOACTION: The submitted data will overwrite the properties of the DataObject, but no action will be performed on the database.
  • DB_DATAOBJECT_FORMBUILDER_QUERY_AUTODETECT: The processForm() method will try to detect for itself if an INSERT or UPDATE query has to be performed. This will not work if no primary key field can be detected for the current DataObject. In this case, no action will be performed. This is the default behaviour.

  • Access: public

Parameters:

integer   $queryType   —  The type of the query to be performed. Please use the preset constants for setting this.

[ Top ]

getDataObjectSelectDisplayValue   [line 1335]

string getDataObjectSelectDisplayValue( DB_DataObject &$do, [mixed $displayFields = false], [ $level = 1])

DB_DataObject_FormBuilder::getDataObjectSelectDisplayValue()

Returns a string which identitfies this dataobject. If multiple display fields are given, will display them all seperated by ", ". If a display field is a foreign key (link) the display value for the record it points to will be used. (Its display value will be surrounded by parenthesis as it may have multiple display fields of its own.)

Will use display field configurations from these locations, in this order:
1) $displayFields parameter
2) databaseName.formBuilder.ini file, section [tableName__linkDisplayFields]
3) the fb_linkDisplayFields member variable of the dataobject
4) global 'linkDisplayFields' setting for DB_DataObject_FormBuilder

  • Return: select display value for this field
  • Access: public

Parameters:

DB_DataObject   &$do   —  the dataobject to get the display value for, must be populated
mixed   $displayFields   —  field to use to display, may be an array with field names or a single field
   $level   — 

[ Top ]

getFieldLabel   [line 1306]

string getFieldLabel( $fieldName $fieldName)

DB_DataObject_FormBuilder::getFieldLabel()

Returns the label for the given field name. If no label is specified, the fieldname will be returned with ucfirst() applied.

  • Access: public

Parameters:

$fieldName   $fieldName   —  string The field name

[ Top ]

getForm   [line 1522]

object &getForm( [string $action = false], [string $target = '_self'], [string $formName = false], [string $method = 'post'])

DB_DataObject_FormBuilder::getForm()

Returns a HTML form that was automagically created by _generateForm(). You need to use the get() method before calling this one in order to prefill the form with the retrieved data.

If you have a method named "preGenerateForm()" in your DataObject-derived class, it will be called before _generateForm(). This way, you can create your own elements there and add them to the "fb_preDefElements" property, so they will not be auto-generated.

If you have your own "getForm()" method in your class, it will be called instead of _generateForm(). This enables you to have some classes that make their own forms completely from scratch, without any auto-generation. Use this for highly complex forms. Your getForm() method needs to return the complete HTML_QuickForm object by reference.

If you have a method named "postGenerateForm()" in your DataObject-derived class, it will be called after _generateForm(). This allows you to remove some elements that have been auto-generated from table fields but that you don't want in the form.

Many ways lead to rome.

  • Access: public

Parameters:

string   $action   —  The form action. Optional. If set to false (default), $_SERVER['PHP_SELF'] is used.
string   $target   —  The window target of the form. Optional. Defaults to '_self'.
string   $formName   —  The name of the form, will be used in "id" and "name" attributes. If set to false (default), the class name is used, prefixed with "frm"
string   $method   —  The submit method. Defaults to 'post'.

[ Top ]

getSelectOptions   [line 1388]

array getSelectOptions( string $field, [string $displayFields = false])

DB_DataObject_FormBuilder::getSelectOptions()

Returns an array of options for use with the HTML_QuickForm "select" element. It will try to fetch all related objects (if any) for the given field name and build the array. For the display name of the option, it will try to use the settings in the database.formBuilder.ini file. If those are not found, the linked object's property "fb_linkDisplayFields". If that one is not present, it will try to use the global configuration setting "linkDisplayFields". Can also be called with a second parameter containing the name of the display field - this will override all other settings. Same goes for "linkOrderFields", which determines the field name used for sorting the option elements. If neither a config setting nor a class property of that name is set, the display field name will be used.

  • Return: strings representing all of the records in the table $field links to.
  • Access: public

Parameters:

string   $field   —  The field to fetch the links from. You should make sure the field actually *has* links before calling this function (see: DB_DataObject::links())
string   $displayFields   —  (Optional) The name of the field used for the display text of the options

[ Top ]

getValidationErrors   [line 1737]

mixed getValidationErrors( )

DB_DataObject_FormBuilder::getValidationErrors()

Returns errors from data validation. If errors have occured, this will be an array with the fields that have errors, otherwise a boolean.

  • See: DB_DataObject::validate()
  • Access: public

[ Top ]

populateOptions   [line 1484]

void populateOptions( )

DB_DataObject_FormBuilder::populateOptions()

Populates public member vars with fb_ equivalents in the DataObject.


[ Top ]

processForm   [line 1783]

boolean processForm( array $values, string $queryType)

DB_DataObject_FormBuilder::processForm()

This will take the submitted form data and put it back into the object's properties. If the primary key is not set or NULL, it will be assumed that you wish to insert a new element into the database, so DataObject's insert() method is invoked. Otherwise, an update() will be performed. <b>Careful:</b> If you're using natural keys or cross-referencing tables where you don't have one dedicated primary key, this will always assume that you want to do an update! As there won't be a matching entry in the table, no action will be performed at all - the reason for this behaviour can be very hard to detect. Thus, if you have such a situation in one of your tables, simply override this method so that instead of the key check it will try to do a SELECT on the table using the current settings. If a match is found, do an update. If not, do an insert. This method is perfect for use with QuickForm's process method. Example:

  1.  if ($form->validate()) {
  2.      $form->freeze();
  3.      $form->process(array(&$formGenerator,'processForm')false);
  4.  }

If you wish to enforce a special type of query, use the forceQueryType() method.

Always remember to pass your objects by reference - otherwise, if the operation was an insert, the primary key won't get updated with the new database ID because processForm() was using a local copy of the object!

If a method named "preProcessForm()" exists in your derived class, it will be called before processForm() starts doing its magic. The data that has been submitted by the form will be passed to that method as a parameter. Same goes for a method named "postProcessForm()", with the only difference - you might have guessed this by now - that it's called after the insert/update operations have been done. Use this for filtering data, notifying users of changes etc.pp. ...

  • Return: TRUE if database operations were performed, FALSE if not
  • Access: public

Parameters:

array   $values   —  The values of the submitted form
string   $queryType   —  If the standard query behaviour ain't good enough for you, you can force a certain type of query

[ Top ]

useForm   [line 1283]

boolean useForm( $form &$form, [$append $append = false])

DB_DataObject_FormBuilder::useForm()

Sometimes, it might come in handy not just to create a new QuickForm object, but to work with an existing one. Using FormBuilder together with HTML_QuickForm_Controller or HTML_QuickForm_Page is such an example ;-) If you do not call this method before the form is generated, a new QuickForm object will be created (default behaviour).

  • Return: Returns false if the passed object was not a HTML_QuickForm object or a QuickForm object was already created
  • Access: public

Parameters:

$form   &$form   —  object A HTML_QuickForm object (or extended from that)
$append   $append   —  boolean If TRUE, the form will be appended to the one generated by FormBuilder. If false, FormBuilder will just add its own elements to this form.

[ Top ]

validateData   [line 1721]

mixed validateData( )

DB_DataObject_FormBuilder::validateData()

Makes a call to the current DataObject's validate() method and returns the result.

  • See: DB_DataObject::validate()
  • Access: public

[ Top ]

_array2date   [line 1691]

mixed _array2date( $dateInput, [boolean $timestamp = false], array $date)

DB_DataObject_FormBuilder::_array2date()

Takes a date array as used by the QuickForm date element and turns it back into a string representation suitable for use with a database date field (format 'YYYY-MM-DD'). If second parameter is true, it will return a unix timestamp instead. //FRANK: Not at this point it wont

Beware: For the date conversion to work, you must at least use the letters "d", "m" and "Y" in your format string (see "dateElementFormat" option). If you want to enter a time as well, you will have to use "H", "i" and "s" as well. Other letters will not work! Exception: You can also use "M" instead of "m" if you want plain text month names.

  • Access: protected

Parameters:

array   $date   —  An array representation of a date, as user in HTML_QuickForm's date element
boolean   $timestamp   —  Optional. If true, return a timestamp instead of a string. Defaults to false.
   $dateInput   — 

[ Top ]

_date2array   [line 1640]

array _date2array( mixed $date)

DB_DataObject_FormBuilder::_date2array()

Takes a string representing a date or a unix timestamp and turns it into an array suitable for use with the QuickForm data element. When using a string, make sure the format can be handled by the PEAR::Date constructor!

Beware: For the date conversion to work, you must at least use the letters "d", "m" and "Y" in your format string (see "dateElementFormat" option). If you want to enter a time as well, you will have to use "H", "i" and "s" as well. Other letters will not work! Exception: You can also use "M" instead of "m" if you want plain text month names.

  • Access: protected

Parameters:

mixed   $date   —  A unix timestamp or the string representation of a date, compatible to strtotime()

[ Top ]

_explodeArrString   [line 1195]

array _explodeArrString( string $str)

DB_DataObject_FormBuilder::_exlplodeArrString()

Internal method, will convert string representations of arrays as used in .ini files to real arrays. String format example: key1:value1,key2:value2,key3:value3,...

  • Access: protected

Parameters:

string   $str   —  The string to convert to an array

[ Top ]

_generateForm   [line 777]

object &_generateForm( [string $action = false], [string $target = '_self'], [string $formName = false], [string $method = 'post'])

DB_DataObject_FormBuilder::_generateForm()

Builds a simple HTML form for the current DataObject. Internal function, called by the public getForm() method. You can override this in child classes if needed, but it's also possible to leave this as it is and just override the getForm() method to simply fine-tune the auto-generated form object (i.e. add/remove elements, alter options, add/remove rules etc.). If a key with the same name as the current field is found in the fb_preDefElements property, the QuickForm element object contained in that array will be used instead of auto-generating a new one. This allows for complete step-by-step customizing of your forms.

Note for date fields: HTML_QuickForm allows passing of an options array to the HTML_QuickForm_date element. You can define your own options array for date elements in your DataObject-derived classes by defining a method "dateOptions($fieldName)". FormBuilder will call that method whenever it encounters a date field and expects to get back a valid options array.


Parameters:

string   $action   —  The form action. Optional. If set to false (default), PHP_SELF is used.
string   $target   —  The window target of the form. Optional. Defaults to '_self'.
string   $formName   —  The name of the form, will be used in "id" and "name" attributes. If set to false (default), the class name is used
string   $method   —  The submit method. Defaults to 'post'.

[ Top ]

_getSelectOptions   [line 1420]

array _getSelectOptions( string $table, [array $displayFields = false], [bool $selectAddEmpty = false])

Internal function to get the select potions for a table.
  • Return: strings representing all of the records in $table.
  • Access: protected

Parameters:

string   $table   —  The table to get the select display strings for.
array   $displayFields   —  array of diaply fields to use. Will default to the FB or DO options.
bool   $selectAddEmpty   —  If set to true, there will be an empty option in the returned array.

[ Top ]

_reorderElements   [line 1224]

mixed _reorderElements( )

DB_DataObject_FormBuilder::_reorderElements()

Changes the order in which elements are being processed, so that you can use QuickForm's default renderer or dynamic templates without being dependent on the field order in the database.

Make a class property named "fb_preDefOrder" in your DataObject-derived classes which contains an array with the correct element order to use this feature.

  • Return: Array in correct order or FALSE if reordering was not possible
  • Author: Fabien Franzen <atelierfabien@home.nl>
  • Access: protected

[ Top ]


Documentation generated on Mon, 11 Mar 2019 13:57:56 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.