Changeset 893

Timestamp:

10/25/2007 08:53:51 PM (13 months ago)

Author:

Shadowhand

Message:

Small changes:

• Comments updated in helpers
  
• Small optimizations to helpers
  
• Possible issue with index.php fixed (require vs require_once)
  

Location:

trunk

Files:

• index.php (modified) (1 diff)
• system/helpers/download.php (modified) (2 diffs)
• system/helpers/file.php (modified) (3 diffs)
• system/helpers/form.php (modified) (3 diffs)
• system/helpers/inflector.php (modified) (5 diffs)
• system/helpers/security.php (modified) (4 diffs)
• system/helpers/text.php (modified) (8 diffs)
• system/helpers/url.php (modified) (6 diffs)

trunk/index.php

@@ -87 +87 @@
 );
 
-require_once SYSPATH.'core/Bootstrap'.EXT;
+require SYSPATH.'core/Bootstrap'.EXT;

trunk/system/helpers/download.php

@@ -1 +1 @@
 <?php defined('SYSPATH') or die('No direct script access.');
-/**
- * Kohana: The swift, small, and secure PHP5 framework
+/*
+ * Class: download
+ *  Download helper class.
  *
- * @package    Kohana
- * @author     Kohana Team
- * @copyright  Copyright (c) 2007 Kohana Team
- * @link       http://kohanaphp.com
- * @license    http://kohanaphp.com/license.html
- * @since      Version 2.0
- * @filesource
- * $Id$
- */
-
-/**
- * Download Class
- *
- * @category    Helpers
- * @author      Kohana Team
- * @link        http://kohanaphp.com/user_guide/en/helpers/download.html
+ * Kohana Source Code:
+ *  author    - Kohana Team
+ *  copyright - (c) 2007 Kohana Team
+ *  license   - <http://kohanaphp.com/license.html>
  */
 class download {
 
-        /**
-         * Force Download
+        /*
+         * Method: force
+         *  Force a download of a file to the user's browser. This function is
+         *  binary-safe and will work with any MIME type that Kohana is aware of.
          *
-         * Generates headers that force a download to happen
-         *
-         * @access  public
-         * @param   string  filename
-         * @param   mixed   the data to be downloaded
-         * @return  void
+         * Parameters:
+         *  filename - a file path or file name
+         *  data     - data to be sent if the filename does not exist
          */
         public static function force($filename = '', $data = '')
@@ -113 +101 @@
         }
 
-} // End download class
+} // End download

trunk/system/helpers/file.php

@@ -1 +1 @@
 <?php defined('SYSPATH') or die('No direct script access.');
-/**
- * Kohana: The swift, small, and secure PHP5 framework
+/*
+ * Class: file
+ *  File helper class.
  *
- * @package    Kohana
- * @author     Kohana Team
- * @copyright  Copyright (c) 2007 Kohana Team
- * @link       http://kohanaphp.com
- * @license    http://kohanaphp.com/license.html
- * @since      Version 2.0
- * @filesource
- * $Id$
- */
-
-/**
- * File Class
- *
- * @category    Helpers
- * @author      Kohana Team
- * @link        http://kohanaphp.com/user_guide/en/helpers/file.html
+ * Kohana Source Code:
+ *  author    - Kohana Team
+ *  copyright - (c) 2007 Kohana Team
+ *  license   - <http://kohanaphp.com/license.html>
  */
 class file {
 
+        /*
+         * Method: split
+         *  Split a file into pieces matching a specific size.
+         *
+         * Parameters:
+         *  filename   - file to be split
+         *  output_dir - directory to output to, defaults to the same directory as the file
+         *  piece_size - size, in MB, for each chunk to be
+         *
+         * Returns:
+         *  The number of pieces that were created.
+         */
         public static function split($filename, $output_dir = FALSE, $piece_size = 10)
         {
@@ -71 +72 @@
         }
 
+        /*
+         * Method: join
+         *  Join a split file into a whole fike.
+         *
+         * Parameters:
+         *  filename  - split filename, without .000 extension
+         *  output    - output filename, if different then an the filename
+         *
+         * Returns:
+         *  The number of pieces that were joined.
+         */
         public static function join($filename, $output = FALSE)
         {
@@ -109 +121 @@
         }
 
-} // End file class
+} // End file

