PHP Класс Piwik\Plugin\API
Plugins that want to expose functionality through the Reporting API should create a class
that extends this one. Every public method in that class that is not annotated with **@ignore**
will be callable through Piwik's Web API.
_Note: If your plugin calculates and stores reports, they should be made available through the API._
### Examples
**Defining an API for a plugin**
class API extends \Piwik\Plugin\API
{
public function myMethod($idSite, $period, $date, $segment = false)
{
$dataTable = // ... get some data ...
return $dataTable;
}
}
**Linking to an API method**
Link
Показать файл
Открыть проект
Примеры использования класса
Открытые методы
| Метод |
Описание |
|
|
getInstance ( ) : static |
Returns the singleton instance for the derived class. If the singleton instance
has not been created, this method will create it. |
|
|
setSingletonInstance ( $instance ) |
Sets the singleton instance. For testing purposes. |
|
|
unsetAllInstances ( ) |
Used in tests only |
|
|
unsetInstance ( ) |
Used in tests only |
|
Описание методов
getInstance()
публичный статический Метод
Returns the singleton instance for the derived class. If the singleton instance
has not been created, this method will create it.
|
public static getInstance ( ) : static |
| Результат |
static |
|
setSingletonInstance()
публичный статический Метод
Sets the singleton instance. For testing purposes.
unsetAllInstances()
публичный статический Метод
unsetInstance()
публичный статический Метод
