Added the Form class and updated the configuration arrangement.
This commit is contained in:
Josh Sherman
parent
cd1593a045
commit
b210803e81
5 changed files with 397 additions and 15 deletions
375
classes/Form.php
Normal file
375
classes/Form.php
Normal file
|
|
@ -0,0 +1,375 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* Form Class File for PICKLES
|
||||
*
|
||||
* PHP version 5
|
||||
*
|
||||
* Licensed under the GNU General Public License Version 3
|
||||
* Redistribution of these files must retain the above copyright notice.
|
||||
*
|
||||
* @package PICKLES
|
||||
* @author Josh Sherman <josh@phpwithpickles.org>
|
||||
* @copyright Copyright 2007-2010, Gravity Boulevard, LLC
|
||||
* @license http://www.gnu.org/licenses/gpl.html GPL v3
|
||||
* @link http://phpwithpickles.org
|
||||
*/
|
||||
|
||||
/**
|
||||
* Form Class
|
||||
*
|
||||
* This class contains methods for easily generating form elements. There is a
|
||||
* heavy focus on select boxes as they have the most overhead for a developer.
|
||||
*/
|
||||
class Form extends Object
|
||||
{
|
||||
/**
|
||||
* Input
|
||||
*
|
||||
* Generates an input with the passed data.
|
||||
*
|
||||
* @param string $name name (and ID) for the select element
|
||||
* @param string $value optional preset value
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
* @param string $type optional type of input
|
||||
* @return string HTML for the input
|
||||
*/
|
||||
public function input($name, $value = '', $classes = '', $additional = null, $type = 'input')
|
||||
{
|
||||
return '<input type="' . $type . '" name="' . $name . '" id="' . $name . '" value="' . $value . '" class="' . $classes . '" ' . $additional . ' />';
|
||||
}
|
||||
|
||||
/**
|
||||
* Hidden Input
|
||||
*
|
||||
* Shorthand method to generate a hidden input.
|
||||
*
|
||||
* @param string $name name (and ID) for the select element
|
||||
* @param string $value optional preset value
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
* @return string HTML for the input
|
||||
*/
|
||||
public function hiddenInput($name, $value = '', $classes = '', $additional = null)
|
||||
{
|
||||
return $this->input($name, $value, $classes, $additional, 'hidden');
|
||||
}
|
||||
|
||||
/**
|
||||
* Text Area
|
||||
*
|
||||
* Generates a textarea with the passed data.
|
||||
*
|
||||
* @param string $name name (and ID) for the select element
|
||||
* @param string $value optional preset value
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
* @param string $type optional type of input
|
||||
* @return string HTML for the input
|
||||
*/
|
||||
public function textarea($name, $value = '', $classes = '', $additional = null)
|
||||
{
|
||||
return '<input name="' . $name . '" id="' . $name . '" class="' . $classes . '" ' . $additional . '>' . $value . '</textarea>';
|
||||
}
|
||||
|
||||
/**
|
||||
* Select
|
||||
*
|
||||
* Generates a select box with the passed data.
|
||||
*
|
||||
* @param string $name name (and ID) for the select element
|
||||
* @param array $options key/values for the option elements
|
||||
* @param string $selected optional selected option
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
* @return string HTML for the select box
|
||||
*/
|
||||
public function select($name, $options, $selected = null, $classes = '', $additional = null)
|
||||
{
|
||||
return '<select id="' . $name . '" name="' . $name . '" class="' . $classes . '" ' . $additional . '>' . $this->options($options, $selected) . '</select>';
|
||||
}
|
||||
|
||||
/**
|
||||
* Options
|
||||
*
|
||||
* Generates the option elements from the passed array
|
||||
*
|
||||
* @param array $options key/values for the options
|
||||
* @param string $selected optional default option
|
||||
* @return string HTML for the options
|
||||
* @todo Add support for optgroup
|
||||
*/
|
||||
public function options($options, $selected = null)
|
||||
{
|
||||
$found_selected = false;
|
||||
$options_html = '';
|
||||
|
||||
if (is_array($options))
|
||||
{
|
||||
foreach ($options as $value => $label)
|
||||
{
|
||||
$selected_attribute = false;
|
||||
if ($selected_value !== null && $found_selected === false)
|
||||
{
|
||||
if ($selected_value == $value)
|
||||
{
|
||||
$selected_attribute = ' selected="selected"';
|
||||
$found_selected = true;
|
||||
}
|
||||
}
|
||||
|
||||
$options_html .= '<option value="' . $value . '"' . $selected . '>' . $label . '</option>';
|
||||
}
|
||||
}
|
||||
|
||||
if ($selected !== null && $found_selected === false)
|
||||
{
|
||||
$options_html .= '<option value="' . $selected . '" selected="selected" class="error">' . $selected . '</option>';
|
||||
}
|
||||
|
||||
return $options_html;
|
||||
}
|
||||
|
||||
/**
|
||||
* State Select
|
||||
*
|
||||
* Generates a select box with the United States, Puerto Rico and miliary
|
||||
* options
|
||||
*
|
||||
* @param string $name optional name (and ID) for the select element
|
||||
* @param string $selected optional selected option
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
* @return string HTML for the select box
|
||||
*/
|
||||
public function stateSelect($name = 'state', $selected = null, $classes = '', $additional = null)
|
||||
{
|
||||
$options = array(
|
||||
null => '-- Select State --',
|
||||
'AK' => 'Alaska',
|
||||
'AL' => 'Alabama',
|
||||
'AS' => 'American Samoa',
|
||||
'AZ' => 'Arizona',
|
||||
'AR' => 'Arkansas',
|
||||
'CA' => 'California',
|
||||
'CO' => 'Colorado',
|
||||
'CT' => 'Connecticut',
|
||||
'DE' => 'Delaware',
|
||||
'DC' => 'District of Columbia',
|
||||
'FL' => 'Florida',
|
||||
'GA' => 'Georgia',
|
||||
'GU' => 'Guam',
|
||||
'HI' => 'Hawaii',
|
||||
'ID' => 'Idaho',
|
||||
'IL' => 'Illinois',
|
||||
'IN' => 'Indiana',
|
||||
'IA' => 'Iowa',
|
||||
'KS' => 'Kansas',
|
||||
'KY' => 'Kentucky',
|
||||
'LA' => 'Louisiana',
|
||||
'ME' => 'Maine',
|
||||
'MH' => 'Marshall Islands',
|
||||
'MD' => 'Maryland',
|
||||
'MA' => 'Massachusetts',
|
||||
'MI' => 'Michigan',
|
||||
'MN' => 'Minnesota',
|
||||
'MS' => 'Mississippi',
|
||||
'MO' => 'Missouri',
|
||||
'MT' => 'Montana',
|
||||
'NE' => 'Nebraska',
|
||||
'NV' => 'Nevada',
|
||||
'NH' => 'New Hampshire',
|
||||
'NJ' => 'New Jersey',
|
||||
'NM' => 'New Mexico',
|
||||
'NY' => 'New York',
|
||||
'NC' => 'North Carolina',
|
||||
'ND' => 'North Dakota',
|
||||
'MP' => 'Northern Mariana Islands',
|
||||
'OH' => 'Ohio',
|
||||
'OK' => 'Oklahoma',
|
||||
'OR' => 'Oregon',
|
||||
'PW' => 'Palau',
|
||||
'PA' => 'Pennsylvania',
|
||||
'PR' => 'Puerto Rico',
|
||||
'RI' => 'Rhode Island',
|
||||
'SC' => 'South Carolina',
|
||||
'SD' => 'South Dakota',
|
||||
'TN' => 'Tennessee',
|
||||
'TX' => 'Texas',
|
||||
'UT' => 'Utah',
|
||||
'VT' => 'Vermont',
|
||||
'VI' => 'Virgin Islands',
|
||||
'VA' => 'Virginia',
|
||||
'WA' => 'Washington',
|
||||
'WV' => 'West Virginia',
|
||||
'WI' => 'Wisconsin',
|
||||
'WY' => 'Wyoming',
|
||||
'AE' => 'Armed Forces Africa',
|
||||
'AA' => 'Armed Forces Americas (except Canada)',
|
||||
'AE' => 'Armed Forces Canada',
|
||||
'AE' => 'Armed Forces Europe',
|
||||
'AE' => 'Armed Forces Middle East',
|
||||
'AP' => 'Armed Forces Pacific'
|
||||
);
|
||||
|
||||
return $this->select($name, $options, $selected, $additional);
|
||||
}
|
||||
|
||||
/**
|
||||
* Date Select
|
||||
*
|
||||
* Generates 3 select boxes (month, day, year)
|
||||
*
|
||||
* @param string $name optional name (and ID) for the select element
|
||||
* @param string $selected optional selected option
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
* @param integer $end_year optional last year to display
|
||||
* @param integer $start_year optional first year to display
|
||||
* @return string HTML for the select boxes
|
||||
* @todo Currently only the DOB select is using this code, if another
|
||||
* select comes along the DOB-centric logic will need to be
|
||||
* moved.
|
||||
*/
|
||||
public function dateSelect($name = 'date', $selected = null, $classes = '', $additional = null, $end_year = null, $start_year = null)
|
||||
{
|
||||
$html = '';
|
||||
|
||||
// Breaks apart the selected value if present
|
||||
if ($selected == null || $selected == '0000-00-00')
|
||||
{
|
||||
$selected_month = null;
|
||||
$selected_day = null;
|
||||
$selected_year = null;
|
||||
}
|
||||
else
|
||||
{
|
||||
list($selected_year, $selected_month, $selected_day) = explode('-', $selected);
|
||||
}
|
||||
|
||||
$month_options = array(
|
||||
null => 'Month',
|
||||
'01' => 'January',
|
||||
'02' => 'February',
|
||||
'03' => 'March',
|
||||
'04' => 'April',
|
||||
'05' => 'May',
|
||||
'06' => 'June',
|
||||
'07' => 'July',
|
||||
'08' => 'August',
|
||||
'09' => 'September',
|
||||
'10' => 'October',
|
||||
'11' => 'November',
|
||||
'12' => 'December',
|
||||
);
|
||||
|
||||
$day_options = array(null => 'Day');
|
||||
$year_options = array(null => 'Year');
|
||||
|
||||
// Generates the list of days
|
||||
for ($i = 1; $i <= 31; ++$i)
|
||||
{
|
||||
$day_options[str_pad($i, 2, '0', STR_PAD_LEFT)] = $i;
|
||||
}
|
||||
|
||||
// Generates the list of years
|
||||
$start_year = $start_year == null ? date('Y') : $start_year;
|
||||
$end_year = $end_year == null ? 1895 : $end_year;
|
||||
|
||||
// Start year based on oldest living person: http://en.wikipedia.org/wiki/Oldest_people as of September 2009
|
||||
for ($i = $start_year; $i >= $end_year; --$i)
|
||||
{
|
||||
$year_options[$i] = $i;
|
||||
}
|
||||
|
||||
// Loops through and generates the selects
|
||||
foreach (array('month', 'day', 'year') as $part)
|
||||
{
|
||||
$options = $part . '_options';
|
||||
$selected = 'selected_' . $part;
|
||||
$html .= ' ' . $this->select($name . '[' . $part . ']', $$options, $$selected, $classes, $additional);
|
||||
}
|
||||
|
||||
return $html;
|
||||
}
|
||||
|
||||
/**
|
||||
* Date of Birth Select
|
||||
*
|
||||
* Generates 3 select boxes (month, day, year)
|
||||
*
|
||||
* @param string $name optional name (and ID) for the select element
|
||||
* @param string $selected optional selected option
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
* @return string HTML for the select boxes
|
||||
*/
|
||||
public function dobSelect($name = 'dob', $selected = null, $classes = '', $additional = null)
|
||||
{
|
||||
return $this->dateSelect($name, $selected, $classes, $additional);
|
||||
}
|
||||
|
||||
/**
|
||||
* Polar Select
|
||||
*
|
||||
* Generates a polar (yes / no) select box.
|
||||
*
|
||||
* @param string $name optional name (and ID) for the select element
|
||||
* @param string $selected optional selected option
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
*/
|
||||
public function polarSelect($name = 'decision', $selected_value = 0, $classes = '', $additional = null)
|
||||
{
|
||||
$options = array(1 => 'Yes', 0 => 'No');
|
||||
|
||||
return $this->select($name, $options, $selected, $classes, $additional);
|
||||
}
|
||||
|
||||
/**
|
||||
* Phone Input
|
||||
*
|
||||
* Generates 3 inputs for a phone number from the passed values.
|
||||
*
|
||||
* @param string $name optional name (and ID) for the input elements
|
||||
* @param string $value optional existing value
|
||||
* @param string $classes optional class names
|
||||
* @param string $additional optional additional parameters
|
||||
*/
|
||||
public function phoneInput($name = 'phone', $value = null, $classes = '', $additional = null)
|
||||
{
|
||||
if ($value == null)
|
||||
{
|
||||
$value = array(
|
||||
'area_code' => '',
|
||||
'prefix' => '',
|
||||
'line_number' => ''
|
||||
);
|
||||
}
|
||||
else
|
||||
{
|
||||
$value = array(
|
||||
'area_code' => substr($value, 0, 3),
|
||||
'prefix' => substr($value, 3, 3),
|
||||
'line_number' => substr($value, 6)
|
||||
);
|
||||
}
|
||||
|
||||
$parts = array(
|
||||
'area_code' => 3,
|
||||
'prefix' => 3,
|
||||
'line_number' => 4
|
||||
);
|
||||
|
||||
$html = '';
|
||||
foreach ($parts as $part => $size)
|
||||
{
|
||||
$html .= '<input type="input" name="' . $name . '[' . $part . ']" id="' . $name . '[' . $part . ']" value="' . $value[$part] . '" minlength="' . $size . '" maxlength="' . $size . '" class="digits ' . $class . '" /> ';
|
||||
}
|
||||
|
||||
return $html;
|
||||
}
|
||||
}
|
||||
|
||||
?>
|
||||
Loading…
Add table
Add a link
Reference in a new issue