Show
Ignore:
Timestamp:
02/23/06 20:09:13 (6 years ago)
Author:
john
Message:

added in phpDoc commenting tests docs - Walt

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/trax/vendor/trax/session.php

    r117 r138  
    11<?php 
    2 # $Id$ 
    3 # 
    4 # Copyright (c) 2005 John Peterson 
    5 # 
    6 # Permission is hereby granted, free of charge, to any person obtaining 
    7 # a copy of this software and associated documentation files (the 
    8 # "Software"), to deal in the Software without restriction, including 
    9 # without limitation the rights to use, copy, modify, merge, publish, 
    10 # distribute, sublicense, and/or sell copies of the Software, and to 
    11 # permit persons to whom the Software is furnished to do so, subject to 
    12 # the following conditions: 
    13 # 
    14 # The above copyright notice and this permission notice shall be 
    15 # included in all copies or substantial portions of the Software. 
    16 # 
    17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
    18 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
    19 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
    20 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
    21 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
    22 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
    23 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
    24  
     2/** 
     3 *  File containing the Session class 
     4 * 
     5 *  (PHP 5) 
     6 * 
     7 *  @package PHPonTrax 
     8 *  @version $Id$ 
     9 *  @copyright (c) 2005 John Peterson 
     10 * 
     11 *  Permission is hereby granted, free of charge, to any person obtaining 
     12 *  a copy of this software and associated documentation files (the 
     13 *  "Software"), to deal in the Software without restriction, including 
     14 *  without limitation the rights to use, copy, modify, merge, publish, 
     15 *  distribute, sublicense, and/or sell copies of the Software, and to 
     16 *  permit persons to whom the Software is furnished to do so, subject to 
     17 *  the following conditions: 
     18 * 
     19 *  The above copyright notice and this permission notice shall be 
     20 *  included in all copies or substantial portions of the Software. 
     21 * 
     22 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
     23 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
     24 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
     25 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
     26 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
     27 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
     28 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
     29 */ 
     30 
     31/** 
     32 * 
     33 *  @todo document this class 
     34 *  @package PHPonTrax 
     35 */ 
    2536class Session { 
    2637 
    … …  
    4354        $id = null; 
    4455 
    45  
     56    /** 
     57     * 
     58     *  @todo document this method 
     59     */ 
    4660    function get($key) { 
    4761        if(self::is_valid_host()) { 
    … …  
    5165    } 
    5266 
     67    /** 
     68     * 
     69     *  @todo document this method 
     70     */ 
    5371    function set($key, $value) { 
    5472        if(self::is_valid_host()) { 
    … …  
    5775    } 
    5876 
     77    /** 
     78     * 
     79     *  @todo document this method 
     80     */ 
    5981    function is_valid_host() { 
    6082        if(($_SERVER['REMOTE_ADDR'] == self::$ip || self::is_aol_host()) && 
    … …  
    6587    } 
    6688 
     89    /** 
     90     * 
     91     *  @todo document this method 
     92     */ 
    6793    function is_aol_host() { 
    6894        if(ereg("proxy\.aol\.com$", gethostbyaddr($_SERVER['REMOTE_ADDR'])) || 
    … …  
    7399    } 
    74100 
     101    /** 
     102     * 
     103     *  @todo document this method 
     104     */ 
    75105    function get_hash() { 
    76106        $key = session_id().$_SERVER['HTTP_USER_AGENT']; 
    … …  
    81111    } 
    82112 
     113    /** 
     114     * 
     115     *  @todo document this method 
     116     */ 
    83117    function start() { 
    84118         
    … …  
    107141    } 
    108142 
     143    /** 
     144     * 
     145     *  @todo document this method 
     146     */ 
    109147    function destory_session() { 
    110148        session_destroy(); 
    111149    } 
    112150 
     151    /** 
     152     * 
     153     *  @todo document this method 
     154     */ 
    113155    function unset_session() { 
    114156        session_unset($_SESSION[self::get_hash()]); 
    115157    } 
    116158 
     159    /** 
     160     * 
     161     *  @todo document this method 
     162     */ 
    117163    function unset_var($key) { 
    118164        if(self::is_valid_host()) { 
    … …  
    121167    } 
    122168 
     169    /** 
     170     * 
     171     *  @todo document this method 
     172     */ 
    123173    function isset_var($key) { 
    124174        if(self::is_valid_host()) { 
    … …  
    130180    } 
    131181 
     182    /** 
     183     * 
     184     *  @todo document this method 
     185     */ 
    132186    function isset_flash($key) { 
    133187        if(self::is_valid_host()) { 
    … …  
    139193    } 
    140194 
     195    /** 
     196     * 
     197     *  @todo document this method 
     198     */ 
    141199    function flash($key, $value = null) { 
    142200        if(self::is_valid_host()) {