Add documentation

Author: arun251

README.md

@@ -0,0 +1,31 @@
+LaunchDarkly SDK for PHP
+===========================
+
+Quick setup
+-----------
+
+0. Install the PHP SDK with [Composer](https://getcomposer.org/)
+
+        php composer.phar require launchdarkly/launchdarkly-php
+
+1. After installing, require Composer's autoloader:
+
+		require 'vendor/autoload.php';
+
+2. Create a new LDClient with your API key:
+
+        $client = new LaunchDarkly\LDClient("your_api_key");
+
+Your first feature flag
+-----------------------
+
+1. Create a new feature flag on your [dashboard](https://app.launchdarkly.com)
+
+2. In your application code, use the feature's key to check whether the flag is on for each user:
+
+		$user = new LaunchDarkly\LDUser("[email protected]");
+        if ($client->getFlag("your.flag.key", $user)) {
+            # application code to show the feature
+        } else {
+            # the code to run if the feature is off
+        }

src/LaunchDarkly/FeatureRep.php

@@ -1,6 +1,9 @@
 <?php
 namespace LaunchDarkly;
 
+/**
+ * @internal
+ */
 class FeatureRep {
     protected static $LONG_SCALE = 0xFFFFFFFFFFFFFFF;
 

src/LaunchDarkly/LDClient.php

@@ -4,6 +4,9 @@
 use \GuzzleHttp\Exception\BadResponseException;
 use \GuzzleHttp\Subscriber\Cache\CacheSubscriber;
 
+/**
+ * A client for the LaunchDarkly API.
+ */
 class LDClient {
     const DEFAULT_BASE_URI = 'https://app.launchdarkly.com';
     const VERSION = '0.1.0';
@@ -12,6 +15,16 @@ class LDClient {
     protected $_baseUri;
     protected $_client;
 
+    /**
+     * Creates a new client instance that connects to LaunchDarkly.
+     *
+     * @param string $apiKey  The API key for your account
+     * @param array  $options Client configuration settings
+     *     - base_uri: Base URI of the LaunchDarkly API. Defaults to `DEFAULT_BASE_URI`
+     *     - timeout: Float describing the maximum length of a request in seconds. Defaults to 3
+     *     - connect_timeout: Float describing the number of seconds to wait while trying to connect to a server. Defaults to 3
+     *     - cache_storage: An optional GuzzleHttp\Subscriber\Cache\CacheStorageInterface. Defaults to an in-memory cache.
+     */
     public function __construct($apiKey, $options = []) {
         $this->_apiKey = $apiKey;
         $this->_baseUri = $options['base_uri'] ? rtrim($options['base_uri'], '/') : self::DEFAULT_BASE_URI;
@@ -25,6 +38,15 @@ public function __construct($apiKey, $options = []) {
         $this->_client = $this->_make_client($options);
     }
 
+   /** 
+    * Calculates the value of a feature flag for a given user.
+    *
+    * @param string  $key     The unique key for the feature flag
+    * @param LDUser  $user    The end user requesting the flag
+    * @param boolean $default The default value of the flag
+    *
+    * @return boolean Whether or not the flag should be enabled, or `default` if the flag is disabled in the LaunchDarkly control panel
+    */
     public function getFlag($key, $user, $default = false) {
         try {
             $flag = $this->_getFlag($key, $user, $default);

src/LaunchDarkly/LDUser.php

@@ -1,13 +1,25 @@
 <?php
 namespace LaunchDarkly;
 
+/**
+ * Contains specific attributes of a user browsing your site. The only mandatory property property is the key,
+ * which must uniquely identify each user. For authenticated users, this may be a username or e-mail address. For anonymous users,
+ * this could be an IP address or session ID.
+ */
 class LDUser {
     protected $_key = null;
     protected $_secondary = null;
     protected $_ip = null;
     protected $_country = null;
     protected $_custom = [];
 
+    /**
+     * @param string      $key       Unique key for the user. For authenticated users, this may be a username or e-mail address. For anonymous users, this could be an IP address or session ID.
+     * @param string|null $secondary An optional secondary identifier
+     * @param string|null $ip        The user's IP address (optional)
+     * @param string|null $country   The user's country, as an ISO 3166-1 alpha-2 code (e.g. 'US') (optional)
+     * @param array       $custom    Other custom attributes that can be used to create custom rules
+     */
     public function __construct($key, $secondary = null, $ip = null, $country = null, $custom = []) {
         $this->_key = $key;
         $this->_secondary = $secondary;
@@ -16,7 +28,6 @@ public function __construct($key, $secondary = null, $ip = null, $country = null
         $this->_custom = $custom;
     }
 
-
     public function getCountryCode() {
         return $this->_country;
     }

src/LaunchDarkly/TargetRule.php

@@ -1,6 +1,9 @@
 <?php
 namespace LaunchDarkly;
 
+/**
+ * @internal
+ */
 class TargetRule {
     protected $_attribute = null;
     protected $_operator = null;

src/LaunchDarkly/Variation.php

@@ -1,6 +1,9 @@
 <?php
 namespace LaunchDarkly;
 
+/**
+ * @internal
+ */
 class Variation {
     protected $_value = null;
     protected $_weight = 0;