PHP download

Download the PHP package simpleab/sdk-php without Composer

On this page you can find all versions of the php package simpleab/sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download simpleab/sdk-php
More information about simpleab/sdk-php
Files in simpleab/sdk-php

Vendor simpleab
Package sdk-php
Short Description PHP SDK for Captchify's SimpleAB A/B testing platform
License MIT

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of simpleab/sdk-php

Informations about the package sdk-php

SimpleAB PHP SDK

This is the PHP SDK for SimpleAB, a powerful A/B testing platform by Captchify.

Installation

You can install the SimpleAB PHP SDK via Composer:

Usage

Here's a basic example of how to use the SimpleAB PHP SDK:

API Reference

SimpleABSDK

Constructor

$apiURL: The URL of the SimpleAB API. Use BaseAPIUrls::CAPTCHIFY_NA for the North America API.
$apiKey: Your SimpleAB API key.
$experiments: (Optional) An array of experiment IDs to preload.

getTreatment

Gets the treatment for a given experiment, stage, dimension, and allocation key.

$experimentID: The ID of the experiment.
$stage: The stage of the experiment. Use Stages::PROD or Stages::BETA.
$dimension: The dimension of the experiment.
$allocationKey: The allocation key for the user.

trackMetric

Tracks a metric for an experiment. The $params array should include:

experimentID: The ID of the experiment.
stage: The stage of the experiment. Use Stages::PROD or Stages::BETA.
dimension: The dimension of the experiment.
treatment: The treatment assigned to the user.
metricName: The name of the metric being tracked.
metricValue: The value of the metric.
aggregationType: The type of aggregation for the metric. Use AggregationTypes::SUM, AggregationTypes::AVERAGE, or AggregationTypes::PERCENTILE.

getSegment

Gets a segment for a user based on their IP address and user agent.

$options: An array containing:
- ip: The IP address of the user.
- userAgent: The user agent string of the user's browser.

Returns a Segment object.

getTreatmentWithSegment

Gets the treatment for a given experiment, stage, segment, and allocation key.

$experimentID: The ID of the experiment.
$stage: The stage of the experiment. Use Stages::PROD or Stages::BETA.
$segment: A Segment object obtained from getSegment().
$allocationKey: The allocation key for the user.

trackMetricWithSegment

Tracks a metric for an experiment using a segment. The $params array should include:

experimentID: The ID of the experiment.
stage: The stage of the experiment. Use Stages::PROD or Stages::BETA.
segment: A Segment object obtained from getSegment().
treatment: The treatment assigned to the user.
metricName: The name of the metric being tracked.
metricValue: The value of the metric.
aggregationType: The type of aggregation for the metric. Use AggregationTypes::SUM, AggregationTypes::AVERAGE, or AggregationTypes::PERCENTILE.

flush

Flushes all tracked metrics to the SimpleAB API. Call this method before your script ends to ensure all metrics are sent.

Segment

The Segment class represents a user segment based on their location and device type.

File Structure

The SDK consists of the following files:

src/SimpleABSDK.php: The main SDK class.
md5.php: A fallback MD5 implementation.
composer.json: Composer package definition.
LICENSE: MIT License file.
.gitignore: Git ignore file.
README.md: This file.
tests/SimpleABSDKTest.php: Unit tests for the SDK.

Development

To set up the project for development:

Clone the repository.
Run composer install to install dependencies.
Make your changes in the src/SimpleABSDK.php file.
Add or modify tests in the tests directory.

Running Tests

To run the unit tests for the SimpleAB PHP SDK, follow these steps:

Ensure you have PHPUnit installed. It should be installed automatically when you run composer install.
From the root directory of the project, run the following command:

This will execute all the tests in the tests directory.
To run a specific test file, you can specify the file name:
For more detailed output, you can use the --verbose flag:

Make sure to run the tests after making any changes to the SDK to ensure that everything is working as expected.

License

This SDK is distributed under the MIT License. See the LICENSE file for more information.

Support

For support, please contact [email protected] or visit our documentation at https://captchify.com.

All versions of sdk-php with dependencies

PHP Build Version

Package Version

Version 1.0.0 Release 05. Oct 2024
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of sdk-php from vendor simpleab

Requires php Version >=7.4

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package simpleab/sdk-php contains the following files

Loading the files please wait ...