updated with latest in master

Author: mmelograno

.github/workflows/ci.yml

@@ -6,8 +6,13 @@ on:
       - master
   push:
     branches:
+      - develop
       - master
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
 jobs:
   build:
     name: Build
@@ -18,69 +23,63 @@ jobs:
         ports:
           - 6379:6379
     strategy:
+      fail-fast: false
       matrix:
-        version: ['7.4', '8.0', '8.1', '8.2']
+        version:
+          - '7.3'
+          - '8.0'
+          - '8.1'
+          - '8.2'
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.version }}
           extensions: mbstring, intl
           ini-values: post_max_size=256M, max_execution_time=180
-          coverage: xdebug
+          coverage: pcov
 
       - name: Install dependencies
         run: |
           composer install --prefer-dist
           composer update
-          composer dumpautoload
 
       - name: Build
         run: |
           vendor/bin/phpcs --ignore=functions.php --standard=PSR2 src/
-          vendor/bin/phpunit -c phpunit.xml.dist -v --testsuite integration
+          vendor/bin/phpunit -c phpunit.xml.dist -v --testsuite integration --coverage-clover coverage.xml
 
-  sonarqube:
-    name: Sonarqube
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
+      - name: Set VERSION env
+        run: echo "VERSION=$(cat src/SplitIO/Version.php | grep 'const CURRENT' | cut -d "'" -f 2 | sed "s/'//g")" >> $GITHUB_ENV
 
       - name: SonarQube Scan (Push)
-        if: github.event_name == 'push'
-        uses: SonarSource/sonarcloud-github-action@v1.5
+        if: matrix.version == '8.2' && github.event_name == 'push'
+        uses: SonarSource/sonarcloud-github-action@v1.9
         env:
           SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           projectBaseDir: .
           args: >
             -Dsonar.host.url=${{ secrets.SONARQUBE_HOST }}
-            -Dsonar.projectName=${{ github.event.repository.name }}
-            -Dsonar.projectKey=splitsoftware_split-sdk-php
-            -Dsonar.exclusions="**/tests/**/*.*"
-            -Dsonar.links.ci="https://github.com/splitio/${{ github.event.repository.name }}/actions"
-            -Dsonar.links.scm="https://github.com/splitio/${{ github.event.repository.name }}"
+            -Dsonar.projectVersion=${{ env.VERSION }}
 
       - name: SonarQube Scan (Pull Request)
-        if: github.event_name == 'pull_request'
-        uses: SonarSource/sonarcloud-github-action@v1.5
+        if: matrix.version == '8.2' && github.event_name == 'pull_request'
+        uses: SonarSource/sonarcloud-github-action@v1.9
         env:
           SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           projectBaseDir: .
           args: >
             -Dsonar.host.url=${{ secrets.SONARQUBE_HOST }}
-            -Dsonar.projectName=${{ github.event.repository.name }}
-            -Dsonar.projectKey=splitsoftware_split-sdk-php
-            -Dsonar.exclusions="**/tests/**/*.*"
-            -Dsonar.links.ci="https://github.com/splitio/${{ github.event.repository.name }}/actions"
-            -Dsonar.links.scm="https://github.com/splitio/${{ github.event.repository.name }}"
+            -Dsonar.projectVersion=${{ env.VERSION }}
             -Dsonar.pullrequest.key=${{ github.event.pull_request.number }}
             -Dsonar.pullrequest.branch=${{ github.event.pull_request.head.ref }}
-            -Dsonar.pullrequest.base=${{ github.event.pull_request.base.ref }}
+            -Dsonar.pullrequest.base=${{ github.event.pull_request.base.ref }}

.github/workflows/update-license-year.yml

@@ -16,10 +16,10 @@ jobs:
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      
+
       - name: Set Current year
         run: "echo CURRENT=$(date +%Y) >> $GITHUB_ENV"
-      
+
       - name: Set Previous Year
         run: "echo PREVIOUS=$(($CURRENT-1)) >> $GITHUB_ENV"
 

.gitignore

@@ -26,3 +26,7 @@ test.php
 
 # Sonarqube
 .scannerwork
+
+# Tests
+.phpunit.result.cache
+coverage.xml

CHANGES.txt

@@ -2,6 +2,10 @@
  - BREAKING CHANGE: Removed support from versions older than PHP 7.4.
  - BREAKING CHANGE: Added support for Multiple Factory Instantiation.
 
+7.1.7 (May 16, 2023)
+ - Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and phpdoc comments.
+ - Fixed php 8.2 warnings in code.
+
 7.1.6 (Feb 14, 2023)
  - Fixed logging on array conversion.
 
