tomk79/request v1.4.1 API Document

request

tomk79/request core class

Tags
author

Tomoya Koyanagi tomk79@gmail.com

Table of Contents

$cli_options  : mixed
コマンドラインオプション
$cli_params  : mixed
コマンドラインパラメータ
$conf  : mixed
設定オブジェクト
$directory_index_primary  : mixed
優先ディレクトリインデックス
$flg_cmd  : mixed
コマンドからのアクセス フラグ
$fs  : mixed
ファイルシステムオブジェクト
$param  : mixed
URLパラメータ
$request_file_path  : mixed
リクエストファイルパス
__construct()  : mixed
コンストラクタ
delete_cookie()  : bool
クッキー情報を削除する。
delete_session()  : bool
セッション情報を削除する。
delete_uploadfile()  : bool
セッションに保存されたファイルを削除する。
delete_uploadfile_all()  : bool
セッションに保存されたファイルを全て削除する。
get_all_params()  : array<string|int, mixed>
パラメータをすべて取得する。
get_cli_option()  : string
コマンドラインオプションを取得する
get_cli_options()  : array<string|int, mixed>
すべてのコマンドラインオプションを連想配列で取得する
get_cli_param()  : string
コマンドラインパラメータを取得する
get_cli_params()  : array<string|int, mixed>
すべてのコマンドラインパラメータを配列で取得する
get_cookie()  : mixed
クッキー情報を取得する。
get_header()  : string|bool|null
リクエストヘッダを取得する
get_headers()  : array<string|int, mixed>|bool|null
リクエストヘッダ全体を取得する
get_method()  : string|bool
メソッドを取得する
get_param()  : mixed
パラメータを取得する。
get_request_file_path()  : string
リクエストパスを取得する。
get_session()  : mixed
セッション情報を取得する。
get_session_id()  : string
セッションIDを取得する。
get_uploadfile()  : array<string|int, mixed>|bool
セッションに保存されたファイル情報を取得する。
get_uploadfile_list()  : array<string|int, mixed>
セッションに保存されたファイル情報の一覧を取得する。
get_user_agent()  : string
USER_AGENT を取得する。
is_cmd()  : bool
コマンドラインによる実行か確認する。
is_ssl()  : bool
SSL通信か調べる
save_uploadfile()  : bool
アップロードされたファイルをセッションに保存する。
session_update()  : bool
セッションを更新する。
set_cookie()  : bool
クッキー情報をセットする。
set_param()  : bool
パラメータをセットする。
set_session()  : bool
セッション情報をセットする。
convert_encoding()  : string
受け取ったテキストを、指定の文字セットに変換する。
get_path_current_dir()  : string
カレントディレクトリのパスを取得
normalize_input()  : array<string|int, mixed>
入力値に対する標準的な変換処理
parse_input()  : bool
入力値を解析する。
session_start()  : bool
セッションを開始する。
stripslashes()  : string
クォートされた文字列のクォート部分を取り除く。

Properties

$cli_options

コマンドラインオプション

private mixed $cli_options

$cli_params

コマンドラインパラメータ

private mixed $cli_params

$conf

設定オブジェクト

private mixed $conf

$directory_index_primary

優先ディレクトリインデックス

private mixed $directory_index_primary

$flg_cmd

コマンドからのアクセス フラグ

private mixed $flg_cmd = false

$fs

ファイルシステムオブジェクト

private mixed $fs

$param

URLパラメータ

private mixed $param = array()

$request_file_path

リクエストファイルパス

private mixed $request_file_path

Methods

__construct()

コンストラクタ

public __construct([object $conf = null ]) : mixed
Parameters
$conf : object = null

設定オブジェクト

Return values
mixed —

delete_cookie()

クッキー情報を削除する。

public delete_cookie(string $key) : bool
Parameters
$key : string

クッキー名

Return values
bool —

成功時 true、失敗時 false を返します。

delete_session()

セッション情報を削除する。

public delete_session(string $key) : bool
Parameters
$key : string

