ここの情報は古いです。ご理解頂いた上でお取り扱いください。

Changeset 4932


Ignore:
Timestamp:
Jan 12, 2008, 6:11:25 PM (13 years ago)
Author:
ogawa
Message:

#1776:OpenPNE_Action/Auth/DBにPHPDoc形式のコメントを追加

Location:
OpenPNE/trunk/webapp/lib/OpenPNE
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • OpenPNE/trunk/webapp/lib/OpenPNE/Action.php

    r1856 r4932  
    55 */
    66
     7/**
     8 * OpenPNEの全アクションの親クラス
     9 *
     10 * @package OpenPNE
     11 * @author OGAWA Rinpei <ogawa@tejimaya.com>
     12 */
    713class OpenPNE_Action
    814{
    915    /**
     16     * OpenPNE_Smartyのインスタンス
     17     *
    1018     * @var OpenPNE_Smarty
    1119     */
    1220    var $view;
    1321
     22    /**
     23     * Validation済みリクエスト変数
     24     *
     25     * @var array
     26     */
    1427    var $requests;
    1528
    16     function OpenPNE_Action()
    17     {
    18     }
    19 
     29    /**
     30     * アクションの実際の処理
     31     *
     32     * @return string pageアクションが成功した場合は、'success'を返す
     33     */
    2034    function execute()
    2135    {
     
    2337    }
    2438
     39    /**
     40     * Request Validation のエラー処理
     41     *
     42     * @param array $errors
     43     */
    2544    function handleError($errors)
    2645    {
     
    2847    }
    2948
     49    /**
     50     * 認証が必要なアクションかどうかを返す
     51     *
     52     * @return bool
     53     */
    3054    function isSecure()
    3155    {
     
    3357    }
    3458
     59    /**
     60     * Viewに値をセットする
     61     *
     62     * @param string $key
     63     * @param mixed $value
     64     */
    3565    function set($key, $value = null)
    3666    {
     
    3868    }
    3969
     70    /**
     71     * Viewにセットされた値を取得
     72     *
     73     * @param string $key
     74     * @return mixed
     75     */
    4076    function get($key)
    4177    {
     
    4379    }
    4480
     81    /**
     82     * Viewのインスタンスを返す
     83     *
     84     * @return OpenPNE_Smarty
     85     */
    4586    function &getView()
    4687    {
  • OpenPNE/trunk/webapp/lib/OpenPNE/Auth.php

    r4918 r4932  
    55 */
    66
    7 // PEAR::Auth
     7/**
     8 * PEAR::Auth class
     9 */
    810require_once 'Auth.php';
    911
    10 
     12/**
     13 * 認証処理をおこなうクラス
     14 *
     15 * requires PEAR::Auth
     16 *
     17 * @package OpenPNE
     18 * @author OGAWA Rinpei <ogawa@tejimaya.com>
     19 */
    1120class OpenPNE_Auth
    1221{
     
    2736    var $cookie_path = '/';
    2837
     38    /**
     39     * 設定値の初期化をおこなう
     40     *
     41     * $config に渡せる値
     42     * + storage: PEAR::Authのストレージコンテナ名
     43     * + options: PEAR::Auth用オプション
     44     * + is_ktai: 携帯用認証かどうか
     45     * + is_encrypt_username: usernameをt_encryptで暗号化するかどうか
     46     *
     47     * @param array $config
     48     */
    2949    function OpenPNE_Auth($config = array())
    3050    {
     
    5474                session_id($this->sess_id);
    5575            }
    56         }
    57         $this->set_cookie_params();
    58     }
    59 
    60     function set_cookie_params()
    61     {
    62         $url = parse_url(OPENPNE_URL);
    63         if (substr($url['path'], -1) != '/') {
    64             $url['path'] .= '/';
    65         }
    66         $this->cookie_path = $url['path'];
    67     }
    68 
     76            // cookie_path を OPENPNE_URLから抜き出す
     77            $url = parse_url(OPENPNE_URL);
     78            if (substr($url['path'], -1) != '/') {
     79                $url['path'] .= '/';
     80            }
     81            $this->cookie_path = $url['path'];           
     82        }
     83    }
     84
     85    /**
     86     * PEAR::Authのインスタンスを生成する
     87     *
     88     * @param bool $login ログイン処理に使用するかどうか
     89     * @return Auth
     90     */
    6991    function &factory($login = false)
    7092    {
     
    82104    }
    83105
     106    /**
     107     * リクエストからログイン処理をおこなう
     108     *
     109     * @param bool $is_save_cookie クッキーの保存期限を設定するかどうか
     110     * @return bool
     111     */
    84112    function login($is_save_cookie = false)
    85113    {
     
    111139    }
    112140
     141    /**
     142     * 認証処理をおこなう
     143     *
     144     * @return bool 認証が成功したかどうか
     145     */
    113146    function auth()
    114147    {
     
    120153    }
    121154
     155    /**
     156     * ログアウト処理をおこなう
     157     *
     158     * @return bool
     159     */
    122160    function logout()
    123161    {
     
    139177
    140178        $this->set_session_save_handler();
    141     }
    142 
     179        return true;
     180    }
     181
     182    /**
     183     * セッションの生成時からの有効期限を設定する
     184     *
     185     * @param int $expiretime
     186     */
    143187    function setExpire($expiretime)
    144188    {
     
    146190    }
    147191
     192    /**
     193     * セッションの最終アクセス時からの有効期限を設定する
     194     *
     195     * @param int $idletime
     196     */
    148197    function setIdle($idletime)
    149198    {
     
    151200    }
    152201
     202    /**
     203     * uid getter/setter
     204     *
     205     * @param string $uid
     206     * @return string
     207     */
    153208    function uid($uid = '')
    154209    {
     
    159214    }
    160215
     216    /**
     217     * PEAR::Auth側のusernameを返す
     218     *
     219     * @return string
     220     */
    161221    function getUsername()
    162222    {
     
    165225
    166226    /**
    167      * static set_session_save_handler()
     227     * セッションハンドラを設定する
     228     *
     229     * @static
    168230     */
    169231    function set_session_save_handler()
     
    192254    }
    193255
     256    /**
     257     * checkAuth
     258     *
     259     * PEAR::Auth標準の認証処理に加えて、OPENPNE_URLのチェックもおこなう
     260     *
     261     * @return bool
     262     * @see PEAR::Auth::checkAuth
     263     */
    194264    function checkAuth()
    195265    {
  • OpenPNE/trunk/webapp/lib/OpenPNE/DB.php

    r4930 r4932  
    55 */
    66
    7 // PEAR::DB依存
     7/**
     8 * PEAR::DB class
     9 */
    810require_once 'DB.php';
    911
    1012/**
    11  * OpenPNE_DB (PEAR::DB依存)
     13 * OpenPNE_DB
     14 *
     15 * @package OpenPNE
     16 * @author OGAWA Rinpei <ogawa@tejimaya.com>
    1217 */
    1318class OpenPNE_DB
     
    2126    var $readonly = false;
    2227
     28    /**
     29     * @param mixed $dsn
     30     * @param bool $readonly
     31     */
    2332    function OpenPNE_DB($dsn, $readonly = false)
    2433    {
     
    2837    }
    2938
     39    /**
     40     * OpenPNE_DBのインスタンスを返す(Singleton)
     41     *
     42     * @return OpenPNE_DB
     43     */
    3044    function &getInstance()
    3145    {
     
    3852
    3953    /**
     54     * DBに接続する
     55     *
    4056     * @access private
    4157     */
     
    5268    }
    5369
     70    /**
     71     * 先頭行、先頭列の1データを取得する
     72     *
     73     * @param string $sql
     74     * @param array $params for placeholder
     75     * @return mixed
     76     */
    5477    function get_one($sql, $params = array())
    5578    {
     
    6285    }
    6386
     87    /**
     88     * 先頭行のデータを取得する
     89     *
     90     * @param string $sql
     91     * @param array $params for placeholder
     92     * @return array
     93     */
    6494    function get_row($sql, $params = array())
    6595    {
     
    72102    }
    73103
     104    /**
     105     * 先頭列のデータを取得する
     106     *
     107     * @param string $sql
     108     * @param array $params for placeholder
     109     * @return array
     110     */
    74111    function get_col($sql, $params = array())
    75112    {
     
    81118    }
    82119
     120    /**
     121     * 先頭列のデータをlimit付きで取得する
     122     *
     123     * @param string $sql
     124     * @param int $from 開始行
     125     * @param int $count 最大行数
     126     * @param array $params for placeholder
     127     * @return array
     128     */
    83129    function get_col_limit($sql, $from, $count, $params = array())
    84130    {
     
    87133    }
    88134
     135    /**
     136     * 先頭列のデータをpaging処理用limit付きで取得する
     137     *
     138     * @param string $sql
     139     * @param int $page 取得するページ番号
     140     * @param int $count 1ページあたりの最大行数
     141     * @param array $params for placeholder
     142     * @return array
     143     */
    89144    function get_col_page($sql, $page, $count, $params = array())
    90145    {
     
    93148    }
    94149
     150    /**
     151     * 1列目をキー、2列目を値とした連想配列を取得する
     152     *
     153     * @param string $sql
     154     * @param array $params for placeholder
     155     * @return array
     156     */
    95157    function get_assoc($sql, $params = array())
    96158    {
     
    102164    }
    103165
     166    /**
     167     * 1列目をキー、2列目を値とした連想配列をlimit付きで取得する
     168     *
     169     * @param string $sql
     170     * @param int $from 開始行
     171     * @param int $count 最大行数
     172     * @param array $params for placeholder
     173     * @return array
     174     */
    104175    function get_assoc_limit($sql, $from, $count, $params = array())
    105176    {
     
    108179    }
    109180
     181    /**
     182     * 全列のデータを全行取得する
     183     *
     184     * @param string $sql
     185     * @param array $params for placeholder
     186     * @return array
     187     */
    110188    function get_all($sql, $params = array())
    111189    {
     
    117195    }
    118196
     197    /**
     198     * 全列のデータをlimit付きで取得する
     199     *
     200     * @param string $sql
     201     * @param int $from 開始行
     202     * @param int $count 最大行数
     203     * @param array $params for placeholder
     204     * @return array
     205     */
    119206    function get_all_limit($sql, $from, $count, $params = array())
    120207    {
     
    123210    }
    124211
     212    /**
     213     * 全列のデータをpaging処理用limit付きで取得する
     214     *
     215     * @param string $sql
     216     * @param int $page 取得するページ番号
     217     * @param int $count 1ページあたりの最大行数
     218     * @param array $params for placeholder
     219     * @return array
     220     */
    125221    function get_all_page($sql, $page, $count, $params = array())
    126222    {
     
    129225    }
    130226
     227    /**
     228     * @param mixed $in
     229     * @return string
     230     * @see PEAR::DB::quoteSmart
     231     */
    131232    function quote($in)
    132233    {
     
    135236
    136237    /**
    137      * static method
     238     * Identifierとして使える文字以外を除去する
     239     *
     240     * @static
     241     * @param string $str
     242     * @return string
    138243     */
    139244    function escapeIdentifier($str)
     
    142247    }
    143248
     249    /**
     250     * 連想配列からWhere条件節に使える文字列を生成する
     251     *
     252     * @param array $where
     253     * @return string
     254     */
    144255    function makeWhereClause($where)
    145256    {
     
    161272    }
    162273
     274    /**
     275     * 任意のクエリを実行する
     276     *
     277     * @param string $sql
     278     * @param array $params
     279     * @return mixed
     280     */
    163281    function &query($sql, $params = array())
    164282    {
     
    166284    }
    167285
     286    /**
     287     * insertクエリを生成して実行する
     288     *
     289     * @param string $table テーブル名
     290     * @param array $fields_values 挿入するデータの連想配列
     291     * @param string $pkey primary key名
     292     * @return int 成功した場合は挿入した行のprimary id、失敗の場合 false
     293     */
    168294    function insert($table, $fields_values, $pkey = '')
    169295    {
     
    187313    }
    188314
     315    /**
     316     * insertに使用するprimary idを取得する
     317     *
     318     * ただし、mysqlの場合はauto_incrementの使用を想定して、nullを返す
     319     *
     320     * @param string $seq_name
     321     * @param bool $ondemand
     322     * @return int
     323     */
    189324    function nextId($seq_name = '', $ondemand = true)
    190325    {
    191         if ($this->db->phptype == 'mysql') {
     326        if ($this->db->phptype === 'mysql') {
    192327            return null;
    193328        } else {
     
    196331    }
    197332
     333    /**
     334     * 直前にinsertされた行のprimary idを返す
     335     *
     336     * @param int $id 指定されている場合はそのまま返す
     337     * @return int
     338     */
    198339    function insertId($id = null)
    199340    {
    200         if ($this->db->phptype == 'mysql') {
     341        if ($this->db->phptype === 'mysql') {
    201342            return $this->db->getOne('SELECT LAST_INSERT_ID()');
    202343        } else {
     
    205346    }
    206347
     348    /**
     349     * updateクエリを生成して実行する
     350     *
     351     * @param string $table
     352     * @param array $fields_values
     353     * @param array $where
     354     * @return bool
     355     */
    207356    function update($table, $fields_values, $where)
    208357    {
     
    219368    }
    220369
     370    /**
     371     * 直前のクエリが影響を与えた行数を取得
     372     *
     373     * @return int
     374     */
    221375    function affectedRows()
    222376    {
Note: See TracChangeset for help on using the changeset viewer.