@@ -45,7 +49,7 @@
  - Added flag `IPAddressesEnabled` into options to enable/disable sending MachineName and MachineIP when data is posted in headers.
 
 6.2.2 (Sep 18, 2019)
- - Fetch multiple splits at once on getTreatments/getTreatmentsWithConfig
+ - Fetch multiple feature flags at once on getTreatments/getTreatmentsWithConfig
  - Removed MatcherClient (DependencyMatcher now uses Evaluator directly)
  - Removed shared memory.
  - Several code cleanups
@@ -56,7 +60,7 @@
 
 6.2.0 (May 30, 2019)
  - Added validation for TrafficType in track calls.
- - Added validation when split does not exist on treatments and manager calls.
+ - Added validation when feature flag does not exist on treatments and manager calls.
  - Added multiple factory instantiation check.
  - Removed producer modules.
  - Added properties to track method.
@@ -98,7 +102,7 @@
  - Downgrade logging level for shared memory messages
 
 5.2.3: (Sep 5, 2017)
- - Adding hotfix to return empty splits array in SplitManager when redis is empty.
+ - Adding hotfix to return empty feature flags array in SplitManager when redis is empty.
 
 5.2.2: (Aug 1, 2017)
  - Adding hotfix to return CONTROL if redis is down instead of failing.

README.md