セッションキー

Return values
bool —

常に true を返します。

delete_uploadfile()

セッションに保存されたファイルを削除する。

public delete_uploadfile(string $key) : bool
Parameters
$key : string

セッションキー

Return values
bool —

常に true を返します。

delete_uploadfile_all()

セッションに保存されたファイルを全て削除する。

public delete_uploadfile_all() : bool
Return values
bool —

常に true を返します。

get_all_params()

パラメータをすべて取得する。

public get_all_params() : array<string|int, mixed>
Return values
array<string|int, mixed> —

すべてのパラメータを格納する連想配列

get_cli_option()

コマンドラインオプションを取得する

public get_cli_option(string $name) : string
Parameters
$name : string

オプション名

Return values
string —

指定されたオプション値

get_cli_options()

すべてのコマンドラインオプションを連想配列で取得する

public get_cli_options() : array<string|int, mixed>
Return values
array<string|int, mixed> —

すべてのコマンドラインオプション

get_cli_param()

コマンドラインパラメータを取得する

public get_cli_param(string $idx) : string
Parameters
$idx : string

パラメータ番号

Return values
string —

指定されたオプション値

get_cli_params()

すべてのコマンドラインパラメータを配列で取得する

public get_cli_params() : array<string|int, mixed>
Return values
array<string|int, mixed> —

すべてのコマンドラインパラメータ

get_cookie()

クッキー情報を取得する。

public get_cookie(string $key) : mixed
Parameters
$key : string

クッキー名

Return values
mixed —

クッキーの値

get_header()

リクエストヘッダを取得する

public get_header(string $name[, bool $ignore_case = true ]) : string|bool|null
Parameters
$name : string

ヘッダー名。get_header() は、大文字/小文字を区別しません。

$ignore_case : bool = true

true が指定された場合、 get_header() は、 $name の大文字/小文字を区別せずに検索します。デフォルトは true です。

Return values
string|bool|null —

リクエストヘッダーの値。 与えられた名前に該当する項目がない場合、コマンドラインから実行されている場合は null を返します。 getallheaders が実行できない場合、その他ヘッダー情報全体にアクセスできない場合は false を返します。

get_headers()

リクエストヘッダ全体を取得する

public get_headers() : array<string|int, mixed>|bool|null
Return values
array<string|int, mixed>|bool|null —

リクエストヘッダーのリスト。コマンドラインから実行されている場合は null を返します。getallheaders が実行できない場合 false を返します。

get_method()

メソッドを取得する

public get_method() : string|bool
Return values
string|bool —

メソッド名。すべて小文字に変換されて返されます。コマンドラインから実行された場合は command が返されます。取得できない場合は false を返します。

get_param()

パラメータを取得する。

public get_param(string $key) : mixed

$_GET, $_POST、$_FILES を合わせた連想配列の中から $key に当たる値を引いて返します。 キーが定義されていない場合は、null を返します。

Parameters
$key : string

URLパラメータ名

Return values
mixed —

URLパラメータ値

get_request_file_path()

リクエストパスを取得する。

public get_request_file_path() : string
Return values
string —

リクエストパス

get_session()

セッション情報を取得する。

public get_session(string $key) : mixed
Parameters
$key : string

セッションキー

Return values
mixed —

$key に対応するセッション値

get_session_id()

セッションIDを取得する。

public get_session_id() : string
Return values
string —

セッションID

get_uploadfile()

セッションに保存されたファイル情報を取得する。

public get_uploadfile(string $key) : array<string|int, mixed>|bool
Parameters
$key : string

セッションキー

Return values
array<string|int, mixed>|bool —

成功時、ファイル情報 を格納した連想配列、失敗時 false を返します。

get_uploadfile_list()

セッションに保存されたファイル情報の一覧を取得する。

public get_uploadfile_list() : array<string|int, mixed>
Return values
array<string|int, mixed> —

ファイル情報 を格納した連想配列

get_user_agent()

USER_AGENT を取得する。

