README

概述

Leadpages Auth 设计目的是让您的 Leadpages 集成快速启动变得简单。

• 抽象出调用 Leadpages 获取安全令牌所需的方法。
• 内置最小存储抽象，以便 Leadpages 扩展遵循已知的标准集。
• 使用 Guzzle5 来允许所有平台上一致的 Http 抽象层。选择 Guzzle5 以支持 PHP 5.4

代码示例 - WordPress

<?php

/**
 * require composer autoload this path will probably change for your implementation
 * wordpress would suggest using plugin_dir_path
 * example require plugin_dir_path(dirname(dirname(dirname(__FILE__))))."/vendor/autoload.php";
*/

require dirname(dirname(dirname(__FILE__))) . "/vendor/autoload.php";

use GuzzleHttp\Client;
use Leadpages\Auth\LeadpagesLogin;

/**
 * Extend the Leadpages login abstract class
 * and fill out the required methods to store and retrieve your token
 * Class WordPressLeadpagesLogin
 */
class WordPressLeadpagesLogin extends LeadpagesLogin
{

    /**
     * store token in Wordpress Database
     *
     * @return mixed
     */
    public function storeToken()
    {
        update_option($this->tokenLabel, $this->token);
    }


    /**
     * get token form WordPress Database and set the $this->token
     * $this->token needs to be set on this method
     */
    public function getToken()
    {
        $this->token = get_option($this->tokenLabel);
    }

    /**
     * Delete token from WordPress Database
     * @return mixed
     */
     
    public function deleteToken()
    {
        delete_options($this->tokenLabel);
    }

    /**
     * method to check if token is empty
     *
     * @return mixed
     */
    public function checkIfTokenIsEmpty()
    {
        // TODO: Implement checkIfTokenIsEmpty() method.
    }
}

//instantiate Class
$leadpagesLogin = new WordPressLeadpagesLogin(new Client());
//call get user pipe into parseResponse
$response = $leadpagesLogin->getUser('example@example.com', 'password')->parseResponse();

if($response == 'success'){
    $this->storeToken();
}else{
    //this->response holds a json object with response codes
    return $this->response;
}

//check if a user is logged in
$isLoggedIn = $leadpagesLogin->checkIfUserIsLoggedIn();

安装

可以通过 Composer 安装此包。

#install composer
curl -sS https://getcomposer.org/installer | php

运行 composer 以要求安装此包。

php composer.phar require leadpages/leadpages-auth

接下来，确保将 composer 自动加载器包含到您的项目中。包使用 PSR-4 自动加载

require 'vendor/autoload.php';

API 参考

文档即将推出

测试

测试通过 PHPUnit 运行

贡献者

许可证