launchdarkly · LaunchDarklyCI · Apr 24, 2020 · Jul 16, 2018 · Jul 16, 2018 · Aug 20, 2018
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -7,19 +7,27 @@ workflows:
           name: PHP 5.5
       - test-with-preinstalled-php:
           name: PHP 5.6
-          docker-image: circleci/php:5.6.34-cli-jessie
+          docker-image: circleci/php:5.6
           use-phpredis: false
       - test-with-preinstalled-php:
           name: PHP 7.0
-          docker-image: circleci/php:7.0.28-cli-jessie
+          docker-image: circleci/php:7.0
       - test-with-preinstalled-php:
           name: PHP 7.1
-          docker-image: circleci/php:7.1.15-cli-jessie
+          docker-image: circleci/php:7.1
       - test-with-preinstalled-php:
           name: PHP 7.2
-          docker-image: circleci/php:7.2.3-cli-stretch
+          docker-image: circleci/php:7.2
           include-lowest-compatible-versions-test: false 
           # lowest "compatible" version of phpunit in 7.2 has a bug - https://github.com/sebastianbergmann/comparator/pull/30
+      - test-with-preinstalled-php:
+          name: PHP 7.3
+          docker-image: circleci/php:7.3
+          include-lowest-compatible-versions-test: false 
+      - test-with-preinstalled-php:
+          name: PHP 7.4
+          docker-image: circleci/php:7.4
+          include-lowest-compatible-versions-test: false 
       - integration-test
 
 jobs:

diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ composer.phar
 .vagrant
 integration-tests/vendor
 composer.lock
+docs/build
diff --git a/.ldrelease/build-docs.sh b/.ldrelease/build-docs.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+
+cd docs
+make PHPDOC_ARCHIVE=/home/circleci/ldtools/phpDocumentor.phar  # provided in ldcircleci/ld-php-sdk-release image
diff --git a/.ldrelease/config.yml b/.ldrelease/config.yml
@@ -6,5 +6,12 @@ publications:
   - url: https://packagist.org/packages/launchdarkly/server-sdk
     description: Packagist
 
+circleCI:
+  linux:
+    image: ldcircleci/ld-php-sdk-release:1  # built in sdks-ci-docker project, contains PHP 7.2 + phpDocumentor
+
+documentation:
+  githubPages: true
+
 sdk:
   displayName: "PHP"
diff --git a/.ldrelease/publish-docs.sh b/.ldrelease/publish-docs.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+# Releaser will publish the docs to GitHub pages for us if we put a "docs.zip" artifact in ./artifacts
+
+mkdir -p artifacts
+pushd docs/build/html
+rm -f docs.zip
+zip -r docs.zip *
+popd
+mv docs/build/html/docs.zip artifacts
diff --git a/.ldrelease/update-version.sh b/.ldrelease/update-version.sh
@@ -1,5 +1,7 @@
 #!/bin/bash
 
+set -e
+
 # Update version in LDClient class
 LDCLIENT_PHP=src/LaunchDarkly/LDClient.php
 LDCLIENT_PHP_TEMP=${LDCLIENT_PHP}.tmp

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,7 +9,7 @@ All notable changes to the LaunchDarkly PHP SDK will be documented in this file.
 
 ## [3.7.0] - 2019-12-13
 ### Added:
