API Documentation
\

\BEAR_Ro_Prototype_Link

リソースオブジェクトリンク

リソースリンクを処理します。BEAR_Ro_Prototype::getLinkedBody()から利用されています。

Summary

Methods
Properties
Constants
__construct()
onInject()
setConfig()
getConfig()
setService()
chainLink()
No public properties found
No constants found
_exception()
$_config
$_chain
$_links
N/A
_chainLink()
_changeRecursive()
_cleanUpLink()
_makeCollectionChain()
No private properties found
N/A

Properties

$_config

$_config : array

Class config

Type

array

$_chain

$_chain : array

Type

array

$_links

$_links :

Type

Methods

__construct()

__construct(array  $config)

Universal 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

サービス

chainLink()

chainLink(\BEAR_Ro  $rootRo, array  $chain) : array

リソースのリンクをつなげる

リソースをリンクした結果をHEADER_LINK_BODYヘッダーに付加します

Parameters

\BEAR_Ro $rootRo
array $chain

Returns

array

_exception()

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

例外の作成

Parameters

string $msg

例外メッセージ
array $config

例外config

Returns

\BEAR_Exception

_chainLink()

_chainLink(\BEAR_Ro  $rootRo, array  $chain) : array

リソースのリンクをつなげる

リソースをリンクした結果をHEADER_LINK_BODYヘッダーに付加します

Parameters

\BEAR_Ro $rootRo
array $chain

Returns

array

_changeRecursive()

_changeRecursive(  $linked, string  $linkFrom, string  $linkTo) : void

リンクリソースを再帰で変更

Parameters

$linked
string $linkFrom
string $linkTo

_cleanUpLink()

_cleanUpLink(  $data) : void

リンクのクリーンアップ

リンクマークを除去

Parameters

$data

_makeCollectionChain()

_makeCollectionChain(array  $body, string  $link, \BEAR_Ro  $ro) : void

リンクリソースからリンクマークを設定

リンクリソースリクエストを行う場所を特定するために配列データに'_link'というリンクマークをつけます。
つけられたマークは後でまとめて変換が行われます

Parameters

array $body
string $link

リンク
\BEAR_Ro $ro

リソースオブジェクト