FeatureGateConfig Class Reference

Public Member Functions
	HasFeature (String $feature)
	GetFeatureData (String $feature)

Static Public Member Functions
static	GetInstance ($dbh)

Protected Member Functions
	__construct ($dbh)
	GetConfig ()
	LoadConfig ()

Protected Attributes
	$data = []
	$dbh

Static Protected Attributes
static	$instance

Detailed Description

Class to retrieve and contain the database configuration for Feature Gates

Definition at line 8 of file FeatureGateConfig.i.

Constructor & Destructor Documentation

__construct()

FeatureGateConfig::__construct (   $dbh )

protected

FeatureGateConfig constructor.

Parameters

$dbh	Object Database handler

Exceptions

exception

Definition at line 19 of file FeatureGateConfig.i.

                                         {
        $this->dbh = $dbh;
        $this->LoadConfig();
    }

Member Function Documentation

GetConfig()

FeatureGateConfig::GetConfig ( )

protected

Database access. Ideally this would be repository class.

Returns

array Database result; empty array if no rows

Exceptions

exception

Definition at line 30 of file FeatureGateConfig.i.

                                  :array {
        $sql = <<< SQL
SELECT  feature, enabled_all, enabled_cu, params
FROM    cufeaturegate;
SQL;
        $query = db_query($sql, $this->dbh);
        if (!$query) {
            throw new Exception('Could not read cufeaturegate table.');
        }
        $rows = db_fetch_all($query);
        if (!$rows) {
            return [];
        }
        return $rows;
    }

GetFeatureData()

FeatureGateConfig::GetFeatureData

(

String

$feature

)

Return the config for a particular feature.

Parameters

String

$feature

Indicates which feature to gate

Returns

bool|mixed

Definition at line 92 of file FeatureGateConfig.i.

                                                    {
        if ($this->HasFeature($feature)) {
            return $this->data[$feature];
        }
        return false;
    }

GetInstance()

static FeatureGateConfig::GetInstance (   $dbh )

static

Create or recover an instance of FeatureGateConfig

Parameters

$dbh	Object Database handle

Returns

FeatureGateConfig

Exceptions

exception

Definition at line 69 of file FeatureGateConfig.i.

                                            :FeatureGateConfig {
        if (!static::$instance instanceof FeatureGateConfig) {
            static::$instance = new FeatureGateConfig($dbh);
        }
        return static::$instance;
    }

HasFeature()

FeatureGateConfig::HasFeature

(

String

$feature

)

Checks if the feature is represented in the config

Parameters

String

$feature

Indicates which feature to gate

Returns

bool

Definition at line 82 of file FeatureGateConfig.i.

                                               :bool {
        return array_key_exists($feature, $this->data);
    }

LoadConfig()

FeatureGateConfig::LoadConfig ( )

protected

Iterates through data, loading it by feature id

Exceptions

exception

Definition at line 51 of file FeatureGateConfig.i.

                                    {
        $data = $this->GetConfig();
        foreach ($data as $dataRow) {
            $this->data[$dataRow['feature']] = [
                'enabled_all' => $dataRow['enabled_all'],
                'enabled_cu' => json_decode($dataRow['enabled_cu'], true) ?? [],
                'params' => json_decode($dataRow['params'], true) ?? [],
            ];
        }
    }

---

The documentation for this class was generated from the following file:

• app/web/shared/library/FeatureGateConfig.i