Merge pull request #145 from splitio/fix/ClientInterface

Fix/client interface

Author: mredolatti

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2018 Split Software, Co.
+Copyright © 2020 Split Software, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

composer.json

@@ -6,11 +6,16 @@
   "authors": [
     {
       "name": "Split",
-      "homepage": "http://split.io"
+      "homepage": "https://www.split.io/",
+      "email": "php@split.io"
     },
     {
-      "name": "Sebastian Arrubia",
-      "email": "sebastian@split.io"
+      "name": "Martin Redolatti",
+      "email": "martin.redolatti@split.io"
+    },
+    {
+      "name": "Matias Melograno",
+      "email": "matias.melograno@split.io"
     }
   ],
 

src/SplitIO/Sdk/Client.php

@@ -168,37 +168,7 @@ private function doEvaluation($operation, $metricName, $key, $featureName, $attr
     }
 
     /**
-     * Returns the treatment to show this id for this feature.
-     * The set of treatments for a feature can be configured
-     * on the Split web console.
-     * This method returns the string 'control' if:
-     * <ol>
-     *     <li>Any of the parameters were null</li>
-     *     <li>There was an exception</li>
-     *     <li>The SDK does not know this feature</li>
-     *     <li>The feature was deleted through the web console.</li>
-     * </ol>
-     * 'control' is a reserved treatment, to highlight these
-     * exceptional circumstances.
-     *
-     * <p>
-     * The sdk returns the default treatment of this feature if:
-     * <ol>
-     *     <li>The feature was killed</li>
-     *     <li>The id did not match any of the conditions in the
-     * feature roll-out plan</li>
-     * </ol>
-     * The default treatment of a feature is set on the Split web
-     * console.
-     *
-     * <p>
-     * This method does not throw any exceptions.
-     * It also never  returns null.
-     *
-     * @param $key
-     * @param $featureName
-     * @param $attributes
-     * @return string
+     * @inheritdoc
      */
     public function getTreatment($key, $featureName, array $attributes = null)
     {
@@ -218,42 +188,7 @@ public function getTreatment($key, $featureName, array $attributes = null)
     }
 
     /**
-     * Returns an object with the treatment to show this id for this feature
-     * and the config provided.
-     * The set of treatments and config for a feature can be configured
-     * on the Split web console.
-     * This method returns the string 'control' if:
-     * <ol>
-     *     <li>Any of the parameters were null</li>
-     *     <li>There was an exception</li>
-     *     <li>The SDK does not know this feature</li>
-     *     <li>The feature was deleted through the web console.</li>
-     * </ol>
-     * 'control' is a reserved treatment, to highlight these
-     * exceptional circumstances.
-     *
-     * <p>
-     * The sdk returns the default treatment of this feature if:
-     * <ol>
-     *     <li>The feature was killed</li>
-     *     <li>The id did not match any of the conditions in the
-     * feature roll-out plan</li>
-     * </ol>
-     * The default treatment of a feature is set on the Split web
-     * console.
-     *
-     * <p>
-     * This method does not throw any exceptions.
-     * It also never returns null.
-     *
-     * This method returns null configuration if:
-     * <ol>
-     *     <li>config was not set up</li>
-     * </ol>
-     * @param $key
-     * @param $featureName
-     * @param $attributes
-     * @return string
+     * @inheritdoc
      */
     public function getTreatmentWithConfig($key, $featureName, array $attributes = null)
     {
@@ -388,35 +323,7 @@ private function doEvaluationForTreatments($operation, $metricName, $key, $featu
     }
 
     /**
-     * Returns an associative array which each key will be
-     * the treatment result for each feature passed as parameter.
-     * The set of treatments for a feature can be configured
-     * on the Split web console.
-     * This method returns the string 'control' if:
-     * <ol>
-     *     <li>featureNames is invalid/li>
-     * </ol>
-     * 'control' is a reserved treatment, to highlight these
-     * exceptional circumstances.
-     *
-     * <p>
-     * The sdk returns the default treatment of this feature if:
-     * <ol>
-     *     <li>The feature was killed</li>
-     *     <li>The id did not match any of the conditions in the
-     * feature roll-out plan</li>
-     * </ol>
-     * The default treatment of a feature is set on the Split web
-     * console.
-     *
-     * <p>
-     * This method does not throw any exceptions.
-     * It also never returns null.
-     *
-     * @param $key
-     * @param $featureNames
-     * @param $attributes
-     * @return array|control
+     * @inheritdoc
      */
     public function getTreatments($key, $featureNames, array $attributes = null)
     {
@@ -434,44 +341,14 @@ function ($feature) {
                 )
             );
         } catch (\Exception $e) {
-            SplitApp::logger()->critical('getTreatmens method is throwing exceptions');
+            SplitApp::logger()->critical('getTreatments method is throwing exceptions');
             $splitNames = InputValidator::validateFeatureNames($featureNames, 'getTreatments');
             return is_null($splitNames) ? array() : array_fill_keys($splitNames, TreatmentEnum::CONTROL);
         }
     }
 
     /**
-     * Returns an associative array which each key will be
-     * the treatment result and the config for each
-     * feature passed as parameter.
-     * The set of treatments for a feature can be configured
-     * on the Split web console and the config for
-     * that treatment.
-     * This method returns the string 'control' if:
-     * <ol>
-     *     <li>featureNames is invalid/li>
-     * </ol>
-     * 'control' is a reserved treatment, to highlight these
-     * exceptional circumstances.
-     *
-     * <p>
-     * The sdk returns the default treatment of this feature if:
-     * <ol>
-     *     <li>The feature was killed</li>
-     *     <li>The id did not match any of the conditions in the
-     * feature roll-out plan</li>
-     * </ol>
-     * The default treatment of a feature is set on the Split web
-     * console.
-     *
-     * <p>
-     * This method does not throw any exceptions.
-     * It also never returns null.
-     *
-     * @param $key
-     * @param $featureNames
-     * @param $attributes
-     * @return array|control
+     * @inheritdoc
      */
     public function getTreatmentsWithConfig($key, $featureNames, array $attributes = null)
     {
@@ -492,18 +369,7 @@ public function getTreatmentsWithConfig($key, $featureNames, array $attributes =
     }
 
     /**
-     * A short-hand for
-     * <pre>
-     *     (getTreatment(key, feature) == treatment) ? true : false;
-     * </pre>
-     *
-     * This method never throws exceptions.
-     * Instead of throwing  exceptions, it returns false.
-     *
-     * @param $key
-     * @param $featureName
-     * @param $treatment
-     * @return bool
+     * @inheritdoc
      */
     public function isTreatment($key, $featureName, $treatment)
     {

src/SplitIO/Sdk/ClientInterface.php

@@ -38,6 +38,114 @@ interface ClientInterface
      */
     public function getTreatment($key, $featureName, array $attributes = null);
 
+    /**
+     * Returns an object with the treatment to show this id for this feature
+     * and the config provided.
+     * The set of treatments and config for a feature can be configured
+     * on the Split web console.
+     * This method returns the string 'control' if:
+     * <ol>
+     *     <li>Any of the parameters were null</li>
+     *     <li>There was an exception</li>
+     *     <li>The SDK does not know this feature</li>
+     *     <li>The feature was deleted through the web console.</li>
+     * </ol>
+     * 'control' is a reserved treatment, to highlight these
+     * exceptional circumstances.
+     *
+     * <p>
+     * The sdk returns the default treatment of this feature if:
+     * <ol>
+     *     <li>The feature was killed</li>
+     *     <li>The id did not match any of the conditions in the
+     * feature roll-out plan</li>
+     * </ol>
+     * The default treatment of a feature is set on the Split web
+     * console.
+     *
+     * <p>
+     * This method does not throw any exceptions.
+     * It also never returns null.
+     *
+     * This method returns null configuration if:
+     * <ol>
+     *     <li>config was not set up</li>
+     * </ol>
+     * @param $key
+     * @param $featureName
+     * @param $attributes
+     * @return string
+     */
+    public function getTreatmentWithConfig($key, $featureName, array $attributes = null);
+
+    /**
+     * Returns an associative array which each key will be
+     * the treatment result for each feature passed as parameter.
+     * The set of treatments for a feature can be configured
+     * on the Split web console.
+     * This method returns the string 'control' if:
+     * <ol>
+     *     <li>featureNames is invalid/li>
+     * </ol>
+     * 'control' is a reserved treatment, to highlight these
+     * exceptional circumstances.
+     *
+     * <p>
+     * The sdk returns the default treatment of this feature if:
+     * <ol>
+     *     <li>The feature was killed</li>
+     *     <li>The id did not match any of the conditions in the
+     * feature roll-out plan</li>
+     * </ol>
+     * The default treatment of a feature is set on the Split web
+     * console.
+     *
+     * <p>
+     * This method does not throw any exceptions.
+     * It also never returns null.
+     *
+     * @param $key
+     * @param $featureNames
+     * @param $attributes
+     * @return array
+     */
+    public function getTreatments($key, $featureNames, array $attributes = null);
+
+    /**
+     * Returns an associative array which each key will be
+     * the treatment result and the config for each
+     * feature passed as parameter.
+     * The set of treatments for a feature can be configured
+     * on the Split web console and the config for
+     * that treatment.
+     * This method returns the string 'control' if:
+     * <ol>
+     *     <li>featureNames is invalid/li>
+     * </ol>
+     * 'control' is a reserved treatment, to highlight these
+     * exceptional circumstances.
+     *
+     * <p>
+     * The sdk returns the default treatment of this feature if:
+     * <ol>
+     *     <li>The feature was killed</li>
+     *     <li>The id did not match any of the conditions in the
+     * feature roll-out plan</li>
+     * </ol>
+     * The default treatment of a feature is set on the Split web
+     * console.
+     *
+     * <p>
+     * This method does not throw any exceptions.
+     * It also never returns null.
+     *
+     * @param $key
+     * @param $featureNames
+     * @param $attributes
+     * @return array
+     */
+    public function getTreatmentsWithConfig($key, $featureNames, array $attributes = null);
+
     /**
      * A short-hand for
      * <pre>