API Documentation
\

\CurrentLibBlock

NetCommonsの機能に必要な情報(ブロック)を取得する内容をまとめたUtility

Summary

Methods
Properties
Constants
__construct()
load()
initialize()
getInstance()
resetInstance()
getCurrentBlockId()
getBlockKeysInCurrentPage()
isBlockIdInRequest()
getFindFields()
findBlockById()
setBlock()
findBlockRolePermissionsByBlockKey()
setBlockRolePermissions()
findUseWorkflowPermissionsByBlockKey()
setUseWorkflowPermissions()
$uses
$libs
$_controller
$Language
$Block
$BlocksLanguage
$BlockRolePermission
$BlockSetting
$CurrentLibLanguage
$CurrentLibRoom
No constants found
_loadLibs()
_getInstance()
_resetInstance()
$_controller
$_instances
$_loaded
N/A
__getFields()
__makeJoinsByMultipleLang()
__makeJoinsBySingleLang()
__setUseWorkflowPermission()
$__blocks
$__rolePermFromSetting
$__rolePermissions
N/A

Properties

$uses

$uses : array

使用するモデル

Type

array

$libs

$libs : array

使用するライブラリ

Type

array

$_controller

$_controller : \Controller

クラス内で処理するコントローラを保持

コントローラ

Type

\Controller

$Language

$Language : \Language

Languageモデル

Type

\Language

$Block

$Block : \Block

Pluginモデル

Type

\Block

$BlocksLanguage

$BlocksLanguage : \BlocksLanguage

BlocksLanguageモデル

Type

\BlocksLanguage

$BlockRolePermission

$BlockRolePermission : \BlockRolePermission

BlockRolePermissionモデル

Type

\BlockRolePermission

$BlockSetting

$BlockSetting : \BlockSetting

BlockSettingモデル

Type

\BlockSetting

$CurrentLibLanguage

$CurrentLibLanguage : \CurrentLibLanguage

CurrentLibLanguageライブラリ

Type

\CurrentLibLanguage

$CurrentLibRoom

$CurrentLibRoom : \CurrentLibRoom

CurrentLibRoomライブラリ

Type

\CurrentLibRoom

$_controller

$_controller : \Controller

クラス内で処理するコントローラを保持

Type

\Controller

$_instances

$_instances : object

インスタンス

Type

object

$_loaded

$_loaded : boolean

ロードしているか否か

Type

boolean

$__blocks

$__blocks : array

一度取得したブロックデータを保持

Type

array

$__rolePermFromSetting

$__rolePermFromSetting : array

一度取得したルーム権限パーミッション(block_settingからblock_permissionのフォーマットに変換)データを保持

Type

array

$__rolePermissions

$__rolePermissions : array|null

一度取得したルーム権限パーミッション(block_role_permissions)データを保持

Type

array|null

Methods

__construct()

__construct() : void

コンストラクター

load()

load() : void

ライブラリのロード

initialize()

initialize(\Controller  $controller = null) : void

コントローラのセット

Parameters

\Controller $controller

コントローラ

getInstance()

getInstance() : \CurrentLibFrame

インスタンスの取得

Returns

\CurrentLibFrame

resetInstance()

resetInstance() : void

インスタンスのクリア

getCurrentBlockId()

getCurrentBlockId() : integer|null

ブロックIDの取得

Returns

integer|null —

ブロックID(int)。nullの場合、パラメータ等からblock_idが取得できなかった

getBlockKeysInCurrentPage()

getBlockKeysInCurrentPage() : array

ページブロックキーの取得

Returns

array

isBlockIdInRequest()

isBlockIdInRequest() : boolean

リクエストパラメータにブロックIDがあるか

Returns

boolean

getFindFields()

getFindFields() : array

ブロックデータを取得するカラムの取得

CurrentLibFrameで使用する

Returns

array

findBlockById()

findBlockById(string|integer  $blockId) : array

ブロックデータを取得

Parameters

string|integer $blockId

ブロックID

Returns

array

setBlock()

setBlock(string|integer  $blockId, array  $block) : void

ブロックデータを変数にセットする

CurrentLibFrameで使用するため、publicメソッド化

Parameters

string|integer $blockId

ブロックID
array $block

ブロックデータ

findBlockRolePermissionsByBlockKey()

findBlockRolePermissionsByBlockKey(string|integer  $roomId, string  $blockKey) : array

ブロックキーからブロックロールパーミッションのデータを取得

Parameters

string|integer $roomId

ルームID
string $blockKey

ブロックキー

Throws

\InternalErrorException

Returns

array

setBlockRolePermissions()

setBlockRolePermissions(string|integer  $roomId, array  $blockKeys) : void

ブロックキーからブロックロールパーミッションのデータをローカル変数にセットする

Parameters

string|integer $roomId

ルームID
array $blockKeys

ブロックキーリスト

Throws

\InternalErrorException

findUseWorkflowPermissionsByBlockKey()

findUseWorkflowPermissionsByBlockKey(string|integer  $roomId, string  $blockKey) : array

ブロックキーからブロック設定データからワークフローの有無を取得

・承認ありのルームの場合、BlockSettingの承認有無は使用せずに、room_role_permissionsを使用する。 ・承認なしのルームの場合、BlockSettingにデータは、承認なしのデータとする。 　ただし、実際に利用するpermissionのデータは、room_role_permissionsの設定値を利用する。 　逆にBlockSettingにデータがない場合、承認ありとする(元のソースktera)。

Parameters

string|integer $roomId

ルームID
string $blockKey

ブロックキー

Returns

array

setUseWorkflowPermissions()

setUseWorkflowPermissions(string|integer  $roomId, array  $blockKeys) : array

ブロック設定データのワークフローの有無をローカル変数にセットする

Parameters

string|integer $roomId

ルームID
array $blockKeys

ブロックキーリスト

Returns

array

_loadLibs()

_loadLibs(array  $libs) : void

ライブラリのロード

Parameters

array $libs

ロードするライブラリ群

_getInstance()

_getInstance(string|null  $className = null) : object

インスタンスの取得

Parameters

string|null $className

クラス名

Returns

object

_resetInstance()

_resetInstance(string  $className) : void

インスタンスのクリア

※メイン処理ではあまり使う機会はないが、主にUnitTestで使用する

Parameters

string $className

クラス名

__getFields()

__getFields() : array

ブロックデータを取得するカラムを生成する

Returns

array

__makeJoinsByMultipleLang()

__makeJoinsByMultipleLang() : array

多言語のフレーム取得のためのjoinsを生成する

Returns

array

__makeJoinsBySingleLang()

__makeJoinsBySingleLang() : array

単一言語のフレーム取得のためのjoinsを生成する

Returns

array

__setUseWorkflowPermission()

__setUseWorkflowPermission(string  $blockKey, array  $blockSettings) : array

ブロック設定データのワークフローの有無をローカル変数をセットする

Parameters

string $blockKey

ブロックキー
array $blockSettings

ブロック設定データリスト

Returns

array