BurgerEditorHelper
extends Helper
in package
Table of Contents
Properties
- $bgeConfig : array<string|int, mixed>
- ブロッククラス設定オプション・API URL 等、エディタへ渡す設定
- $initialized : bool
- 設定の初期化が済んでいるか
- $loadingStyle : mixed
- $useBlock : array<string|int, mixed>
- 描画中に利用されたブロック
- $useType : array<string|int, mixed>
- 描画中に利用されたタイプ
Methods
- __construct() : void
- コンストラクタ
- defaultBlock() : mixed
- ブロックの読み込み
- editor() : mixed
- BurgerEditor 出力
- getBgeConfig() : array<string|int, mixed>
- エディタへ渡す設定を取得する
- getCSSList() : mixed
- getMajorVersionOfSystem() : int
- baserCMSのメジャーバージョンを整数で取得する
- getPostImage() : string
- 記事に埋め込まれた画像のパスを取得する(ブログにのみ対応)
- getVersionOfSystem() : string
- baserCMSのバージョンを取得する
- initArea() : mixed
- 初期処理ファイル読み込み
- inputArea() : mixed
- panelArea() : mixed
- postImage() : string
- 記事に埋め込まれた画像を表示する
- preventLoadingStyle() : void
- スタイルの読み込みを防止する
- setSelfValue() : void
- エディタへ渡す設定を組み立てる
- shouldLoadStyle() : false
- スタイルを読み込むかどうか
- type() : mixed
- タイプの読み込み
- typeVersionList() : mixed
- タイプのリスト
- getThemeAssetPath() : string
- コンテンツが所属しているテーマのアセットのパスを取得する
- getThemeAssetUrl() : string
- コンテンツが所属しているテーマのアセットのURLを取得する
- getAddonDir() : array<string|int, string>
- Addon フォルダのパスを取得する
- getConfigJSONPath() : string
- bgeconfig.json のパスを取得する
- getThemeByContent() : string
- 記事が所属するsiteIdから、どのテーマファイルがロードされているかを取得する
Properties
$bgeConfig
ブロッククラス設定オプション・API URL 等、エディタへ渡す設定
private
array<string|int, mixed>
$bgeConfig
= []
$initialized
設定の初期化が済んでいるか
private
bool
$initialized
= false
$loadingStyle
private
mixed
$loadingStyle
= true
$useBlock
描画中に利用されたブロック
private
array<string|int, mixed>
$useBlock
= []
$useType
描画中に利用されたタイプ
private
array<string|int, mixed>
$useType
= []
Methods
__construct()
コンストラクタ
public
__construct(View $View[, mixed $settings = [] ]) : void
Parameters
- $View : View
- $settings : mixed = []
Tags
defaultBlock()
ブロックの読み込み
public
defaultBlock(mixed $blockPathList) : mixed
Parameters
- $blockPathList : mixed
editor()
BurgerEditor 出力
public
editor(mixed $fieldName[, mixed $options = [] ]) : mixed
Parameters
- $fieldName : mixed
- $options : mixed = []
getBgeConfig()
エディタへ渡す設定を取得する
public
getBgeConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getCSSList()
public
static getCSSList() : mixed
getMajorVersionOfSystem()
baserCMSのメジャーバージョンを整数で取得する
public
static getMajorVersionOfSystem() : int
Return values
int —major version
getPostImage()
記事に埋め込まれた画像のパスを取得する(ブログにのみ対応)
public
getPostImage(array<string|int, mixed> $post[, array<string|int, mixed> $options = [] ]) : string
Parameters
- $post : array<string|int, mixed>
-
blogpost
- $options : array<string|int, mixed> = []
-
option
Return values
string —filepath
getVersionOfSystem()
baserCMSのバージョンを取得する
public
static getVersionOfSystem() : string
/lib/Baser/VERSION.txt に記述されているバージョン
Return values
string —version
initArea()
初期処理ファイル読み込み
public
initArea() : mixed
inputArea()
public
inputArea() : mixed
panelArea()
public
panelArea() : mixed
postImage()
記事に埋め込まれた画像を表示する
public
postImage(array<string|int, mixed> $post[, array<string|int, mixed> $options = [] ]) : string
Parameters
- $post : array<string|int, mixed>
-
blogpost
- $options : array<string|int, mixed> = []
-
option
Return values
string —imgタグ
preventLoadingStyle()
スタイルの読み込みを防止する
public
preventLoadingStyle() : void
setSelfValue()
エディタへ渡す設定を組み立てる
public
setSelfValue() : void
二重実行を避けるため初回のみ処理する
shouldLoadStyle()
スタイルを読み込むかどうか
public
shouldLoadStyle() : false
Return values
falsetype()
タイプの読み込み
public
type(string $typeName) : mixed
Parameters
- $typeName : string
-
タイプ名
typeVersionList()
タイプのリスト
public
typeVersionList() : mixed
getThemeAssetPath()
コンテンツが所属しているテーマのアセットのパスを取得する
protected
static getThemeAssetPath(string $file) : string
Parameters
- $file : string
-
テーマの css フォルダ配下のファイル名
Return values
string —該当テーマが無い場合は空文字
getThemeAssetUrl()
コンテンツが所属しているテーマのアセットのURLを取得する
protected
static getThemeAssetUrl() : string
テーマはプラグインとして webroot をシンボリックリンクで公開するため、 アンダースコア区切りの名称がそのままURLとなる
Return values
string —該当テーマが無い場合は空文字
getAddonDir()
Addon フォルダのパスを取得する
private
getAddonDir() : array<string|int, string>
Return values
array<string|int, string>getConfigJSONPath()
bgeconfig.json のパスを取得する
private
getConfigJSONPath() : string
Return values
stringgetThemeByContent()
記事が所属するsiteIdから、どのテーマファイルがロードされているかを取得する
private
static getThemeByContent() : string
Return values
string —theme