b2evolution

Multilingual multiuser multiblog engine

b2evolution Technical Documentation (CVS HEAD) [ 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.7 2010/02/08 17:52:01 efy-yury Exp $
Copyright:  

(c)2003-2010 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 186]

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 waltercruz > still used by mtimport
Deprecated:  Deprecated by (@link Form::checkbox())


[ Top ]
form_formstart  [line 241]

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()) waltercruz> still used by inc/widgets/widgets/_coll_search_form.widget.php


[ Top ]
form_info  [line 222]

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_select  [line 109]

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 waltercruz> still used by mtimport

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


[ Top ]
form_select_object  [line 149]

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 waltercruz> still used by mtimport

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


[ Top ]
form_text  [line 55]

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 ]


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