PHP Class Piwik\Plugins\Marketplace\Api\Service

Public Methods

Method	Description
__construct ( $domain )
authenticate ( $accessToken )
download ( string $url, null \| string $destinationPath = null, null \| integer $timeout = null ) : boolean \| string	Downloads data from the given URL via a POST request. If a destination path is given, the downloaded data will be stored in the given path and returned otherwise.
fetch ( string $action, array $params ) : mixed	Executes the given API action on the Marketplace using the given params and returns the result.
getAccessToken ( ) : null \| string	Returns the currently set access token
getDomain ( ) : string	Get the domain that is used in order to access the Marketplace. Eg http://plugins.piwik.org
getVersion ( ) : string	The API version that will be used on the Marketplace.
hasAccessToken ( )

public __construct ( $domain )

public authenticate ( $accessToken )

Make sure to call {@link authenticate()} to download paid plugins.

public download ( string $url, null \| string $destinationPath = null, null \| integer $timeout = null ) : boolean \| string
$url	string	An absolute URL to the marketplace including domain.
$destinationPath	null \| string
$timeout	null \| integer	Defaults to 60 seconds see {@link self::HTTP_REQUEST_METHOD}
return	boolean \| string	Returns the downloaded data or true if a destination path was given.

Make sure to call {@link authenticate()} to download paid plugins.

public fetch ( string $action, array $params ) : mixed
$action	string	eg 'plugins', 'plugins/$pluginName/info', ...
$params	array	eg array('sort' => 'alpha')
return	mixed

Returns the currently set access token

public getAccessToken ( ) : null \| string
return	null \| string

Get the domain that is used in order to access the Marketplace. Eg http://plugins.piwik.org

public getDomain ( ) : string
return	string

The API version that will be used on the Marketplace.

public getVersion ( ) : string
return	string	eg 2.0

public hasAccessToken ( )