trunk/system/helpers/form.php

@@ -1 +1 @@
 <?php defined('SYSPATH') or die('No direct script access.');
-/**
- * Kohana: The swift, small, and secure PHP5 framework
+/*
+ * Class: form
+ *  Form helper class.
  *
- * @package    Kohana
- * @author     Kohana Team
- * @copyright  Copyright (c) 2007 Kohana Team
- * @link       http://kohanaphp.com
- * @license    http://kohanaphp.com/license.html
- * @since      Version 2.0
- * @filesource
- * $Id$
- */
-
-/**
- * Form Class
- *
- * @category    Helpers
- * @author      Kohana Team
- * @link        http://kohanaphp.com/user_guide/en/helpers/form.html
+ * Kohana Source Code:
+ *  author    - Kohana Team
+ *  copyright - (c) 2007 Kohana Team
+ *  license   - <http://kohanaphp.com/license.html>
  */
 class form {
 
-        /**
-         * Form Declaration
-         *
-         * Creates the opening portion of the form.
-         *
-         * @access  public
-         * @param   string  the URI segments of the form destination
-         * @param   array   a key/value pair of attributes
-         * @param   array   a key/value pair hidden data
-         * @return  string
+        /*
+         * Method: open
+         *  Generates an opening HTML form tag.
+         *
+         * Parameters:
+         *  action - form action attribute
+         *  attr   - extra attributes
+         *  hidden - hidden fields to be created immediately after the form tag
+         *
+         * Returns:
+         *  An HTML form tag.
          */
         public static function open($action = '', $attr = array(), $hidden = array())
@@ -66 +56 @@
         }
 
