• Home
• Piwik
• Plugin
• ViewDataTable

PHP Class Piwik\Plugin\ViewDataTable

ViewDataTable instances load analytics data via Piwik's Reporting API and then output some type of visualization of that data. Visualizations can be in any format. HTML-based visualizations should extend {@link Visualization}. Visualizations that use other formats, such as visualizations that output an image, should extend ViewDataTable directly. ### Creating ViewDataTables ViewDataTable instances are not created via the new operator, instead the {@link Piwik\ViewDataTable\Factory} class is used. The specific subclass to create is determined, first, by the **viewDataTable** query paramater. If this parameter is not set, then the default visualization type for the report being displayed is used. ### Configuring ViewDataTables **Display properties** ViewDataTable output can be customized by setting one of many available display properties. Display properties are stored as fields in {@link Piwik\ViewDataTable\Config} objects. ViewDataTables store a {@link Piwik\ViewDataTable\Config} object in the {@link $config} field. Display properties can be set at any time before rendering. **Request properties** Request properties are similar to display properties in the way they are set. They are, however, not used to customize ViewDataTable instances, but in the request to Piwik's API when loading analytics data. Request properties are set by setting the fields of a {@link Piwik\ViewDataTable\RequestConfig} object stored in the {@link $requestConfig} field. They can be set at any time before rendering. Setting them after data is loaded will have no effect. **Customizing how reports are displayed** Each individual report should be rendered in its own controller method. There are two ways to render a report within its controller method. You can either: 1. manually create and configure a ViewDataTable instance 2. invoke {@link Piwik\Plugin\Controller::renderReport} and configure the ViewDataTable instance in the {@hook ViewDataTable.configure} event. ViewDataTable instances are configured by setting and modifying display properties and request properties. ### Creating new visualizations New visualizations can be created by extending the ViewDataTable class or one of its descendants. To learn more read our guide on creating new visualizations. ### Examples **Manually configuring a ViewDataTable** a controller method that displays a single report public function myReport() { $view = \Piwik\ViewDataTable\Factory::build('table', 'MyPlugin.myReport'); $view->config->show_limit_control = true; $view->config->translations['myFancyMetric'] = "My Fancy Metric"; ... return $view->render(); } **Using {@link Piwik\Plugin\Controller::renderReport}** First, a controller method that displays a single report: public function myReport() { return $this->renderReport(__FUNCTION__);` } Then the event handler for the {@hook ViewDataTable.configure} event: public function configureViewDataTable(ViewDataTable $view) { switch ($view->requestConfig->apiMethodToRequestDataTable) { case 'MyPlugin.myReport': $view->config->show_limit_control = true; $view->config->translations['myFancyMetric'] = "My Fancy Metric"; ... break; } } **Using custom configuration objects in a new visualization** class MyVisualizationConfig extends Piwik\ViewDataTable\Config { public $my_new_property = true; } class MyVisualizationRequestConfig extends Piwik\ViewDataTable\RequestConfig { public $my_new_property = false; } class MyVisualization extends Piwik\Plugin\ViewDataTable { public static function getDefaultConfig() { return new MyVisualizationConfig(); } public static function getDefaultRequestConfig() { return new MyVisualizationRequestConfig(); } } ファイルを表示 Open project: piwik/piwik Class Usage Examples

Public Properties

Property	Type	Description
$config	Piwik\ViewDataTable\Config	Contains display properties for this visualization.
$requestConfig	Piwik\ViewDataTable\RequestConfig	Contains request properties for this visualization.

Protected Properties

Property	Type	Description
$dataTable	Piwik\DataTable	DataTable loaded from the API for this ViewDataTable.
$request	Piwik\ViewDataTable\Request

Public Methods

Method	Description
__construct ( $controllerAction, $apiMethodToRequestDataTable, $overrideParams = [] )	Constructor. Initializes display and request properties to their default values.
canDisplayViewDataTable ( ViewDataTable $view ) : boolean	Returns true if this visualization can display some type of data or not.
getDataTable ( ) : DataTable	Returns the DataTable loaded from the API.
getDefaultConfig ( ) : Config	Returns the default config instance.
getDefaultRequestConfig ( ) : RequestConfig	Returns the default request config instance.
getNonOverridableParams ( $overrideParams ) : array
getViewDataTableId ( ) : string	Returns the viewDataTable ID for this DataTable visualization.
isRequestingSingleDataTable ( ) : boolean	Returns true if this instance will request a single DataTable, false if requesting more than one.
isViewDataTableId ( string $viewDataTableId ) : boolean	Returns true if this instance's or any of its ancestors' viewDataTable IDs equals the supplied ID, false if otherwise.
render ( ) : string	Requests all needed data and renders the view.
setDataTable ( DataTable $dataTable ) : void	To prevent calling an API multiple times, the DataTable can be set directly.
throwWhenSettingNonOverridableParameter ( $overrideParams )	Display a meaningful error message when any invalid parameter is being set.

Protected Methods

Method	Description
checkStandardDataTable ( ) : void	Checks that the API returned a normal DataTable (as opposed to DataTable\Map)
getDefaultDataTableCssClass ( )
getOverridableProperties ( ) : array	Returns the list of view properties that can be overriden by query parameters.
getPropertyFromQueryParam ( $name, $defaultValue )
loadDataTableFromAPI ( )

Private Methods

Method	Description
assignRelatedReportsTitle ( )
overrideViewPropertiesWithParams ( $overrideParams )
overrideViewPropertiesWithQueryParams ( )

Method Details

Property Details