Changeset 932

Show
Ignore:
Timestamp:
11/01/2007 03:14:45 AM (11 months ago)
Author:
PugFish
Message:

Englishised some descriptions
Converted Validation to new comments

Location:
trunk/system/libraries
Files:
16 modified

Legend:

Unmodified
Added
Removed

  • trunk/system/libraries/Cache.php

    r931 r932  
    1616        /* 
    1717         * Method: __construct 
    18          *  Set up driver and get groups 
     18         *  Set up driver and get groups. 
    1919         * 
    2020         * Parameters: 
    … …  
    3030        /* 
    3131         * Method: get 
    32          *  Get data from cache 
     32         *  Get data from cache. 
    3333         * 
    3434         * Parameters: 
    … …  
    4545        /* 
    4646         * Method: set 
    47          *  Save data into cache 
     47         *  Save data into cache. 
    4848         * 
    4949         * Parameters: 
    … …  
    6161        /* 
    6262         * Method: del 
    63          *  Delete cache entry 
     63         *  Delete cache entry. 
    6464         * 
    6565         * Parameters: 

  • trunk/system/libraries/Calendar.php

    r929 r932  
    2121        /* 
    2222         * Method: __construct 
    23          *  Sets the default time reference 
     23         *  Sets the default time reference. 
    2424         * 
    2525         * Parameters: 
    … …  
    4141         * Method: initialize 
    4242         *  Initialize the user preferences.  
    43          *  Accepts an associative array as input, containing display preferences 
    44          * 
    45          * Parameters: 
    46          *  config - config preferences 
     43         * 
     44         * Parameters: 
     45         *  config - display preferences 
    4746         */ 
    4847        private function initialize($config = array()) 
    … …  
    5958        /* 
    6059         * Method: generate 
    61          *  Generate the calendar 
     60         *  Generate the calendar. 
    6261         * 
    6362         * Parameters: 
    … …  
    332331        /* 
    333332         * Method: get_total_days 
    334          *  Total days in a given month 
     333         *  Total days in a given month. 
    335334         * 
    336335         * Parameters: 
    … …  
    364363        /* 
    365364         * Method: default_template 
    366          *  This is used in the event that the user has not created their own template 
     365         *  This is used in the event that the user has not created their own template. 
    367366         * 
    368367         * Returns: 
    … …  
    398397        /* 
    399398         * Method: parse_template 
    400          *  Harvests the data within the template {pseudo-variables} used to display the calendar 
     399         *  Harvests the data within the template {pseudo-variables} used to display the calendar. 
    401400         */ 
    402401        private function parse_template() 

  • trunk/system/libraries/Controller.php

    r929 r932  
    1212        /* 
    1313         * Method: __construct 
    14          *  Loads the Input, URI and Loader libraries into the '$this' namespace 
     14         *  Loads the Input, URI and Loader libraries into the '$this' namespace. 
    1515         */ 
    1616        public function __construct() 
    … …  
    3131        /* 
    3232         * Method: kohana_include_view 
    33          *  Includes a View within the controller scope 
     33         *  Includes a View within the controller scope. 
    3434         * 
    3535         * Parameters: 

  • trunk/system/libraries/Encrypt.php

    r931 r932  
    3030         * Method: get_key 
    3131         *  Returns it as MD5 in order to have an exact-length 128 bit key. 
    32          *  mcrypt is sensitive to keys that are not the correct length 
     32         *  mcrypt is sensitive to keys that are not the correct length. 
    3333         * 
    3434         * Parameters: 
    … …  
    5454        /* 
    5555         * Method: set_key 
    56          *  Set the encryption key 
     56         *  Set the encryption key. 
    5757         * 
    5858         * Parameters: 
    … …  
    9696        /* 
    9797         * Method: decode 
    98          *  Reverses the encode process 
     98         *  Reverses the encode process. 
    9999         * 
    100100         * Parameters: 
    … …  
    123123        /* 
    124124         * Method: xor_encode 
    125          *  Takes a plain-text string and key as input and generates an encoded bit-string using XOR 
     125         *  Takes a plain-text string and key as input and generates an encoded bit-string using XOR. 
    126126         * 
    127127         * Parameters: 
    … …  
    154154        /* 
    155155         * Method: xor_decode 
    156          *  Takes an encoded string and key as input and generates the plain-text original message 
     156         *  Takes an encoded string and key as input and generates the plain-text original message. 
    157157         * 
    158158         * Parameters: 
    … …  
    178178        /* 
    179179         * Method: xor_merge 
    180          *  Takes a string and key as input and computes the difference using XOR 
     180         *  Takes a string and key as input and computes the difference using XOR. 
    181181         * 
    182182         * Parameters: 
    … …  
    202202        /* 
    203203         * Method: mcrypt_encode 
    204          *  Encrypt using mcrypt 
     204         *  Encrypt using mcrypt.. 
    205205         * 
    206206         * Parameters: 
    … …  
    221221        /* 
    222222         * Method: mcrypt_decode 
    223          *  Decrypt using mcrypt 
     223         *  Decrypt using mcrypt. 
    224224         * 
    225225         * Parameters: 
    … …  
    240240        /* 
    241241         * Method: set_cipher 
    242          *  Set the mcrypt Cipher 
     242         *  Set the mcrypt Cipher. 
    243243         * 
    244244         * Parameters: 
    … …  
    252252        /* 
    253253         * Method: set_mode 
    254          *  Set the mcrypt Mode 
     254         *  Set the mcrypt Mode. 
    255255         * 
    256256         * Parameters: 
    … …  
    264264        /* 
    265265         * Method: get_cipher 
    266          *  Get mcrypt cipher Value 
     266         *  Get mcrypt cipher Value. 
    267267         * 
    268268         * Returns: 
    … …  
    281281        /* 
    282282         * Method: get_mode 
    283          *  Get mcrypt Mode Value 
     283         *  Get mcrypt Mode Value. 
    284284         * 
    285285         * Returns: 
    … …  
    298298        /* 
    299299         * Method: set_hash 
    300          *  Set the Hash type 
     300         *  Set the Hash type. 
    301301         * 
    302302         * Parameters: 
    … …  
    310310        /* 
    311311         * Method: hash 
    312          *  Hash encode a string 
     312         *  Hash encode a string. 
    313313         * 
    314314         * Parameters: 

  • trunk/system/libraries/Ftp.php

    r931 r932  
    2020        /* 
    2121         * Method: __construct 
    22          *  Sets Preferences. Can be passed an array of config values 
     22         *  Sets Preferences. 
     23         * 
     24         * Parameters: 
     25         *  config - custom configuration 
    2326         */ 
    2427        public function __construct($config = array()) 
    … …  
    3437        /* 
    3538         * Method: initialize 
    36          *  Initialize preferences 
    37          * 
    38          * Parameters: 
    39          *  config - config preferences 
     39         *  Initialize preferences. 
     40         * 
     41         * Parameters: 
     42         *  config - custom configuration 
    4043         */ 
    4144        public function initialize($config = array()) 
    … …  
    5558        /* 
    5659         * Method: connect 
    57          *  Connect to the FTP 
     60         *  Connect to the FTP. 
    5861         * 
    5962         * Parameters: 
    … …  
    99102        /* 
    100103         * Method: login 
    101          *  Login to the FTP 
     104         *  Login to the FTP. 
    102105         * 
    103106         * Returns: 
    … …  
    111114        /* 
    112115         * Method: is_conn 
    113          *  Validates the connection ID 
     116         *  Validates the connection ID. 
    114117         * 
    115118         * Returns: 
    … …  
    168171        /* 
    169172         * Method: mkdir 
    170          *  Create a directory 
     173         *  Create a directory. 
    171174         * 
    172175         * Parameters: 
    … …  
    204207        /* 
    205208         * Method: upload 
    206          *  Upload a file to the server 
     209         *  Upload a file to the server. 
    207210         * 
    208211         * Parameters: 
    … …  
    258261        /* 
    259262         * Method: rename 
    260          *  Rename (or move) a file 
     263         *  Rename (or move) a file. 
    261264         * 
    262265         * Parameters: 
    … …  
    291294        /* 
    292295         * Method: move 
    293          *  Move a file 
     296         *  Move a file. 
    294297         * 
    295298         * Parameters: 
    … …  
    307310        /* 
    308311         * Method: delete_file 
    309          *  Delete a file 
     312         *  Delete a file. 
    310313         * 
    311314         * Parameters: 
    … …  
    336339        /* 
    337340         * Method: delete_dir 
    338          *  Delete a folder and recursively delete everything (including sub-folders) contained within it 
     341         *  Delete a folder and recursively delete everything (including sub-folders) contained within it. 
    339342         * 
    340343         * Parameters: 
    … …  
    383386        /* 
    384387         * Method: chmod 
    385          *  Set file permissions 
     388         *  Set file permissions. 
    386389         * 
    387390         * Parameters: 
    … …  
    423426        /* 
    424427         * Method: list_files 
    425          *  FTP List files in the specified directory 
     428         *  FTP List files in the specified directory. 
    426429         * 
    427430         * Parameters: 
    … …  
    447450         *  This function recursively reads a folder and everything it contains (including 
    448451         *  sub-folders) and creates a mirror via FTP based on it.  Whatever the directory structure 
    449          *  of the original file path will be recreated on the server 
     452         *  of the original file path will be recreated on the server. 
    450453         * 
    451454         * Parameters: 
    … …  
    496499        /* 
    497500         * Method: get_extension 
    498          *  Extract the file extension 
     501         *  Extract the file extension. 
    499502         * 
    500503         * Parameters: 
    … …  
    517520        /* 
    518521         * Method: set_type 
    519          *  Returns the transfer mode for a file extension (ascii or binary) 
     522         *  Returns the transfer mode for a file extension (ascii or binary). 
    520523         * 
    521524         * Parameters: 
    … …  
    549552        /* 
    550553         * Method: close 
    551          *  Close the connection 
     554         *  Close the connection. 
    552555         * 
    553556         * Returns: 
    … …  
    564567        /* 
    565568         * Method: error 
    566          *  Display error message 
     569         *  Display error message. 
    567570         * 
    568571         * Parameters: 

  • trunk/system/libraries/Input.php

    r931 r932  
    1919        /* 
    2020         * Method: __construct 
    21          *  Sets whether to globally enable the XSS processing and whether to allow the $_GET array 
     21         *  Sets whether to globally enable the XSS processing and whether to allow the $_GET array. 
    2222         */ 
    2323        public function __construct() 
    … …  
    9696        /* 
    9797         * Method: __call 
    98          *  Fetch an item from a global array 
     98         *  Fetch an item from a global array. 
    9999         * 
    100100         * Parameters: 
    … …  
    153153        /* 
    154154         * Method: clean_input_data 
    155          *  This is a helper function. It escapes data and standardizes newline characters to \n 
     155         *  This is a helper function. It escapes data and standardizes newline characters to '\n'. 
    156156         * 
    157157         * Parameters: 
    … …  
    211211        /* 
    212212         * Method: ip_address 
    213          *  Fetch the IP Address 
     213         *  Fetch the IP Address. 
    214214         * 
    215215         * Returns: 
    … …  
    260260        /* 
    261261         * Method: valid_ip 
    262          *  Validates an IPv4 address based on RFC specifications 
     262         *  Validates an IPv4 address based on RFC specifications. 
    263263         * 
    264264         * Parameters: 
    … …  
    275275        /* 
    276276         * Method: user_agent 
    277          *  Get the user agent of the current request 
     277         *  Get the user agent of the current request. 
    278278         * 
    279279         * Returns: 

  • trunk/system/libraries/Loader.php

    r931 r932  
    1212        /* 
    1313         * Method: __construct 
    14          *  Autoloads libraries and models specified in config file 
     14         *  Autoloads libraries and models specified in config file. 
    1515         */ 
    1616        public function __construct() 
    … …  
    4646        /* 
    4747         * Method: library 
    48          *  Load library 
     48         *  Load library. 
    4949         * 
    5050         * Parameters: 
    … …  
    8080        /* 
    8181         * Method: database 
    82          *  Load database 
     82         *  Load database. 
    8383         * 
    8484         * Parameters: 
    … …  
    102102        /* 
    103103         * Method: helper 
    104          *  Load helper 
     104         *  Load helper. 
    105105         * 
    106106         * Parameters: 
    … …  
    127127        /* 
    128128         * Method: model 
    129          *  Load model 
     129         *  Load model. 
    130130         * 
    131131         * Parameters: 
    … …  
    166166        /* 
    167167         * Method: view 
    168          *  Load view 
     168         *  Load view. 
    169169         * 
    170170         * Parameters: 

  • trunk/system/libraries/Model.php

    r931 r932  
    1212        /* 
    1313         * Method: __construct 
    14          *  Loads database into '$this->db' 
     14         *  Loads database into '$this->db'. 
    1515         */ 
    1616        public function __construct() 

  • trunk/system/libraries/Pagination.php

    r931 r932  
    2828        /* 
    2929         * Method: __construct 
    30          *  Sets up the config values 
     30         *  Sets up the config values. 
    3131         * 
    3232         * Parameters: 
    … …  
    9797        /* 
    9898         * Method: create_links 
    99          *  Generates the HTML for the chosen pagination style 
     99         *  Generates the HTML for the chosen pagination style. 
    100100         * 
    101101         * Parameters: 
    … …  
    119119        /* 
    120120         * Method: url 
    121          *  Get the base_url with the specified page number 
     121         *  Get the base_url with the specified page number. 
    122122         * 
    123123         * Parameters: 
    … …  
    136136        /* 
    137137         * Method: sql_offset 
    138          *  Get the SQL offset of the first row to return 
     138         *  Get the SQL offset of the first row to return. 
    139139         * 
    140140         * Returns: 
    … …  
    148148        /* 
    149149         * Method: url 
    150          *  Generate the complete SQL LIMIT clause 
     150         *  Generate the complete SQL LIMIT clause. 
    151151         * 
    152152         * Returns: 

  • trunk/system/libraries/Profiler.php

    r931 r932  
    4040        /* 
    4141         * Method: render 
    42          *  Run the Profiler and add to the bottom of the page 
     42         *  Run the Profiler and add to the bottom of the page. 
    4343         */ 
    4444        public function render() 

  • trunk/system/libraries/Router.php

    r931 r932  
    248248        /* 
    249249         * Method: filter_uri 
    250          *  Filter a string for allowed URI characters 
     250         *  Filter a string for allowed URI characters. 
    251251         * 
    252252         * Parameters: 

  • trunk/system/libraries/Session.php

    r931 r932  
    2828        /* 
    2929         * Method: __construct 
    30          *  On first session instance creation, sets up the driver and creates session 
     30         *  On first session instance creation, sets up the driver and creates session. 
    3131         */ 
    3232        public function __construct() 
    … …  
    8888        /* 
    8989         * Method: id 
    90          *  Get the session id 
     90         *  Get the session id. 
    9191         * 
    9292         * Returns: 
    … …  
    100100        /* 
    101101         * Method: create 
    102          *  Create a new session 
     102         *  Create a new session. 
    103103         */ 
    104104        public function create($vars = NULL) 
    … …  
    189189        /* 
    190190         * Method: regenerate