Symfoware

Symfowareについての考察blog

CodeIgniter 3 独自関数について(General Topics - Common Functions)

CodeIgniter User Guide

General TopicsのCommon Functionsについて調べてみます。
Common Functions


Common Functions



CodeIgniterでは、ヘルパーやライブラリのロード指定なしで、
自動的にグローバル領域に展開している関数があります。



is_php($version)



is_php($version)で、実行しているPHPのバージョンチェックが行えます。
引数で指定したバージョン以上であればtrue、それ以外はfalseとなります。


Parameters:
$version (string) – バージョン番号

Returns:
TRUEは指定バージョン以上。
FALSEは指定バージョン未満。

Return type:
bool





使用例)


  1. if (is_php('5.3')){
  2.     $str = quoted_printable_encode($str);
  3. }







is_really_writable($file)



ファイルの書き込み権限をチェックします。
PHP標準で「is_writable()」という関数がありますが、どうもWindows環境だと
読み取り専用で書き込み権限がなくてもtrueを報告するようです。

プラットフォームに依存しない、ファイルの書き込み権限チェックが行えます。


Parameters:
$file (string) – チェックするファイルのパス

Returns:
TRUEはファイルの書き込み権限あり。
FALSEはファイルの書き込み権限なし。

Return type:
bool





使用例)


  1. if (is_really_writable('file.txt')) {
  2.     echo "I could write to this if I wanted to";
  3. } else {
  4.     echo "File is not writable";
  5. }






config_item($key)



configファイルに記載している値を読み取ります。
設定ファイルの読み込み用にConfigライブラリがありますが、
これはキーを指定して値を読み取ることに特化した関数のようです。


Parameters:
$key (string) – configファイルのキー値

Returns:
指定されたキーの値
キーが存在しない場合はNULL

Return type:
mixed - コンフィグの値の指定方法による







set_status_header($code[, $text = ''])



HTTPレスポンスヘッダーを設定します。


Parameters:    
$code (int) – HTTP Reponse ステータスコード
$text (string) – A custom message to set with the status code

Return type:    
void





使用例)


  1. set_status_header(401);
  2. // Sets the header as: Unauthorized






remove_invisible_characters($str[, $url_encoded = TRUE])



文字として認識できない値(nullキャラクターなど)を文字列から除去します。


Parameters:    
$str (string) – 変換元の文字列
$url_encoded (bool) – URL-encoded不能な文字も除去するか?

Returns:    
不正値を除去した文字列

Return type:    
string




使用例)


  1. remove_invisible_characters('Java\\0script');
  2. // Returns: 'Javascript'







html_escape($var)



PHP標準のhtmlspecialcharsを呼び出します。
htmlspecialcharsとの違いは、引数にarrayを指定できる点です。


Parameters:
$var (mixed) – HTML エスケープしたい文字列、または文字列のarray

Returns:
HTML エスケープ済の値

Return type:
mixed - 引数の型による






get_mimes()



MIMEの情報を返します。
application/config/mimes.phpの内容が取得できるようです。


Returns:
MIME情報

Return type:
array






is_https()



この接続がhttpsによるものか判定します。
ログイン画面でhttpsを矯正したいとき、チェックに使えそうです。


Returns:
TRUEの場合、HTTPS接続である。
FALSEの場合、HTTPS接続ではない。

Return type:
bool







is_cli()



この処理がコマンドラインにより実行されているかを返します。
バッチ処理により起動された時の分岐に使えそうです。


Returns:
TRUEの場合、CLIによる実行。
FALSEの場合、CLI以外による実行。

Return type:
bool







function_usable($function_name)



引数の関数が使用可能であるか(宣言済であるか)のチェックを行います。
PHP標準で、function_exists()という同等の関数がありますが、
「suhosin」というライブラリを導入している場合、disable状態の関数の
判定がうまく行えないようで、この関数が生まれているようです。


Parameters:
$function_name (string) – チェックする関数名

Returns:
TRUEの場合、関数の呼び出し可能。
FALSEの場合、関数の呼び出しは行えない。

Return type:
bool






CodeIgniter 3のユーザーガイド(User Guide)まとめ

関連記事

テーマ:プログラミング - ジャンル:コンピュータ

  1. 2015/01/25(日) 17:02:37|
  2. PHP
  3. | トラックバック:0
  4. | コメント:0
  5. | 編集
<<CodeIgniter 3 互換性維持のための関数について(General Topics - Compatibility Functions) | ホーム | CodeIgniter 3 ヘルパー、ライブラリの自動ロード(General Topics - Auto-loading Resources)>>

コメント

コメントの投稿


管理者にだけ表示を許可する

トラックバック

トラックバック URL
http://symfoware.blog68.fc2.com/tb.php/1609-d7f4fb99
この記事にトラックバックする(FC2ブログユーザー)