@@ -4,23 +4,24 @@
 [![Latest stable](https://img.shields.io/packagist/v/splitsoftware/split-sdk-php)](https://packagist.org/packages/splitsoftware/split-sdk-php)
 [![Documentation](https://img.shields.io/badge/php_client-documentation-informational)](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 
-This SDK is designed to work with Split, the platform for controlled rollouts, serving features to your users via the Split feature flag to manage your complete customer experience.
+## Overview
+This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.
 
 ## Compatibility
 This SDK is compatible with PHP 7.3 and above.
 
 ## Getting started
 Below is a simple example that describes the instantiation and most basic usage of our SDK.
-Keep in mind that since PHP does not have the ability to share memory between processes the use of the [split-synchronizer](https://help.split.io/hc/en-us/articles/360019686092-Split-Synchronizer-Proxy) is mandatory for this SDK.
+Keep in mind that since PHP does not have the ability to share memory between processes the use of the [split-synchronizer](https://help.split.io/hc/en-us/articles/360019686092-Split-Synchronizer) is mandatory for this SDK.
 
 ```php
 <?php
 
 $sdkConfig = ['cache' => ['adapter' => 'predis']];
-$splitFactory = \SplitIO\Sdk::factory('SDK_API_KEY', $sdkConfig);
+$splitFactory = \SplitIO\Sdk::factory('YOUR_SDK_KEY', $sdkConfig);
 
 $splitClient = $splitFactory->client();
-$treatment = $splitClient->getTreatment('CUSTOMER_ID','SPLIT_NAME');
+$treatment = $splitClient->getTreatment('CUSTOMER_ID','FEATURE_FLAG_NAME');
 if ($treatment === 'on') {
     // Feature is enabled for this user!
 } elseif ($treatment === 'off') {
@@ -30,9 +31,11 @@ if ($treatment === 'on') {
 }
 ```
 
+Please refer to [our official docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK) to learn about all the functionality provided by our SDK and the configuration options available for tailoring it to your current application setup.
+
 ## Submitting issues
 
-The Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/php-client/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.
+ The Split team monitors all issues submitted to this [issue tracker](https://github.com/splitio/php-client/issues). We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.
 
 ## Contributing
 Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to submit a Pull Request (PR).
@@ -41,26 +44,31 @@ Please see [Contributors Guide](CONTRIBUTORS-GUIDE.md) to find all you need to s
 Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).
 
 ## About Split
- 
+
 Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy features as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new features will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.
- 
+
 To learn more about Split, contact hello@split.io, or get started with feature flags for free at https://www.split.io/signup.
- 
+
 Split has built and maintains SDKs for:
- 
+
+* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
+* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
+* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
+* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
-* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
+* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
-* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
-* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
-* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
-* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
-* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
- 
+* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
+* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
+* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
+* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
+
 For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
- 
+
 **Learn more about Split:**
- 
+
 Visit [split.io/product](https://www.split.io/product) for an overview of Split, or visit our documentation at [help.split.io](http://help.split.io) for more detailed information.

bin/splitio.dist.ini

@@ -10,8 +10,8 @@
 ;NOTE: This file is read by default. If you would like customize it, please copy this file and replace the values.
 ;
 
-;API-KEY for Split environment
-api-key = 'YOUR_SPLITIO_APIKEY'
+;SDK-KEY for Split environment
+sdk-key = 'YOUR_SDK_KEY'
 
 ;---------------------
 ;LOG configuration
@@ -53,26 +53,3 @@ log-level = 'error'
 cache-adapter = 'predis'
 predis-parameters = '{"scheme":"tcp","host":"localhost","port":6379,"timeout":881}'
 predis-options = '{"prefix":""}'
-
-
-;---------------------
-;PROCESS configuration
-;---------------------
-
-;SPLITS
-;Set the rate to fetch the Splits definitions from server
-features-refresh-rate = 30
-
-;SEGMENTS
-;Set the rate to fetch the Segments keys from server
-segments-refresh-rate = 60
-
-;IMPRESSIONS
-;Set the rate to send the treatments impressions to server
-impressions-refresh-rate = 60
-
-;METRICS
-;Set the rate to send the SDK metrics to server
-metrics-refresh-rate = 60
-
-

phpunit.xml.dist

@@ -8,6 +8,12 @@
         <const name="TEST_PREFIX" value="SPLITIO_TEST:."/>
     </php>
 
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src</directory>
+        </whitelist>
+    </filter>
+
     <testsuites>
         <testsuite name="splitio">
             <directory suffix="Test.php">tests/</directory>
@@ -49,8 +55,6 @@
             <directory suffix="Test.php">tests/Suite/Sdk/</directory>
         </testsuite>
 
-
-
         <testsuite name="integration">
             <directory suffix="Test.php">tests/Suite/Adapter/</directory>
             <directory suffix="Test.php">tests/Suite/Attributes/</directory>

sonar-project.properties

@@ -0,0 +1,7 @@
+sonar.projectName=php-client
+sonar.projectKey=splitsoftware_split-sdk-php
+sonar.sources=src
+sonar.tests=tests
+sonar.php.coverage.reportPaths=coverage.xml
+sonar.links.ci=https://github.com/splitio/php-client
+sonar.links.scm=https://github.com/splitio/php-client/actions

src/SplitIO/Component/Cache/SplitCache.php

@@ -68,7 +68,9 @@ public function getSplit($splitName)
      */
     public function getSplits($splitNames)
     {
-        $cacheItems = $this->cache->fetchMany(array_map(self::class . '::getCacheKeyForSplit', $splitNames));
+        $cacheItems = $this->cache->fetchMany(array_map([
+            self::class, 'getCacheKeyForSplit'
+        ], $splitNames));
         $toReturn = array();
         foreach ($cacheItems as $key => $value) {
             $toReturn[self::getSplitNameFromCacheKey($key)] = $value;
@@ -81,8 +83,8 @@ public function getSplits($splitNames)
      */
     public function getSplitNames()
     {
-        $splitKeys = $this->cache->getKeys(self::getCacheKeySearchPattern());
-        return array_map('self::getSplitNameFromCacheKey', $splitKeys);
+        $splitKeys =  $this->cache->getKeys(self::getCacheKeySearchPattern());
+        return array_map([self::class, 'getSplitNameFromCacheKey'], $splitKeys);
     }
 
     /**

src/SplitIO/Component/Common/Context.php

@@ -10,7 +10,7 @@
  */
 class Context
 {
-    const SAME_APIKEY = "Factory Instantiation: You already have %s factory/factories with this API Key. "
+    const SAME_SDK_KEY = "Factory Instantiation: You already have %s factory/factories with this SDK Key. "
         . "We recommend keeping only one instance of the factory at all times (Singleton pattern) and "
         . "reusing it throughout your application.";
 
@@ -72,19 +72,19 @@ public function __wakeup()
     }
 
     /**
-     * @param string $apiKey
+     * @param string $sdkKey
      * @return int
      */
-    public static function trackFactory($apiKey)
+    public static function trackFactory($sdkKey)
     {
-        $current = self::getInstance()->factoryTracker[$apiKey] ?? 0;
+        $current = self::getInstance()->factoryTracker[$sdkKey] ?? 0;
         if ($current > 0) {
-            self::getInstance()->getLogger()->warning(sprintf(self::SAME_APIKEY, $current));
+            self::getInstance()->getLogger()->warning(sprintf(self::SAME_SDK_KEY, $current));
         } elseif (count(self::getInstance()->factoryTracker) > 0) {
             self::getInstance()->getLogger()->warning(self::MULTIPLE_INSTANCES);
         }
         $current += 1;
-        self::getInstance()->factoryTracker[$apiKey] = $current;
+        self::getInstance()->factoryTracker[$sdkKey] = $current;
         return $current;
     }