• Главная
• Piwik
• Plugin

PHP Класс Piwik\Plugin

Any plugin that wants to add event observers to one of Piwik's {@hook # hooks}, or has special installation/uninstallation logic must implement this class. Plugins that can specify everything they need to in the _plugin.json_ files, such as themes, don't need to implement this class. Class implementations should be named after the plugin they are a part of (eg, class UserCountry extends Plugin). ### Plugin Metadata In addition to providing a place for plugins to install/uninstall themselves and add event observers, this class is also responsible for loading metadata found in the plugin.json file. The plugin.json file must exist in the root directory of a plugin. It can contain the following information: - **description**: An internationalized string description of what the plugin does. - **homepage**: The URL to the plugin's website. - **authors**: A list of author arrays with keys for 'name', 'email' and 'homepage' - **license**: The license the code uses (eg, GPL, MIT, etc.). - **license_homepage**: URL to website describing the license used. - **version**: The plugin version (eg, 1.0.1). - **theme**: true or false. If true, the plugin will be treated as a theme. ### Examples **How to extend** use Piwik\Common; use Piwik\Plugin; use Piwik\Db; class MyPlugin extends Plugin { public function getListHooksRegistered() { return array( 'API.getReportMetadata' => 'getReportMetadata', 'Another.event' => array( 'function' => 'myOtherPluginFunction', 'after' => true // executes this callback after others ) ); } public function install() { Db::exec("CREATE TABLE " . Common::prefixTable('mytable') . "..."); } public function uninstall() { Db::exec("DROP TABLE IF EXISTS " . Common::prefixTable('mytable')); } public function getReportMetadata(&$metadata) { ... } public function myOtherPluginFunction() { ... } } Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$pluginName	string	Name of this plugin.

Открытые методы

Метод	Описание
__construct ( string | boolean $pluginName = false )	Constructor.
activate ( )	Executed every time the plugin is enabled.
deactivate ( )	Executed every time the plugin is disabled.
findComponent ( string $componentName, string $expectedSubclass ) : string | null	Tries to find a component such as a Menu or Tasks within this plugin.
findMultipleComponents ( $directoryWithinPlugin, $expectedSubclass )
getInformation ( ) : array	Returns plugin information, including:
getListHooksRegistered ( ) : array
getMissingDependencies ( $piwikVersion = null )
getMissingDependenciesAsString ( string $piwikVersion = null ) : string	Returns a string (translated) describing the missing requirements for this plugin and the given Piwik version
getPluginName ( ) : string	Returns the plugin's base class name without the namespace, e.g., "UserCountry" when the plugin class is "Piwik\Plugins\UserCountry\UserCountry".
getPluginNameFromBacktrace ( array $backtrace ) : string | false	Extracts the plugin name from a backtrace array. Returns false if we can't find one.
getPluginNameFromNamespace ( string $namespaceOrClassName ) : string | false	Extracts the plugin name from a namespace name or a fully qualified class name. Returns false if we can't find one.
getVersion ( ) : string	Returns the plugin version number.
hasMissingDependencies ( null $piwikVersion = null ) : boolean	Detect whether there are any missing dependencies.
install ( )	Installs the plugin. Derived classes should implement this class if the plugin needs to:
isTheme ( ) : boolean	Returns true if this plugin is a theme, false if otherwise.
isTrackerPlugin ( ) : boolean	Override this method in your plugin class if you want your plugin to be loaded during tracking.
postLoad ( )	This method is executed after a plugin is loaded and translations are registered.
registerEvents ( ) : array	Returns a list of events with associated event observers.
reloadPluginInformation ( )
uninstall ( )	Uninstalls the plugins. Derived classes should implement this method if the changes made in {@link install()} need to be undone during uninstallation.

Приватные методы

Метод	Описание
createCacheIfNeeded ( )
doFindMultipleComponents ( $directoryWithinPlugin, $expectedSubclass ) : array
hasDefinedPluginInformationInPluginClass ( )
includeComponents ( $components ) : boolean
makeDependency ( $piwikVersion ) : Dependency

Описание методов

Описание свойств