adback/adback-sdk-php

用于调用 AdBack API 的 PHP SDK

v2.5.0 2018-06-28 15:21 UTC

This package is auto-updated.

Last update: 2024-09-12 05:32:26 UTC


README

Scrutinizer Code Quality Code Coverage Build Status Latest Stable Version Total Downloads License

此 PHP 库将调用 AdBack API 并生成应在所有页面上放置的 JavaScript 标签。

有关更多信息,请参阅 AdBack 网站

有关安装指南,请参阅 AdBack 文档

用法

Query 和 Generators 都需要一个实现 ScriptCacheInterface 的驱动程序才能工作。

已提供 Redis 驱动程序。

用法示例

安装

使用 composer 安装库

    composer require adback/adback-sdk-php

使用 Redis 的用法

查询 API

首先您需要查询 API 以在 Redis 数据存储中预热缓存

    use Adback\ApiClient\Client\Client;
    use Adback\ApiClient\Driver\RedisScriptCache;
    use Adback\ApiClient\Query\ScriptUrlQuery;

    function createApiCache()
    {
        $client = new Client();
        $redis = new \Redis();
        $redis->connect('127.0.0.1');
        $redisCache = new RedisScriptCache($redis);

        $query = new ScriptUrlQuery($client, $redisCache, 'your-token');
        $query->execute();
    }

    createApiCache();

生成脚本

在您的页面上(最好在 <head> 中),使用生成器创建脚本

    use Adback\ApiClient\Driver\RedisScriptCache;
    use Adback\ApiClient\Generator\AnalyticsScriptGenerator;

    function generateAnalyticsScript()
    {
        $redis = new \Redis();
        $redis->connect('127.0.0.1');
        $redisCache = new RedisScriptCache($redis);
        $generator = new AnalyticsScriptGenerator($redisCache);

        return $generator->generate();
    }

    echo generateAnalyticsScript();

您可以使用适当的生成器通过相同的方式创建其他脚本。

使用 MySQL 的用法

创建表

要创建用于在 MySQL 中存储数据的表,请运行查询

    CREATE TABLE adback_cache_table(our_key varchar(255), our_value varchar(255));

使用 PDO 驱动程序

查询 API

首先您需要查询 API 以在 MySQL 表中预热缓存

    use Adback\ApiClient\Client\Client;
    use Adback\ApiClient\Driver\PdoScriptCache;
    use Adback\ApiClient\Query\ScriptUrlQuery;

    function createApiCache()
    {
        $client = new Client();
        $connection = new \PDO('mysql:host=your-database-host;dbname=your-database;charset=utf8', 'login', 'password');
        $cache = new PdoScriptCache($connection);

        $query = new ScriptUrlQuery($client, $cache, 'your-token');
        $query->execute();
    }

    createApiCache();
生成脚本

在您的页面上(最好在 <head> 中),使用生成器创建脚本

    use Adback\ApiClient\Generator\AnalyticsScriptGenerator;
    use Adback\ApiClient\Driver\PdoScriptCache;


    function generateAnalyticsScript()
    {
        $connection = new \PDO('mysql:host=your-database-host;dbname=your-database;charset=utf8', 'login', 'password');
        $cache = new PdoScriptCache($connection);
        $generator = new AnalyticsScriptGenerator($cache);

        return $generator->generate();
    }

    echo generateAnalyticsScript();

您可以使用适当的生成器通过相同的方式创建其他脚本。

使用 Mysqli 驱动程序

查询 API

首先您需要查询 API 以在 MySQL 表中预热缓存

    use Adback\ApiClient\Client\Client;
    use Adback\ApiClient\Driver\MysqliScriptCache;
    use Adback\ApiClient\Query\ScriptUrlQuery;

    function createApiCache()
    {
        $client = new Client();
        $connection = new \mysqli('your-database-host', 'login', 'password', 'your-database');
        $cache = new MysqliScriptCache($connection);

        $query = new ScriptUrlQuery($client, $cache, 'your-token');
        $query->execute();
    }

    createApiCache();
生成脚本

在您的页面上(最好在 <head> 中),使用生成器创建脚本

    use Adback\ApiClient\Generator\AnalyticsScriptGenerator;
    use Adback\ApiClient\Driver\PdoScriptCache;


    function generateAnalyticsScript()
    {
        $connection = new \mysqli('your-database-host', 'login', 'password', 'your-database');
        $cache = new MysqliScriptCache($connection);
        $generator = new AnalyticsScriptGenerator($cache);

        return $generator->generate();
    }

    echo generateAnalyticsScript();

您可以使用适当的生成器通过相同的方式创建其他脚本。

使用完整脚本保存和 Redis 的用法

查询 API

首先您需要查询完整脚本 API 以在 Redis 数据存储中预热缓存

    use Adback\ApiClient\Client\Client;
    use Adback\ApiClient\Driver\RedisScriptCache;
    use Adback\ApiClient\Query\FullScriptQuery;

    function createApiCache()
    {
        $client = new Client();
        $redis = new \Redis();
        $redis->connect('127.0.0.1');
        $redisCache = new RedisScriptCache($redis);

        $query = new FullScriptQuery($client, $redisCache, 'your-token');
        $query->execute();
    }

    createApiCache();

生成代码

在您的页面上,使用生成器创建代码

    use Adback\ApiClient\Driver\RedisScriptCache;
    use Adback\ApiClient\Generator\AnalyticsCodeGenerator;

    function generateAnalyticsCode()
    {
        $redis = new \Redis();
        $redis->connect('127.0.0.1');
        $redisCache = new RedisScriptCache($redis);
        $generator = new AnalyticsCodeGenerator($redisCache);

        return $generator->generate();
    }

    echo generateAnalyticsCode();

您可以使用适当的生成器通过相同的方式创建其他脚本。

使用 predis/predis 的完整脚本保存和 Redis 的用法

查询 API

首先您需要查询完整脚本 API 以在 Redis 数据存储中预热缓存

    use Adback\ApiClient\Client\Client;
    use Adback\ApiClient\Driver\RedisScriptCache;
    use Adback\ApiClient\Query\FullScriptQuery;
    use Predis\Client as Predis;

    function createApiCache()
    {
        $client = new Client();
        $redis = new \Predis('127.0.0.1');
        $redisCache = new RedisScriptCache($redis);

        $query = new FullScriptQuery($client, $redisCache, 'your-token');
        $query->execute();
    }

    createApiCache();

生成代码

在您的页面上,使用生成器创建代码

    use Adback\ApiClient\Driver\RedisScriptCache;
    use Adback\ApiClient\Generator\AnalyticsCodeGenerator;
    use Predis\Client as Predis;

    function generateAnalyticsCode()
    {
        $redis = new \Predis('127.0.0.1');
        $redisCache = new RedisScriptCache($redis);
        $generator = new AnalyticsCodeGenerator($redisCache);

        return $generator->generate();
    }

    echo generateAnalyticsCode();

您可以使用适当的生成器通过相同的方式创建其他脚本。