Completed
Push — 7.x-1.x ( 2f9e3c...1070be )
by Frédéric G.
01:36
created

BaseControl   A

Complexity

Total Complexity 9

Size/Duplication

Total Lines 106
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 2

Importance

Changes 0
Metric Value
dl 0
loc 106
rs 10
c 0
b 0
f 0
wmc 9
lcom 2
cbo 2

5 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A getDependencies() 0 3 1
A getInstance() 0 17 3
A getControls() 0 11 3
A run() 0 6 1
1
<?php
2
3
namespace Drupal\qa\Plugin\Qa\Control;
4
5
use Drupal\qa\Exportable;
6
use Drupal\qa\Pass;
7
8
abstract class BaseControl extends Exportable {
9
10
  /**
11
   * The package to which the control belongs
12
   *
13
   * @var string
14
   */
15
  public $package_name;
16
17
  /**
18
   * An options hash
19
   *
20
   * @var array
21
   */
22
  public $options;
23
24
  /**
25
   * The hash of passes for that control.
26
   *
27
   * @var array
28
   */
29
  public $passes;
30
31
  /**
32
   * Singleton-per-child-class data holder.
33
   *
34
   * @var array
35
   */
36
  protected static $instances = array();
37
38
  /**
39
   * Per-package list of instances
40
   *
41
   * @var array
42
   */
43
  protected static $packages = array();
44
45
  public function __construct() {
46
    parent::__construct();
47
    $this->package_name = $this->namespace;
48
  }
49
50
  /**
51
   * Return an array of module dependencies.
52
   *
53
   * @return array
54
   */
55
  public static function getDependencies() {
56
    return array();
57
  }
58
59
  public static function getInstance() {
60
    $name = get_called_class();
61
    if (!isset(self::$instances[$name])) {
62
      $instance = new $name();
63
      self::$instances[$name] = $instance;
64
      if (!isset(self::$packages[$instance->package_name])) {
65
        $package = new $instance->package_name();
66
        self::$packages[get_class($package)] = array(
67
          'package' => $package,
68
          'controls' => array(),
69
        );
70
      }
71
      self::$packages[$instance->package_name]['controls'][$instance->name] = $instance;
72
    }
73
    $ret = self::$instances[$name];
74
    return $ret;
75
  }
76
77
  /**
78
   * Returns per-package controls.
79
   *
80
   * @param string $package_name
81
   *   If given, only return the list of controls belonging to that package
82
   *
83
   * @return array
84
   *   - if $package_name is given, an array of control instances
85
   *   - else a package-name-indexed hash of arrays of control instances
86
   */
87
  public static function getControls($package_name = NULL) {
88
    if (isset($package_name)) {
89
      $ret = isset(self::$packages[$package_name])
90
        ? self::$packages[$package_name]
91
        : NULL;
92
    }
93
    else {
94
      $ret = self::$packages;
95
    }
96
    return $ret;
97
  }
98
99
  /**
100
   * Run the control.
101
   *
102
   * @return \Drupal\qa\Pass
103
   *   - 0: failure
104
   *   - 1: success
105
   */
106
  public function run() {
107
    $key = uniqid(variable_get('site_key', NULL));
108
    $pass = new Pass($this);
109
    $this->passes[$key] = $pass;
110
    return $pass;
111
  }
112
113
}
114