b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (Version 2.4) [ class tree: evocore ] [ index: evocore ] [ all elements ]

Procedural File: _form.funcs.php

Source Location: /blogs/inc/_core/ui/forms/_form.funcs.php

Page Details

This file implements Fast Form handling functions.

This file is part of the evoCore framework - http://evocore.net/ See also http://sourceforge.net/projects/evocms/.

Author:  blueyed: Daniel HAHLER.
Author:  fplanque: Francois PLANQUE.
Version:  $Id: _form.funcs.php,v 1.2 2008/01/21 09:35:24 fplanque Exp $
Copyright:  

(c)2003-2008 by Francois PLANQUE - http://fplanque.net/ Parts of this file are copyright (c)2004-2005 by Daniel HAHLER - http://thequod.de/contact.

Deprecated:  

All those functions should be handled by the Form class.

Filesource:  Source Code for this file
Functions
form_checkbox  [line 395]

mixed form_checkbox( string $field_name, boolean $field_value, string $field_label, [string $field_note = ''], [string $field_class = ''], [boolean $output = true]  )

form_checkbox(-)

Parameters:
string   $field_name:  the name of the checkbox
boolean   $field_value:  initial value
string   $field_label:  label
string   $field_note:  note
string   $field_class:  CSS class
boolean   $output:  to output (default) or not

API Tags:
Return:  true (if output) or the generated HTML if not outputting
Deprecated:  Deprecated by (@link Form::checkbox())


[ Top ]
form_checkbox_tr  [line 431]

void form_checkbox_tr( $field_name, $field_value, $field_label, [ $field_note = ''], [ $field_class = '']  )

form_checkbox_tr(-)

Parameters:
   $field_name: 
   $field_value: 
   $field_label: 
   $field_note: 
   $field_class: 

API Tags:
Deprecated:  Deprecated by (@link Form::checkbox_input())


[ Top ]
form_fieldend  [line 87]

void form_fieldend( )

End an input field.

A field is a fieldset containing a label div and an input div.


API Tags:
Deprecated:  Deprecated by (@link Form::end_field())


[ Top ]
form_fieldstart  [line 73]

void form_fieldstart( $field_name, $field_label  )

Start an input field.

A field is a fielset containing a label div and an input div.

Parameters:
   $field_name: 
   $field_label: 

API Tags:
Deprecated:  Deprecated by (@link Form::begin_field())


[ Top ]
form_formstart  [line 491]

void form_formstart( $action, [ $class = ''], [ $name = ''], [ $method = 'get'], [ $id = '']  )

Builds a form header and puts GET params of $action into hidden form inputs

Parameters:
   $action: 
   $class: 
   $name: 
   $method: 
   $id: 

API Tags:
Deprecated:  Deprecated by (@link Form::begin_form())


[ Top ]
form_groupend  [line 60]

void form_groupend( [ $title = '']  )

End an field group.

Fieldset with legend.

Parameters:
   $title: 

API Tags:
Deprecated:  Deprecated by (@link Form::end_fieldset())


[ Top ]
form_groupstart  [line 46]

void form_groupstart( [ $title = '']  )

Start an field group.

Fieldset with legend.

Parameters:
   $title: 

API Tags:
Deprecated:  Deprecated by (@link Form::begin_fieldset())


[ Top ]
form_hidden  [line 209]

string form_hidden( string $field_name, string $field_value, [ $display = true]  )

Builds a hidden field.

Parameters:
string   $field_name:  name
string   $field_value:  value
   $display: 

API Tags:
Deprecated:  Deprecated by (@link Form::button_input())


[ Top ]
form_info  [line 455]

void form_info( $field_label, $field_info, [ $field_note = '']  )

form_info(-)

Parameters:
   $field_label: 
   $field_info: 
   $field_note: 

API Tags:
Deprecated:  Deprecated by (@link Form::info_field())


[ Top ]
form_infoend  [line 113]

void form_infoend( )

End an info field.

An info field is a fielset containing a label div and an info div.


API Tags:
Deprecated:  Deprecated by (@link Form::info_field())


[ Top ]
form_infostart  [line 99]

void form_infostart( $field_label  )

Start an info field.

An info field is a fielset containing a label div and an info div.

Parameters:
   $field_label: 

API Tags:
Deprecated:  Deprecated by (@link Form::info_field())


[ Top ]
form_info_tr  [line 474]

