Docs For Class BEAR

void assert(
bool
$bool, [array
$msg = 'Bad Resource Request (assert)'])

シンプルアサーション

 単純なboolean値を引数にしてfalseの時は例外を投げ、
 リソースの結果は400エラー(Bad Request)のリソースオブジェクト(BEAR_Roオブジェクト)になります。
 onRead, onCreateなどCRUDメソッドに値が正しく渡されているか確認するために使用します。
 再利用のためにAOPアドバイスですることも検討してください。

Tags:

throws:	BEAR_Ro_Exception
access:	public

Parameters:

bool	$bool	条件
array	$msg	エラー例外のinfo

[ Top ]

void assertRequired(

$keys, array
$values)

必須項目アサーション

 連想配列に指定のキー配列が全て含まれてるか検査し、問題があれば例外を投げます。
 リソースの結果は400エラー(Bad Request)のリソースオブジェクト(BEAR_Roオブジェクト)になります。
 onRead, onCreateなどCRUDメソッドに値が正しく渡されているか確認するために使用します。

Tags:

deprecated:	@requierdを用います。
throws:	BEAR_Exception
access:	public

Parameters:

array	$keys	必須キー配列
array	$values	テストする配列

[ Top ]

BEAR_Ro __construct(

$config)

Constructor

Tags:

access:

public

Overrides ArrayObject::constructor __construct ( $array ) (parent method not documented)

Parameters:

array

$config

[ Top ]

int count(
)

count取得

count取得 arrayとして振舞うための実装です。

Tags:

access:

public

Overrides ArrayObject::count ( ) (parent method not documented)

[ Top ]

mixed getBody(
)

リソースボディの取得

リソースボディの取得ボディ（リソース取得結果本体）を取得します。

Tags:

access:

public

Overridden in child classes as:

BEAR_Ro_Prototype::getBody(): リソースボディを取得

Implementation of:

BEAR_Ro_Interface::getBody(): リソースボディの取得

[ Top ]

int getCode(
)

コードの取得

Tags:

return:	(200\|400\|500)
access:	public

Implementation of:

BEAR_Ro_Interface::getCode(): 状態コードの取得

[ Top ]

array getConfig(
[
$key = null])

コンフィグ取得

Tags:

access:

public

Parameters:

$key

[ Top ]

array getHeader(

$headerKey)

リソースヘッダーの取得

Tags:

access:

public

Overridden in child classes as:

BEAR_Ro_Prototype::getHeader(): リソースヘッダーを取得（アイテム)

Parameters:

$headerKey

[ Top ]

array getHeaders(
)

リソースヘッダーの取得

Tags:

access:

public

Overridden in child classes as:

BEAR_Ro_Prototype::getHeaders(): リソースヘッダーを取得（リスト)

Implementation of:

BEAR_Ro_Interface::getHeaders(): リソースヘッダーの取得

[ Top ]

string getHtml(
)

HTML取得

Tags:

access:

public

[ Top ]

IteratorAggregate getIterator(
)

イテレーター

イテレーター optionsで指定したイテレーター、もしくはdefaultのArrayIteratorが使用されます

Tags:

access:

public

Implementation of:

IteratorAggregate::getIterator

Overrides ArrayObject::getIterator ( ) (parent method not documented)

[ Top ]

Traversable getIterator1(
)

Create a new iterator from an ArrayObject instance

Tags:

access:

public

[ Top ]

array getLinks(
)

リソースリンクの取得

リソースリンクの取得リソースのリンクを取得します。

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::getLinks(): リソースリンクの取得

[ Top ]

App_Ro getRo(
)

Ro取得

Ro取得 link()がついてるリソースでもgetRo()で取得されるのは最初のリソースです。

Tags:

access:

public

Overridden in child classes as:

BEAR_Ro_Prototype::getRo(): Ro取得

[ Top ]

mixed onCreate(
array
$values)

リソース作成

リソース作成リソースを作成します。このメソッドはキャッシュオプションが使えます。

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::onCreate(): リソース作成

Parameters:

array

$values

引数

[ Top ]

mixed onDelete(
array
$values)

リソース消去

リソース消去リソースを消去します。このメソッドはPOEオプション（一度だけ実行する）オプションが使えます。

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::onDelete(): リソース削除

Parameters:

array

$values

引数

[ Top ]

void onInject(
)

Inject

Tags:

access:

public

Overridden in child classes as:

BEAR_Ro_Prototype::onInject(): Inject

BEAR_Ro_Prototype_Debug::onInject(): Inject

[ Top ]

array onLink(
array
$values)

リンク

Tags:

access:

public

Parameters:

array

$values

[ Top ]

mixed onRead(
array
$values)

リソース読み込み

リソース読み込みオプションにcacheが使えます

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::onRead(): リソース読み込み

Parameters:

array

$values

引数

[ Top ]

mixed onUpdate(
array
$values)

リソース変更

リソース変更リソースを変更します。このメソッドはPOEオプション（一度だけ実行する）オプションが使えます。

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::onUpdate(): リソース変更

Parameters:

array

$values

引数

[ Top ]

void outputHttp(
)

