\BEAR_Resource

リソースクライアント

リソースの’メソッド’、'URI', 引数(Values)、およびオプションを指定してリソースを操作します。
オプションはキャッシュ、ページング処理、コールバック関数によるポストプロセス、作成時の二重動作禁止のための
トークン処理などがあります。

Example. キャッシュの使用

$options['cache']['key'] = 'cacheid_foo'; //省略できます $options['cache']['life'] = 30; $resoruce->read($params, $options)->set('user', 'object'); //または $user = $resoruce->read($params, $options)->getBody();

Example. 二重実行防止にはPOE(Post Once Exactly)オプションを指定します

//二重送信されたものを一度しか実行しない $options['poe'] = true; $resource->create($values, $options)->request();

Summary

Methods
Properties
Constants
__construct()
onInject()
setConfig()
getConfig()
setService()
getPager()
create()
read()
update()
delete()
request()
No public properties found
METHOD_CREATE
METHOD_READ
METHOD_UPDATE
METHOD_DELETE
OPTION_PAGER
OPTION_CACHE_KEY
OPTION_CACHE_LIFE
OPTION_RESOURCE_FILE_EXTENTION
OPTION_POE
OPTION_CSRF
OPTION_TOKEN
LINK_PAGER
_exception()
$_config
N/A
No private methods found
$_ro
N/A

Constants

METHOD_CREATE

METHOD_CREATE

リソースメソッド - create(POST, INSERT)

METHOD_READ

METHOD_READ

リソースメソッド - read(GET, SELECT)

METHOD_UPDATE

METHOD_UPDATE

リソースメソッド - update(PUT, UPDATE)

METHOD_DELETE

METHOD_DELETE

リソースメソッド - delete(DELETE, DELETE)

OPTION_PAGER

OPTION_PAGER

リソースオプション ページャー

OPTION_CACHE_KEY

OPTION_CACHE_KEY

 リソースキャッシュ キャッシュキー

OPTION_CACHE_LIFE

OPTION_CACHE_LIFE

リソースオプションキー キャッシュ時間

OPTION_RESOURCE_FILE_EXTENTION

OPTION_RESOURCE_FILE_EXTENTION

リソースオプションキー スタティックリソースキー

OPTION_POE

OPTION_POE

オプション POE (Post Once Exactly)

OPTION_CSRF

OPTION_CSRF

オプション CSRF (Cross Site Request Forgeries)

OPTION_TOKEN

OPTION_TOKEN

オプション トークン無視

Properties

$_config

$_config : array

Class config

Type

array

Methods

__construct()

__construct(array  $config) 

Constructor

設定を_configプロパティに代入します。

Parameters

array $config

ユーザー設定値

onInject()

onInject() : void

Inject

設定にしたがってサービスをインジェクトします。

setConfig()

setConfig(mixed  $config, mixed  $values = null) : self

Set config

Parameters

mixed $config

(string) 設定キー | (array) 設定配列

mixed $values

(string) $configの時の設定値

Returns

self

getConfig()

getConfig(string  $key = null) : mixed

Get config

Parameters

string $key

設定キー、指定なければ全ての設定を取得

Returns

mixed

setService()

setService(string  $name, mixed  $service) : void

Set service

Parameters

string $name

サービスキー

mixed $service

サービス

getPager()

getPager() : array

ページャー情報の取得

ページャーで生成されたナビゲーションHTMLを取得します。
DBページャーの場合はページャー情報も取得されます
['links']にナビゲーションリンクが
['info']のページャー情報がはいります

DBページャーの場合は結果がリソースオブジェクトになっているので、
リンクとメタ情報からページャー情報を生成しています

Returns

array

create()

create(array  $params) : \BEAR_Ro_Prototype

リソース作成

リソースを作成します。

$params
'uri'     string URI
'values'  array  引数
'options' array  オプション

Parameters

array $params

リクエストパラメータ

Returns

\BEAR_Ro_Prototype

read()

read(array  $params) : \BEAR_Ro_Prototype

リソース読み込み

リソースを読み込みます。

$params
'uri'     string URI
'values'  array  引数
'options' array  オプション

$params['options']
 'cache' 'id'   string キャッシュID
 'cache' 'life' int    キャッシュ時間(秒)
 

Parameters

array $params

引数

Returns

\BEAR_Ro_Prototype

update()

update(array  $params) : \BEAR_Ro_Prototype

リソース更新

リソースを更新します。

リソースを読み込みます。

$params
'uri'     string URI
'values'  array  引数
'options' array  オプション

$params['options']
 'cache' 'id'   string キャッシュID
 'cache' 'life' int    キャッシュ時間(秒)
 

Parameters

array $params

引数

Returns

\BEAR_Ro_Prototype

delete()

delete(array  $params) : \BEAR_Ro_Prototype

リソース削除

リソースを削除します。

$params 'uri' string URI 'values' array 引数 'options' array オプション

Parameters

array $params

引数

Returns

\BEAR_Ro_Prototype

request()

request(string  $method, string  $uri, array  $values = array(), array  $options = array()) : \BEAR_Ro_Prototype

リソース操作

リソースの操作情報を保持するオブジェクト(BEAR_Ro_Prototype)を取得します。 同クラスのcreate(), read(), update(), delete()から呼ばれるリソース操作クラスです。

Example 1.リソース読み込み

$params['uri'] = 'user/profile'; $params['values'] = array('id'=>1); $resource = BEAR::dependency('BEAR_Resource'); $profileObject = $resource->read($params)->getRo(); $profileValues = $resource->read($params)->getBody(); // objectとしてテンプレートにset $profileObject = $resource->read($params)->set('profile', 'object');

Parameters

string $method

メソッド(create | read | update | delete)

string $uri

URI

array $values

引数

array $options

オプション

Returns

\BEAR_Ro_Prototype

_exception()

_exception(string  $msg, array  $config = array()) : \BEAR_Exception

例外の作成

Parameters

string $msg

例外メッセージ

array $config

例外config

Returns

\BEAR_Exception