API Documentation
\

\CurrentLibRoom

NetCommonsの機能に必要な情報(ルーム関連)を取得する内容をまとめたUtility

Summary

Methods
Properties
Constants
__construct()
load()
initialize()
getInstance()
resetInstance()
addSpaceIdsWithoutLogin()
getCurrentRoomId()
isRoomIdInRequest()
findRoomsByIds()
findRoomById()
findSpaceByRoomId()
findPrivateRoom()
getMemberRoomIds()
findUserRoomRoleByRoomId()
findRoleRoomById()
getRoleRoomIdByRoomId()
getRoomRoleKeyByRoomId()
findPluginsRoom()
findRoomRolePermissions()
allowRoomManager()
$uses
$libs
$_lang
$_controller
$Room
$Space
$RolesRoom
$RoomRolePermission
$RolesRoomsUser
$RoomsLanguage
$PluginsRoom
$CurrentLibPlugin
$CurrentLibLanguage
$CurrentLibUser
No constants found
_loadLibs()
_getInstance()
_resetInstance()
$_controller
$_instances
$_loaded
N/A
__getFieldsByRoom()
__getFieldsByRoomsLanguage()
__findRoomsLanguage()
$__spacesWOLogin
$__rooms
$__privateRoomId
$__memberRoomIds
$__userRoomRoles
$__roomsIdById
$__plugins
$__userId
$__langId
$__rolePermissions
N/A

Properties

$uses

$uses : array

使用するモデル

Type

array

$libs

$libs : array

使用するライブラリ

Type

array

$_lang

$_lang : string

言語ID

Type

string

$_controller

$_controller : \Controller

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

コントローラ

Type

\Controller

$Room

$Room : \Room

Roomモデル

Type

\Room

$Space

$Space : \Space

Spaceモデル

Type

\Space

$RolesRoom

$RolesRoom : \RolesRoom

RolesRoomモデル

Type

\RolesRoom

$RoomRolePermission

$RoomRolePermission : \RoomRolePermission

RoomRolePermissionモデル

Type

\RoomRolePermission

$RolesRoomsUser

$RolesRoomsUser : \RolesRoomsUser

RolesRoomsUserモデル

Type

\RolesRoomsUser

$RoomsLanguage

$RoomsLanguage : \RoomsLanguage

RoomsLanguageモデル

Type

\RoomsLanguage

$PluginsRoom

$PluginsRoom : \PluginsRoom

PluginsRoomモデル

Type

\PluginsRoom

$CurrentLibPlugin

$CurrentLibPlugin : \CurrentLibPlugin

CurrentLibPluginライブラリ

Type

\CurrentLibPlugin

$CurrentLibLanguage

$CurrentLibLanguage : \CurrentLibLanguage

CurrentLibLanguageライブラリ

Type

\CurrentLibLanguage

$CurrentLibUser

$CurrentLibUser : \CurrentLibUser

CurrentLibUserライブラリ

Type

\CurrentLibUser

$_controller

$_controller : \Controller

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

Type

\Controller

$_instances

$_instances : object

インスタンス

Type

object

$_loaded

$_loaded : boolean

ロードしているか否か

Type

boolean

$__spacesWOLogin

$__spacesWOLogin : array

ログインなしで参照できるスペースリストデータ

Type

array

$__rooms

$__rooms : array|null

一度取得したルームデータを保持

Type

array|null

$__privateRoomId

$__privateRoomId : string|null

プライベートルームID

Type

string|null

$__memberRoomIds

$__memberRoomIds : array|null

一度取得した参加ルーム(roles_rooms_uses)のIDリストを保持

※カレンダーなどで使用できるように取得する

Type

array|null

$__userRoomRoles

$__userRoomRoles : array|null

一度取得したルーム権限(roles_rooms)データを保持

Type

array|null

$__roomsIdById

$__roomsIdById : array|null

ルーム権限IDからルームIDに変換するためのIDを保存

Type

array|null

$__plugins

$__plugins : array|null

一度取得したルームに対するプラグインデータを保持