HTTP出力

 BEAR_RoリソースオブジェクトをHTTP出力します。
 _codeプロパティがレスポンスコード、_header配列プロパティのうち
 文字列のものがHTTPヘッダー,_bodyプロパティがHTTPボディとして出力されます。

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::outputHttp(): HTTP出力

[ Top ]

BEAR_Ro set(
[string
$key = null], array
$config)

ビューにセット

ビューにセット readの後ろにつなげて使います。

 $config
 'pager' string ページャーをアサインする変数名
 'ro'    bool   ROアサイン

$resource->$read($params)->set('user');

Tags:

access:

public

Overridden in child classes as:

BEAR_Ro_Prototype::set(): リソースセット

Parameters:

string	$key	テンプレート変数名省略すればURI(/を_に置換)
array	$config	設定

[ Top ]

BEAR_Ro setBody(
mixed
$body)

リソースボディをセット

リソースボディをセットリソースのボディ（リソース結果）をセットします。

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::setBody(): リソースボディをセット

Parameters:

mixed

$body

ボディ

[ Top ]

BEAR_Ro setCode(
int
$code)

状態コード設定

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::setCode(): 状態コード設定

Parameters:

int

$code

コード

[ Top ]

BEAR_Ro setConfig(
mixed
$config, [mixed
$values = null])

Set config

Tags:

access:

public

Parameters:

mixed	$config	(string)コンフィグキー \| (array)コンフィグ配列
mixed	$values	(string)$configの時のコンフィグ値

[ Top ]

BEAR_Ro setHeader(
string
$key, string
$header)

リソースヘッダーセット

 キーを指定してリソースヘッダーをセットします。
 予約済みキーはこのクラスのconstとして定義されています。

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::setHeader(): リソースヘッダーセット

Parameters:

string	$key	ヘッダーキー
string	$header	ヘッダー

[ Top ]

BEAR_Ro setHeaders(

$headers)

ヘッダーのセット

Tags:

access:

public

Parameters:

array

$headers

ヘッダー配列

[ Top ]

BEAR_Ro setHtml(

$html)

リソースHTMLの指定

Tags:

access:

public

Parameters:

$html

[ Top ]

BEAR_Ro setLink(
string
$key, string
$link)

リンクのセット

 リソースリンクをセットします。
 予約済みキーはこのクラスのconstとして定義されています。

Tags:

access:

public

Implementation of:

BEAR_Ro_Interface::setLink(): リンクのセット

Parameters:

string	$key	リンクキー
string	$link	リンク

[ Top ]

BEAR_Ro setLinks(
array
$links)

リンクをセット

Tags:

access:

public

Parameters:

array

$links

リンク

[ Top ]

void setService(
string
$name, object
$service)

サービスセット

Tags:

access:

public

Parameters:

string	$name	プロパティ
object	$service	サービス

[ Top ]

string toString(
)

リソースの文字列化

 変数状態のリソース(body)にテンプレートを適用して文字列化します。
 テンプレート指定がない場合、スカラー値ならそのまま、スカラー値でないなら''になります。
 プロトタイプリソース（リクエストをまだ行っていないリソース）の場合は実リクエストを行った後に文字列化を行います。
 このメソッドはRoクラスのマジックメソッドとして機能します。

Tags:

access:

public

[ Top ]

Exception _exception(
string
$msg, 
$config)

例外の作成

Tags:

access:

protected

Parameters:

string	$msg
array	$config

[ Top ]

BEAR_Ro __invoke(

$values)

関数としての振る舞い

Tags:

access:

public

Parameters:

array

$values

[ Top ]

string __toString(
)

マジックメソッド - 文字列化

Tags:

access:

public

[ Top ]

Class: BEAR_Ro

Class Overview

Author(s):

Version:

Copyright:

Variables

Constants

Methods

Child classes:

Inherited Constants

Class: ArrayObject (Internal Class)

Inherited Methods

Class: ArrayObject (Internal Class)

Class Details

Tags:

Class Variables

$_config = array()

Tags:

Class Methods

method assert [line 272]

Tags:

Parameters:

method assertRequired [line 299]

Tags:

Parameters:

constructor __construct [line 162]

Tags:

Parameters:

method count [line 694]

Tags:

method getBody [line 317]

Tags:

method getCode [line 467]

Tags:

method getConfig [line 795]

Tags:

Parameters:

method getHeader [line 337]

Tags:

Parameters:

method getHeaders [line 327]

Tags:

method getHtml [line 852]

Tags:

method getIterator [line 663]

Tags:

method getIterator1 [line 679]

Tags:

method getLinks [line 350]

Tags:

method getRo [line 842]

Tags:

method onCreate [line 191]

Tags:

Parameters:

method onDelete [line 238]

Tags:

Parameters:

method onInject [line 177]

Tags:

method onLink [line 251]

Tags:

Parameters:

method onRead [line 206]

Tags:

Parameters:

method onUpdate [line 222]

Tags:

Parameters:

method outputHttp [line 548]

Tags:

method set [line 756]

Tags:

Parameters:

method setBody [line 364]

Tags:

Parameters:

method setCode [line 452]

Tags:

Parameters: