FeatureGate.i

<?php
/**
 * 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.
 *
 */

abstract class FeatureGate {
    protected $featureGateConfig;
    protected $feature = '';

    /**
     * FeatureGate constructor.
     *
     * @param String            $feature        Indicates which feature to gate
     * @param FeatureGateConfig $config
     * @throws Exception
     */
    public function __construct(String $feature, FeatureGateConfig $config) {
        $this->featureGateConfig = $config;
        if (strlen(trim($feature)) == 0) {
            throw new Exception('Must supply a non-empty feature');
        }
        $this->feature = $feature;
    }

    /**
     * Check if credit union is allowed to pass.
     *
     * @param String    $creditUnion    Credit union to check the gate for
     * @param array     $params         Extra params for the gate check [Optional]
     * @return bool
     */
    public function WillPass(String $creditUnion, array $params = null):bool {
        return $this->DeterminePass($creditUnion, $params);
    }

    /**
     * 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.
     *
     * @param String    $creditUnion    Credit union to check the gate for
     * @return bool
     */
    protected function DetermineCreditUnionPass(String $creditUnion):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;
    }

    /**
     * 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"]}}
     *
     * @param String    $feature    Indicates which feature to gate
     * @return bool|array
     */
    protected function GetFeatureParams(String $creditUnion) {
        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;
    }

    /**
     * Abstract method to determine if the credit union does, indeed, pass
     *
     * @param String    $creditUnion    Credit union to check the gate for
     * @param array     $params         Extra params for the gate check [Optional]
     * @return bool
     */
    abstract protected function DeterminePass(String $creditUnion, array $params = null):bool;

}