API Documentation
\

\CurrentLibUser

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

Summary

Methods
Properties
Constants
__construct()
load()
initialize()
getInstance()
resetInstance()
isLoginChanged()
renewSessionUser()
getLoginUser()
getLoginUserId()
getLoginUserRoleKey()
isLogined()
$uses
$libs
$_controller
$Language
$PluginsRole
$Plugin
No constants found
_loadLibs()
_getInstance()
_resetInstance()
$_controller
$_instances
$_loaded
N/A
No private methods found
$__user
N/A

Properties

$uses

$uses : array

使用するモデル

Type

array

$libs

$libs : array

使用するライブラリ

Type

array

$_controller

$_controller : \Controller

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

コントローラ

Type

\Controller

$Language

$Language : \Language

Languageモデル

Type

\Language

$PluginsRole

$PluginsRole : \PluginsRole

PluginsRoleモデル

Type

\PluginsRole

$Plugin

$Plugin : \Plugin

Pluginモデル

Type

\Plugin

$_controller

$_controller : \Controller

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

Type

\Controller

$_instances

$_instances : object

インスタンス

Type

object

$_loaded

$_loaded : boolean

ロードしているか否か

Type

boolean

$__user

$__user : array|null

一度取得したユーザデータを保持

Type

array|null

Methods

__construct()

__construct() : void

コンストラクター

load()

load() : void

ライブラリのロード

initialize()

initialize(\Controller  $controller = null) : void

コントローラのセット

Parameters

\Controller $controller

コントローラ

getInstance()

getInstance() : \CurrentLibUser

インスタンスの取得

Returns

\CurrentLibUser

resetInstance()

resetInstance() : void

インスタンスのクリア

isLoginChanged()

isLoginChanged() : boolean

ログイン情報が変わっているか否か

Returns

boolean

renewSessionUser()

renewSessionUser() : void

セッションのログイン情報を再登録する

getLoginUser()

getLoginUser() : array

ログイン情報の取得

Returns

array

getLoginUserId()

getLoginUserId() : string|null

ログインしているユーザIDの取得

Returns

string|null —

数値の文字列

getLoginUserRoleKey()

getLoginUserRoleKey() : string|null

ログインしているユーザのロールキーの取得

Returns

string|null

isLogined()

isLogined() : 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

クラス名