Drupal\qa\Plugin\Qa\Control\BaseControl

Complexity

Total Complexity

11

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	getControls()	0	10	3
A	getInstance()	0	16	3
A	getPluginDefinition()	0	2	1
A	getPluginId()	0	2	1
A	__construct()	0	4	1
A	run()	0	7	1

<?php

namespace Drupal\qa\Plugin\Qa\Control;

use Drupal\Component\Utility\Crypt;
use Drupal\Core\PrivateKey;
use Drupal\qa\Exportable;
use Drupal\qa\Pass;
use Drupal\qa\Plugin\QaCheckInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Base class for legacy Controls.
 */
abstract class BaseControl extends Exportable implements QaCheckInterface {

  /**
   * The package to which the control belongs.
   *
   * @var string
   */
  // phpcs:ignore
  public $package_name;

  /**
   * An options hash.
   *
   * @var array
   */
  public $options;

  /**
   * The hash of passes for that control.
   *
   * @var array
   */
  public $passes;

  /**
   * Singleton-per-child-class data holder.
   *
   * @var array
   */
  protected static $instances = [];

  /**
   * Per-package list of instances.
   *
   * @var array
   */
  protected static $packages = [];

  /**
   * The private_key service.
   *
   * @var \Drupal\Core\PrivateKey
   */
  protected $pk;

  /**
   * BaseControl constructor.
   *
   * @param \Drupal\Core\PrivateKey $pk
   *   The private_ket service.
   */
  public function __construct(PrivateKey $pk) {
    parent::__construct();
    $this->package_name = $this->namespace;
    $this->pk = $pk;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $pk = $container->get('private_key');
    assert($pk instanceof PrivateKey);
    return new static($pk);
  }

  /**
   * Return an array of module dependencies.
   *
   * @return array
   *   The names of the dependencies.
   */
  abstract public static function getDependencies(): array;

  /**
   * Get the singleton instance for the requested control.
   *
   * @return \Drupal\qa\Plugin\Qa\Control\BaseControl
   *   The instance.
   */
  public static function getInstance() {
    $name = get_called_class();
    if (!isset(self::$instances[$name])) {
      $instance = new $name();
      self::$instances[$name] = $instance;
      if (!isset(self::$packages[$instance->package_name])) {
        $package = new $instance->package_name();
        self::$packages[get_class($package)] = [
          'package' => $package,
          'controls' => [],
        ];
      }
      self::$packages[$instance->package_name]['controls'][$instance->name] = $instance;
    }
    $ret = self::$instances[$name];
    return $ret;
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginId() {
    return self::getInstance()->name;
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginDefinition() {
    return [];
  }

  /**
   * Returns per-package controls.
   *
   * @param string $package_name
   *   If given, only return the list of controls belonging to that package.
   *
   * @return array
   *   - if $package_name is given, an array of control instances
   *   - else a package-name-indexed hash of arrays of control instances
   */
  public static function getControls($package_name = NULL) {
    if (isset($package_name)) {
      $ret = isset(self::$packages[$package_name])
        ? self::$packages[$package_name]
        : NULL;
    }
    else {
      $ret = self::$packages;
    }
    return $ret;
  }

  /**
   * Run the control.
   *
   * @return \Drupal\qa\Pass
   *   - 0: failure
   *   - 1: success
   */
  public function run(): Pass {
    global $base_url;
    $site_key = Crypt::hmacBase64($base_url, $this->pk->get());
    $key = uniqid($site_key);
    $pass = new Pass($this);
    $this->passes[$key] = $pass;
    return $pass;
  }

}