class ReportsForm in Piwik Reports 8

Class ReportsForm.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\piwik_reports\Form\ReportsForm

Expanded class hierarchy of ReportsForm

File

src/Form/ReportsForm.php, line 14

Namespace

Drupal\piwik_reports\Form

View source

class ReportsForm extends FormBase {

  /**
   * Drupal\user\UserDataInterface definition.
   *
   * @var \Drupal\user\UserDataInterface
   */
  protected $userData;

  /**
   * The Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a new ReportsForm object.
   *
   * @param \Drupal\user\UserDataInterface $user_data
   *   The user data service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(UserDataInterface $user_data, MessengerInterface $messenger) {
    $this->userData = $user_data;
    $this->messenger = $messenger;
  }
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('user.data'), $container
      ->get('messenger'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'piwik_reports_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, array $sites = NULL) {
    $config = \Drupal::config('piwik_reports.piwikreportssettings');
    $session = $this
      ->getRequest()
      ->getSession();
    $allowed_sites = [];
    $allowed_keys = explode(',', $config
      ->get('piwik_reports_allowed_sites'));
    $form['#attributes'] = [
      'class' => [
        'search-form',
        'container-inline',
      ],
    ];
    $form['piwik_filters'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Select site and time period'),
    ];
    $period = [
      0 => $this
        ->t('Today'),
      1 => $this
        ->t('Yesterday'),
      2 => $this
        ->t('Last week'),
      3 => $this
        ->t('Last month'),
      4 => $this
        ->t('Last year'),
    ];
    $form['piwik_filters']['period'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('When'),
      '#description' => $this
        ->t('Report Period'),
      '#options' => $period,
      '#size' => 1,
      '#default_value' => $session
        ->get('piwik_reports_period') ?? 0,
      '#weight' => '0',
    ];
    if ($sites) {
      foreach ($sites as $site) {
        if (empty($allowed_keys[0]) || in_array($site['idsite'], $allowed_keys)) {
          $allowed_sites[$site['idsite']] = $site['name'];
        }
        if ($session
          ->get('piwik_reports_site') == $site['idsite']) {
          $session_site_exists = TRUE;
        }
      }
      if ($session
        ->get('piwik_reports_site') == '' || !$session_site_exists || !array_key_exists($session
        ->get('piwik_reports_site'), $allowed_sites)) {

        // When not set, set to first of the allowed sites.
        $session
          ->set('piwik_reports_site', array_key_first($allowed_sites));
      }
      if (count($allowed_sites) > 1) {
        $form['piwik_filters']['site'] = array(
          '#type' => 'select',
          '#title' => $this
            ->t('Site'),
          '#weight' => -5,
          '#default_value' => $session
            ->get('piwik_reports_site'),
          '#options' => $allowed_sites,
        );
      }
      elseif (count($allowed_sites) == 1) {
        foreach ($allowed_sites as $siteid => $sitename) {
          break;
        }
        $form['piwik_filters']['site'] = array(
          '#type' => 'hidden',
          '#value' => $siteid,
        );
        $form['piwik_filters']['sitename'] = array(
          '#type' => 'textfield',
          '#title' => $this
            ->t('Site'),
          '#weight' => -5,
          '#size' => 25,
          '#value' => $sitename,
          '#disabled' => TRUE,
        );
        $form['piwik_filters']['period']['#attributes'] = [
          'onchange' => 'this.form.submit();',
        ];
      }
    }
    $form['piwik_filters']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Filter'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $session = $this
      ->getRequest()
      ->getSession();
    $session
      ->set('piwik_reports_period', $form_state
      ->getValue('period'));
    $session
      ->set('piwik_reports_site', $form_state
      ->getValue('site'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
ReportsForm::$messenger	protected	property	The Messenger service. Overrides MessengerTrait::$messenger
ReportsForm::$userData	protected	property	Drupal\user\UserDataInterface definition.
ReportsForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ReportsForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ReportsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ReportsForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ReportsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ReportsForm::__construct	public	function	Constructs a new ReportsForm object.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.

You are here

class ReportsForm in Piwik Reports 8

Hierarchy

File

Namespace

Members

API Navigation