Niko/PHP-Docs-to-new-template #552

nikomancy · 2024-12-16T06:20:48Z

What

Updated the PHP docs to follow a similar template to the node docs.

Why?

The goal is to make the learning journey for engineers working with specific SDKs easier.
Content is easier to find in the TOC improving navigability.
Code samples for typed examples have been added for ease of use.
Boilerplate prose docs have been added to allow engineers to learn about relevant conceptual information along side the code without having to context switch to other parts of the docs.

Review Instructions

Due to me not knowing PHP, we are missing code samples for bandits.
All net new code samples in this are untested and need to be validated by someone who actually knows PHP.

Todo before merge

Add bandit code samples
Update redirects
Delete php.md file

netlify · 2024-12-16T06:21:07Z

✅ Deploy Preview for eppo-data-docs ready!

Name	Link
🔨 Latest commit	`9105887`
🔍 Latest deploy log	https://app.netlify.com/sites/eppo-data-docs/deploys/675fc6c272fff900084e9935
😎 Deploy Preview	https://deploy-preview-552--eppo-data-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

typotter

Hi Niko,
Thanks for reorganizing our docs! I know there's a lot (and all written by different people). Big undertaking 💪

I apologize that the docs you had to start with were out of date. When the PHP SDK was last touched, the updated APIs were captured only in the repository's README and EppoClient.php

I copied over a number of code samples as suggestions you should hopefully be able to just drop in.

typotter · 2024-12-20T22:57:02Z

docs/sdks/server-sdks/php/intro.mdx

+---
+import FeatureCard from '/src/components/FeatureCard';
+
+The Eppo PHP SDK allows you to manage feature flags and experiments in your PHP applications.


The SDKs allow developers to use feature flags and experiments within their applications. "manage" implies being able to edit or make changes to the flags.

typotter · 2024-12-20T23:11:52Z

docs/sdks/server-sdks/php/quickstart.mdx

+$eppoClient = EppoClient::init(
+   "<your_sdk_key>",
+   "<base_url>", // optional, default https://eppo.cloud/api
+   $assignmentLogger, // optional, must be an instance of Eppo\LoggerInterface
+   $cache // optional, must be an instance of PSR-6 CacheInterface. If not passed, FileSystem cache will be used
+);


Suggested change

$eppoClient = EppoClient::init(

"<your_sdk_key>",

"<base_url>", // optional, default https://eppo.cloud/api

$assignmentLogger, // optional, must be an instance of Eppo\LoggerInterface

$cache // optional, must be an instance of PSR-6 CacheInterface. If not passed, FileSystem cache will be used

);

$eppoClient = EppoClient::init(

'<your_api_key>',

'<base_url>', // optional, default https://fscdn.eppo.cloud/api

$assignmentLogger, // optional, must be an instance of Eppo\Logger\LoggerInterface

$cache // optional, must be an instance of PSR-16 SimpleCache\CacheInterface. If not passed, FileSystem cache will be used

$httpClient // optional, must be an instance of PSR-18 ClientInterface. If not passed, Discovery will be used to find a suitable implementation

$requestFactory // optional, must be an instance of PSR-17 Factory. If not passed, Discovery will be used to find a suitable implementation

);

typotter · 2024-12-20T23:40:24Z

docs/sdks/server-sdks/php/quickstart.mdx

+$subjectAttributes = [];
+$variation = $eppoClient->getStringAssignment('subject-1', 'experiment_5', $subjectAttributes);
+
+if ($variation === 'control') {
+    // do something
+}


Suggested change

$subjectAttributes = [];

$variation = $eppoClient->getStringAssignment('subject-1', 'experiment_5', $subjectAttributes);

if ($variation === 'control') {

// do something

}

$subjectAttributes = [ 'tier' => 2 ];

$assignment = $eppoClient->getStringAssignment('experimentalBackground', 'user123', $subjectAttributes, 'control');

if ($assignment !== 'control') {

// do something special

} else {

// Show the default treatment

}

typotter · 2024-12-20T23:41:06Z

docs/sdks/server-sdks/php/quickstart.mdx

+
+## Experiments 
+
+For experiments, you'll need to implement logging. Here's a basic example:


here is an example which logs to Segment
https://github.com/Eppo-exp/php-sdk/blob/main/README.md#assignment-logger

typotter · 2024-12-20T23:43:48Z