-- Added integration with the [`phpredis`](https://github.com/phpredis/phpredis) extension, which supports persistent Redis connections unlike the existing `predis` integration. See `LaunchDarkly::Integrations::PHPRedis`. (Thanks, [nicofff](https://github.com/launchdarkly/php-server-sdk/pull/128)!)
+- Added integration with the [`phpredis`](https://github.com/phpredis/phpredis) extension, which has similar functionality to the already-supported `predis` but may have better performance (since `predis` is written in pure PHP, whereas `phpredis` uses a C extension). See `LaunchDarkly::Integrations::PHPRedis`. (Thanks, [nicofff](https://github.com/launchdarkly/php-server-sdk/pull/128)!)
 
 ## [3.6.0] - 2019-10-01
 ### Added:

diff --git a/composer.json b/composer.json
@@ -20,10 +20,9 @@
     },
     "require-dev": {
         "aws/aws-sdk-php": "^3.86",
-        "friendsofphp/php-cs-fixer": "~2.2.19",
+        "friendsofphp/php-cs-fixer": ">=2.2.19 <3.0",
         "guzzlehttp/guzzle": "^6.2.1",
         "kevinrob/guzzle-cache-middleware": "^1.4.1",
-        "phpdocumentor/phpdocumentor": "^2.0",
         "phpunit/phpunit": ">=4.8.26 <5.4",
         "predis/predis": "^1.0",
         "sensiolabs/consul-php-sdk": ">=2.1 <3.0",

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,17 @@
+
+# PHPDOC_ARCHIVE is overridden in the CircleCI release
+PHPDOC_ARCHIVE := $(shell pwd)/build/phpDocumentor.phar
+OUTPUT_DIR := $(shell pwd)/build
+PHPDOC_URL=https://www.phpdoc.org/phpDocumentor.phar
+
+.PHONY: install html
+
+html: install
+	rm -rf build/temp build/html
+	cd .. && php $(PHPDOC_ARCHIVE) --visibility public --title "LaunchDarkly PHP SDK ${LD_RELEASE_VERSION}"
+
+install: $(PHPDOC_ARCHIVE)
+
+$(PHPDOC_ARCHIVE):
+	mkdir -p build
+	cd build && unzip ../lib/phpDocumentor.phar.zip
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdoc>
+  <parser>
+    <target>docs/build/temp</target>
+  </parser>
+  <transformer>
+    <target>docs/build/html</target>
+  </transformer>
+  <files>
+    <directory>src</directory>
+    <ignore>src/LaunchDarkly/Impl/*</ignore>
+    <ignore>src/LaunchDarkly/Impl/Integrations/*</ignore>
+    <!-- the @ignore and @internal tags currently not working correctly in phpDocumentor, so we will manually ignore these internal files: -->
+    <ignore>src/LaunchDarkly/Clause.php</ignore>
+    <ignore>src/LaunchDarkly/EvalResult.php</ignore>
+    <ignore>src/LaunchDarkly/EvaluationException.php</ignore>
+    <ignore>src/LaunchDarkly/EventProcessor.php</ignore>
+    <ignore>src/LaunchDarkly/EventSerializer.php</ignore>
+    <ignore>src/LaunchDarkly/FeatureFlag.php</ignore>
+    <ignore>src/LaunchDarkly/Operators.php</ignore>
+    <ignore>src/LaunchDarkly/PreloadedFeatureRequester.php</ignore>
+    <ignore>src/LaunchDarkly/Prerequisite.php</ignore>
+    <ignore>src/LaunchDarkly/Rollout.php</ignore>
+    <ignore>src/LaunchDarkly/Rule.php</ignore>
+    <ignore>src/LaunchDarkly/Segment.php</ignore>
+    <ignore>src/LaunchDarkly/SegmentRule.php</ignore>
+    <ignore>src/LaunchDarkly/SemanticVersion.php</ignore>
+    <ignore>src/LaunchDarkly/Target.php</ignore>
+    <ignore>src/LaunchDarkly/UnrecoverableHTTPStatusException.php</ignore>
+    <ignore>src/LaunchDarkly/Util.php</ignore>
+    <ignore>src/LaunchDarkly/VariationOrRollout.php</ignore>
+    <ignore>src/LaunchDarkly/WeightedVariation.php</ignore>
+  </files>
+  <transformations>
+    <template name="clean"/>
+  </transformations>
+  <title>
+    LaunchDarkly PHP SDK
+  </title>
+</phpdoc> 
diff --git a/src/LaunchDarkly/ApcLDDFeatureRequester.php b/src/LaunchDarkly/ApcLDDFeatureRequester.php
@@ -5,14 +5,13 @@
 use LaunchDarkly\Impl\Integrations\RedisFeatureRequester;
 
 /**
- * Deprecated feature requester from an LDD-populated Redis, with APC caching.
+ * Deprecated integration class for reading flags from a Redis database, with APC caching.
  *
- * @deprecated Per the docs (http://php.net/manual/en/intro.apc.php):
- * "This extension (APC) is considered unmaintained and dead".
+ * The APC extension (http://php.net/manual/en/intro.apc.php) is no longer maintained and has been
+ * replaced by APCu. The new Redis integration which uses APCu caching is
+ * {@link \LaunchDarkly\Integrations\Redis::featureRequester()}.
  *
- * Install APCu and use {@link \LaunchDarkly\Integrations\Redis::featureRequester()} instead!
- *
- * @package LaunchDarkly
+ * @deprecated use Redis::featureRequester()
  */
 class ApcLDDFeatureRequester extends RedisFeatureRequester
 {

diff --git a/src/LaunchDarkly/ApcuLDDFeatureRequester.php b/src/LaunchDarkly/ApcuLDDFeatureRequester.php
@@ -6,16 +6,14 @@
 use LaunchDarkly\Impl\Integrations\RedisFeatureRequester;
 
 /**
- * Feature requester from an LDD-populated redis, with APCu caching.
+ * Deprecated integration class for reading flags from a Redis database, with APCu caching.
  *
  * Unlike APC, APCu is actively maintained and is available from php53 to php7.
  *
  * This class is deprecated. Use {@link \LaunchDarkly\Integrations\Redis::featureRequester()}
  * and set the `apc_expiration` option.
  *
  * @deprecated Use {@link \LaunchDarkly\Integrations\Redis::featureRequester()} and set the `apc_expiration` option.
- *
- * @package LaunchDarkly
  */
 class ApcuLDDFeatureRequester extends RedisFeatureRequester
 {

diff --git a/src/LaunchDarkly/Clause.php b/src/LaunchDarkly/Clause.php
@@ -2,6 +2,14 @@
 
 namespace LaunchDarkly;
 
+/**
+ * Internal data model class that describes a clause within a feature flag rule or segment rule.
+ *
+ * Application code should never need to reference the data model directly.
+ *
+ * @ignore
+ * @internal
+ */
 class Clause
 {
     /** @var string */

diff --git a/src/LaunchDarkly/EvalResult.php b/src/LaunchDarkly/EvalResult.php
@@ -2,6 +2,12 @@
 
 namespace LaunchDarkly;
 
+/**
+ * Internal class that holds intermediate flag evaluation results.
+ *
+ * @ignore
+ * @internal
+ */
 class EvalResult
 {
     /** @var EvaluationDetail */

diff --git a/src/LaunchDarkly/EvaluationDetail.php b/src/LaunchDarkly/EvaluationDetail.php
@@ -3,8 +3,9 @@
 namespace LaunchDarkly;
 
 /**
- * An object returned by LDClient.variationDetail(), combining the result of a flag evaluation with
- * an explanation of how it was calculated.
+ * An object that combines the result of a flag evaluation with an explanation of how it was calculated.
+ *
+ * This is returned by {@link \LaunchDarkly\LDClient::variationDetail()}.
  */
 class EvaluationDetail
 {

diff --git a/src/LaunchDarkly/EvaluationException.php b/src/LaunchDarkly/EvaluationException.php
@@ -3,6 +3,13 @@
 
 use Exception;
 
+/**
+ * Obsolete internal exception class, no longer used. Will be removed in a future version.
+ *
+ * @deprecated
+ * @ignore
+ * @internal
+ */
 class EvaluationException extends Exception
 {
     /**

diff --git a/src/LaunchDarkly/EvaluationReason.php b/src/LaunchDarkly/EvaluationReason.php
@@ -3,69 +3,81 @@
 namespace LaunchDarkly;
 
 /**
- * Describes the reason that a flag evaluation produced a particular value. This is part of
- * the EvaluationDetail object returned by LDClient.variationDetail().
+ * Describes the reason that a flag evaluation produced a particular value.
+ *
+ * This is part of the {@link \LaunchDarkly\EvaluationDetail} object returned by {@link \LaunchDarkly\LDClient::variationDetail()}.
  */
 class EvaluationReason implements \JsonSerializable
 {
     /**
      * A possible value for getKind(): indicates that the flag was off and therefore returned
      * its configured off value.
+     * @var string
      */
     const OFF = 'OFF';
     /**
      * A possible value for getKind(): indicates that the flag was on but the user did not
      * match any targets or rules.
+     * @var string
      */
     const FALLTHROUGH = 'FALLTHROUGH';
     /**
      * A possible value for getKind(): indicates that the user key was specifically targeted
      * for this flag.
+     * @var string
      */
     const TARGET_MATCH = 'TARGET_MATCH';
     /**
      * A possible value for getKind(): indicates that the user matched one of the flag's rules.
+     * @var string
      */
     const RULE_MATCH = 'RULE_MATCH';
     /**
      * A possible value for getKind(): indicates that the flag was considered off because it
      * had at least one prerequisite flag that either was off or did not return the desired variation.
+     * @var string
      */
     const PREREQUISITE_FAILED = 'PREREQUISITE_FAILED';
     /**
      * A possible value for getKind(): indicates that the flag could not be evaluated, e.g.
      * because it does not exist or due to an unexpected error.
+     * @var string
      */
     const ERROR = 'ERROR';
 
     /**
      * A possible value for getErrorKind(): indicates that the caller tried to evaluate a flag
      * before the client had successfully initialized.
+     * @var string
      */
     const CLIENT_NOT_READY_ERROR = 'CLIENT_NOT_READY';
 
     /**
      * A possible value for getErrorKind(): indicates that the caller provided a flag key that
      * did not match any known flag.
+     * @var string
      */
     const FLAG_NOT_FOUND_ERROR = 'FLAG_NOT_FOUND';
 
     /**
      * A possible value for getErrorKind(): indicates that there was an internal inconsistency
      * in the flag data, e.g. a rule specified a nonexistent variation. An error message will
      * always be logged in this case.
+     * @var string
      */
     const MALFORMED_FLAG_ERROR = 'MALFORMED_FLAG';
 
     /**
      * A possible value for getErrorKind(): indicates that the caller passed null for the user
      * parameter, or the user lacked a key.
+     * @var string
      */
     const USER_NOT_SPECIFIED_ERROR = 'USER_NOT_SPECIFIED';
 
     /**
      * A possible value for getErrorKind(): indicates that an unexpected exception stopped flag
      * evaluation.
+     * @var string
      */
     const EXCEPTION_ERROR = 'EXCEPTION';
 
@@ -77,6 +89,7 @@ class EvaluationReason implements \JsonSerializable
 
     /**
      * Creates a new instance of the OFF reason.
+     * @return EvaluationReason
      */
     public static function off()
     {
@@ -85,6 +98,7 @@ public static function off()
 
     /**
      * Creates a new instance of the FALLTHROUGH reason.
+     * @return EvaluationReason
      */
     public static function fallthrough()
     {
@@ -93,6 +107,7 @@ public static function fallthrough()
 
     /**
      * Creates a new instance of the TARGET_MATCH reason.
+     * @return EvaluationReason
      */
     public static function targetMatch()
     {
@@ -101,6 +116,7 @@ public static function targetMatch()
 
     /**
      * Creates a new instance of the RULE_MATCH reason.
+     * @return EvaluationReason
      */
     public static function ruleMatch($ruleIndex, $ruleId)
     {
@@ -109,6 +125,7 @@ public static function ruleMatch($ruleIndex, $ruleId)
 
     /**
      * Creates a new instance of the PREREQUISITE_FAILED reason.
+     * @return EvaluationReason
      */
     public static function prerequisiteFailed($prerequisiteKey)
     {
@@ -117,6 +134,7 @@ public static function prerequisiteFailed($prerequisiteKey)
 
     /**
      * Creates a new instance of the ERROR reason.
+     * @return EvaluationReason
      */
     public static function error($errorKind)
     {

diff --git a/src/LaunchDarkly/EventProcessor.php b/src/LaunchDarkly/EventProcessor.php
@@ -4,6 +4,9 @@
 use LaunchDarkly\Integrations\Curl;
 
 /**
+ * Internal class that processes analytics event data.
+ *
+ * @ignore
  * @internal
  */
 class EventProcessor