戻る
クラスリファレンス：RisolutoUtilsクラス(risoluto_util.php)
クラスの概要
Risolutoを使って様々なアプリケーションを作成する際に便利なメソッドを集めたクラスです。このクラスに含まれているメソッドは、特定カテゴリに属さないものとなっています。
クラスインスタンスの作成方法
require_once( RISOLUTO_FUNC . 'risoluto_util.php' );
$instance = RisolutoUtils::singleton();
このクラスが依存しているもの
- RisolutoConfクラス
- RisoluteDbクラス
- RisolutoSessionクラス
クラスの内容
クラス変数
$obj_instance
| スコープ | private(static) |
| 型 | object |
| 用途 | singletonパターンのため、自身のインスタンスを保持します。 |
$obj_sess
| スコープ | private |
| 型 | object |
| 用途 | セッションクラスのインスタンスを保持します。 |
クラスメソッド
__construct()
| スコープ | private |
| 引数 | なし |
| 戻り値 | なし |
| 用途 | 当該クラスのコンストラクタ（実処理はなし） |
__clone()
| スコープ | private |
| 引数 | なし |
| 戻り値 | なし |
| 戻り値の型 | なし |
| 用途 | 当該クラスのクローンメソッド（実処理はなし） |
singleton()
| スコープ | public(static) |
| 引数 | なし |
| 戻り値 | なし |
| 戻り値の型 | なし |
| 用途 | 当該クラスのインスタンスをシングルトンパターンで生成し、返却する。 |
is_Supervisor()
| スコープ | public |
| 引数 | なし |
| 戻り値 | ファンクション実行結果（ true：スーパバイザセッションである/ false: スーパバイザセッションではない ） |
| 戻り値の型 | boolean |
| 用途 | 現在のセッションがスーパバイザセッションかを判定する。 |
$result = $instance->is_Supervisor();
var_dump( $result );
is_Admin()
| スコープ | public |
| 引数 | なし |
| 戻り値 | ファンクション実行結果（ true：アドミンセッションである/ false: アドミンセッションではない ） |
| 戻り値の型 | boolean |
| 用途 | 現在のセッションがアドミンセッションかを判定する。is_Supervisor()がtrueの場合、このメソッドもtrueになる。 |
$result = $instance->is_Admin();
var_dump( $result );
is_User()
| スコープ | public |
| 引数 | なし |
| 戻り値 | ファンクション実行結果（ true：ユーザセッションである/ false: ユーザセッションではない ） |
| 戻り値の型 | boolean |
| 用途 | 現在のセッションがユーザセッションかを判定する。is_Supervisor()またはis_Admin()がtrueの場合、このメソッドもtrueになる。 |
$result = $instance->is_User();
var_dump( $result );
is_Guest()
| スコープ | public |
| 引数 | なし |
| 戻り値 | ファンクション実行結果（ true：ゲストセッションである/ false: ゲストセッションではない ） |
| 戻り値の型 | boolean |
| 用途 | 現在のセッションがゲストセッションかを判定する。is_Supervisor()またはis_Admin()またはis_User()がtrueの場合、このメソッドもtrueになる。 |
$result = $instance->is_Guest();
var_dump( $result );
getBaseUrl()
| スコープ | public |
| 引数 | なし |
| 戻り値 | 自身のベースURL |
| 戻り値の型 | string |
| 用途 | ベースURL（RisolutoシステムのURL）を返却する。 |
$result = $instance->getBaseUrl();
// 「http://www.example.com/index.php」のようなURLが返却される。
redirectTo()
| スコープ | public |
| 引数 | string $actionId リダイレクト先のAct / string $cageId リダイレクト先のCage（省略可） / array $getKey リダイレクト時に付与するGETパラメタのキー部（配列指定、省略可）/ array $getVal リダイレクト時に付与するGETパラメタのバリュー部（配列指定、省略可） |
| 戻り値 | なし |
| 戻り値の型 | void |
| 用途 | Risoluto内の指定された指定された画面へリダイレクトする。 |
$result = $instance->redirectTo( 'act', 'cage', array( 'foo', 'bar' ), array( 'hoge','fuga' ));
// 「～/?act=act&cage=cage&foo=hoge&bar=fuga」のようなURLが作成され、リダイレクトされる
statChecker()
| スコープ | public |
| 引数 | array $target チェック対象の情報が格納された連想配列（'path': 対象の絶対パス / 'stat':期待される状態(writable or readable) ） |
| 戻り値 | チェック結果が格納された連想配列('path': 対象の絶対パス / 'required':期待される状態(writable or readable) / 'real':実際の状態(writable or readable) / 'result':判定結果(OK or NG) ) |
| 戻り値の型 | array |
| 用途 | 指定されたファイルやディレクトリのステータスをチェックする。 |
$result = $instance->statChecker( array( 'path'=>'/tmp/test.txt', 'stat'=>'writable' ) );
var_dump( $result );
fileOperator()
| スコープ | public |
| 引数 | string $operation 処理内容を示す文字列(make/copy/move/unlink/mkdir/rmdir) / string $target 対象となるパス / $destination コピー又は移動先となるパス(第1引数がcopyまたはmove以外の時のみ省略可) |
| 戻り値 | 処理結果（true: 成功 / false: 失敗） |
| 戻り値の型 | boolean |
| 用途 | 指定されたファイルやディレクトリに対し、指定されたオペレーションを実行する。 |
$result = $instance->fileOperator( 'copy', '/tmp/test.txt', '/tmp/test2.txt' );
var_dump( $result );
answerMyId()
| スコープ | public |
| 引数 | なし |
| 戻り値 | 識別子（何らかの理由で生成できない場合は、null） |
| 戻り値の型 | string |
| 用途 | CageおよびActから画面を特定するための識別子を生成する。主にデータ更新などを行うときに、各種テーブルのcuserまたはmuserにセットするための文字列として使うことを想定している。 |
$result = $instance->answerMyId();
var_dump( $result );
serviceStatus()
| スコープ | public |
| 引数 | なし |
| 戻り値 | サイトの状態( 0:オープン/1:既存セッションのみ許可/2:ユーザセッションのみ許可/3:管理者セッションのみ許可/4:スーパバイザセッションのみ許可 ) |
| 戻り値の型 | integer |
| 用途 | サービスの状態を判定する。 |
$result = $instance->serviceStatus();
var_dump( $result );
autoUrlLink()
| スコープ | public |
| 引数 | string $val 対象となる文字列／boolean $newwindow 新規ウィンドウで表示するか（true:新規ウィンドウ表示、デフォルト）／string $extra リンクタグに付与するアトリビュート（デフォルト:null） |
| 戻り値 | 変換後の文字列 |
| 戻り値の型 | string |
| 用途 | 引数で指定された文字列中に含まれる「http(s)://」で始まる部分を、リンクに変更する。 |
$result = $instance->autoUrlLink( 'This is test. See, http://www.example.com/', true, 'class="link_external"' );
// 「This is test. See, <a href="http://www.example.com/" target="_blank" class="link_external">http://www.example.com/</a>」のような文字列に変換される。
var_dump( $result );
| スコープ | public |
| 引数 | なし |
| 戻り値 | ヘッダ情報 |
| 戻り値の型 | array |
| 用途 | データベースから、現在の画面用のHTMLヘッダ情報を取得する。登録がない場合はデフォルトの情報を、取得できなかった場合はfalseを返却する。 |
$result = $instance->getHeader();
var_dump( $result );
is_emailAddr()
| スコープ | public |
| 引数 | string $value 検査対象となる値 |
| 戻り値 | 判定結果（ true / false ） |
| 戻り値の型 | boolean |
| 用途 | 引数で指定された値がメールアドレスのフォーマットと合致しているか判定する |
$result = $instance->is_emailAddr( 'example@example.com' );
var_dump( $result );
is_halfWidth()
| スコープ | public |
| 引数 | string $value 検査対象となる値 |
| 戻り値 | 判定結果（ true / false ） |
| 戻り値の型 | boolean |
| 用途 | 引数で指定された値が半角文字列のみで構成されているか判定する |
$result = $instance->is_halfWidth( 'Aあ' );
var_dump( $result );
is_leapYear()
| スコープ | public |
| 引数 | string $value 検査対象となる値 |
| 戻り値 | 判定結果（ true / false ） |
| 戻り値の型 | boolean |
| 用途 | 引数で指定された値が閏年であるか判定する |
$result = $instance->is_leapYear( 2009 );
var_dump( $result );
is_between()
| スコープ | public |
| 引数 | string $value 検査対象となる値 / string $lowerVal 下限値 / string $upperVal 上限値 |
| 戻り値 | 判定結果（ true / false ） |
| 戻り値の型 | boolean |
| 用途 | 引数で指定された値が引数で指定された下限値及び上限値の範囲内にあるかを判定する |
$result = $instance->is_between( 2009, 2000, 2010 );
var_dump( $result );
cnvYear()
| スコープ | public |
| 引数 | integer $year 対象となる西暦年 |
| 戻り値 | 引数に指定された西暦年に対応する和暦年（変換に失敗した場合はnullを返却） |
| 戻り値の型 | string |
| 用途 | 西暦に対応する和暦を取得する |
$result = $instance->cnvYear( 2009 );
var_dump( $result );
genYear()
| スコープ | public |
| 引数 | boolean $firsttype 配列の先頭を「----」にするかどうか（デフォルトfalse、True: ----をセットする / False: ----をセットしない ） / integer $base 生成開始年（西暦指定、デフォルトは現在年 - 5） / integer $limit 生成年数（デフォルトは10） / integer $mode 返却する配列のタイプ(デフォルト西暦のみ、 0: 西暦のみ / 1: 和暦のみ / 2: 両方 ) |
| 戻り値 | 「年」の情報が格納された配列 |
| 戻り値の型 | array |
| 用途 | 「年」の情報が格納された配列を生成する |
$result = $instance->genYear( true, 2000, 10, 2);
var_dump( $result );
genMonth()
| スコープ | public |
| 引数 | boolean $firsttype 配列の先頭を「--」にするかどうか（デフォルトfalse、True: ----をセットする / False: ----をセットしない ） |
| 戻り値 | 「月」の情報が格納された配列 |
| 戻り値の型 | array |
| 用途 | 「月」の情報が格納された配列を生成する |
$result = $instance->genMonth( true );
var_dump( $result );
genDay()
| スコープ | public |
| 引数 | boolean $firsttype 配列の先頭を「--」にするかどうか（デフォルトfalse、True: ----をセットする / False: ----をセットしない ） / integer $targetMonth 生成対象となる月（値を指定するとその月の日数に基づいた内容が返却される） / integer $targetYear 生成対象となる年（値を指定するとその年がうるう年かどうかを考慮する） |
| 戻り値 | 「日」の情報が格納された配列 |
| 戻り値の型 | array |
| 用途 | 「日」の情報が格納された配列を生成する |
$result = $instance->genDay( true, 2, 2000 );
var_dump( $result );
genHour()
| スコープ | public |
| 引数 | boolean $firsttype 配列の先頭を「--」にするかどうか（デフォルトfalse、True: ----をセットする / False: ----をセットしない ） / boolean $hourtype 表示を24時制にするかどうか（デフォルトtrue、True: 24時制 / False: 12時制、数字の前に「午前」または「午後」がつく ） |
| 戻り値 | 「時」の情報が格納された配列 |
| 戻り値の型 | array |
| 用途 | 「時」の情報が格納された配列を生成する |
$result = $instance->genHour( true, true );
var_dump( $result );
genMinSec()
| スコープ | public |
| 引数 | boolean $firsttype 配列の先頭を「--」にするかどうか（デフォルトfalse、True: ----をセットする / False: ----をセットしない ） |
| 戻り値 | 「分」または「秒」の情報が格納された配列 |
| 戻り値の型 | array |
| 用途 | 「分」または「秒」の情報が格納された配列を生成する |
$result = $instance->genMinSec( true, true );
var_dump( $result );
戻る
edit
PDF
Creative Commons Attribution-ShareAlike