From c576995304fc3609cca0b7b92d1b2cd611ec82f5 Mon Sep 17 00:00:00 2001 From: Andrey Andreev Date: Wed, 16 Jan 2019 17:49:35 +0200 Subject: [ci skip] 3.1.10 release --- user_guide_src/source/helpers/form_helper.rst | 743 -------------------------- 1 file changed, 743 deletions(-) delete mode 100644 user_guide_src/source/helpers/form_helper.rst (limited to 'user_guide_src/source/helpers/form_helper.rst') diff --git a/user_guide_src/source/helpers/form_helper.rst b/user_guide_src/source/helpers/form_helper.rst deleted file mode 100644 index 8da5d22b5..000000000 --- a/user_guide_src/source/helpers/form_helper.rst +++ /dev/null @@ -1,743 +0,0 @@ -########### -Form Helper -########### - -The Form Helper file contains functions that assist in working with -forms. - -.. contents:: - :local: - -.. raw:: html - -
- -Loading this Helper -=================== - -This helper is loaded using the following code:: - - $this->load->helper('form'); - -Escaping field values -===================== - -You may need to use HTML and characters such as quotes within your form -elements. In order to do that safely, you'll need to use -:doc:`common function <../general/common_functions>` -:func:`html_escape()`. - -Consider the following example:: - - $string = 'Here is a string containing "quoted" text.'; - - - -Since the above string contains a set of quotes, it will cause the form -to break. The :php:func:`html_escape()` function converts HTML special -characters so that it can be used safely:: - - - -.. note:: If you use any of the form helper functions listed on this page, - the form values will be automatically escaped, so there is no need - to call this function. Use it only if you are creating your own - form elements. - -Available Functions -=================== - -The following functions are available: - - -.. php:function:: form_open([$action = ''[, $attributes = ''[, $hidden = array()]]]) - - :param string $action: Form action/target URI string - :param array $attributes: HTML attributes - :param array $hidden: An array of hidden fields' definitions - :returns: An HTML form opening tag - :rtype: string - - Creates an opening form tag with a base URL **built from your config preferences**. - It will optionally let you add form attributes and hidden input fields, and - will always add the `accept-charset` attribute based on the charset value in your - config file. - - The main benefit of using this tag rather than hard coding your own HTML is that - it permits your site to be more portable in the event your URLs ever change. - - Here's a simple example:: - - echo form_open('email/send'); - - The above example would create a form that points to your base URL plus the - "email/send" URI segments, like this:: - -
- - **Adding Attributes** - - Attributes can be added by passing an associative array to the second - parameter, like this:: - - $attributes = array('class' => 'email', 'id' => 'myform'); - echo form_open('email/send', $attributes); - - Alternatively, you can specify the second parameter as a string:: - - echo form_open('email/send', 'class="email" id="myform"'); - - The above examples would create a form similar to this:: - - - - **Adding Hidden Input Fields** - - Hidden fields can be added by passing an associative array to the - third parameter, like this:: - - $hidden = array('username' => 'Joe', 'member_id' => '234'); - echo form_open('email/send', '', $hidden); - - You can skip the second parameter by passing any falsy value to it. - - The above example would create a form similar to this:: - - - - - - -.. php:function:: form_open_multipart([$action = ''[, $attributes = array()[, $hidden = array()]]]) - - :param string $action: Form action/target URI string - :param array $attributes: HTML attributes - :param array $hidden: An array of hidden fields' definitions - :returns: An HTML multipart form opening tag - :rtype: string - - This function is absolutely identical to :php:func:`form_open()` above, - except that it adds a *multipart* attribute, which is necessary if you - would like to use the form to upload files with. - - -.. php:function:: form_hidden($name[, $value = '']) - - :param string $name: Field name - :param string $value: Field value - :returns: An HTML hidden input field tag - :rtype: string - - Lets you generate hidden input fields. You can either submit a - name/value string to create one field:: - - form_hidden('username', 'johndoe'); - // Would produce: - - ... or you can submit an associative array to create multiple fields:: - - $data = array( - 'name' => 'John Doe', - 'email' => 'john@example.com', - 'url' => 'http://example.com' - ); - - echo form_hidden($data); - - /* - Would produce: - - - - */ - - You can also pass an associative array to the value field:: - - $data = array( - 'name' => 'John Doe', - 'email' => 'john@example.com', - 'url' => 'http://example.com' - ); - - echo form_hidden('my_array', $data); - - /* - Would produce: - - - - - */ - - If you want to create hidden input fields with extra attributes:: - - $data = array( - 'type' => 'hidden', - 'name' => 'email', - 'id' => 'hiddenemail', - 'value' => 'john@example.com', - 'class' => 'hiddenemail' - ); - - echo form_input($data); - - /* - Would produce: - - - */ - -.. php:function:: form_input([$data = ''[, $value = ''[, $extra = '']]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML text input field tag - :rtype: string - - Lets you generate a standard text input field. You can minimally pass - the field name and value in the first and second parameter:: - - echo form_input('username', 'johndoe'); - - Or you can pass an associative array containing any data you wish your - form to contain:: - - $data = array( - 'name' => 'username', - 'id' => 'username', - 'value' => 'johndoe', - 'maxlength' => '100', - 'size' => '50', - 'style' => 'width:50%' - ); - - echo form_input($data); - - /* - Would produce: - - - */ - - If you would like your form to contain some additional data, like - JavaScript, you can pass it as a string in the third parameter:: - - $js = 'onClick="some_function()"'; - echo form_input('username', 'johndoe', $js); - - Or you can pass it as an array:: - - $js = array('onClick' => 'some_function();'); - echo form_input('username', 'johndoe', $js); - -.. php:function:: form_password([$data = ''[, $value = ''[, $extra = '']]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML password input field tag - :rtype: string - - This function is identical in all respects to the :php:func:`form_input()` - function above except that it uses the "password" input type. - - -.. php:function:: form_upload([$data = ''[, $value = ''[, $extra = '']]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML file upload input field tag - :rtype: string - - This function is identical in all respects to the :php:func:`form_input()` - function above except that it uses the "file" input type, allowing it to - be used to upload files. - - -.. php:function:: form_textarea([$data = ''[, $value = ''[, $extra = '']]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML textarea tag - :rtype: string - - This function is identical in all respects to the :php:func:`form_input()` - function above except that it generates a "textarea" type. - - .. note:: Instead of the *maxlength* and *size* attributes in the above example, - you will instead specify *rows* and *cols*. - -.. php:function:: form_dropdown([$name = ''[, $options = array()[, $selected = array()[, $extra = '']]]]) - - :param string $name: Field name - :param array $options: An associative array of options to be listed - :param array $selected: List of fields to mark with the *selected* attribute - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML dropdown select field tag - :rtype: string - - Lets you create a standard drop-down field. The first parameter will - contain the name of the field, the second parameter will contain an - associative array of options, and the third parameter will contain the - value you wish to be selected. You can also pass an array of multiple - items through the third parameter, and CodeIgniter will create a - multiple select for you. - - Example:: - - $options = array( - 'small' => 'Small Shirt', - 'med' => 'Medium Shirt', - 'large' => 'Large Shirt', - 'xlarge' => 'Extra Large Shirt', - ); - - $shirts_on_sale = array('small', 'large'); - echo form_dropdown('shirts', $options, 'large'); - - /* - Would produce: - - - */ - - echo form_dropdown('shirts', $options, $shirts_on_sale); - - /* - Would produce: - - - */ - - If you would like the opening - - The third parameter contains a boolean TRUE/FALSE to determine whether - the box should be checked or not. - - Similar to the other form functions in this helper, you can also pass an - array of attributes to the function:: - - $data = array( - 'name' => 'newsletter', - 'id' => 'newsletter', - 'value' => 'accept', - 'checked' => TRUE, - 'style' => 'margin:10px' - ); - - echo form_checkbox($data); - // Would produce: - - Also as with other functions, if you would like the tag to contain - additional data like JavaScript, you can pass it as a string in the - fourth parameter:: - - $js = 'onClick="some_function()"'; - echo form_checkbox('newsletter', 'accept', TRUE, $js); - - Or you can pass it as an array:: - - $js = array('onClick' => 'some_function();'); - echo form_checkbox('newsletter', 'accept', TRUE, $js); - - -.. php:function:: form_radio([$data = ''[, $value = ''[, $checked = FALSE[, $extra = '']]]]) - - :param array $data: Field attributes data - :param string $value: Field value - :param bool $checked: Whether to mark the radio button as being *checked* - :param mixed $extra: Extra attributes to be added to the tag either as an array or a literal string - :returns: An HTML radio input tag - :rtype: string - - This function is identical in all respects to the :php:func:`form_checkbox()` - function above except that it uses the "radio" input type. - - -.. php:function:: form_label([$label_text = ''[, $id = ''[, $attributes = array()]]]) - - :param string $label_text: Text to put in the