Piwik\

View

Encapsulates and manages a Twig template.

View lets you set properties that will be passed on to a Twig template. View will also set several properties that will be available in all Twig templates, including:

  • currentModule: The value of the module query parameter.
  • currentAction: The value of the action query parameter.
  • userLogin: The current user login name.
  • sites: List of site data for every site the current user has at least view access for.
  • url: The current URL (sanitized).
  • token_auth: The current user's token auth.
  • userHasSomeAdminAccess: True if the user has admin access to at least one site, false if otherwise.
  • userIsSuperUser: True if the user is the superuser, false if otherwise.
  • latest_version_available: The latest version of Matomo (formerly Piwik) available.
  • isWidget: The value of the 'widget' query parameter.
  • show_autocompleter: Whether the site selector should be shown or not.
  • loginModule: The name of the currently used authentication module.
  • userAlias: The alias of the current user.
  • isInternetEnabled: Whether the matomo server is allowed to connect to external networks.

Template Naming Convention

Template files should be named after the controller method they are used in. If they are used in more than one controller method or are included by another template, they should describe the output they generate and be prefixed with an underscore, eg, _dataTable.twig.

Twig

Twig templates must exist in the templates folder in a plugin's root folder.

The following filters are available to twig templates:

  • translate: Outputs internationalized text using a translation token, eg, {{ 'General_Date'|translate }}. sprintf parameters can be passed to the filter.
  • urlRewriteWithParameters: Modifies the current query string with the given set of parameters, eg,

                                {{ {'module':'MyPlugin', 'action':'index'} | urlRewriteWithParameters }}
    
  • sumTime: Pretty formats an number of seconds.

  • money: Formats a numerical value as a monetary value using the currency of the supplied site (second arg is site ID). eg, `{{ 23|money(site.idsite)|raw }}
  • truncate: Truncates the text to certain length (determined by first arg.) eg, {{ myReallyLongText|truncate(80) }}
  • implode: Calls implode.
  • ucwords: Calls ucwords.

The following functions are available to twig templates:

  • linkTo: Modifies the current query string with the given set of parameters, eg {{ linkTo({'module':'MyPlugin', 'action':'index'}) }}.
  • sparkline: Outputs a sparkline image HTML element using the sparkline image src link. eg, {{ sparkline(sparklineUrl) }}.
  • postEvent: Posts an event that allows event observers to add text to a string which is outputted in the template, eg, {{ postEvent('MyPlugin.event') }}
  • isPluginLoaded: Returns true if the supplied plugin is loaded, false if otherwise. {% if isPluginLoaded('Goals') %}...{% endif %}
  • areAdsForProfessionalServicesEnabled: Returns true if it is ok to show some advertising in the UI for providers of Professional Support for Matomo (from Matomo 2.16.0)
  • isMultiServerEnvironment: Returns true if Matomo is used on more than one server (since Matomo 2.16.1)

Examples

Basic usage

// a controller method
public function myView()
{
    $view = new View("@MyPlugin/myView");
    $view->property1 = "a view property";
    $view->property2 = "another view property";
    return $view->render();
}

Methods

The class defines the following methods:

__construct()

Constructor.

Signature

  • It accepts the following parameter(s):
    • $templateFile (string) — The template file to load. Must be in the following format: "@MyPlugin/templateFileName". Note the absence of .twig from the end of the name.

disableCacheBuster()

Disables the cache buster (adding of ?cb=...) to JavaScript and stylesheet files

Signature

  • It does not return anything.

getTemplateFile()

Returns the template filename.

Signature

  • It returns a string value.

getTemplateVars()

Returns the variables to bind to the template when rendering.

Signature

  • It accepts the following parameter(s):
    • $override (array) — Template variable override values. Mainly useful when including View templates in other templates.
  • It returns a array value.

__set()

Directly assigns a variable to the view script.

Variable names may not be prefixed with '_'.

Signature

  • It accepts the following parameter(s):
    • $key (string) — The variable name.
    • $val (mixed) — The variable value.
  • It does not return anything.

__get()

Retrieves an assigned variable.

Variable names may not be prefixed with '_'.

Signature

  • It accepts the following parameter(s):

    • $key (string) — The variable name.
  • Returns: mixed — The variable value.

__isset()

Returns true if a template variable has been set or not.

Signature

  • It accepts the following parameter(s):
    • $name (string) — The name of the template variable.
  • It returns a bool value.

__unset()

Unsets a template variable.

Signature

  • It accepts the following parameter(s):
    • $name (string) — The name of the template variable.
  • It does not return anything.

render()

Renders the current view.

Also sends the stored 'Content-Type' HTML header. See setContentType().

Signature

  • Returns: string — Generated template.

setContentType()

Set stored value used in the Content-Type HTTP header field.

The header is set just before rendering.

Signature

  • It accepts the following parameter(s):

    • $contentType (string) —
  • It does not return anything.

setXFrameOptions()

Set X-Frame-Options field in the HTTP response.

The header is set just before rendering.

Note: setting this allows you to make sure the View cannot be embedded in iframes. Learn more here.

Signature

  • It accepts the following parameter(s):
    • $option (string) — ('deny' or 'sameorigin')
  • It does not return anything.

singleReport()

Creates a View for and then renders the single report template.

Can be used for pages that display only one report to avoid having to create a new template.

Signature

  • It accepts the following parameter(s):

    • $title (string) — The report title.
    • $reportHtml (string) — The report body HTML.
  • Returns: string|void — The report contents if $fetch is true.