public get_user_agent() : string
Return values
string —

USER_AGENT

is_cmd()

コマンドラインによる実行か確認する。

public is_cmd() : bool
Return values
bool —

コマンドからの実行の場合 true、ウェブからの実行の場合 false を返します。

is_ssl()

SSL通信か調べる

public is_ssl() : bool
Return values
bool —

SSL通信の場合 true、それ以外の場合 false を返します。

save_uploadfile()

アップロードされたファイルをセッションに保存する。

public save_uploadfile(string $key, array<string|int, mixed> $ulfileinfo) : bool
Parameters
$key : string

セッションキー

$ulfileinfo : array<string|int, mixed>

アップロードファイル情報

Return values
bool —

成功時 true、失敗時 false を返します。

session_update()

セッションを更新する。

public session_update() : bool
Return values
bool —

成功した場合に true を、失敗した場合に false を返します。

set_cookie()

クッキー情報をセットする。

public set_cookie(string $key, string $val[, string $expires_or_options = null ][, string $path = null ][, string $domain = null ][, bool $secure = true ][, bool $httponly = true ]) : bool
Parameters
$key : string

クッキー名

$val : string

クッキー値

$expires_or_options : string = null

クッキーの有効期限。

$path : string = null

サーバー上での、クッキーを有効としたいパス。デフォルトは /

$domain : string = null

クッキーが有効なドメイン。

$secure : bool = true

true を設定し、クライアントからのセキュアな HTTPS 接続の場合にのみクッキーが送信されるようにします。デフォルトは true

$httponly : bool = true

true を設定し、HTTPでの送信のみ許可し、JavaScriptから参照できないようにします。デフォルトは true

Return values
bool —

成功時 true、失敗時 false を返します。

set_param()

パラメータをセットする。

public set_param(string $key, mixed $val) : bool
Parameters
$key : string

パラメータ名

$val : mixed

パラメータ値

Return values
bool —

常に true

set_session()

セッション情報をセットする。

public set_session(string $key, mixed $val) : bool
Parameters
$key : string

セッションキー

$val : mixed

$key に対応するセッション値

Return values
bool —

常に true を返します。

convert_encoding()

受け取ったテキストを、指定の文字セットに変換する。

private static convert_encoding(mixed $text[, string $encode = null ][, string $encodefrom = null ]) : string
Parameters
$text : mixed

テキスト

$encode : string = null

変換後の文字セット。省略時、mb_internal_encoding() から取得

$encodefrom : string = null

変換前の文字セット。省略時、自動検出

Return values
string —

文字セット変換後のテキスト

get_path_current_dir()

カレントディレクトリのパスを取得

private get_path_current_dir() : string
Return values
string —

ドキュメントルートからのパス(スラッシュ閉じ)

normalize_input()

入力値に対する標準的な変換処理

private normalize_input(array<string|int, mixed> $param) : array<string|int, mixed>
Parameters
$param : array<string|int, mixed>

パラメータ

Return values
array<string|int, mixed> —

変換後のパラメータ

parse_input()

入力値を解析する。

private parse_input() : bool

$_GET, $_POST, $_FILES に送られたパラメータ情報を取りまとめ、1つの連想配列としてまとめま、オブジェクト内に保持します。

コマンドラインから実行された場合は、コマンドラインオプションをそれぞれ = 記号で区切り、URLパラメータ同様にパースします。

このメソッドの処理には、入力文字コードの変換(UTF-8へ統一)などの整形処理が含まれます。

Return values
bool —

常に true

session_start()

セッションを開始する。

private session_start() : bool
Return values
bool —

セッションが正常に開始した場合に true、それ以外の場合に false を返します。

stripslashes()

クォートされた文字列のクォート部分を取り除く。

private static stripslashes(mixed $text) : string

この関数は、PHPの stripslashes() のラッパーです。 配列を受け取ると再帰的に文字列を変換して返します。

Parameters
$text : mixed

テキスト

Return values
string —

クォートが元に戻されたテキスト

Search results