PluginsServiceInterface
in
Interface PluginsServiceInterface
Table of Contents
- attach() : bool
- プラグインを有効にする
- batch() : bool
- 一括処理
- changePriority() : bool
- 優先度を変更する
- detach() : bool
- プラグインを無効にする
- get() : EntityInterface
- プラグインを取得する
- getByName() : array<string|int, mixed>|EntityInterface|null
- プラグイン名からプラグインエンティティを取得
- getIndex() : array<string|int, mixed>
- プラグイン一覧を取得
- getInstallStatusMessage() : string
- インストール時の状態を返す
- getMarketPlugins() : array<string|int, mixed>|mixed
- baserマーケットのプラグイン一覧を取得する
- getNamesById() : array<string|int, mixed>
- IDを指定して名前リストを取得する
- getVersion() : mixed|string
- バージョンを取得する
- install() : bool|null
- プラグインをインストールする
- resetDb() : void
- データベースをリセットする
- uninstall() : void
- プラグインを削除する
- update() : bool
- プラグインをアップデートする
Methods
attach()
プラグインを有効にする
public
attach(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —batch()
一括処理
public
batch(string $method, array<string|int, mixed> $ids) : bool
Parameters
- $method : string
- $ids : array<string|int, mixed>
Tags
Return values
bool —changePriority()
優先度を変更する
public
changePriority(int $id, int $offset[, array<string|int, mixed> $conditions = [] ]) : bool
Parameters
- $id : int
- $offset : int
- $conditions : array<string|int, mixed> = []
Tags
Return values
bool —detach()
プラグインを無効にする
public
detach(string $name) : bool
Parameters
- $name : string
Tags
Return values
bool —get()
プラグインを取得する
public
get(int $id) : EntityInterface
Parameters
- $id : int
Tags
Return values
EntityInterface —getByName()
プラグイン名からプラグインエンティティを取得
public
getByName(string $name) : array<string|int, mixed>|EntityInterface|null
Parameters
- $name : string
Tags
Return values
array<string|int, mixed>|EntityInterface|null —getIndex()
プラグイン一覧を取得
public
getIndex(string $sortMode) : array<string|int, mixed>
Parameters
- $sortMode : string
Tags
Return values
array<string|int, mixed> —$plugins
getInstallStatusMessage()
インストール時の状態を返す
public
getInstallStatusMessage(string $pluginName) : string
Parameters
- $pluginName : string
Tags
Return values
string —getMarketPlugins()
baserマーケットのプラグイン一覧を取得する
public
getMarketPlugins() : array<string|int, mixed>|mixed
Tags
Return values
array<string|int, mixed>|mixed —getNamesById()
IDを指定して名前リストを取得する
public
getNamesById( $ids) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —getVersion()
バージョンを取得する
public
getVersion( $name) : mixed|string
Parameters
Tags
Return values
mixed|string —install()
プラグインをインストールする
public
install(string $name, bool $permission[, string $connection = 'default' ]) : bool|null
Parameters
- $name : string
-
プラグイン名
- $permission : bool
-
アクセスルールを作るか作らないか
- $connection : string = 'default'
-
test connection指定用
Tags
Return values
bool|null —resetDb()
データベースをリセットする
public
resetDb(string $name[, array<string|int, mixed> $connection = 'default' ]) : void
Parameters
- $name : string
- $connection : array<string|int, mixed> = 'default'
Tags
Return values
void —uninstall()
プラグインを削除する
public
uninstall(string $name[, string $connection = 'default' ]) : void
Parameters
- $name : string
- $connection : string = 'default'
Tags
Return values
void —update()
プラグインをアップデートする
public
update(mixed $name[, mixed $connection = 'default' ]) : bool
Parameters
- $name : mixed
- $connection : mixed = 'default'