Form helper class. Unless otherwise noted, all generated HTML will be made safe using the HTML::chars method. This prevents against simple XSS attacks that could otherwise be trigged by inserting HTML characters into form fields.
Class declared in SYSPATH/classes/form.php on line 3.
Creates a button form input. Note that the body of a button is NOT escaped, to allow images and other HTML to be used.
echoForm::button('save','Save Profile',array('type'=>'submit'));
string
$name
required - Input namestring
$body
required - Input valuearray
$attributes
= NULL - Html attributesstring
publicstaticfunctionbutton($name,$body,array$attributes= NULL){// Set the input name$attributes['name'] =$name;return'<button'.HTML::attributes($attributes).'>'.$body.'</button>';}
Creates a checkbox form input.
echoForm::checkbox('remember_me', 1, (bool)$remember);
string
$name
required - Input namestring
$value
= NULL - Input valueboolean
$checked
= bool FALSE - Checked statusarray
$attributes
= NULL - Html attributesstring
publicstaticfunctioncheckbox($name,$value= NULL,$checked= FALSE,array$attributes= NULL){$attributes['type'] ='checkbox';if($checked=== TRUE){// Make the checkbox active$attributes['checked'] ='checked';}returnForm::input($name,$value,$attributes);}
Creates the closing form tag.
echoForm::close();
string
publicstaticfunctionclose(){return'</form>';}
Creates a file upload form input. No input value can be specified.
echoForm::file('image');
string
$name
required - Input namearray
$attributes
= NULL - Html attributesstring
publicstaticfunctionfile($name,array$attributes= NULL){$attributes['type'] ='file';returnForm::input($name, NULL,$attributes);}
Creates a hidden form input.
echoForm::hidden('csrf',$token);
string
$name
required - Input namestring
$value
= NULL - Input valuearray
$attributes
= NULL - Html attributesstring
publicstaticfunctionhidden($name,$value= NULL,array$attributes= NULL){$attributes['type'] ='hidden';returnForm::input($name,$value,$attributes);}
Creates a image form input.
echoForm::image(NULL, NULL,array('src'=>'media/img/login.png'));
string
$name
required - Input namestring
$value
required - Input valuearray
$attributes
= NULL - Html attributesboolean
$index
= bool FALSE - Add index file to URL?string
publicstaticfunctionimage($name,$value,array$attributes= NULL,$index= FALSE){if( !empty($attributes['src'])){if(strpos($attributes['src'],'://') === FALSE){// Add the base URL$attributes['src'] = URL::base($index).$attributes['src'];}}$attributes['type'] ='image';returnForm::input($name,$value,$attributes);}
Creates a form input. If no type is specified, a "text" type input will be returned.
echoForm::input('username',$username);
string
$name
required - Input namestring
$value
= NULL - Input valuearray
$attributes
= NULL - Html attributesstring
publicstaticfunctioninput($name,$value= NULL,array$attributes= NULL){// Set the input name$attributes['name'] =$name;// Set the input value$attributes['value'] =$value;if( ! isset($attributes['type'])){// Default type is text$attributes['type'] ='text';}return'<input'.HTML::attributes($attributes).' />';}
Creates a form label. Label text is not automatically translated.
echoForm::label('username','Username');
string
$input
required - Target inputstring
$text
= NULL - Label textarray
$attributes
= NULL - Html attributesstring
publicstaticfunctionlabel($input,$text= NULL,array$attributes= NULL){if($text=== NULL){// Use the input name as the text$text= ucwords(preg_replace('/[\W_]+/',' ',$input));}// Set the label target$attributes['for'] =$input;return'<label'.HTML::attributes($attributes).'>'.$text.'</label>';}
Generates an opening HTML form tag.
// Form will submit back to the current page using POSTechoForm::open();// Form will submit to 'search' using GETechoForm::open('search',array('method'=>'get'));// When "file" inputs are present, you must include the "enctype"echoForm::open(NULL,array('enctype'=>'multipart/form-data'));
mixed
$action
= NULL - Form action, defaults to the current request URI, or [Request] class to usearray
$attributes
= NULL - Html attributesstring
publicstaticfunctionopen($action= NULL,array$attributes= NULL){if($actioninstanceofRequest){// Use the current URI$action=$action->uri();}if( !$action){// Allow empty form actions (submits back to the current url).$action='';}elseif(strpos($action,'://') === FALSE){// Make the URI absolute$action= URL::site($action);}// Add the form action to the attributes$attributes['action'] =$action;// Only accept the default character set$attributes['accept-charset'] = Kohana::$charset;if( ! isset($attributes['method'])){// Use POST method$attributes['method'] ='post';}return'<form'.HTML::attributes($attributes).'>';}
Creates a password form input.
echoForm::password('password');
string
$name
required - Input namestring
$value
= NULL - Input valuearray
$attributes
= NULL - Html attributesstring
publicstaticfunctionpassword($name,$value= NULL,array$attributes= NULL){$attributes['type'] ='password';returnForm::input($name,$value,$attributes);}
Creates a radio form input.
echoForm::radio('like_cats', 1,$cats);echoForm::radio('like_cats', 0, !$cats);
string
$name
required - Input namestring
$value
= NULL - Input valueboolean
$checked
= bool FALSE - Checked statusarray
$attributes
= NULL - Html attributesstring
publicstaticfunctionradio($name,$value= NULL,$checked= FALSE,array$attributes= NULL){$attributes['type'] ='radio';if($checked=== TRUE){// Make the radio active$attributes['checked'] ='checked';}returnForm::input($name,$value,$attributes);}
Creates a select form input.
echoForm::select('country',$countries,$country);
Support for multiple selected options was added in v3.0.7.
string
$name
required - Input namearray
$options
= NULL - Available optionsmixed
$selected
= NULL - Selected option string, or an array of selected optionsarray
$attributes
= NULL - Html attributesstring
publicstaticfunctionselect($name,array$options= NULL,$selected= NULL,array$attributes= NULL){// Set the input name$attributes['name'] =$name;if(is_array($selected)){// This is a multi-select, god save us!$attributes['multiple'] ='multiple';}if( !is_array($selected)){if($selected=== NULL){// Use an empty array$selected=array();}else{// Convert the selected options to an array$selected=array( (string)$selected);}}if(empty($options)){// There are no options$options='';}else{foreach($optionsas$value=>$name){if(is_array($name)){// Create a new optgroup$group=array('label'=>$value);// Create a new list of options$_options=array();foreach($nameas$_value=>$_name){// Force value to be string$_value= (string)$_value;// Create a new attribute set for this option$option=array('value'=>$_value);if(in_array($_value,$selected)){// This option is selected$option['selected'] ='selected';}// Change the option to the HTML string$_options[] ='<option'.HTML::attributes($option).'>'.HTML::chars($_name, FALSE).'</option>';}// Compile the options into a string$_options="\n".implode("\n",$_options)."\n";$options[$value] ='<optgroup'.HTML::attributes($group).'>'.$_options.'</optgroup>';}else{// Force value to be string$value= (string)$value;// Create a new attribute set for this option$option=array('value'=>$value);if(in_array($value,$selected)){// This option is selected$option['selected'] ='selected';}// Change the option to the HTML string$options[$value] ='<option'.HTML::attributes($option).'>'.HTML::chars($name, FALSE).'</option>';}}// Compile the options into a single string$options="\n".implode("\n",$options)."\n";}return'<select'.HTML::attributes($attributes).'>'.$options.'</select>';}
Creates a submit form input.
echoForm::submit(NULL,'Login');
string
$name
required - Input namestring
$value
required - Input valuearray
$attributes
= NULL - Html attributesstring
publicstaticfunctionsubmit($name,$value,array$attributes= NULL){$attributes['type'] ='submit';returnForm::input($name,$value,$attributes);}
Creates a textarea form input.
echoForm::textarea('about',$about);
string
$name
required - Textarea namestring
$body
= string(0) "" - Textarea bodyarray
$attributes
= NULL - Html attributesboolean
$double_encode
= bool TRUE - Encode existing HTML charactersstring
publicstaticfunctiontextarea($name,$body='',array$attributes= NULL,$double_encode= TRUE){// Set the input name$attributes['name'] =$name;// Add default rows and cols attributes (required)$attributes+=array('rows'=> 10,'cols'=> 50);return'<textarea'.HTML::attributes($attributes).'>'.HTML::chars($body,$double_encode).'</textarea>';}