void form_info_tr( $field_label, $field_info, [ $field_note = '']  )

form_info_tr(-)

Parameters:
   $field_label: 
   $field_info: 
   $field_note: 

API Tags:
Deprecated:  Deprecated by (@link Form::info_field())


[ Top ]
form_radio  [line 341]

void form_radio( string $field_name, string $field_value, array $field_options, string $field_label, [boolean $field_lines = false], [string $field_notes = '']  )

Generate set of radio options.

Parameters:
string   $field_name:  the name of the radio options
string   $field_value:  the checked option
array   $field_options:  of arrays the radio options (0: value, 1: label, 2: notes, 3: additional HTML [input field, ..], 4: attribs for <input tag> )
string   $field_label:  label
boolean   $field_lines:  options on seperate lines (DIVs)
string   $field_notes:  notes

API Tags:
Deprecated:  Deprecated by (@link Form::radio_input())


[ Top ]
form_select  [line 266]

void form_select( string $field_name, string $field_value, callback $field_list_callback, string $field_label, [string $field_note = ''], [string $field_class = '']  )

Display a select field and populate it with a callback function.

Parameters:
string   $field_name:  field name
string   $field_value:  default field value
callback   $field_list_callback:  callback function
string   $field_label:  field label to be display before the field
string   $field_note:  note to be displayed after the field
string   $field_class:  CSS class for select

API Tags:
Deprecated:  Deprecated by (@link Form::select_input())


[ Top ]
form_select_object  [line 305]

void form_select_object( string $field_name, string $field_value, DataObjectCache &$field_object, string $field_label, [string $field_note = ''], [boolean $allow_none = false], [string $field_class = '']  )

Display a select field and populate it with a cache object.

Parameters:
string   $field_name:  field name
string   $field_value:  default field value
DataObjectCache   &$field_object:  Cache containing values for list (get_option_list() gets called on it)
string   $field_label:  field label to be display before the field
string   $field_note:  note to be displayed after the field
boolean   $allow_none:  allow to select [none] in list
string   $field_class:  CSS class for select

API Tags:
Deprecated:  Deprecated by (@link Form::select_object())


[ Top ]
form_submit  [line 532]

void form_submit( [ $submit_attribs = '']  )
Parameters:
   $submit_attribs: 

API Tags:
Deprecated:  Deprecated by (@link Form::end_form())


[ Top ]
form_text  [line 135]

mixed form_text( string $field_name, string $field_value, integer $field_size, string $field_label, [string $field_note = ''], [integer $field_maxlength = 0], [string $field_class = ''], [string $inputtype = 'text'], [boolean $output = true]  )

Builds a text (or password) input field.

Parameters:
string   $field_name:  the name of the input field
string   $field_value:  initial value
integer   $field_size:  size of the input field
string   $field_label:  label displayed in front of the field
string   $field_note:  note displayed with field
integer   $field_maxlength:  max length of the value (if 0 field_size will be used!)
string   $field_class:  the CSS class to use
string   $inputtype:  input type (only 'text' or 'password' makes sense)
boolean   $output:  display (default) or return

API Tags:
Return:  true (if output) or the generated HTML if not outputting
Deprecated:  Deprecated by (@link Form::text_input())


[ Top ]
form_textarea  [line 236]

void form_textarea( string $field_name, string $field_value, integer $field_rows, string $field_label, [string $field_note = ''], [integer $field_cols = 50], [string $field_class = '']  )

Build a text area.

Parameters:
string   $field_name: 
string   $field_value: 
integer   $field_rows: 
string   $field_label: 
string   $field_note: 
integer   $field_cols: 
string   $field_class: 

API Tags:
Deprecated:  Deprecated by (@link Form::textarea_input())


[ Top ]
form_text_tr  [line 182]

void form_text_tr( $field_name, $field_value, $field_size, $field_label, [ $field_note = ''], [ $field_maxlength = 0], [ $field_class = '']  )

form_text_tr(-)

Parameters:
   $field_name: 
   $field_value: 
   $field_size: 
   $field_label: 
   $field_note: 
   $field_maxlength: 
   $field_class: 

API Tags:
Deprecated:  Deprecated by (@link Form::text_input())


[ Top ]


Documentation generated on Sat, 06 Mar 2010 03:32:55 +0100 by phpDocumentor 1.4.2. This site is hosted and maintained by Daniel HAHLER (Contact).