API Documentation
\

\CurrentLibPage

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

Summary

Methods
Properties
Constants
__construct()
load()
initialize()
getInstance()
resetInstance()
addPluginAsPrivateRooms()
findTopPage()
isTopPageId()
findCurrentPage()
setCurrentPage()
findPage()
findCurrentPageContainer()
findCurrentPageWithContainer()
findPageContainer()
getPageIdByPermalink()
getPageIdByRoomWeightTop()
findBoxById()
$uses
$libs
$_controller
$Page
$PagesLanguage
$PageContainer
$Room
$RoomsLanguage
$Box
$BoxesPageContainer
$SettingMode
$CurrentLibFrame
$CurrentLibRoom
$CurrentLibBlock
$CurrentLibLanguage
$CurrentLibUser
No constants found
_loadLibs()
_getInstance()
_resetInstance()
$_controller
$_instances
$_loaded
N/A
__makePageFields()
__getPageIdInRequest()
__getCurrentPageId()
__findPagesLanguage()
__getFieldsByBoxes()
__findBoxes()
__makeFullPermalink()
__getPageIdByRoomId()
__getPageIdByBlockId()
__getPageIdByFrameId()
__getPageIdByBoxId()
__getPageIdByPrivateRoom()
$__privateRooms
$__cache
$__topPage
$__currentPage
$__pages
$__curPageContainer
$__langId
$__boxMaps
N/A

Properties

$uses

$uses : array

使用するモデル

Type

array

$libs

$libs : array

使用するライブラリ

Type

array

$_controller

$_controller : \Controller

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

コントローラ

Type

\Controller

$Page

$Page : \Page

Pageモデル

Type

\Page

$PagesLanguage

$PagesLanguage : \PagesLanguage

PagesLanguageモデル

Type

\PagesLanguage

$PageContainer

$PageContainer : \PageContainer

PageContainerモデル

Type

\PageContainer

$Room

$Room : \Room

Roomモデル

Type

\Room

$RoomsLanguage

$RoomsLanguage : \RoomsLanguage

RoomsLanguageモデル

Type

\RoomsLanguage

$Box

$Box : \Box

Boxモデル

Type

\Box

$BoxesPageContainer

$BoxesPageContainer : \BoxesPageContainer

BoxesPageContainerモデル

Type

\BoxesPageContainer

$SettingMode

$SettingMode : \SettingMode

SettingModeライブラリ

Type

\SettingMode

$CurrentLibFrame

$CurrentLibFrame : \CurrentLibFrame

CurrentLibFrameライブラリ

Type

\CurrentLibFrame

$CurrentLibRoom

$CurrentLibRoom : \CurrentLibRoom

CurrentLibRoomライブラリ

Type

\CurrentLibRoom

$CurrentLibBlock

$CurrentLibBlock : \CurrentLibBlock

CurrentLibBlockライブラリ

Type

\CurrentLibBlock

$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

$__privateRooms

$__privateRooms : array

キャッシュクラスを保持する変数

Type

array

$__cache

$__cache : array

キャッシュクラスを保持する変数

Type

array

$__topPage

$__topPage : array|null

一度取得したページデータを保持

Type

array|null

$__currentPage

$__currentPage : array|null

一度取得したページデータを保持

Type

array|null

$__pages

$__pages : array

一度取得したページデータを保持

Type

array

$__curPageContainer

$__curPageContainer : array|null

一度取得したページコンテナーデータを保持

Type

array|null

$__langId

$__langId : string

言語IDを保持

Type

string — 数値の文字列

$__boxMaps

$__boxMaps : array

$__currentPageに保持したボックスデータを取得するための情報保持

$this->__boxMaps = [
    (ボックスID) => [
        'box_id' => (ボックスID),
        'page_id' => (ページID),
        'container_type' => (コンテナータイプ：左カラム等のタイプ),
        'page_container_id' => (ページコンテナーID：ページID＋コンテナータイプで一意になるID),
    ]
];

Type

array

Methods

__construct()

__construct() : void

コンストラクター

load()

load() : void

ライブラリのロード

initialize()

initialize(\Controller  $controller = null) : void

コントローラのセット

Parameters

\Controller $controller

コントローラ

getInstance()

getInstance() : \CurrentPage

インスタンスの取得

Returns

\CurrentPage

resetInstance()

resetInstance() : void

インスタンスのクリア

addPluginAsPrivateRooms()

addPluginAsPrivateRooms(string  $plugin) : void

