FeatureGate Class Reference

Inheritance diagram for FeatureGate:

Public Member Functions
	__construct (String $feature, FeatureGateConfig $config)
	WillPass (String $creditUnion, array $params=null)

Protected Member Functions
	DetermineCreditUnionPass (String $creditUnion)
	GetFeatureParams (String $creditUnion)
	DeterminePass (String $creditUnion, array $params=null)

Protected Attributes
	$featureGateConfig
	$feature = ''

Detailed Description

Abstract base class to determine if a gate is passed. A gate can look at the credit union and if that passes look to see if there is an additional username filter. The minimal implementation is for a credit union to pass. Other entry points will allow testing of other parameters to make sure those requirements pass the gate check.

Definition at line 11 of file FeatureGate.i.

Constructor & Destructor Documentation

__construct()

FeatureGate::__construct	(	String	$feature,
		FeatureGateConfig	$config
	)

FeatureGate constructor.

Parameters

String	$feature	Indicates which feature to gate
FeatureGateConfig	$config

Exceptions

Exception

Definition at line 22 of file FeatureGate.i.

                                                                            {
        $this->featureGateConfig = $config;
        if (strlen(trim($feature)) == 0) {
            throw new Exception('Must supply a non-empty feature');
        }
        $this->feature = $feature;
    }

Member Function Documentation

DetermineCreditUnionPass()

FeatureGate::DetermineCreditUnionPass ( String  $creditUnion )

protected

Since all possible types of feature gates must start with a check for the credit union, this is located in the abstract class. If the feature does not exist, default return to false.

Parameters

String

$creditUnion

Credit union to check the gate for

Returns

bool

Definition at line 48 of file FeatureGate.i.

                                                                    :bool {
        $config = $this->featureGateConfig->GetFeatureData($this->feature);
        if ($config) {
            switch ($config['enabled_all']) {
                case 'Y':           // YES
                    return true;
                    break;
                case 'O':           // OFF
                    return false;
                    break;
                case 'N':           // NOT EVERONE - check credit union
                    return in_array($creditUnion, $config['enabled_cu']);
                    break;
                default:
                    return false;
            }
        }
        return false;
    }

DeterminePass()

FeatureGate::DeterminePass ( String  $creditUnion, array  $params = null  )

abstractprotected

Abstract method to determine if the credit union does, indeed, pass

Parameters

String	$creditUnion	Credit union to check the gate for
array	$params	Extra params for the gate check [Optional]

Returns

bool

GetFeatureParams()

FeatureGate::GetFeatureParams ( String  $creditUnion )

protected

Return the params for a particular feature. This should only be called if the caller knows the credit union is allowed (i.e DetermineCreditUnionPass returned true).

params would be json string object in the form: {"creditUnion":{"usernames":["BongoBob","958777"],"ip":["192.168.1.14"],"someOtherParam":["item1","item2"]}} example: {"MYCU":{"usernames":["smith","jones"]}, "SCRUBCU":{"usernames":["bongobob", "4188"]}}

Parameters

String

$feature

Indicates which feature to gate

Returns

bool|array

Definition at line 79 of file FeatureGate.i.

                                                             {
        if ($this->featureGateConfig->HasFeature($this->feature)) {
            $config = $this->featureGateConfig->GetFeatureData($this->feature);

            if ( $config && is_array($config) && array_key_exists("params", $config) ) {
                // convert json params to array
                $paramsByCU = $config["params"];
                $returnArray = isset( $paramsByCU[$creditUnion] ) ? $paramsByCU[$creditUnion] : array();

                return $returnArray;
            }
        }
        return false;
    }

WillPass()

FeatureGate::WillPass	(	String	$creditUnion,
		array	$params = null
	)

Check if credit union is allowed to pass.

Parameters

String	$creditUnion	Credit union to check the gate for
array	$params	Extra params for the gate check [Optional]

Returns

bool

Definition at line 37 of file FeatureGate.i.

                                                                       :bool {
        return $this->DeterminePass($creditUnion, $params);
    }

---

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

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