API Documentation
\

\CurrentFrame

CurrentFrame Utility

Summary

Methods
Properties
Constants
initialize()
clear()
reset()
setFrame()
setBox()
setBoxPageContainer()
setBlock()
setBlockRolePermissions()
$skipFramePlugins
No constants found
No protected methods found
$_instancePage
N/A
__getFrame()
__setCurrentBlockRolePermission()
__getCurrentBlockRolePermissionByBlockKey()
__getBlockRolePermissionsByRoleRoomId()
__getPermissionFromBlockSetting()
$__memoryCache
$__roomIds
N/A

Properties

$skipFramePlugins

$skipFramePlugins : mixed

管理プラグイン以外でFrameチェックからスキップするプラグインリスト

Type

mixed

$_instancePage

$_instancePage : mixed

CurrentPage Instance object

Type

mixed

$__memoryCache

$__memoryCache : array

同じデータを取得しないようにキャッシュする

Type

array

$__roomIds

$__roomIds : array

ページ内で使用するフレームの所属するルームID

Type

array

Methods

initialize()

initialize() : void

setup current data

clear()

clear() : void

setup current data

reset()

reset() : void

reset

setFrame()

setFrame(string  $frameId = null) : void

Set Frame

Parameters

string $frameId

フレームID

setBox()

setBox() : void

Set PageByBox

setBoxPageContainer()

setBoxPageContainer() : void

Set BoxPageContainer

setBlock()

setBlock(integer  $blockId = null) : void

Set Block

Parameters

integer $blockId

Blocks.id

setBlockRolePermissions()

setBlockRolePermissions() : void

Set BlockRolePermissions

__getFrame()

__getFrame(string  $frameId) : array

Get Frame

Parameters

string $frameId

フレームID

Returns

array

__setCurrentBlockRolePermission()

__setCurrentBlockRolePermission() : void

Set current BlockRolePermissions

Throws

\InternalErrorException

__getCurrentBlockRolePermissionByBlockKey()

__getCurrentBlockRolePermissionByBlockKey() : array

Get current BlockRolePermissionsByBlockKey

Throws

\InternalErrorException

Returns

array

__getBlockRolePermissionsByRoleRoomId()

__getBlockRolePermissionsByRoleRoomId() : array

Get current BlockRolePermissionsByRoleRoomId

Throws

\InternalErrorException

Returns

array

__getPermissionFromBlockSetting()

__getPermissionFromBlockSetting(array  $permission) : void

Get permission from BlockSetting

Parameters

array $permission

permission data