README

Laravel Seeclickfix API 是一个简单的 Laravel 4 服务提供者（包装器），用于seeclickfix/seeclickfix-php-sdk，该 SDK 为 PHP 5.3+ 提供API支持。

• 安装
• 注册包
• 配置
• 用法
• 基本用法
• 许可证

安装

将 laravel-seeclickfix-api 添加到您的 composer.json 文件中

"require": {
  "seeclickfix/laravel-seeclickfix-api": "dev-master"
}

使用 composer 安装此包。

$ composer update

使用 artisan 创建配置文件

$ php artisan config:publish seeclickfix/laravel-seeclickfix-api

配置

注册包

在 app/config/app.php 文件的底部添加一个别名

'SeeClickFix' => 'SeeClickFix\API\Facade\API',

并在 $providers 数组的底部注册此服务提供者

'SeeClickFix\API\APIServiceProvider',

凭证

将您的凭证添加到 app/config/packages/seeclickfix/laravel-seeclickfix-api/config.php

return array( 
	
	/*
	 |--------------------------------------------------------------------------
	 | Settings
	 |--------------------------------------------------------------------------
	 */

    'location'	     => 'default',
    'sandbox_mode'	 => false,

	/*
	 |--------------------------------------------------------------------------
	 | Keys
	 |--------------------------------------------------------------------------
	 */

	 'client_id'      => '',
	 'client_secret'  => '',
	 'redirect_uri'   => '', // Relative path

);

在开发应用程序时，将 sandbox_mode 设置为 true。这将允许您在我们的测试服务器上测试功能。

用法

基本用法

SeeClickFix::getAuthorizationUri() - 这将用户重定向到 SeeClickFix 授权页面。

SeeClickFix::getAccessToken() - 获取访问令牌并验证它。

SeeClickFix::check() - 确定用户是否已登录。

SeeClickFix::getUserId( $id ) - 通过 id 返回单个用户。

SeeClickFix::logout() - 注销当前用户。

有关 API 调用的完整列表，请参阅seeclickfix/seeclickfix-php-sdk 维基。

用法示例

在您的控制器中使用以下代码

/**
 * Login user with SeeClickFix
 *
 * @return void
 */

public function loginWithSeeClickFix() {
	
	// get data from input
	$code = Input::get( 'code' );
	
	// check if code is valid
	if ( !empty( $code ) ) 
	{
		// Try to log the user in
        SeeClickFix::getAccessToken( $code );

		return Redirect::route("/")->with("success", "You have successfully logged in.");
	}
	// if not ask for permission first
	else {
		// get SeeClickFix authorization URL
		$url = SeeClickFix::getAuthorizationUri();
		
		// return to SeeClickFix login url
		return Response::make()->header( 'Location', (string)$url );
	}

}

在您的 Blade 视图中使用以下代码

@if (SeeClickFix::check())
	<li><a href="{{ route('logout') }}" class="external">Logout</a></li>
@else
	<li><a href="{{ route('login') }}" class="external">Login/Sign-up</a></li>
@endif

##许可证

根据 Apache License 2.0 许可证（“许可证”）授权；除非符合许可证规定，否则您不得使用此文件。您可以在以下位置获得许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则根据许可证分发的软件按“原样”基础分发，不提供任何明示或暗示的保证或条件。有关许可证的具体语言管理权限和限制，请参阅许可证。

版权所有 2013-2015 SeeClickFix