プライベートルームとするプラグインの追加

Parameters

string $plugin

追加するプラグイン

findTopPage()

findTopPage() : array

トップページのデータを取得する

Returns

array

isTopPageId()

isTopPageId(string|integer  $pageId) : boolean

トップページのページIDか否かチェックする

Parameters

string|integer $pageId

ページID

Returns

boolean

findCurrentPage()

findCurrentPage() : array

ページデータを取得する

Returns

array

setCurrentPage()

setCurrentPage(array  $page) : array

ページデータをセットする

Parameters

array $page

ページデータ

Returns

array

findPage()

findPage(string|integer  $pageId) : array

ページデータを取得する

Parameters

string|integer $pageId

ページID

Returns

array

findCurrentPageContainer()

findCurrentPageContainer() : array

ページデータ(コンテナー付き)を取得する

Returns

array

findCurrentPageWithContainer()

findCurrentPageWithContainer() : array

ページデータ(コンテナー付き)を取得する

Returns

array

findPageContainer()

findPageContainer(string|integer  $pageId) : array

ページコンテナ―データの取得

Parameters

string|integer $pageId

ページID

Returns

array

getPageIdByPermalink()

getPageIdByPermalink(string  $permalink, string|integer|null  $spaceId = null) : string|integer|false

パーマリンクからページIDを取得

Parameters

string $permalink

パーマリンク
string|integer|null $spaceId

スペースID

Returns

string|integer|false —

ページID

getPageIdByRoomWeightTop()

getPageIdByRoomWeightTop(string|integer  $roomId) : string|integer|false

対象ルームのトップページのページIDを取得

Parameters

string|integer $roomId

ルームID

Returns

string|integer|false —

ページID

findBoxById()

findBoxById(string|integer  $boxId) : array

ボックスデータを取得する

Parameters

string|integer $boxId

ボックスID

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

クラス名

__makePageFields()

__makePageFields() : array

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

Returns

array

__getPageIdInRequest()

__getPageIdInRequest() : string|null

リクエストの中からページIDを取得

Returns

string|null —

ページID。nullの場合、パラメータ等からpage_idが取得できなかった

__getCurrentPageId()

__getCurrentPageId() : string|null

ページIDの取得

Returns

string|null —

ページID(intの文字列)。nullの場合、パラメータ等からpage_idが取得できなかった

__findPagesLanguage()

__findPagesLanguage(string|integer  $pageId) : array

ページ言語データの取得

Parameters

string|integer $pageId

ページID

Returns

array

__getFieldsByBoxes()

__getFieldsByBoxes() : array

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

Returns

array

__findBoxes()

__findBoxes(array  $pageContainerIds) : array

ボックスデータの取得

Parameters

array $pageContainerIds

ページコンテナ―IDリスト

Returns

array

__makeFullPermalink()

__makeFullPermalink(string|integer  $roomId, string|integer  $pageId, string  $pagePermalink) : string|null

full_permalinkの生成

Parameters

string|integer $roomId

ルームID
string|integer $pageId

ページID
string $pagePermalink

ページのパーマリンク

Returns

string|null —

ページID。該当するルームのページIDが存在しない場合、nullとする

__getPageIdByRoomId()

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

room_idからルームのトップページIDを取得

Parameters

string|integer $roomId

ルームID

Returns

string|null —

ページID。該当するルームのページIDが存在しない場合、nullとする

__getPageIdByBlockId()

__getPageIdByBlockId(string|integer  $blockId) : string|null

block_idからルームのトップページIDを取得

Parameters

string|integer $blockId

ブロックID

Returns

string|null —

ページID。該当するルームのページIDが存在しない場合、nullとする

__getPageIdByFrameId()

__getPageIdByFrameId(string|integer  $frameId) : string|null

frame_idからページIDを取得

Parameters

string|integer $frameId

フレームID

Returns

string|null —

ページID。該当するルームのページIDが存在しない場合、nullとする

__getPageIdByBoxId()

__getPageIdByBoxId(string|integer  $boxId) : string|null

box_idからページIDを取得

Parameters

string|integer $boxId

ボックスID

Returns

string|null —

ページID。該当するルームのページIDが存在しない場合、nullとする

__getPageIdByPrivateRoom()

__getPageIdByPrivateRoom(string|integer  $userId) : string|null

プライベートルームのトップページIDを取得

Parameters

string|integer $userId

ユーザID

Returns

string|null —

ページID。該当するルームのページIDが存在しない場合、nullとする