• Inicio
• piwik
• plugin
• Controller

PHP Class piwik\plugin\Controller

Plugins that wish to add display HTML should create a Controller that either extends from this class or from {@link ControllerAdmin}. Every public method in the controller will be exposed as a controller method and can be invoked via an HTTP request. Learn more about Piwik's MVC system here. ### Examples **Defining a controller** class Controller extends \Piwik\Plugin\Controller { public function index() { $view = new View("@MyPlugin/index.twig"); ... setup view ... return $view->render(); } } **Linking to a controller action** Link Mostrar archivo Open project: piwik/piwik Class Usage Examples

Protected Properties

Property	Type	Description
$date	Piwik\Date | null	The Date object created with ($strDate)[#strDate] or null if the requested date is a range.
$idSite	integer	The value of the **idSite** query parameter.
$pluginName	string	The plugin name, eg. 'Referrers'.
$site	Piwik\Site	The Site object created with {@link $idSite}.
$strDate	string	The value of the **date** query parameter.

Public Methods

Method	Description
__construct ( )	Constructor.
getCalendarPrettyDate ( Piwik\Period $period ) : string	Returns a prettified date string for use in period selector widget.
getDefaultAction ( ) : string	Returns the name of the default method that will be called when visiting: index.php?module=PluginName without the action parameter.
getPrettyDate ( $date, $period ) : string	Returns the pretty date representation
redirectToIndex ( string $moduleToRedirect, string $actionToRedirect, integer | null $websiteId = null, string | null $defaultPeriod = null, string | null $defaultDate = null, array $parameters = [] )	Helper method used to redirect the current HTTP request to another module/action.
setHostValidationVariablesView ( View $view )	Checks if the current host is valid and sets variables on the given view, including:
setPeriodVariablesView ( View $view )	Sets general period variables on a view, including:

Protected Methods

Method	Description
addCustomLogoInfo ( $view )
checkSitePermission ( )
checkTokenInUrl ( )	Checks that the token_auth in the URL matches the currently logged-in user's token_auth.
getDateParameterInTimezone ( string $date, string $timezone ) : Date	Helper method that converts "today" or "yesterday" to the specified timezone.
getEnabledPeriodsInUI ( ) : array	Returns values that are enabled for the parameter &period=
getGraphParamsModified ( array $paramsToSet = [] ) : array	Returns the array of new processed parameters once the parameters are applied.
getLastUnitGraph ( string $currentModuleName, string $currentControllerAction, string $apiMethod ) : ViewDataTable	Returns a ViewDataTable object that will render a jqPlot evolution graph for the last30 days/weeks/etc. of the current period, relative to the current date.
getLastUnitGraphAcrossPlugins ( string $currentModuleName, string $currentControllerAction, array $columnsToDisplay = false, array $selectableColumns = [], boolean | string $reportDocumentation = false, string $apiMethod = 'API.get' ) : ViewDataTable	Same as {@link getLastUnitGraph()}, but will set some properties of the ViewDataTable object based on the arguments supplied.
getNumericValue ( string $methodToCall, boolean | string $date = false ) : integer | float	Returns a numeric value from the API.
getUrlSparkline ( string $action, array $customParameters = [] ) : string	Returns a URL to a sparkline image for a report served by the current plugin.
init ( )
renderReport ( string | Report $apiAction, boolean $controllerAction = false ) : string | void	Convenience method that creates and renders a ViewDataTable for a API method.
renderTemplate ( string $template, array $variables = [] ) : string	Assigns the given variables to the template and renders it.
renderView ( Piwik\View\ViewInterface $view ) : string | void	A helper method that renders a view either to the screen or to a string.
setBasicVariablesView ( View $view )	Assigns a set of generally useful variables to a {@link Piwik\View} instance.
setDate ( Date $date ) : void	Sets the date to be used by all other methods in the controller.
setGeneralVariablesView ( View $view ) : void	Assigns variables to {@link Piwik\View} instances that display an entire page.
setMaxDateView ( Date $maxDate, View $view )	Sets the last date available in the period selector's calendar. Usually this is just the "today" date for a site (which varies based on the timezone of a site).
setMinDateView ( Date $minDate, View $view )	Sets the first date available in the period selector's calendar.

Private Methods

Method	Description
doRedirectToUrl ( $moduleToRedirect, $actionToRedirect, $websiteId, $defaultPeriod, $defaultDate, $parameters )
getEnabledPeriodsNames ( ) : array
getValidDate ( Date $date, Date $minDate, Date $maxDate )

Method Details

Property Details