AbstractPluginManager
Tags
Table of Contents
| MIGRATION_TABLE_PREFIX | 'migration_' | |
|---|---|---|
| migration() | プラグインのマイグレーションを実行する. | mixed |
| install() | Install the plugin. | mixed |
| update() | Update the plugin. | mixed |
| enable() | Enable the plugin. | mixed |
| disable() | Disable the plugin. | mixed |
| uninstall() | Uninstall the plugin. | mixed |
Constants
MIGRATION_TABLE_PREFIX
public
mixed
$MIGRATION_TABLE_PREFIX
= 'migration_'
Methods
migration()
プラグインのマイグレーションを実行する.
public
migration(
$connection :
Connection
, $pluginCode :
string
[, $version :
string
= null ]
[, $migrationFilePath :
string
= null ]
)
: mixed
PluginManager 実行時に、 Doctrine SchemaUpdate が自動的に行なわれるため、 このメソッドは主にデータの更新に使用する.
引数 $version で指定したバージョンまでマイグレーションする. null を渡すと最新バージョンまでマイグレートする. 0 を渡すと最初に戻る。
Parameters
- $connection : Connection
Doctrine Connection
- $pluginCode : string
プラグインコード
- $version : string = null
マイグレーション先のバージョン
- $migrationFilePath : string = null
マイグレーションファイルを格納したファイルパス. 指定しない場合は app/Plugin/<pluginCode>/DoctrineMigrations を使用する
Return values
mixedinstall()
Install the plugin.
public
install(
$meta :
array
, $container :
ContainerInterface
)
: mixed
Parameters
- $meta : array
- $container : ContainerInterface
Return values
mixedupdate()
Update the plugin.
public
update(
$meta :
array
, $container :
ContainerInterface
)
: mixed
Parameters
- $meta : array
- $container : ContainerInterface
Return values
mixedenable()
Enable the plugin.
public
enable(
$meta :
array
, $container :
ContainerInterface
)
: mixed
Parameters
- $meta : array
- $container : ContainerInterface
Return values
mixeddisable()
Disable the plugin.
public
disable(
$meta :
array
, $container :
ContainerInterface
)
: mixed
Parameters
- $meta : array
- $container : ContainerInterface
Return values
mixeduninstall()
Uninstall the plugin.
public
uninstall(
$meta :
array
, $container :
ContainerInterface
)
: mixed
Parameters
- $meta : array
- $container : ContainerInterface