feat: OptimizelyConfigService (#188)

Author: oakbani

phpcs.xml

@@ -19,5 +19,6 @@
     <exclude name="PSR2.Classes.PropertyDeclaration.Underscore"/>
     <exclude name="PSR1.Classes.ClassDeclaration.MultipleClasses"/>
     <exclude name="PSR1.Files.SideEffects.FoundWithSymbols"/>
+    <exclude name="Generic.Files.LineEndings.InvalidEOLChar"/>
   </rule >
 </ruleset>

src/Optimizely/Config/DatafileProjectConfig.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2019, Optimizely
+ * Copyright 2019-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -393,6 +393,15 @@ public function getFeatureFlags()
         return $this->_featureFlags;
     }
 
+    /**
+     * @return array List of all experiments (including group experiments)
+     *               parsed from the datafile
+     */
+    public function getAllExperiments()
+    {
+        return array_values($this->_experimentKeyMap);
+    }
+
     /**
      * @param $groupId string ID of the group.
      *

src/Optimizely/Config/ProjectConfigInterface.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016, 2018-2019 Optimizely
+ * Copyright 2016, 2018-2020 Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -56,6 +56,11 @@ public function getRevision();
      */
     public function getFeatureFlags();
 
+    /**
+     * @return array List of all experiments (including group experiments)
+     */
+    public function getAllExperiments();
+
     /**
      * @param $groupId string ID of the group.
      *

src/Optimizely/Entity/Variation.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016-2019, Optimizely
+ * Copyright 2016-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -47,7 +47,7 @@ class Variation
     private $_variableIdToVariableUsageInstanceMap;
 
 
-    public function __construct($id = null, $key = null, $featureEnabled = false, $variableUsageInstances = [])
+    public function __construct($id = null, $key = null, $featureEnabled = null, $variableUsageInstances = [])
     {
         $this->_id = $id;
         $this->_key = $key;

src/Optimizely/Optimizely.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright 2016-2019, Optimizely
+ * Copyright 2016-2020, Optimizely
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,6 +36,7 @@
 use Optimizely\Logger\NoOpLogger;
 use Optimizely\Notification\NotificationCenter;
 use Optimizely\Notification\NotificationType;
+use Optimizely\OptimizelyConfig\OptimizelyConfigService;
 use Optimizely\ProjectConfigManager\ProjectConfigManagerInterface;
 use Optimizely\ProjectConfigManager\StaticProjectConfigManager;
 use Optimizely\UserProfile\UserProfileServiceInterface;
@@ -266,6 +267,24 @@ public function activate($experimentKey, $userId, $attributes = null)
         return $variationKey;
     }
 
+    /**
+     * Gets OptimizelyConfig object for the current ProjectConfig.
+     *
+     * @return OptimizelyConfig Representing current ProjectConfig.
+     */
+    public function getOptimizelyConfig()
+    {
+        $config = $this->getConfig();
+        if ($config === null) {
+            $this->_logger->log(Logger::ERROR, sprintf(Errors::INVALID_DATAFILE, __FUNCTION__));
+            return null;
+        }
+
+        $optConfigService = new OptimizelyConfigService($config);
+        
+        return $optConfigService->getConfig();
+    }
+
     /**
      * Send conversion event to Optimizely.
      *

src/Optimizely/OptimizelyConfig/OptimizelyConfig.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Copyright 2020, Optimizely Inc and Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+namespace Optimizely\OptimizelyConfig;
+
+class OptimizelyConfig implements \JsonSerializable
+{
+    /**
+     * @var string Revision of the config.
+     */
+    private $revision;
+
+    /**
+     * Map of Experiment Keys to OptimizelyExperiments.
+     *
+     * @var <String, OptimizelyExperiment> associative array
+     */
+    private $experimentsMap;
+
+    /**
+     * Map of Feature Keys to OptimizelyFeatures.
+     *
+     * @var <String, OptimizelyFeature> associative array
+     */
+    private $featuresMap;
+
+    public function __construct($revision, array $experimentsMap, array $featuresMap)
+    {
+        $this->revision = $revision;
+        $this->experimentsMap = $experimentsMap;
+        $this->featuresMap = $featuresMap;
+    }
+
+    /**
+     * @return string Config revision.
+     */
+    public function getRevision()
+    {
+        return $this->revision;
+    }
+
+    /**
+     * @return array Map of Experiment Keys to OptimizelyExperiments.
+     */
+    public function getExperimentsMap()
+    {
+        return $this->experimentsMap;
+    }
+
+    /**
+     * @return array Map of Feature Keys to OptimizelyFeatures.
+     */
+    public function getFeaturesMap()
+    {
+        return $this->featuresMap;
+    }
+
+    /**
+     * @return string JSON representation of the object.
+     */
+    public function jsonSerialize()
+    {
+        return get_object_vars($this);
+    }
+}