VWO PHP SDK

VWO server side sdk helps in integrating you integrating the vwo features in backend. Using the sdk you can fetch the campaigns , variations and goals which you have configured in vwo app. Sdk will automatically calculate the variation that should be assigned to the user. One can also send the goal track data to vwo app to check the conversions on the vwo dashborad.

Requirements

• PHP 5.6 or later

Installation

Install the latest version with

$ composer require vwo/vwo-php-sdk

Basic Usage

Use the below code for inital setup.

<?php

require_once('vendor/autoload.php');
require_once('userProfile.php'); // Optional :if you are using userProfile service feature
require_once('customLogger.php');// Optional :if you are using custom logging feature


use vwo\VWO;


$account_id=123456;
$sdk_key='loremipsum1234567890';
$campaignKey='LOREM_IPSUM';
$userId='Test';
$goalIdentifier='LOREM';


// to fetch the settings i.e campaigns, variations and goals 
$settings=VWO::getSettingsFile($account_id,$sdk_key);
$config=['settings'=>$settings,
    'isDevelopmentMode'=>0,  // optional: 1 to enable the dev mode 
    'logging'=>new CustomLogger(), // optional 
    'userProfileService'=> new userProfile() // optional
];

$vwoClient = new VWO($config);

// to get the variation name along with add a visitor hit to vwo app stats 
$varient=$vwoClient->activate($campaignKey,$userId);


// to get the variation name 
$varient=$vwoClient->getVariation($campaignKey,$userId);


// add code here to use variation 
//...



/**
*send the track api hit to the vwo app stats to increase conversions
* $revenue is optional send in case if there is any revenue 
*/

$vwoClient->track($campaignKey,$userId,$goalIdentifier,$revenue);

Code for UserProfile service

<?php
require_once('vendor/autoload.php');
use vwo\Utils\UserProfileInterface;
Class UserProfile implements UserProfileInterface{

    /**
     * @param $userId
     * @param $campaignName
     * @return string
     */
    public function lookup($userId,$campaignName){
        // xyz actions     
       return[
            'userId'=>$userId,
            $campaignName=>['variationName'=>'Control']
        ];

    }

    /**
     * @param $campaignInfo
     * @return bool
     */
    public function save($campaignInfo){
       // print_r($campaignInfo);
        return True;

    }

}

Code for customLogger file

<?php
require_once('vendor/autoload.php');
use vwo\Logger\LoggerInterface;

/**
 * Class CustomLogger
 */
Class CustomLogger implements LoggerInterface{

    /**
     * @param $message
     * @param $level
     * @return string
     */
    public function addLog($message,$level){
        //do code for writing logs to your files/databases
        //throw new Exception('my test');
        //return $x;

    }

}

Code Snippets

Use the code below to fetch settings

// to fetch the settings i.e campaigns, variations and goals 
$settings=VWO::getSettings($account_id,$sdk_key);

Use the code below to create a vwo instance

$config=['settings'=>$settings,
    'isDevelopmentMode'=>0,  // optional: 1 to enable the dev mode 
    'logger'=>new CustomLogger(), // optional 
    'userProfileService'=> new userProfile() // optional
];

$vwoClient = new VWO($config);

Use the code below to both activate campaign for a user and fetch variation name

// to get the variation name along with add a visitor hit to vwo app stats 
$varient=$vwoClient->activate($campaignKey,$userId);

Use the code below to get variation name

// to get the variation name along with add a visitor hit to vwo app stats 
$varient=$vwoClient->getVariation($campaignKey,$userId);

Use the code below to track

/**
*send the track api hit to the vwo app stats to increase conversions
* $revenue is optional send in case if there is any revenue 
*/

$vwoClient->track($campaignKey,$userId,$goalIdentifier,$revenue);

Documentation

Refer Official VWO Documentation

Third Party Packages

• Monolog
• ramsey/uuid
• justinrainbow/json-schema
• phpunit/phpunit
• psr-4 (standard followed)

License

    MIT License

    Copyright (c) 2019 Wingify Software Pvt. Ltd.

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.