BcFrontPlugin
extends BcPlugin
in package
plugin for BcFront
Table of Contents
Properties
- $currentSite : null
- 現在のサイト キャッシュ用
- $migrations : Migrations
Methods
- applyAsTheme() : mixed
- テーマを適用する
- bootstrap() : void
- bootstrap
- clearCurrentSite() : void
- カレントサイトを初期化する
- contentsRoutingForReverse() : RouteBuilder
- コンテンツ管理ルーティング
- createAssetsSymlink() : bool
- プラグインアセットのシンボリックリンクを作成する
- execScript() : bool
- アップデートスクリプトを実行する
- execUpdater() : mixed
- アップデートプログラムを実行する
- frontPageRouting() : RouteBuilder
- プラグインのフロントエンド用ルーティング(プラグイン名がダッシュ区切りの場合)
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- getUpdaters() : array<string|int, mixed>
- アップデータのパスを取得する
- getUpdateScriptMessages() : array<string|int, mixed>
- アップデータのメッセージを取得する 現在のバージョンより上位のアップデートスクリプトフォルダの config.php を読み込み 変数 $updateMessage より取得する
- hasService() : bool
- Has Service
- initialize() : void
- Initialize
- install() : bool
- プラグインをインストールする
- migrate() : mixed
- マイグレーションを実行する
- prefixRouting() : RouteBuilder
- プラグインの管理画面用ルーティング
- rollbackDb() : bool
- プラグインのテーブルをリセットする
- routes() : void
- ルーティング設定
- siteRouting() : RouteBuilder
- サブサイトのプラグイン用ルーティング
- uninstall() : bool
- プラグインをアンインストールする - `plugin` : プラグイン名 - `connection` : コネクション名 - `target` : ロールバック対象バージョン
- updateDateNow() : void
- 対象のフィールドを現在の日付に更新する
Properties
$currentSite
現在のサイト キャッシュ用
public
static null
$currentSite
= null
$migrations
public
Migrations
$migrations
Methods
applyAsTheme()
テーマを適用する
public
applyAsTheme(Site $site, string $theme) : mixed
Parameters
- $site : Site
- $theme : string
Tags
bootstrap()
bootstrap
public
bootstrap(PluginApplicationInterface $app) : void
Parameters
- $app : PluginApplicationInterface
Tags
clearCurrentSite()
カレントサイトを初期化する
public
clearCurrentSite() : void
contentsRoutingForReverse()
コンテンツ管理ルーティング
public
contentsRoutingForReverse(RouteBuilder $routes, string $plugin) : RouteBuilder
リバースルーティングのために必要
Parameters
- $routes : RouteBuilder
- $plugin : string
Tags
Return values
RouteBuildercreateAssetsSymlink()
プラグインアセットのシンボリックリンクを作成する
public
createAssetsSymlink() : bool
Tags
Return values
boolexecScript()
アップデートスクリプトを実行する
public
execScript(string $__version) : bool
Parameters
- $__version : string
Tags
Return values
boolexecUpdater()
アップデートプログラムを実行する
public
execUpdater() : mixed
Tags
frontPageRouting()
プラグインのフロントエンド用ルーティング(プラグイン名がダッシュ区切りの場合)
public
frontPageRouting(RouteBuilder $routes, string $plugin) : RouteBuilder
BcPrefixAuthより先に定義が必要 定義しない場合、CSRFトークン取得などの処理にて、BcPrefixAuthのルーティングに捕まり認証を求められてしまう場合がある。 例)認証付 MyPage の定義で、alias を '/' とした場合
Parameters
- $routes : RouteBuilder
- $plugin : string
Tags
Return values
RouteBuildergetService()
Get Service
public
getService(mixed $service) : array<string|int, mixed>|mixed|object
Parameters
- $service : mixed
Tags
Return values
array<string|int, mixed>|mixed|objectgetUpdaters()
アップデータのパスを取得する
public
getUpdaters([mixed $name = '' ][, mixed $isUpdateTmp = false ]) : array<string|int, mixed>
Parameters
- $name : mixed = ''
- $isUpdateTmp : mixed = false
Tags
Return values
array<string|int, mixed> —$updates
getUpdateScriptMessages()
アップデータのメッセージを取得する 現在のバージョンより上位のアップデートスクリプトフォルダの config.php を読み込み 変数 $updateMessage より取得する
public
getUpdateScriptMessages([mixed $name = '' ][, mixed $isUpdateTmp = false ]) : array<string|int, mixed>
戻り値例 [ '1.0.1 => 'message', '1.0.2 => 'message' ]
Parameters
- $name : mixed = ''
- $isUpdateTmp : mixed = false
Tags
Return values
array<string|int, mixed> —$messages
hasService()
Has Service
public
hasService(mixed $service) : bool
Parameters
- $service : mixed
Tags
Return values
boolinitialize()
Initialize
public
initialize() : void
Tags
install()
プラグインをインストールする
public
install([array<string|int, mixed> $options = [] ]) : bool
マイグレーションファイルを読み込み、 plugins テーブルに登録する
Parameters
- $options : array<string|int, mixed> = []
-
-
plugin
: プラグイン名 -
connection
: コネクション名 -
permission
: アクセスルールを作るか作らないか。作らない場合は、システム管理ユーザーが利用可能
-
Tags
Return values
boolmigrate()
マイグレーションを実行する
public
migrate([array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $options : array<string|int, mixed> = []
Tags
prefixRouting()
プラグインの管理画面用ルーティング
public
prefixRouting(RouteBuilder $routes, string $plugin) : RouteBuilder
プラグイン名がダッシュ区切りの場合
Parameters
- $routes : RouteBuilder
- $plugin : string
Tags
Return values
RouteBuilderrollbackDb()
プラグインのテーブルをリセットする
public
rollbackDb([array<string|int, mixed> $options = [] ]) : bool
Parameters
- $options : array<string|int, mixed> = []
-
-
plugin
: プラグイン名 -
connection
: コネクション名 -
target
: ロールバック対象バージョン
-
Tags
Return values
boolroutes()
ルーティング設定
public
routes(RouteBuilder $routes) : void
次のルートを設定するが、未インストールの場合はスキップする。
コンテンツ管理のプラグイン用のリバースルーティング
['plugin' => 'BcBlog', 'controller' => 'Blog', 'action' => 'index'] → /news/ ['plugin' => 'BcBlog', 'controller' => 'Blog', 'action' => 'archives', 1] → /news/archives/1
管理画面のプラグイン用ルーティング
/baser/admin/plugin-name/controller_name/index /baser/admin/plugin-name/controller_name/action_name/*
フロントエンドのプラグイン用ルーティング
/plugin-name/controller_name/index /plugin-name/controller_name/action_name/*
サブサイトのプラグイン用ルーティング
/site_alias/plugin-name/controller_name/index /site_alias/plugin-name/controller_name/action_name/*
APIのプラグイン用ルーティング
/baser/api/plugin-name/controller_name/index.json /baser/api/plugin-name/controller_name/action_name/*.json
Parameters
- $routes : RouteBuilder
Tags
siteRouting()
サブサイトのプラグイン用ルーティング
public
siteRouting(RouteBuilder $routes, string $plugin) : RouteBuilder
プラグイン名がダッシュ区切りの場合
Parameters
- $routes : RouteBuilder
- $plugin : string
Tags
Return values
RouteBuilderuninstall()
プラグインをアンインストールする - `plugin` : プラグイン名 - `connection` : コネクション名 - `target` : ロールバック対象バージョン
public
uninstall([mixed $options = [] ]) : bool
Parameters
- $options : mixed = []
Tags
Return values
boolupdateDateNow()
対象のフィールドを現在の日付に更新する
public
updateDateNow(string $table, array<string|int, mixed> $fields[, array<string|int, mixed> $conditions = [] ][, array<string|int, mixed> $options = [] ]) : void
Parameters
- $table : string
- $fields : array<string|int, mixed>
- $conditions : array<string|int, mixed> = []
- $options : array<string|int, mixed> = []