baserCMS クラスリファレンス

Plugin extends BcPlugin
in package

plugin for BcPlugin

Table of Contents

$migrations  : Migrations
applyAsTheme()  : mixed
テーマを適用する
bootstrap()  : void
bootstrap
contentsRoutingForReverse()  : RouteBuilder
コンテンツ管理ルーティング
createAssetsSymlink()  : void
プラグインアセットのシンボリックリンクを作成する
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
ルーティング設定
services()  : void
services
siteRouting()  : RouteBuilder
サブサイトのプラグイン用ルーティング
uninstall()  : bool
プラグインをアンインストールする - `plugin` : プラグイン名 - `connection` : コネクション名 - `target` : ロールバック対象バージョン
updateDateNow()  : void
対象のフィールドを現在の日付に更新する

Properties

$migrations

public Migrations $migrations

Methods

applyAsTheme()

テーマを適用する

public applyAsTheme(Site $site, string $theme) : mixed
Parameters
$site : Site
$theme : string
Tags
checked
noTodo
unitTest
Return values
mixed

bootstrap()

bootstrap

public bootstrap(PluginApplicationInterface $application) : void
Parameters
$application : PluginApplicationInterface
Return values
void

contentsRoutingForReverse()

コンテンツ管理ルーティング

public contentsRoutingForReverse(RouteBuilder $routes, string $plugin) : RouteBuilder

リバースルーティングのために必要

Parameters
$routes : RouteBuilder
$plugin : string
Return values
RouteBuilder

プラグインアセットのシンボリックリンクを作成する

public createAssetsSymlink() : void
Tags
checked
noTodo
unitTest
Return values
void

execScript()

アップデートスクリプトを実行する

public execScript(string $__version) : bool
Parameters
$__version : string
Tags
checked
noTodo
unitTest
Return values
bool

execUpdater()

アップデートプログラムを実行する

public execUpdater() : mixed
Return values
mixed

frontPageRouting()

プラグインのフロントエンド用ルーティング(プラグイン名がダッシュ区切りの場合)

public frontPageRouting(RouteBuilder $routes, string $plugin) : RouteBuilder

BcPrefixAuthより先に定義が必要 定義しない場合、CSRFトークン取得などの処理にて、BcPrefixAuthのルーティングに捕まり認証を求められてしまう場合がある。 例)認証付 MyPage の定義で、alias を '/' とした場合

Parameters
$routes : RouteBuilder
$plugin : string
Return values
RouteBuilder

getService()

Get Service

public getService( $service) : array<string|int, mixed>|mixed|object
Parameters
$service :
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>|mixed|object

getUpdaters()

アップデータのパスを取得する

public getUpdaters([mixed $name = '' ]) : array<string|int, mixed>
Parameters
$name : mixed = ''
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>

$updates

getUpdateScriptMessages()

アップデータのメッセージを取得する 現在のバージョンより上位のアップデートスクリプトフォルダの config.php を読み込み 変数 $updateMessage より取得する

public getUpdateScriptMessages([mixed $name = '' ]) : array<string|int, mixed>

戻り値例 [ '1.0.1 => 'message', '1.0.2 => 'message' ]

Parameters
$name : mixed = ''
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>

$messages

hasService()

Has Service

public hasService( $service) : bool
Parameters
$service :
Tags
checked
noTodo
unitTest
Return values
bool

initialize()

Initialize

public initialize() : void
Tags
checked
unitTest
noTodo
Return values
void

install()

プラグインをインストールする

public install([array<string|int, mixed> $options = [] ]) : bool

マイグレーションファイルを読み込み、 plugins テーブルに登録する

Parameters
$options : array<string|int, mixed> = []
  • plugin : プラグイン名
  • connection : コネクション名
  • permission : アクセスルールを作るか作らないか。作らない場合は、システム管理ユーザーが利用可能
Tags
unitTest
noTodo
checked
Return values
bool

migrate()

マイグレーションを実行する

public migrate([array<string|int, mixed> $options = [] ]) : mixed
Parameters
$options : array<string|int, mixed> = []
Return values
mixed

prefixRouting()

プラグインの管理画面用ルーティング

public prefixRouting(RouteBuilder $routes, string $plugin) : RouteBuilder

プラグイン名がダッシュ区切りの場合

Parameters
$routes : RouteBuilder
$plugin : string
Return values
RouteBuilder

rollbackDb()

プラグインのテーブルをリセットする

public rollbackDb([array<string|int, mixed> $options = [] ]) : bool
Parameters
$options : array<string|int, mixed> = []
  • plugin : プラグイン名
  • connection : コネクション名
  • target : ロールバック対象バージョン
Tags
checked
noTodo
unitTest
Return values
bool

routes()

ルーティング設定

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
checked
unitTest
noTodo
Return values
void

services()

services

public services(ContainerInterface $container) : void

コンテンツリンクプラグインのサービスプロバイダを追加する

Parameters
$container : ContainerInterface
Tags
noTodo
checked
unitTest
Return values
void

siteRouting()

サブサイトのプラグイン用ルーティング

public siteRouting(RouteBuilder $routes, string $plugin) : RouteBuilder

プラグイン名がダッシュ区切りの場合

Parameters
$routes : RouteBuilder
$plugin : string
Return values
RouteBuilder

uninstall()

プラグインをアンインストールする - `plugin` : プラグイン名 - `connection` : コネクション名 - `target` : ロールバック対象バージョン

public uninstall([mixed $options = [] ]) : bool
Parameters
$options : mixed = []
Tags
checked
noTodo
unitTest
Return values
bool

updateDateNow()

対象のフィールドを現在の日付に更新する

public updateDateNow(string $table, array<string|int, mixed> $fields[, array<string|int, mixed> $conditions = [] ]) : void
Parameters
$table : string
$fields : array<string|int, mixed>
$conditions : array<string|int, mixed> = []
Tags
checked
noTodo
Return values
void

Search results