docs/sdks/server-sdks/php/quickstart.mdx

+use Eppo\Logger\LoggerInterface;
+
+class Logger implements LoggerInterface {
+  public function logAssignment(


logAssignment just takes an AssignmentEvent parameter (see example above). The AssignmentEvent class has the following shape

public string $experiment, public string $variation, public string $allocation, public string $featureFlag, public string $subject, public float $timestamp, public array $subjectAttributes = [], public array $sdkMetadata = [], public array $extraLogging = []

typotter · 2024-12-20T23:59:11Z

docs/sdks/server-sdks/php/initialization.mdx

+  public function logAssignment(
+    string $experiment,
+    string $variation,
+    string $subject,
+    string $timestamp,
+    array $subjectAttributes = []
+  ) {


Suggested change

public function logAssignment(

string $experiment,

string $variation,

string $subject,

string $timestamp,

array $subjectAttributes = []

) {

public function logAssignment(AssignmentEvent $assignmentEvent) {

typotter · 2024-12-21T00:00:00Z

docs/sdks/server-sdks/php/initialization.mdx

+}
+```
+
+The logger receives these parameters:


See AssignmentEvent

typotter · 2024-12-21T00:00:59Z

docs/sdks/server-sdks/php/assignments.mdx

+It may take up to 10 seconds for changes to Eppo experiments to be reflected by the SDK assignments.
+:::
+
+## Assignment Logger Schema


please update to schema in AssignmentEvent

typotter · 2024-12-21T00:01:18Z

docs/sdks/server-sdks/php/assignments.mdx

+getBooleanAssignment(...)
+getNumericAssignment(...)
+getJSONStringAssignment(...)
+getParsedJSONAssignment(...)


Suggested change

getBooleanAssignment(...)

getNumericAssignment(...)

getJSONStringAssignment(...)

getParsedJSONAssignment(...)

getBooleanAssignment(...)

getNumericAssignment(...)

getIntegerAssignment(...)

getStringAssignment(...)

getJSONAssignment(...)

typotter · 2024-12-21T00:02:03Z

docs/sdks/server-sdks/php/assignments.mdx

+
+### Logging Examples
+
+[Placeholder: Need PHP-specific examples for logging to different services (Segment, Rudderstack, mParticle, Snowplow)]


segment logger example: https://github.com/Eppo-exp/php-sdk/blob/main/README.md#assignment-logger

Adding baseline PHP docs

9105887

nikomancy requested review from aarsilv and emetelka December 16, 2024 06:20

aarsilv requested a review from typotter December 18, 2024 21:24

aarsilv assigned typotter Dec 18, 2024

typotter requested changes Dec 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Niko/PHP-Docs-to-new-template #552

Niko/PHP-Docs-to-new-template #552

nikomancy commented Dec 16, 2024

netlify bot commented Dec 16, 2024 •

edited

Loading

typotter left a comment

typotter Dec 20, 2024

typotter Dec 20, 2024

typotter Dec 20, 2024

typotter Dec 20, 2024

typotter Dec 20, 2024

typotter Dec 20, 2024

typotter Dec 21, 2024

typotter Dec 21, 2024

typotter Dec 21, 2024

typotter Dec 21, 2024

-$subjectAttributes = [];
-$variation = $eppoClient->getStringAssignment('subject-1', 'experiment_5', $subjectAttributes);
-if ($variation === 'control') {
-    // do something
-}
+$subjectAttributes = [ 'tier' => 2 ];
+$assignment = $eppoClient->getStringAssignment('experimentalBackground', 'user123', $subjectAttributes, 'control');
+if ($assignment !== 'control') {
+    // do something special
+} else {
+  // Show the default treatment
+}


		## Experiments

		For experiments, you'll need to implement logging. Here's a basic example:


		### Logging Examples

		[Placeholder: Need PHP-specific examples for logging to different services (Segment, Rudderstack, mParticle, Snowplow)]

Niko/PHP-Docs-to-new-template #552

Are you sure you want to change the base?

Niko/PHP-Docs-to-new-template #552

Conversation

nikomancy commented Dec 16, 2024

What

Why?

Review Instructions

Todo before merge

netlify bot commented Dec 16, 2024 • edited Loading

✅ Deploy Preview for eppo-data-docs ready!

typotter left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Dec 16, 2024 •

edited

Loading