[FSSDK-9630] Fix: Code examples (#281)

* Fix: Add ReturnTypeWillChange attribute

* Enhancement: Keep packages sorted in composer.json

* Fix: Wrap arguments in code examples

* Fix: Code examples

---------

Co-authored-by: Andreas Möller <[email protected]>

Author: mikechu-optimizely

Diff for: README.md

@@ -37,25 +37,55 @@ php composer.phar require optimizely/optimizely-sdk
 Create the Optimizely client, for example:
 
 ```php
+<?php
+
+use Optimizely\Optimizely;
+
 $optimizely = new Optimizely(<<DATAFILE>>);
 ```
 
 Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key, an optional fallback datafile and an optional datafile access token. Using this method internally creates an HTTPProjectConfigManager. See [HTTPProjectConfigManager](#use-httpprojectconfigmanager) for further detail.
 
 ```php
-$optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>, <<DATAFILE_AUTH_TOKEN>>);
+<?php
+
+use Optimizely\OptimizelyFactory;
+
+$optimizelyClient = OptimizelyFactory::createDefaultInstance(
+    "your-sdk-key",
+    <<DATAFILE>>,
+    <<DATAFILE_AUTH_TOKEN>>
+);
 ```
 To access your HTTPProjectConfigManager:
 
 ```php
+<?php
+
+use Optimizely\Optimizely;
+
+/** @var Optimizely $optimizelyClient */
 $configManager = $optimizelyClient->configManager;
 ```
 
 Or you can also provide an implementation of the [`ProjectConfigManagerInterface`](https://github.com/optimizely/php-sdk/blob/master/src/Optimizely/ProjectConfigManager/ProjectConfigManagerInterface.php) in the constructor:
 
 ```php
+<?php
+
+use Optimizely\Optimizely;
+use Optimizely\ProjectConfigManager\HTTPProjectConfigManager;
+
 $configManager = new HTTPProjectConfigManager(<<SDK_KEY>>);
-$optimizely = new Optimizely(<<DATAFILE>>, null, null, null, false, null, $configManager);
+$optimizely = new Optimizely(
+    <<DATAFILE>>,
+    null,
+    null,
+    null,
+    false,
+    null,
+    $configManager
+);
 ```
 
 ### ProjectConfigManagerInterface
@@ -74,6 +104,10 @@ Calling `fetch` will update the internal ProjectConfig instance that will be ret
 ### Use HTTPProjectConfigManager
 
 ```php
+<?php
+
+use Optimizely\ProjectConfigManager\HTTPProjectConfigManager;
+
 $configManager = new HTTPProjectConfigManager(<<SDK_KEY>>);
 ```
 

Diff for: composer.json

@@ -16,9 +16,9 @@
   },
   "require": {
     "php": ">=8.1",
+    "guzzlehttp/guzzle": ">=6.2",
     "justinrainbow/json-schema": "^1.6 || ^2.0 || ^4.0 || ^5.0",
     "lastguest/murmurhash": "^1.3.0",
-    "guzzlehttp/guzzle": ">=6.2",
     "monolog/monolog": ">=1.21"
   },
   "require-dev": {
@@ -31,5 +31,8 @@
     "psr-4": {
       "Optimizely\\": "src/Optimizely"
     }
+  },
+  "config": {
+    "sort-packages": true
   }
 }

Diff for: composer.lock

@@ -81,6 +81,7 @@ public function getReasons()
         return $this->reasons;
     }
 
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return get_object_vars($this);

Diff for: src/Optimizely/Decide/OptimizelyDecision.php

@@ -53,6 +53,7 @@ public function getKey()
     /**
      * @return string JSON representation of the object.
      */
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return get_object_vars($this);

Diff for: src/Optimizely/OptimizelyConfig/OptimizelyAttribute.php

@@ -68,6 +68,7 @@ public function getConditions()
     /**
      * @return string JSON representation of the object.
      */
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return get_object_vars($this);

Diff for: src/Optimizely/OptimizelyConfig/OptimizelyAudience.php

@@ -166,6 +166,7 @@ public function getEvents()
     /**
      * @return string JSON representation of the object.
      */
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return get_object_vars($this);

Diff for: src/Optimizely/OptimizelyConfig/OptimizelyConfig.php

@@ -68,6 +68,7 @@ public function getExperimentIds()
     /**
      * @return string JSON representation of the object.
      */
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return get_object_vars($this);

Diff for: src/Optimizely/OptimizelyConfig/OptimizelyEvent.php

@@ -83,6 +83,7 @@ public function getVariationsMap()
     /**
      * @return string JSON representation of the object.
      */
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return get_object_vars($this);

Diff for: src/Optimizely/OptimizelyConfig/OptimizelyExperiment.php

@@ -118,6 +118,7 @@ public function getVariablesMap()
     /**
      * @return string JSON representation of the object.
      */
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return get_object_vars($this);

Diff for: src/Optimizely/OptimizelyConfig/OptimizelyFeature.php

@@ -82,6 +82,7 @@ public function getValue()
     /**
      * @return string JSON representation of the object.
      */
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return get_object_vars($this);

Diff for: src/Optimizely/OptimizelyConfig/OptimizelyVariable.php

@@ -84,6 +84,7 @@ public function getVariablesMap()
      * @return string JSON representation of the object.
      *                Unsets featureEnabled property for variations of ab experiments.
      */
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         $props = get_object_vars($this);