+        /*
+         * Method: open_multipart
+         *  Generates an opening HTML form tag that can be used for uploading files.
+         *
+         * Parameters:
+         *  action - form action attribute
+         *  attr   - extra attributes
+         *  hidden - hidden fields to be created immediately after the form tag
+         *
+         * Returns:
+         *  An HTML form tag.
+         */
+        public static function open_multipart($action = '', $attr = array(), $hidden = array())
+        {
+                // Set multi-part form type
+                $attr['enctype'] = 'multipart/form-data';
+
+                return self::open($action, $attr, $hidden);
+        }
+
+        /**
+         * Hidden Input Field
+         *
+         * Generates hidden fields.  You can pass a simple key/value string or an associative
+         * array with multiple values.
+         *
+         * @access  public
+         * @param   mixed
+         * @param   string
+         * @return  string
+         */
+        /*
+         * Method: open
+         *  Generates hidden form fields.
+         *
+         * Parameters:
+         *  data  - input name (string) or key/value pairs (array)
+         *  value - input value, if using an input name
+         *
+         * Returns:
+         *  One or more HTML hidden form input tags.
+         */
+        public static function hidden($data, $value = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array
+                        (
+                                $data => $value
+                        );
+                }
+
+                $input = '';
+                foreach($data as $name => $value)
+                {
+                        $attr = array
+                        (
+                                'type'  => 'hidden',
+                                'name'  => $name,
+                                'value' => $value
+                        );
+
+                        $input .= self::input($attr)."\n";
+                }
+
+                return $input;
+        }
+
+        /*
+         * Method: input
+         *  Creates an HTML form input tag. Defaults to a text type.
+         *
+         * Parameters:
+         *  data  - input name or an array of HTML attributes
+         *  value - input value, when using a name
+         *  extra - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form input tag.
+         */
+        public static function input($data = '', $value = '', $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                // Type and value are required attributes
+                $data += array
+                (
+                        'type'  => 'text',
+                        'value' => $value
+                );
+
+                // Form elements should have the same id as name
+                if ( ! isset($data['id']))
+                {
+                        $data['id'] = $data['name'];
+                }
+
+                // For safe form data
+                $data['value'] = html::specialchars($data['value']);
+
+                return '<input'.self::attributes($data).$extra.' />';
+        }
+
+        /*
+         * Method: password
+         *  Creates a HTML form password input tag.
+         *
+         * Parameters:
+         *  data  - input name or an array of HTML attributes
+         *  value - input value, when using a name
+         *  extra - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form password input tag.
+         */
+        public static function password($data = '', $value = '', $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                $data['type'] = 'password';
+
+                return self::input($data, $value, $extra);
+        }
+
+        /*
+         * Method: input
+         *  Creates an HTML form upload input tag.
+         *
+         * Parameters:
+         *  data  - input name or an array of HTML attributes
+         *  value - input value, when using a name
+         *  extra - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form upload tag.
+         */
+        public static function upload($data = '', $value = '', $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                $data['type'] = 'file';
+
+                return self::input($data, $value, $extra);
+        }
+
+        /*
+         * Method: textarea
+         *  Creates an HTML form textarea tag.
+         *
+         * Parameters:
+         *  data  - textarea name or an array of HTML attributes
+         *  value - textarea value, when using a name
+         *  extra - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form textarea tag.
+         */
+        public static function textarea($data = '', $value = '', $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                // Use the value from $data if possible, or use $value
+                $value = isset($data['value']) ? $data['value'] : $value;
+
+                // Value is not part of the attributes
+                unset($data['value']);
+
+                return '<textarea'.self::attributes($data).'>'.html::specialchars($value).'</textarea>';
+        }
+
+        /*
+         * Method: dropdown
+         *  Creates an HTML form select tag, or "dropdown menu".
+         *
+         * Parameters:
+         *  data     - select name or an array of HTML attributes
+         *  options  - select options, when using a name
+         *  selected - option key that should be selected by default
+         *  extra    - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form select tag, with options.
+         */
+        public static function dropdown($data = '', $options = array(), $selected = '', $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                $input = '<select '.self::attributes($data).$extra.'>'."\n";
+                foreach ($options as $key => $val)
+                {
+                        $sel = ($selected == $key) ? ' selected="selected"' : '';
+
+                        $input .= '<option value="'.$key.'"'.$sel.'>'.$val.'</option>'."\n";
+                }
+                $input .= '</select>';
+
+                return $input;
+        }
+
+        /*
+         * Method: checkbox
+         *  Creates an HTML form checkbox input tag.
+         *
+         * Parameters:
+         *  data    - input name or an array of HTML attributes
+         *  value   - input value, when using a name
+         *  checked - make the checkbox checked by default
+         *  extra   - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form checkbox tag.
+         */
+        public static function checkbox($data = '', $value = '', $checked = FALSE, $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                $data['type'] = 'checkbox';
+
+                if ($checked == TRUE OR (isset($data['checked']) AND $data['checked'] == TRUE))
+                {
+                        $data['checked'] = 'checked';
+                }
+                else
+                {
+                        unset($data['checked']);
+                }
+
+                return self::input($data, $value, $extra);
+        }
+
+        /*
+         * Method: radio
+         *  Creates an HTML form radio input tag.
+         *
+         * Parameters:
+         *  data    - input name or an array of HTML attributes
+         *  value   - input value, when using a name
+         *  checked - make the radio selected by default
+         *  extra   - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form radio tag.
+         */
+        public static function radio($data = '', $value = '', $checked = FALSE, $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                $data['type'] = 'radio';
+
+                if ($checked == TRUE OR (isset($data['checked']) AND $data['checked'] == TRUE))
+                {
+                        $data['checked'] = 'checked';
+                }
+                else
+                {
+                        unset($data['checked']);
+                }
+
+                return self::input($data, $value, $extra);
+        }
+
+        /*
+         * Method: submit
+         *  Creates an HTML form submit input tag.
+         *
+         * Parameters:
+         *  data    - input name or an array of HTML attributes
+         *  value   - input value, when using a name
+         *  extra   - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form submit tag.
+         */
+        public static function submit($data = '', $value = '', $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                $data['type'] = 'submit';
+
+                return self::input($data, $value, $extra);
+        }
+
+        /*
+         * Method: button
+         *  Creates an HTML form button input tag.
+         *
+         * Parameters:
+         *  data    - input name or an array of HTML attributes
+         *  value   - input value, when using a name
+         *  extra   - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form button tag.
+         */
+        public static function button($data = '', $value = '', $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array('name' => $data);
+                }
+
+                $data += array
+                (
+                        'type'  => 'button'
+                );
+
+                if (isset($data['value']))
+                {
+                        $value = $data['value'];
+                        unset($data['value']);
+                }
+
+                return '<button'.self::attributes($data).$extra.'>'.html::specialchars($value).'</button>';
+        }
+
+        /*
+         * Method: close
+         *  Closes an open form tag.
+         *
+         * Parameters:
+         *  extra - string to be attached after the closing tag
+         *
+         * Returns:
+         *  A closing HTML form tag.
+         */
+        public static function close($extra = '')
+        {
+                return '</form>'."\n".$extra;
+        }
+
+        /*
+         * Method: label
+         *  Creates an HTML form label tag.
+         *
+         * Parameters:
+         *  data  - label "for" name or an array of HTML attributes
+         *  text  - label text or HTML
+         *  extra - a string to be attached to the end of the attributes
+         *
+         * Returns:
+         *  An HTML form submit tag.
+         */
+        public static function label($data = '', $text = '', $extra = '')
+        {
+                if ( ! is_array($data))
+                {
+                        $data = array
+                        (
+                                'for' => $data
+                        );
+                }
+
+                return '<label'.self::attributes($data).$extra.'>'.$text.'</label>';
+        }
+
+        /*
+         * Method: attributes
+         *  Sorts a key/value array of HTML attributes, putting form attributes first,
+         *  and returns an attribute string.
+         *
+         * Parameters:
+         *  attr - HTML attributes array
+         *
+         * Returns:
+         *  An HTML attribute string.
+         */
         public static function attributes($attr)
         {
@@ -107 +487 @@
         }
 
