EC-CUBE4 APIドキュメント

PluginController extends AbstractController

Table of Contents

$pluginService PluginService
$BaseInfo BaseInfo
$pluginRepository PluginRepository
$pluginApiService PluginApiService
$composerService ComposerServiceInterface
$systemService SystemService
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() PluginController constructor. mixed
index() インストール済プラグイン画面 array
update() インストール済プラグインからのアップデート RedirectResponse
enable() 対象のプラグインを有効にします。 RedirectResponse|JsonResponse
disable() 対象のプラグインを無効にします。 JsonResponse|RedirectResponse
uninstall() 対象のプラグインを削除します。 RedirectResponse
install() プラグインファイルアップロード画面 array|RedirectResponse
authenticationSetting() 認証キー設定画面 array
getUnregisteredPlugins() フォルダ設置のみのプラグインを取得する. array
setEccubeConfig() mixed
setEntityManager() mixed
setTranslator() mixed
setSession() mixed
setFormFactory() mixed
setEventDispatcher() mixed
addSuccess() mixed
addError() mixed
addDanger() mixed
addWarning() mixed
addInfo() mixed
addRequestError() mixed
clearMessage() mixed
deleteMessage() mixed
setLoginTargetPath() mixed
forwardToRoute() Forwards the request to another controller. Response
isTokenValid() Checks the validity of a CSRF token. bool

Properties

Methods

__construct()

PluginController constructor.

public __construct( $pluginRepository : PluginRepository , $pluginService : PluginService , $baseInfoRepository : BaseInfoRepository , $pluginApiService : PluginApiService , $composerService : ComposerServiceInterface , $systemService : SystemService ) : mixed
Parameters
$pluginRepository : PluginRepository
$pluginService : PluginService
$baseInfoRepository : BaseInfoRepository
$pluginApiService : PluginApiService
$composerService : ComposerServiceInterface
$systemService : SystemService
Tags
throws
NoResultException
throws
NonUniqueResultException
Return values
mixed

index()

インストール済プラグイン画面

public index( ) : array
Tags
Route

("/%eccube_admin_route%/store/plugin", name="admin_store_plugin")

Template

("@admin/Store/plugin.twig")

throws
PluginException
Return values
array

update()

インストール済プラグインからのアップデート

public update( $request : Request , $Plugin : Plugin , $cacheUtil : CacheUtil ) : RedirectResponse
Parameters
$request : Request
$Plugin : Plugin
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/store/plugin/{id}/update", requirements={"id" = "\d+"}, name="admin_store_plugin_update", methods={"POST"})

Return values
RedirectResponse

enable()

対象のプラグインを有効にします。

public enable( $Plugin : Plugin , $cacheUtil : CacheUtil , $request : Request ) : RedirectResponse|JsonResponse
Parameters
$Plugin : Plugin
$cacheUtil : CacheUtil
$request : Request
Tags
Route

("/%eccube_admin_route%/store/plugin/{id}/enable", requirements={"id" = "\d+"}, name="admin_store_plugin_enable", methods={"POST"})

throws
PluginException
Return values
RedirectResponse|JsonResponse

disable()

対象のプラグインを無効にします。

public disable( $request : Request , $Plugin : Plugin , $cacheUtil : CacheUtil ) : JsonResponse|RedirectResponse
Parameters
$request : Request
$Plugin : Plugin
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/store/plugin/{id}/disable", requirements={"id" = "\d+"}, name="admin_store_plugin_disable", methods={"POST"})

Return values
JsonResponse|RedirectResponse

uninstall()

対象のプラグインを削除します。

public uninstall( $Plugin : Plugin , $cacheUtil : CacheUtil ) : RedirectResponse
Parameters
$Plugin : Plugin
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/store/plugin/{id}/uninstall", requirements={"id" = "\d+"}, name="admin_store_plugin_uninstall", methods={"DELETE"})

throws
Exception
Return values
RedirectResponse

install()

プラグインファイルアップロード画面

public install( $request : Request , $cacheUtil : CacheUtil ) : array|RedirectResponse
Parameters
$request : Request
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/store/plugin/install", name="admin_store_plugin_install")

Template

("@admin/Store/plugin_install.twig")

Return values
array|RedirectResponse

authenticationSetting()

認証キー設定画面

public authenticationSetting( $request : Request , $cacheUtil : CacheUtil ) : array
Parameters
$request : Request
$cacheUtil : CacheUtil
Tags
Route

("/%eccube_admin_route%/store/plugin/authentication_setting", name="admin_store_authentication_setting")

Template

("@admin/Store/authentication_setting.twig")

Return values
array

getUnregisteredPlugins()

フォルダ設置のみのプラグインを取得する.

protected getUnregisteredPlugins( $plugins : array ) : array
Parameters
$plugins : array
Tags
throws
PluginException
Return values
array

setEntityManager()

public setEntityManager( $entityManager : EntityManagerInterface ) : mixed
Parameters
$entityManager : EntityManagerInterface
Tags
required
Return values
mixed

setTranslator()

public setTranslator( $translator : TranslatorInterface ) : mixed
Parameters
$translator : TranslatorInterface
Tags
required
Return values
mixed

setSession()

public setSession( $session : SessionInterface ) : mixed
Parameters
$session : SessionInterface
Tags
required
Return values
mixed

setFormFactory()

public setFormFactory( $formFactory : FormFactoryInterface ) : mixed
Parameters
$formFactory : FormFactoryInterface
Tags
required
Return values
mixed

setEventDispatcher()

public setEventDispatcher( $eventDispatcher : EventDispatcherInterface ) : mixed
Parameters
$eventDispatcher : EventDispatcherInterface
Tags
required
Return values
mixed

addSuccess()

public addSuccess( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addError()

public addError( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addDanger()

public addDanger( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addWarning()

public addWarning( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addInfo()

public addInfo( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

addRequestError()

public addRequestError( $message : mixed [, $namespace : mixed = 'front' ] ) : mixed
Parameters
$message : mixed
$namespace : mixed = 'front'
Return values
mixed

setLoginTargetPath()

public setLoginTargetPath( $targetPath : string [, $namespace : mixed = null ] ) : mixed
Parameters
$targetPath : string
$namespace : mixed = null
Return values
mixed

forwardToRoute()

Forwards the request to another controller.

public forwardToRoute( $route : string [, $path : array = [] ] [, $query : array = [] ] ) : Response
Parameters
$route : string

The name of the route

$path : array = []

An array of path parameters

$query : array = []

An array of query parameters

Return values
Response —

A Response instance

isTokenValid()

Checks the validity of a CSRF token.

protected isTokenValid( ) : bool

if token is invalid, throws AccessDeniedHttpException.

Tags
throws
AccessDeniedHttpException
Return values
bool

Search results