.. php:namespace:: DanielSiepmann\Tracking\Dashboard\Provider
.. class:: PageviewsPerOperatingSystem

.. _pageviewsperoperatingsystem:

===========================
PageviewsPerOperatingSystem
===========================

Provides the total calls on a operating system level.
This way editors can see which operating systems most visitors use.

Example
=======

.. figure:: /Images/Widgets/PageviewsPerOperatingSystem.png
    :align: center

Default widget configuration.

:file:`Configuration/Services.yaml`:

.. code-block:: yaml

   services:
     _defaults:
       autowire: true
       autoconfigure: true
       public: false

     DanielSiepmann\Tracking\Dashboard\Provider\PageviewsPerOperatingSystem:
       arguments:
         $queryBuilder: '@querybuilder.tx_tracking_pageview'
         $days: 62

     dashboard.widget.danielsiepmann.tracking.operatingSystems:
       class: 'TYPO3\CMS\Dashboard\Widgets\DoughnutChartWidget'
       arguments:
         $view: '@dashboard.views.widget'
         $dataProvider: '@DanielSiepmann\Tracking\Dashboard\Provider\PageviewsPerOperatingSystem'
       tags:
         - name: 'dashboard.widget'
           identifier: 'operatingSystemsDoughnut'
           groupNames: 'tracking'
           iconIdentifier: 'content-widget-chart-pie'
           title: 'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:dashboard.widgets.operatingSystemsDoughnut.title'
           description: 'LLL:EXT:tracking/Resources/Private/Language/locallang.xlf:dashboard.widgets.operatingSystemsDoughnut.description'
           height: 'medium'
           width: 'small'

Options
=======

..  confval:: $days
    :name: pageviewsPerOperatingSystem-days
    :required: false
    :type: Integer
    :default: 31

    Defines the number of days to respect.

..  confval:: $maxResults
    :name: pageviewsPerOperatingSystem-maxResults
    :required: false
    :type: Integer
    :default: 6

    Defines how many pages should be shown.
    Defaults to 6 because EXT:dashboard only provides 6 colors.

..  confval:: $languageLimitation
    :name: pageviewsPerOperatingSystem-languageLimitation
    :required: false
    :type: array of ``sys_language_uid``'s to include
    :default: empty array, all languages are shown

    Allows to limit results to specific lanuages.
    All entries tracked when visiting page with this language are shown.
    If multiple languages are shown, default system language labels are used.
    If only a single lanugage is allowed, record labels are translated to that language.