-        /**
-         * Form Declaration - Multipart type
-         *
-         * Creates the opening portion of the form, but with "multipart/form-data".
-         *
-         * @access  public
-         * @param   string  the URI segments of the form destination
-         * @param   array   a key/value pair of attributes
-         * @param   array   a key/value pair hidden data
-         * @return  string
-         */
-        public static function open_multipart($action = '', $attr = array(), $hidden = array())
-        {
-                // Set multi-part form type
-                $attr['enctype'] = 'multipart/form-data';
-
-                return self::open($action, $attr, $hidden);
-        }
-
-        /**
-         * Hidden Input Field
-         *
-         * Generates hidden fields.  You can pass a simple key/value string or an associative
-         * array with multiple values.
-         *
-         * @access  public
-         * @param   mixed
-         * @param   string
-         * @return  string
-         */
-        public static function hidden($data, $value = '')
-        {
-                if ( ! is_array($data))
-                {
-                        $data = array
-                        (
-                                $data => $value
-                        );
-                }
-
-                $input = '';
-                foreach($data as $name => $value)
-                {
-                        $attr = array
-                        (
-                                'type'  => 'hidden',
-                                'name'  => $name,
-                                'value' => $value
-                        );
-
-                        $input .= self::input($attr)."\n";
-                }
-
-                return $input;
-        }
-
-        /**
-         * Text Input Field
-         *
-         * @access  public
-         * @param   mixed
-         * @param   string
-         * @param   string
-         * @return  string
-         */
-        public static function input($data = '', $value = '', $extra = '')
-        {
-                if ( ! is_array($data))
-                {
-                        $data = array('name' => $data);
-                }
-
-                // Type and value are required attributes
-                $data += array
-                (
-                        'type'  => 'text',
-                        'value' => $value
-                );
-
-                // Form elements should have the same id as name
-                if ( ! isset($data['id']))
-                {
-                        $data['id'] = $data['name'];
-                }
-
-                // For safe form data
-                $data['value'] = html::specialchars($data['value']);
-
-                return '<input'.self::attributes($data).$extra.' />';
-        }
-
-        /**
-         * Password Field
-         *
-         * Identical to the input public static function but adds the "password" type
-         *
-         * @access  public
-         * @param   mixed
-         * @param   string
-         * @param   string
-         * @return  string
-         */
-        public static function password($data = '', $value = '', $extra = '')
-        {
-                if ( ! is_array($data))
-                {
-                        $data = array('name' => $