You are here

Home » API reference » Analytics 8 » Piwik.php

class Piwik in Analytics 8

Analytics service type.

Plugin annotation


@AnalyticsService(
  id = "piwik",
  label = @Translation("Piwik"),
)

Hierarchy

Expanded class hierarchy of Piwik

File

analytics_piwik/src/Plugin/AnalyticsService/Piwik.php, line 16

Namespace

Drupal\analytics_piwik\Plugin\AnalyticsService
View source 
class Piwik extends ServicePluginBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'url' => '',
      'id' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm($form, FormStateInterface $form_state) {
    $form['url'] = [
      '#type' => 'textfield',
      '#title' => t('URL'),
      '#description' => t('The URL to your Piwik base directory.'),
      '#default_value' => $this->configuration['url'],
      // @todo Add validation

      //'#element_validate' => [$this->validateUrl],
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'number',
      '#title' => t('Site ID'),
      '#default_value' => $this->configuration['id'],
      '#min' => 0,
      '#required' => TRUE,
      '#size' => 15,
    ];
    return $form;
  }
  function validateUrl($element, &$form_state) {
    $value = $element['#value'];
    if ($value != '') {

      // Make sure the URL is normalized.
      $value = rtrim($value, '/') . '/';
      form_set_value($element, $value, $form_state);
      if (!valid_url($value, TRUE)) {
        form_error($element, t('%name is not a valid URL.', [
          '%name' => $element['#title'],
        ]));
      }
      else {
        $request = drupal_http_request($value . '/piwik.js');
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getOutput() {
    $output = [];

    // This is just placeholder code.
    $output['analytics_' . $this
      ->getServiceId()] = [
      '#type' => 'html_tag',
      '#tag' => 'piwik',
      '#attributes' => [
        'src' => $this->configuration['url'],
        'site_id' => $this->configuration['id'],
      ],
    ];
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
Piwik::buildConfigurationForm public function Form constructor. Overrides ServicePluginBase::buildConfigurationForm
Piwik::defaultConfiguration public function Gets default configuration for this plugin. Overrides ServicePluginBase::defaultConfiguration
Piwik::getOutput public function Returns the output of the analytics service. Overrides ServicePluginBase::getOutput
Piwik::validateUrl function
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
ServicePluginBase::$hasMultiple protected property
ServicePluginBase::$serviceId protected property The ID of the service config entity using this plugin.
ServicePluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ServicePluginBase::canTrack public function Determines if the current service can track the current request. Overrides ServicePluginInterface::canTrack
ServicePluginBase::getAmpOutput public function Build an <amp-analytics> tag for output on an amp-enabled page request.
ServicePluginBase::getCacheableUrls public function Overrides ServicePluginInterface::getCacheableUrls
ServicePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ServicePluginBase::getLabel public function Returns the label of the analytics service. Overrides ServicePluginInterface::getLabel
ServicePluginBase::getServiceId public function Gets the current service config entity ID that is using this plugin. Overrides ServicePluginInterface::getServiceId
ServicePluginBase::hasMultipleInstances public function
ServicePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ServicePluginBase::setServiceId public function Sets the current service config entity ID that is using this plugin. Overrides ServicePluginInterface::setServiceId
ServicePluginBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ServicePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ServicePluginBase::validateJson public static function Form element validation callback for a JSON textarea field.
ServicePluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.