Changeset 1911

Show
Ignore:
Timestamp:
02/04/08 11:13:16 (5 months ago)
Author:
PugFish
Message:

A load more comments converted.
Fixed escaping error in fr_FR i18n file.
Fixed wrong closing tag in disabled error view.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/application/controllers/examples.php

    r1792 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Examples 
    4  *  Contains examples of various Kohana library examples. You can access these 
    5  *  samples in your own installation of Kohana by going to ROOT_URL/examples. 
     3 * Contains examples of various Kohana library examples. You can access these 
     4 * samples in your own installation of Kohana by going to ROOT_URL/examples. 
    65 * 
    7  * Kohana Source Code: 
    8  *  author    - Kohana Team 
    9  *  copyright - (c) 2007 Kohana Team 
    10  *  license   - <http://kohanaphp.com/license.html> 
     6 * $Id$ 
     7 * 
     8 * @package    Core 
     9 * @author     Kohana Team 
     10 * @copyright  (c) 2007-2008 Kohana Team 
     11 * @license    http://kohanaphp.com/license.html 
    1112 */ 
    1213class Examples_Controller extends Controller { 
    1314 
    1415        /** 
    15          * Method: index 
    16          *  Displays a list of available examples 
     16         * Displays a list of available examples 
    1717         */ 
    1818        function index() 
    …… 
    6060 
    6161        /** 
    62          * Method: template 
    63          *  Demonstrates how to use views inside of views. 
     62         * Demonstrates how to use views inside of views. 
    6463         */ 
    6564        function template() 
    …… 
    7978 
    8079        /** 
    81          * Method: rss 
    82          *  Demonstrates how to parse RSS feeds by using DOMDocument. 
     80         * Demonstrates how to parse RSS feeds by using DOMDocument. 
    8381         */ 
    8482        function rss() 
    …… 
    9492 
    9593        /** 
    96          * Method: session 
    97          *  Demonstrates the Session library and using session data. 
     94         * Demonstrates the Session library and using session data. 
    9895         */ 
    9996        function session() 
    …… 
    110107 
    111108        /** 
    112          * Method: form 
    113          *  Demonstrates how to use the form helper with the Validation library. 
     109         * Demonstrates how to use the form helper with the Validation library. 
    114110         */ 
    115111        function form() 
    …… 
    138134 
    139135        /** 
    140          * Method: validation 
    141          *  Demontrates how to use the Validation library to validate an arbitrary array. 
     136         * Demontrates how to use the Validation library to validate an arbitrary array. 
    142137         */ 
    143138        function validation() 
    …… 
    177172 
    178173        /** 
    179          * Method: database 
    180          *  Demonstrates the features of the Database library. 
     174         * Demonstrates the features of the Database library. 
     175         * 
    181176         * Table Structure: 
    182177         *  CREATE TABLE `pages` ( 
    …… 
    256251 
    257252        /** 
    258          * Method: pagination 
    259          *  Demonstrates how to use the Pagination library and Pagination styles. 
     253         * Demonstrates how to use the Pagination library and Pagination styles. 
    260254         */ 
    261255        function pagination() 
    …… 
    280274 
    281275        /** 
    282          * Method: user_agent 
    283          *  Demonstrates the User_Agent library. 
     276         * Demonstrates the User_Agent library. 
    284277         */ 
    285278        function user_agent() 
    …… 
    297290 
    298291        /** 
    299          * Method: credit_card 
    300          *  Demonstrates the CreditCard library. 
     292         * Demonstrates the Payment library. 
    301293         */ 
    302294        /*function payment() 
    …… 
    354346        } 
    355347 
    356 } // End Welcome 
     348} // End Examples 

  • trunk/system/controllers/template.php

    r1297 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    2 /** 
    3  * Kohana - The Swift PHP Framework 
    4  * 
    5  *  License: 
    6  *  author    - Kohana Team 
    7  *  copyright - (c) 2007 Kohana Team 
    8  *  license   - <http://kohanaphp.com/license.html> 
    9  */ 
    10  
    112/** 
    123 * Allows a template to be automatically loaded and displayed. Display can be 
    …… 
    145 * can be overloaded. 
    156 * 
    16  * Usage: 
    17  * To use the Template_Controller, declare your controller to extend this class: 
     7 * To use it, declare your controller to extend this class: 
    188 * `class Your_Controller extends Template_Controller` 
     9 * 
     10 * $Id$ 
     11 * 
     12 * @package    Core 
     13 * @author     Kohana Team 
     14 * @copyright  (c) 2007-2008 Kohana Team 
     15 * @license    http://kohanaphp.com/license.html 
    1916 */ 
    2017class Template_Controller extends Controller { 

  • trunk/system/i18n/fr_FR/core.php

    r1831 r1911  
    1616        'stack_trace'           => 'Stack Trace', 
    1717        'generic_error'         => 'Impossible de compléter la requete', 
    18         'errors_disabled'       => 'Vous pouvez aller sur la <a href="%s">page d'accueil</a> ou <a href="%s">essayer encore</a>.', 
     18        'errors_disabled'       => 'Vous pouvez aller sur la <a href="%s">page d\'accueil</a> ou <a href="%s">essayer encore</a>.', 
    1919 
    2020        // Resource names 

  • trunk/system/libraries/Archive.php

    r1908 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Archive 
     3 * Archive library. 
    44 * 
    55 * $Id$ 
    66 * 
    7  * @package    Cache 
     7 * @package    Archive 
    88 * @author     Kohana Team 
    9  * @copyright  (c) 2007 Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
    1010 * @license    http://kohanaphp.com/license.html 
    1111 */ 
    …… 
    5050         * 
    5151         * @param   string       file or directory to add 
    52          * @param   string|bool   
     52         * @param   string|bool 
    5353         * @return  object 
    5454         */ 
    …… 
    131131 
    132132        /** 
    133          * Method: download 
    134          *  Forces a download of a created archive. 
     133         * Forces a download of a created archive. 
    135134         * 
    136135         * @param   string   name of the file that will be downloaded 

  • trunk/system/libraries/Cache.php

    r1842 r1911  
    99 * @package    Cache 
    1010 * @author     Kohana Team 
    11  * @copyright  (c) 2007 Kohana Team 
     11 * @copyright  (c) 2007-2008 Kohana Team 
    1212 * @license    http://kohanaphp.com/license.html 
    1313 */ 

  • trunk/system/libraries/Calendar.php

    r1670 r1911  
    77 * @package    Calendar 
    88 * @author     Kohana Team 
    9  * @copyright  (c) 2007 Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
    1010 * @license    http://kohanaphp.com/license.html 
    1111 */ 

  • trunk/system/libraries/Database.php

    r1906 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Database 
    4  *  Provides database access in a platform agnostic way, using simple query building blocks. 
     3 * Provides database access in a platform agnostic way, using simple query building blocks. 
    54 * 
    6  * Kohana Source Code: 
    7  *  author    - Kohana Team 
    8  *  copyright - (c) 2007 Kohana Team 
    9  *  copyright - (c) 2006 EllisLab, Inc. 
    10  *  license   - <http://www.codeigniter.com/user_guide/license.html> 
     5 * $Id$ 
     6 * 
     7 * @package    Core 
     8 * @author     Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
     10 * @license    http://kohanaphp.com/license.html 
    1111 */ 
    1212class Database_Core { 

  • trunk/system/libraries/Encrypt.php

    r1668 r1911  
    99 * @package    Core 
    1010 * @author     Kohana Team 
    11  * @copyright  (c) 2007 Kohana Team 
     11 * @copyright  (c) 2007-2008 Kohana Team 
    1212 * @license    http://kohanaphp.com/license.html 
    1313 */ 

  • trunk/system/libraries/Image.php

    r1884 r1911  
    33 * Manipulate images using standard methods such as resize, crop, rotate, etc. 
    44 * This class must be re-initialized for every image you wish to manipulate. 
    5  *  
     5 * 
    66 * $Id$ 
    77 * 
    88 * @package    Image 
    99 * @author     Kohana Team 
    10  * @copyright  (c) 2007 Kohana Team 
     10 * @copyright  (c) 2007-2008 Kohana Team 
    1111 * @license    http://kohanaphp.com/license.html 
    1212 */ 

  • trunk/system/libraries/Input.php

    r1846 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Input 
     3 * Input library. 
    44 * 
    5  * Kohana Source Code: 
    6  *  author    - Rick Ellis, Kohana Team 
    7  *  copyright - Copyright (c) 2006, EllisLab, Inc. 
    8  *  license   - <http://www.codeigniter.com/user_guide/license.html> 
     5 * $Id$ 
     6 * 
     7 * @package    Core 
     8 * @author     Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
     10 * @license    http://kohanaphp.com/license.html 
    911 */ 
    1012class Input_Core { 
    …… 
    3335 
    3436        /** 
    35          * Constructor: __construct 
    36          *  Sets whether to globally enable the XSS processing and whether to allow the $_GET array. 
     37         * Sets whether to globally enable the XSS processing. 
    3738         */ 
    3839        public function __construct() 
    …… 
    123124 
    124125        /** 
    125          * Method: __call 
    126          *  Fetch an item from a global array. 
    127          * 
    128          * Parameters: 
    129          *  global - array to access (get, post, cookie or server) 
    130          *  args   - arguments (array key, xss_clean) 
    131          * 
    132          * Returns: 
    133          *  Value of array item 
     126         * Fetch an item from a global array. 
     127         * 
     128         * @param   string  array to access (get, post, cookie or server) 
     129         * @param   array   arguments (array key, xss_clean) 
     130         * @return  mixed 
    134131         */ 
    135132        public function __call($global, $args = array()) 
    …… 
    179176 
    180177        /** 
    181          * Method: clean_input_data 
    182          *  This is a helper function. It escapes data and standardizes newline characters to '\n'. 
    183          * 
    184          * Parameters: 
    185          *  str - string to clean 
    186          * 
    187          * Returns: 
    188          *  Cleaned string 
     178         * This is a helper function. It escapes data and standardizes newline characters to '\n'. 
     179         * 
     180         * @param   unknown_type  string to clean 
     181         * @return  string 
    189182         */ 
    190183        protected function clean_input_data($str) 
    …… 
    215208 
    216209        /** 
    217          * Method: clean_input_keys 
    218          *  This is a helper function. To prevent malicious users 
    219          *  from trying to exploit keys we make sure that keys are 
    220          *  only named with alpha-numeric text and a few other items. 
    221          * 
    222          * Parameters: 
    223          *  str - string to clean 
    224          * 
    225          * Returns: 
    226          *  Cleaned string 
     210         * This is a helper function. To prevent malicious users 
     211         * from trying to exploit keys we make sure that keys are 
     212         * only named with alpha-numeric text and a few other items. 
     213         * 
     214         * @param   string  string to clean 
     215         * @return  string 
    227216         */ 
    228217        protected function clean_input_keys($str) 
    …… 
    239228 
    240229        /** 
    241          * Method: ip_address 
    242          *  Fetch the IP Address. 
    243          * 
    244          * Returns: 
    245          *  IP address 
     230         * Fetch the IP Address. 
     231         * 
     232         * @return string 
    246233         */ 
    247234        public function ip_address() 
    …… 
    288275 
    289276        /** 
    290          * Method: valid_ip 
    291          *  Validates an IPv4 address based on RFC specifications. 
    292          * 
    293          * Parameters: 
    294          *  ip - IP to validate 
    295          * 
    296          * Returns: 
    297          *  TRUE or FALSE 
     277         * Validates an IPv4 address based on RFC specifications. 
     278         * 
     279         * @param   string  IP to validate 
     280         * @return  boolean 
    298281         */ 
    299282        public function valid_ip($ip) 
    …… 
    303286 
    304287        /** 
    305          * Method: user_agent 
    306          *  Get the user agent of the current request. 
    307          * 
    308          * Returns: 
    309          *  The user agent 
     288         * Get the user agent of the current request. 
     289         * 
     290         * @return string 
    310291         */ 
    311292        public function user_agent() 
    …… 
    315296 
    316297        /** 
    317          * Method: xss_clean 
    318          *  Clean cross site scripting exploits from string. 
    319          *  HTMLPurifier may be used if installed, otherwise defaults to built in method. 
    320          *  Note - This function should only be used to deal with data upon submission. 
    321          *  It's not something that should be used for general runtime processing 
    322          *  since it requires a fair amount of processing overhead. 
    323          * 
    324          * Parameters: 
    325          *  data - data to clean 
    326          *  tool - xss_clean method to use ('htmlpurifier' or defaults to built in method) 
    327          * 
    328          * Returns: 
    329          *  Cleaned data 
     298         * Clean cross site scripting exploits from string. 
     299         * HTMLPurifier may be used if installed, otherwise defaults to built in method. 
     300         * Note - This function should only be used to deal with data upon submission. 
     301         * It's not something that should be used for general runtime processing 
     302         * since it requires a fair amount of processing overhead. 
     303         * 
     304         * @param   string  data to clean 
     305         * @param   string  xss_clean method to use ('htmlpurifier' or defaults to built in method) 
     306         * @return  string 
    330307         */ 
    331308        public function xss_clean($data, $tool = NULL) 

  • trunk/system/libraries/Model.php

    r1522 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Model 
     3 * Model class. 
    44 * 
    5  * Kohana Source Code: 
    6  *  author    - Kohana Team 
    7  *  copyright - (c) 2007 Kohana Team 
    8  *  license   - <http://kohanaphp.com/license.html> 
     5 * $Id$ 
     6 * 
     7 * @package    Core 
     8 * @author     Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
     10 * @license    http://kohanaphp.com/license.html 
    911 */ 
    1012class Model_Core { 
    …… 
    1315 
    1416        /** 
    15          * Constructor: __construct 
    16          *  Loads database to $this->db. 
     17         * Loads database to $this->db. 
    1718         */ 
    1819        public function __construct() 
    …… 
    2930        } 
    3031 
    31 } // End Model Core 
     32} // End Model class 

  • trunk/system/libraries/Pagination.php

    r1905 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Pagination 
     3 * Pagination library. 
    44 * 
    5  * Kohana Source Code: 
    6  *  author    - Kohana Team 
    7  *  copyright - (c) 2007 Kohana Team 
    8  *  license   - <http://kohanaphp.com/license.html> 
     5 * $Id$ 
     6 * 
     7 * @package    Core 
     8 * @author     Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
     10 * @license    http://kohanaphp.com/license.html 
    911 */ 
    1012class Pagination_Core { 
    …… 
    3436         * Constructs the Pagination object. 
    3537         * 
    36          * @param  array  configuration 
    37          * @return void 
     38         * @param  array  configuration 
     39         * @return void 
    3840         */ 
    3941        public function __construct($config = array()) 
    …… 
    5052         * Sets or overwrites (some) config values. 
    5153         * 
    52          * @param  array  configuration 
    53          * @return void 
     54         * @param  array  configuration 
     55         * @return void 
    5456         */ 
    5557        public function initialize($config = array()) 
    …… 
    112114         * Generates the HTML for the chosen pagination style. 
    113115         * 
    114          * @param  string  pagination style 
    115          * @return string  pagination html 
     116         * @param  string  pagination style 
     117         * @return string  pagination html 
    116118         */ 
    117119        public function create_links($style = NULL) 
    …… 
    125127         * Magically converts pagination object to string. 
    126128         * 
    127          * @return string  pagination html 
     129         * @return string  pagination html 
    128130         */ 
    129131        public function __toString() 
    …… 
    135137         * Magically gets a pagination variable. 
    136138         * 
    137          * @param  string  variable key 
    138          * @return mixed   variable value if the key is found 
    139          * @return void    if the key is not found 
     139         * @param  string  variable key 
     140         * @return mixed   variable value if the key is found 
     141         * @return void    if the key is not found 
    140142         */ 
    141143        public function __get($key) 
    …… 
    148150         * Gets the SQL offset of the first row to return. Deprecated. 
    149151         * 
    150          * @return integer  sql offset 
     152         * @return integer  sql offset 
    151153         */ 
    152154        public function sql_offset() 
    …… 
    158160         * Generates the complete SQL LIMIT clause. Deprecated. 
    159161         * 
    160          * @return string  sql limit clause 
     162         * @return string  sql limit clause 
    161163         */ 
    162164        public function sql_limit() 

  • trunk/system/libraries/Payment.php

    r1842 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Payment_Core 
    4  *  Provides payment support for credit cards and other providers like PayPal 
     3 * Provides payment support for credit cards and other providers like PayPal. 
    54 * 
    6  * Kohana Source Code: 
    7  *  author    - Kohana Team 
    8  *  copyright - (c) 2007 Kohana Team 
    9  *  license   - <http://kohanaphp.com/license.html> 
     5 * $Id$ 
     6 * 
     7 * @package    Payment 
     8 * @author     Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
     10 * @license    http://kohanaphp.com/license.html 
    1011 */ 
    1112class Payment_Core { 
    …… 
    2324 
    2425        /** 
    25          * Constructor: __construct 
    26          *  Sets the payment processing fields. 
    27          *  The driver will translate these into the specific format for the provider. 
    28          *  Standard fields are (Providers may have additional or different fields): 
     26         * Sets the payment processing fields. 
     27         * The driver will translate these into the specific format for the provider. 
     28         * Standard fields are (Providers may have additional or different fields): 
    2929         * 
    30          * card_num 
    31          * exp_date 
    32          * cvv 
    33          * description 
    34          * amount 
    35          * tax 
    36          * shipping 
    37          * first_name 
    38          * last_name 
    39          * company 
    40          * address 
    41          * city 
    42          * state 
    43          * zip 
    44          * email 
    45          * phone 
    46          * fax 
    47          * ship_to_first_name 
    48          * ship_to_last_name 
    49          * ship_to_company 
    50          * ship_to_address 
    51          * ship_to_city 
    52          * ship_to_state 
    53          * ship_to_zip 
     30         * card_num 
     31         * exp_date 
     32         * cvv 
     33         * description 
     34         * amount 
     35         * tax 
     36         * shipping 
     37         * first_name 
     38         * last_name 
     39         * company 
     40         * address 
     41         * city 
     42         * state 
     43         * zip 
     44         * email 
     45         * phone 
     46         * fax 
     47         * ship_to_first_name 
     48         * ship_to_last_name 
     49         * ship_to_company 
     50         * ship_to_address 
     51         * ship_to_city 
     52         * ship_to_state 
     53         * ship_to_zip 
    5454         * 
    55          * Parameters: 
    56          *  config - the driver string 
     55         * @param  array  the driver string 
    5756         */ 
    5857        public function __construct($config = array()) 
    …… 
    9089 
    9190        /** 
    92          * Method: __set 
    93          *  Sets the credit card processing fields 
     91         * Sets the credit card processing fields 
    9492         * 
    95          * Parameters: 
    96          *  name - the field name 
    97          *  val  - the value 
     93         * @param  string  field name 
     94         * @param  string  value 
    9895         */ 
    9996        public function __set($name, $val) 
    …… 
    103100 
    104101        /** 
    105          * Method: set_fields 
    106          *  Bulk setting of payment processing fields 
     102         * Bulk setting of payment processing fields. 
    107103         * 
    108          * Parameters: 
    109          *  fields - an array of values to set 
    110          * 
    111          * Returns: 
    112          *  <Payment> object 
     104         * @param   array   array of values to set 
     105         * @return  object  this object 
    113106         */ 
    114107        public function set_fields($fields) 
    …… 
    120113 
    121114        /** 
    122          * Method: process 
    123          *  Runs the transaction 
     115         * Runs the transaction 
    124116         * 
    125          * Returns: 
    126          *  TRUE on successful payment, an error string on failure 
     117         * @return  TRUE|string  TRUE on successful payment, an error string on failure 
    127118         */ 
    128119        public function process() 

  • trunk/system/libraries/Profiler.php

    r1761 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Profiler 
    4  *  Adds useful information to the bottom of the current page for debugging and optimization purposes. 
     3 * Adds useful information to the bottom of the current page for debugging and optimization purposes. 
    54 * 
    6  * Benchmarks   - The times and memory usage of benchmarks run by the <Benchmark> library 
    7  * Database     - The raw SQL and number of affected rows of <Database> queries 
    8  * POST Data    - The name and values of any POST data submitted to the current page 
    9  * Session Data - Data stored in the current session if using the <Session> library 
     5 * Benchmarks   - The times and memory usage of benchmarks run by the <Benchmark> library 
     6 * Database     - The raw SQL and number of affected rows of <Database> queries 
     7 * POST Data    - The name and values of any POST data submitted to the current page 
     8 * Session Data - Data stored in the current session if using the <Session> library 
    109 * 
    11  * Kohana Source Code: 
    12  *  author    - Kohana Team 
    13  *  copyright - (c) 2007 Kohana Team 
    14  *  license   - <http://kohanaphp.com/license.html> 
     10 * $Id$ 
     11 * 
     12 * @package    Core 
     13 * @author     Kohana Team 
     14 * @copyright  (c) 2007-2008 Kohana Team 
     15 * @license    http://kohanaphp.com/license.html 
    1516 */ 
    1617class Profiler_Core { 
    1718 
    1819        /** 
    19          * Constructor: __construct 
    20          *  Adds event for adding the profile output to the page when displayed. 
     20         * Adds event for adding the profile output to the page when displayed. 
    2121         */ 
    2222        public function __construct() 
    …… 
    2929 
    3030        /** 
    31          * Method: disable 
    32          *  Disables the profiler for this page only. 
    33          *  Best used when profiler is autoloaded. 
     31         * Disables the profiler for this page only. 
     32         * Best used when profiler is autoloaded. 
    3433         */ 
    3534        public function disable() 
    …… 
    4039 
    4140        /** 
    42          * Method: render 
    43          *  Render the profiler. Output is added to 
    44          *  the bottom of the page by default. 
     41         * Render the profiler. Output is added to the bottom of the page by default. 
    4542         * 
    46          * Parameters: 
    47          *  return - return the output if TRUE 
    48          * 
    49          * Returns: 
    50          *  The profiler output if $return is TRUE 
     43         * @param   boolean  return the output if TRUE 
     44         * @return  void|string 
    5145         */ 
    5246        public function render($return = FALSE) 

  • trunk/system/libraries/Router.php

    r1850 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Router 
     3 * Router 
    44 * 
    5  * Kohana Source Code: 
    6  *  author    - Kohana Team 
    7  *  copyright - (c) 2007 Kohana Team 
    8  *  license   - <http://kohanaphp.com/license.html> 
     5 * $Id$ 
     6 * 
     7 * @package    Core 
     8 * @author     Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
     10 * @license    http://kohanaphp.com/license.html 
    911 */ 
    1012class Router_Core { 
    …… 
    2527 
    2628        /** 
    27          * Method: setup 
    28          *  Router setup routine. Automatically called during Kohana setup process. 
     29         * Router setup routine. Automatically called during Kohana setup process. 
    2930         */ 
    3031        public static function setup() 
    …… 
    178179 
    179180        /** 
    180          * Method: find_uri 
    181          *  Attempts to determine the current URI using CLI, GET, PATH_INFO, ORIG_PATH_INFO, or PHP_SELF. 
     181         * Attempts to determine the current URI using CLI, GET, PATH_INFO, ORIG_PATH_INFO, or PHP_SELF. 
    182182         */ 
    183183        public static function find_uri() 
    …… 
    256256 
    257257        /** 
    258          * Method: filter_uri 
    259          *  Filter a string for allowed URI characters. 
     258         * Filter a string for allowed URI characters. 
    260259         * 
    261          * Parameters: 
    262          *  str - string to filter 
    263          * 
    264          * Returns: 
    265          *  Filtered string 
     260         * @param   string  string to filter 
     261         * @return  string 
    266262         */ 
    267263        public static function filter_uri($str) 

  • trunk/system/libraries/Session.php

    r1902 r1911  
    11<?php defined('SYSPATH') or die('No direct script access.'); 
    22/** 
    3  * Class: Session 
     3 * Session library. 
    44 * 
    5  * Kohana Source Code: 
    6  *  author    - Kohana Team 
    7  *  copyright - (c) 2007 Kohana Team 
    8  *  license   - <http://kohanaphp.com/license.html> 
     5 * $Id$ 
     6 * 
     7 * @package    Core 
     8 * @author     Kohana Team 
     9 * @copyright  (c) 2007-2008 Kohana Team 
     10 * @license    http://kohanaphp.com/license.html 
    911 */ 
    1012class Session_Core { 
    …… 
    3840 
    3941        /** 
    40          * Constructor: __construct 
    41          *  On first session instance creation, sets up the driver and creates session. 
     42         * On first session instance creation, sets up the driver and creates session. 
    4243         */ 
    4344        public function __construct() 
    …… 
    9293 
    9394        /** 
    94          * Method: id 
    95          *  Get the session id. 
    96          * 
    97          * Returns: 
    98          *  Session id 
     95         * Get the session id. 
     96         * 
     97         * @return  string 
    9998         */ 
    10099        public function id() 
    …… 
    104103 
    105104        /** 
    106          * Method: create 
    107          *  Create a new session. 
     105         * Create a new session. 
     106         * 
     107         * @param   array  variables to set after creation 
     108         * @return  void 
    108109         */ 
    109110        public function create($vars = NULL) 
    …… 
    233234 
    234235        /** 
    235          * Method: regenerate 
    236          *  Regenerates the global session id. 
     236         * Regenerates the global session id. 
    237237         */ 
    238238        public function regenerate() 
    …… 
    254254 
    255255        /** 
    256          * Method: destroy 
    257          *  Destroys the current session. 
    258          * 
    259          * Returns: 
    260          *  TRUE or FALSE (or NULL if called before session_start()) 
     256         * Destroys the current session. 
     257         * 
     258         * @return  boolean 
    261259         */ 
    262260        public function destroy() 
    …… 
    297295 
    298296        /** 
    299          * Method: set 
    300          *  Set a session variable. 
    301          * 
    302          * Parameters: 
    303          *  keys - array of values, or key 
    304          *  val  - value (if keys is not an array) 
     297         * Set a session variable. 
     298         * 
     299         * @param   string|array  key, or array of values 
     300         * @param   mixed         value (if keys is not an array) 
     301         * @return  void 
    305302         */ 
    306303        public function set($keys, $val = FALSE) 
    …… 
    325322 
    326323        /** 
    327          * Method: set_flash 
    328          *  Set a flash variable. 
    329          * 
    330          * Parameters: 
    331          *  keys - array of values, or key 
    332          *  val  - value (if keys is not an array) 
     324         * Set a flash variable. 
     325         * 
     326         * @param   string|array  key, or array of values 
     327         * @param   mixed         value (if keys is not an array) 
     328         * @return  void 
    333329         */ 
    334330        public function set_flash($keys, $val = FALSE) 
    …… 
    353349 
    354350        /** 
    355          * Method: keep_flash 
    356          *  Freshen a flash variable. 
    357          * 
    358          * Parameters: 
    359          *  key - variable key 
     351         * Freshen a flash variable. 
     352         * 
     353         * @param   string   variable key 
     354         * @return  boolean 
    360355         */ 
    361356        public function keep_flash($key) 
    …… 
    371366 
    372367        /** 
    373          * Method: get 
    374          *  Get a variable. Access to sub-arrays is supported with key.subkey. 
    375          * 
    376          * Parameters: 
    377          *  key     - variable key (optional) 
    378          *  default - default value returned if variable does not exist 
    379          * 
    380          * Returns: 
    381          *   Variable data if key specified, otherwise array containing all session data 
     368         * Get a variable. Access to sub-arrays is supported with key.subkey. 
     369         * 
     370         * @param   string  variable key 
     371         * @param   mixed   default value returned if variable does not exist 
     372         * @return  mixed   Variable data if key specified, otherwise array containing all session data. 
    382373         */ 
    383374        public function get($key = FALSE, $default = FALSE) 
    …… 
    392383 
    393384        /** 
    394          * Method: get_once 
    395          *  Get a variable, and delete it. 
    396          * 
    397          * Parameters: 
    398          *  key - variable key (optional) 
    399