Type

array|null

$__userId

$__userId : string

ログインしたユーザIDを保持

Type

string — ユーザID(intの文字列)

$__langId

$__langId : string

言語IDを保持

Type

string — 数値の文字列

$__rolePermissions

$__rolePermissions : array|null

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

Type

array|null

Methods

__construct()

__construct() : void

コンストラクター

load()

load() : void

ライブラリのロード

initialize()

initialize(\Controller  $controller = null) : void

コントローラのセット

Parameters

\Controller $controller

コントローラ

getInstance()

getInstance() : \CurrentLibRoom

インスタンスの取得

Returns

\CurrentLibRoom

resetInstance()

resetInstance() : void

インスタンスのクリア

addSpaceIdsWithoutLogin()

addSpaceIdsWithoutLogin(string|integer  $spaceId) : void

ログインなしで閲覧可能なスペースIDリストに追加する

Parameters

string|integer $spaceId

スペースID

getCurrentRoomId()

getCurrentRoomId() : string|null

ルームIDの取得

Returns

string|null —

ルームID。nullの場合、パラメータ等からroom_idが取得できなかった

isRoomIdInRequest()

isRoomIdInRequest() : boolean

リクエストパラメータにルームIDがあるか

Returns

boolean

findRoomsByIds()

findRoomsByIds(array  $roomIds) : array

ルームデータを取得する

Parameters

array $roomIds

ルームID(intの文字列)リスト

Returns

array

findRoomById()

findRoomById(string|integer  $roomId) : array

ルームデータを取得する

Parameters

string|integer $roomId

ルームID

Returns

array

findSpaceByRoomId()

findSpaceByRoomId(string|integer  $roomId) : array

スペースデータを取得する

Parameters

string|integer $roomId

ルームID

Returns

array

findPrivateRoom()

findPrivateRoom(string|integer  $userId) : array

プライベートルームデータを取得する

Parameters

string|integer $userId

ユーザID

Returns

array

getMemberRoomIds()

getMemberRoomIds() : array

参加ルーム(roles_rooms_uses)のIDリストを取得する ※同時に、ユーザのルーム内役割も取得し、内部変数に保持する

Returns

array

findUserRoomRoleByRoomId()

findUserRoomRoleByRoomId(string|integer  $roomId) : array

ルームIDからユーザのルーム権限データ取得

Parameters

string|integer $roomId

ルームID

Returns

array

findRoleRoomById()

findRoleRoomById(string|integer  $roleRoomId) : array

ルーム権限IDからルーム権限データ取得

Parameters

string|integer $roleRoomId

ルーム権限ID

Returns

array

getRoleRoomIdByRoomId()

getRoleRoomIdByRoomId(string|integer  $roomId) : string|null

ルーム権限IDの取得

Parameters

string|integer $roomId

ルームID

Returns

string|null

getRoomRoleKeyByRoomId()

getRoomRoleKeyByRoomId(string|integer  $roomId) : string|null

ルーム権限の取得

Parameters

string|integer $roomId

ルームID

Returns

string|null —

権限の文字列

findPluginsRoom()

findPluginsRoom(string|integer  $roomId) : array

ルームプラグインデータ取得

Parameters

string|integer $roomId

ルームID

Returns

array

findRoomRolePermissions()

findRoomRolePermissions(string|integer  $roomId) : array

ルーム権限パーミッションデータ取得

Parameters

string|integer $roomId

ルームID

Returns

array

allowRoomManager()

allowRoomManager() : boolean

ルーム管理が使用できるか否か

Returns

boolean

_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

クラス名

__getFieldsByRoom()

__getFieldsByRoom() : array

ルームデータを取得するカラムを生成する

Returns

array

__getFieldsByRoomsLanguage()

__getFieldsByRoomsLanguage() : array

ルーム言語データを取得するカラムを生成する

Returns

array

__findRoomsLanguage()

__findRoomsLanguage(string|integer  $roomId) : array

ルーム言語データの取得

Parameters

string|integer $roomId

ルームID

Returns

array