PluginApiService
Table of Contents
| $apiUrl | Url for Api | string |
|---|---|---|
| $eccubeConfig | EccubeConfig | |
| $requestStack | RequestStack | |
| $baseInfoRepository | BaseInfoRepository | |
| $pluginRepository | PluginRepository | |
| __construct() | PluginApiService constructor. | mixed |
| getApiUrl() | mixed | |
| setApiUrl() | mixed | |
| getCategory() | Get master data: category | array |
| getPlugins() | Get plugins list | array |
| getPurchased() | Get purchased plugins list | array |
| getRecommended() | Get recommended plugins list | mixed |
| buildPlugins() | mixed | |
| isUpdate() | Is update | bool |
| getPlugin() | Get a plugin | array |
| pluginInstalled() | mixed | |
| pluginEnabled() | mixed | |
| pluginDisabled() | mixed | |
| pluginUninstalled() | mixed | |
| updatePluginStatus() | mixed | |
| requestApi() | API request processing | array |
| buildInfo() | Get plugin information | array |
| supportedVersion() | Check support version | mixed |
Properties
$apiUrl
Url for Api
private
string
$apiUrl
$eccubeConfig
private
EccubeConfig
$eccubeConfig
$requestStack
private
RequestStack
$requestStack
$baseInfoRepository
private
BaseInfoRepository
$baseInfoRepository
$pluginRepository
private
PluginRepository
$pluginRepository
Methods
__construct()
PluginApiService constructor.
public
__construct(
$eccubeConfig :
EccubeConfig
, $requestStack :
RequestStack
, $baseInfoRepository :
BaseInfoRepository
, $pluginRepository :
PluginRepository
)
: mixed
Parameters
- $eccubeConfig : EccubeConfig
- $requestStack : RequestStack
- $baseInfoRepository : BaseInfoRepository
- $pluginRepository : PluginRepository
Tags
Return values
mixedgetApiUrl()
public
getApiUrl(
)
: mixed
Return values
mixedsetApiUrl()
public
setApiUrl(
$apiUrl :
mixed
)
: mixed
Parameters
- $apiUrl : mixed
Return values
mixedgetCategory()
Get master data: category
public
getCategory(
)
: array
Return values
arraygetPlugins()
Get plugins list
public
getPlugins(
$data :
)
: array
Parameters
Tags
Return values
arraygetPurchased()
Get purchased plugins list
public
getPurchased(
)
: array
Tags
Return values
arraygetRecommended()
Get recommended plugins list
public
getRecommended(
)
: mixed
Tags
Return values
mixedbuildPlugins()
private
buildPlugins(
&$plugins :
mixed
)
: mixed
Parameters
- $plugins : mixed
Return values
mixedisUpdate()
Is update
private
isUpdate(
$pluginVersion :
string
, $remoteVersion :
string
)
: bool
Parameters
- $pluginVersion : string
- $remoteVersion : string
Return values
boolgetPlugin()
Get a plugin
public
getPlugin(
$id :
int|string
)
: array
Parameters
- $id : int|string
Id or plugin code
Tags
Return values
arraypluginInstalled()
public
pluginInstalled(
$Plugin :
Plugin
)
: mixed
Parameters
- $Plugin : Plugin
Return values
mixedpluginEnabled()
public
pluginEnabled(
$Plugin :
Plugin
)
: mixed
Parameters
- $Plugin : Plugin
Return values
mixedpluginDisabled()
public
pluginDisabled(
$Plugin :
Plugin
)
: mixed
Parameters
- $Plugin : Plugin
Return values
mixedpluginUninstalled()
public
pluginUninstalled(
$Plugin :
Plugin
)
: mixed
Parameters
- $Plugin : Plugin
Return values
mixedupdatePluginStatus()
private
updatePluginStatus(
$url :
mixed
, $Plugin :
Plugin
)
: mixed
Parameters
- $url : mixed
- $Plugin : Plugin
Return values
mixedrequestApi()
API request processing
public
requestApi(
$url :
string
[, $data :
array
= [] ]
[, $post :
mixed
= false ]
)
: array
Parameters
- $url : string
- $data : array = []
- $post : mixed = false
Tags
Return values
arraybuildInfo()
Get plugin information
public
buildInfo(
&$plugin :
array
)
: array
Parameters
- $plugin : array
Return values
arraysupportedVersion()
Check support version
public
supportedVersion(
&$plugin :
)
: mixed