EC-CUBE4 APIドキュメント

OwnerStoreController extends AbstractController

Tags
Route

("/%eccube_admin_route%/store/plugin/api")

Table of Contents

$pluginRepository PluginRepository
$pluginService PluginService
$composerService ComposerServiceInterface
$systemService SystemService
$pluginApiService PluginApiService
$vendorName
$BaseInfo BaseInfo
$cacheUtil CacheUtil
$eccubeConfig EccubeConfig
$entityManager EntityManagerInterface
$translator TranslatorInterface
$formFactory FormFactoryInterface
$eventDispatcher EventDispatcherInterface
$session Session
__construct() OwnerStoreController constructor. mixed
search() Owner's Store Plugin Installation Screen - Search function array
doConfirm() Do confirm page array
apiInstall() Api Install plugin by composer connect with package repo JsonResponse
apiUninstall() New ways to remove plugin: using composer command JsonResponse
apiUpgrade() オーナーズブラグインインストール、アップデート JsonResponse
apiSchemaUpdate() オーナーズブラグインインストール、スキーマ更新 JsonResponse
apiUpdate() オーナーズブラグインインストール、更新処理 JsonResponse
doUpdateConfirm() Do confirm update page 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()

OwnerStoreController constructor.

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

search()

Owner's Store Plugin Installation Screen - Search function

public search( $request : Request [, $page_no : int = null ] , $paginator : Paginator ) : array
Parameters
$request : Request
$page_no : int = null
$paginator : Paginator
Tags
Route

("/search", name="admin_store_plugin_owners_search")

Route

("/search/page/{page_no}", name="admin_store_plugin_owners_search_page", requirements={"page_no" = "\d+"})

Template

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

Return values
array

doConfirm()

Do confirm page

public doConfirm( $request : Request , $id : mixed ) : array
Parameters
$request : Request
$id : mixed
Tags
Route

("/install/{id}/confirm", requirements={"id" = "\d+"}, name="admin_store_plugin_install_confirm")

Template

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

throws
PluginException
Return values
array

apiInstall()

Api Install plugin by composer connect with package repo

public apiInstall( $request : Request ) : JsonResponse
Parameters
$request : Request
Tags
Route

("/install", name="admin_store_plugin_api_install", methods={"POST"})

Return values
JsonResponse

apiUninstall()

New ways to remove plugin: using composer command

public apiUninstall( $Plugin : Plugin ) : JsonResponse
Parameters
$Plugin : Plugin
Tags
Route

("/delete/{id}/uninstall", requirements={"id" = "\d+"}, name="admin_store_plugin_api_uninstall", methods={"DELETE"})

Return values
JsonResponse

apiUpgrade()

オーナーズブラグインインストール、アップデート

public apiUpgrade( $request : Request ) : JsonResponse
Parameters
$request : Request
Tags
Route

("/upgrade", name="admin_store_plugin_api_upgrade", methods={"POST"})

Return values
JsonResponse

apiSchemaUpdate()

オーナーズブラグインインストール、スキーマ更新

public apiSchemaUpdate( $request : Request ) : JsonResponse
Parameters
$request : Request
Tags
Route

("/schema_update", name="admin_store_plugin_api_schema_update", methods={"POST"})

Return values
JsonResponse

apiUpdate()

オーナーズブラグインインストール、更新処理

public apiUpdate( $request : Request ) : JsonResponse
Parameters
$request : Request
Tags
Route

("/update", name="admin_store_plugin_api_update", methods={"POST"})

Return values
JsonResponse

doUpdateConfirm()

Do confirm update page

public doUpdateConfirm( $Plugin : Plugin ) : array
Parameters
$Plugin : Plugin
Tags
Route

("/upgrade/{id}/confirm", requirements={"id" = "\d+"}, name="admin_store_plugin_update_confirm")

Template

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

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