共通関数

CodeIgniter はその動作のために少しの関数を使用しており、 それはグローバルに定義され、どこでも使えます。 ライブラリやヘルパーをロードする必要はありません。

is_php($version)
パラメータ:
  • $version (string) – バージョン番号
返り値:

実行している PHP のバージョンが指定のもの以上なら TRUE 、そうでないなら FALSE
返り値の型:

bool

使用している PHP のバージョンが与えられたバージョン番号よりも 大きいかどうかを判定します。

Example:

if (is_php('5.3'))
{
        $str = quoted_printable_encode($str);
}

インストールされている PHP のバージョンが与えられたバージョン番号と 等しいかそれ以上なら真偽値の TRUE を返します。インストールされている PHP のバージョンが与えられたバージョン番号よりも低い場合には FALSE を返します。

is_really_writable($file)
パラメータ:
  • $file (string) – ファイルパス
返り値:

パスが書き込み可能な場合は TRUE 、そうでない場合は FALSE
返り値の型:

bool

is_writable() は Windows サーバー上で TRUE を返し、 OS のレポートとして PHP に読み取り専用属性がマークされていて 本当に書き込めない場合にのみ FALSE を返します。

この関数は最初に実際にファイルに書き込もうとすることによって、 書き込み可能であるかどうかを判定します。一般的に、 情報を信頼できないプラットフォーム上でのみおすすめします。

例:

if (is_really_writable('file.txt'))
{
        echo "書き込もうと思えば書き込めます";
}
else
{
        echo "ファイルは書き込めません";
}

注釈

より詳しくは PHP のバグ #54709 も参照してください。

config_item($key)
パラメータ:
  • $key (string) – 設定項目キー
返り値:

設定キーの値。見つからない場合はNULL
返り値の型:

mixed

設定ライブラリ は設定情報にアクセスするために推奨される方法ですが、 単一のキーを取得するためには config_item() を使用することもできます。詳細については 設定ライブラリ マニュアルを参照してください。

set_status_header($code[, $text = ''])
パラメータ:
  • $code (int) – HTTP Reponse ステータスコード
  • $text (string) – ステータスコードを設定する際のカスタムメッセージ
返り値の型:

void

サーバステータスヘッダを手動で設定することを可能にします。例:

set_status_header(401);
// ヘッダを設定します:  Unauthorized

ヘッダの完全なリストについては ここを参照してください 。

remove_invisible_characters($str[, $url_encoded = TRUE])
パラメータ:
  • $str (string) – 入力文字列
  • $url_encoded (bool) – URL エンコードされた文字を削除するかどうか
返り値:

サニタイズされた文字列
返り値の型:

string

この機能は、Java\0scriptのように、 ASCII 文字の間に NULL 文字を挿入しないようにします。

例:

remove_invisible_characters('Java\\0script');
// 返り値: 'Javascript'
html_escape($var)
パラメータ:
  • $var (mixed) – エスケープする変数（文字列または配列）
返り値:

HTML エスケープされた文字列（または文字列の配列）
返り値の型:

mixed

この関数は PHP ネイティブの htmlspecialchars() 関数の別名として機能するほか、文字列の配列を処理できるという利点があります。

これはクロスサイトスクリプティング（XSS）の予防に有用です。

get_mimes()
返り値:ファイルタイプの連想配列
返り値の型:array

この関数は application/config/mimes.php から MIME の配列への 参照 を返します。

is_https()
返り値:現在 HTTP over SSL を使用している場合は TRUE 、そうでないなら FALSE
返り値の型:bool

セキュア接続（HTTPS）を使用していれば TRUE を返し、他の場合には FALSE を返します（非 HTTP 要求を含みます）。

is_cli()
返り値:現在 CLI で実行されている場合は TRUE 、そうでない場合は FALSE
返り値の型:bool

アプリケーションがコマンドラインから実行している場合は TRUE を返し、そうでないなら FALSE を返します。

注釈

この関数は、 PHP_SAPI 値が「 cli 」であるかどうかと、 STDIN 定数が定義されているかどうかの両方をチェックします。

function_usable($function_name)
パラメータ:
  • $function_name (string) – 関数名
返り値:

関数を使用することができる場合は TRUE 、そうでない場合は FALSE
返り値の型:

bool

関数が存在し使用可能であれば TRUE を、そうでなければ FALSE を返します。

この関数は function_exists() を確認し、また、 Suhosin extension <http://www.hardened-php.net/suhosin/> がロードされていれば 関数が無効化されていないかどうかをチェックします。

これは eval() や exec() など、危険であり、制限の厳しいセキュリティポリシーを持つサーバ上で 無効にされうる関数の可用性をチェックする場合に便利です。

注釈

Suhosinはスクリプトの実行を中断させますが、 これはバグであることが判明したため、この機能が導入されました。 修正プログラムはすでに用意されましたが（バージョン0.9.34）、 残念ながらまだリリースされていません。