BEAR_Resource
[ class tree: BEAR_Resource ] [ index: BEAR_Resource ] [ all elements ]

Class: BEAR_Resource

Source Location: /BEAR/Resource.php

Class Overview

BEAR_Base
   |
   --BEAR_Resource

リソースクライアント


Author(s):

Version:

  • SVN: Release: @package_version@ $Id: Resource.php 2486 2011-06-06 07:44:05Z koriyama@bear-project.net $

Copyright:

  • 2008-2011 Akihito Koriyama All rights reserved.

Implements interfaces:

Constants

Methods


Inherited Variables

Inherited Methods


Class Details

[line 53]
リソースクライアント

リソースクライアント

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

 Example. キャッシュの使用
  1.  $options['cache']['key''cacheid_foo'//省略できます
  2.  $options['cache']['life'30;
  3.  $resoruce->read($params$options)->set('user''object');
  4.  //または
  5.  $user $resoruce->read($params$options)->getBody();
 Example. 二重実行防止にはPOE(Post Once Exactly)オプションを指定します
  1.  //二重送信されたものを一度しか実行しない
  2.  $options['poe'true;
  3.  $resource->create($values$options)->request();




Tags:

author:  Akihito Koriyama <koriyama@bear-project.net>
version:  SVN: Release: @package_version@ $Id: Resource.php 2486 2011-06-06 07:44:05Z koriyama@bear-project.net $
copyright:  2008-2011 Akihito Koriyama All rights reserved.
link:  http://www.bear-project.net/
license:  BSD


[ Top ]


Class Methods


method create [line 177]

BEAR_Ro create( $params)

リソース作成

リソース作成

 リソースを作成します。

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




Tags:

access:  public


Parameters:

array   $params   リクエストパラメータ

[ Top ]

method delete [line 258]

BEAR_Ro_Prototype delete( $params)

リソース削除

リソース削除 リソースを削除します。 $params 'uri' string URI 'values' array 引数 'options' array オプション </pre>




Tags:

access:  public


Parameters:

array   $params   引数

[ Top ]

method getPager [line 153]

array getPager( )

ページャー情報の取得

ページャー情報の取得

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

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




Tags:

access:  public


[ Top ]

method onInject [line 134]

void onInject( )

Inject

Inject




Tags:

access:  public


Overrides BEAR_Base::onInject() (Inject)

[ Top ]

constructor __construct [line 124]

BEAR_Resource __construct( $config)

Constructor

Constructor




Tags:

access:  public


Overrides BEAR_Base::__construct() (Universal constructor)

Parameters:

array   $config  

[ Top ]

method read [line 205]

BEAR_Ro_Prototype read( $params)

リソース読み込み

リソース読み込み

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

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

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




Tags:

access:  public


Parameters:

array   $params   引数

[ Top ]

method request [line 292]

BEAR_Ro_Prototype request( string $method, string $uri, [ $values = array()], [ $options = array()])

リソース操作

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

 Example 1.リソース読み込み
  1.  $params['uri''user/profile';
  2.  $params['values'array('id'=>1);
  3.  $resource BEAR::dependency('BEAR_Resource');
  4.  $profileObject $resource->read($params)->getRo();
  5.  $profileValues $resource->read($params)->getBody();
  6.  // objectとしてテンプレートにset
  7.  $profileObject $resource->read($params)->set('profile''object');




Tags:

access:  public



Implementation of:
BEAR_Resource_Request_Interface::request()
リソースリクエスト

Parameters:

string   $method   メソッド(create | read | update | delete)
string   $uri   URI
array   $values   引数
array   $options   オプション

[ Top ]

method update [line 235]

BEAR_Ro_Prototype update( $params)

リソース更新

リソース更新 リソースを更新します。

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

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

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




Tags:

access:  public


Parameters:

array   $params   引数

[ Top ]


Class Constants

LINK_PAGER =  'pager'

[line 110]

リンクキー page

リンクキー page



[ Top ]

METHOD_CREATE =  'create'

[line 58]

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

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



[ Top ]

METHOD_DELETE =  'delete'

[line 73]

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

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



[ Top ]

METHOD_READ =  'read'

[line 63]

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

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



[ Top ]

METHOD_UPDATE =  'update'

[line 68]

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

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



[ Top ]

OPTION_CACHE_KEY =  'key'

[line 83]

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

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



[ Top ]

OPTION_CACHE_LIFE =  'life'

[line 88]

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

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



[ Top ]

OPTION_PAGER =  'pager'

[line 78]

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

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



[ Top ]

OPTION_POE =  'poe'

[line 99]

オプション POE (Post Once Exactly)

オプション POE (Post Once Exactly)



[ Top ]

OPTION_RESOURCE_FILE_EXTENTION =  'extention'

[line 94]

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

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



[ Top ]

OPTION_TOKEN =  'token'

[line 104]

オプション トークン無視

オプション トークン無視



[ Top ]



Documentation generated on Sat, 30 Jul 2011 00:11:48 +0900 by phpDocumentor 1.4.3