2017 © Pedro Peláez
 

library oauth2

Light PHP wrapper for the OAuth 2.0 protocol (based on OAuth 2.0 Authorization Protocol draft-ietf-oauth-v2-15)

image

adoy/oauth2

Light PHP wrapper for the OAuth 2.0 protocol (based on OAuth 2.0 Authorization Protocol draft-ietf-oauth-v2-15)

  • Wednesday, October 4, 2017
  • by adoy
  • Repository
  • 34 Watchers
  • 365 Stars
  • 563,353 Installations
  • PHP
  • 15 Dependents
  • 1 Suggesters
  • 156 Forks
  • 27 Open issues
  • 3 Versions
  • 7 % Grown

The README.md

Light PHP wrapper for the OAuth 2.0

Latest Stable Version GitHub Total Downloads, (*1)

How can I use it ?

<?php

require('Client.php');
require('GrantType/IGrantType.php');
require('GrantType/AuthorizationCode.php');

const CLIENT_ID     = 'your client id';
const CLIENT_SECRET = 'your client secret';

const REDIRECT_URI           = 'http://url/of/this.php';
const AUTHORIZATION_ENDPOINT = 'https://graph.facebook.com/oauth/authorize';
const TOKEN_ENDPOINT         = 'https://graph.facebook.com/oauth/access_token';

$client = new OAuth2\Client(CLIENT_ID, CLIENT_SECRET);
if (!isset($_GET['code']))
{
    $auth_url = $client->getAuthenticationUrl(AUTHORIZATION_ENDPOINT, REDIRECT_URI);
    header('Location: ' . $auth_url);
    die('Redirect');
}
else
{
    $params = array('code' => $_GET['code'], 'redirect_uri' => REDIRECT_URI);
    $response = $client->getAccessToken(TOKEN_ENDPOINT, 'authorization_code', $params);
    parse_str($response['result'], $info);
    $client->setAccessToken($info['access_token']);
    $response = $client->fetch('https://graph.facebook.com/me');
    var_dump($response, $response['result']);
}

How can I add a new Grant Type ?

Simply write a new class in the namespace OAuth2\GrantType. You can place the class file under GrantType. Here is an example :, (*2)

<?php

namespace OAuth2\GrantType;

/**
 * MyCustomGrantType Grant Type
 */
class MyCustomGrantType implements IGrantType
{
    /**
     * Defines the Grant Type
     *
     * @var string  Defaults to 'my_custom_grant_type'.
     */
    const GRANT_TYPE = 'my_custom_grant_type';

    /**
     * Adds a specific Handling of the parameters
     *
     * @return array of Specific parameters to be sent.
     * @param  mixed  $parameters the parameters array (passed by reference)
     */
    public function validateParameters(&$parameters)
    {
        if (!isset($parameters['first_mandatory_parameter']))
        {
            throw new \Exception('The \'first_mandatory_parameter\' parameter must be defined for the Password grant type');
        }
        elseif (!isset($parameters['second_mandatory_parameter']))
        {
            throw new \Exception('The \'seconde_mandatory_parameter\' parameter must be defined for the Password grant type');
        }
    }
}

call the OAuth client getAccessToken with the grantType you defined in the GRANT_TYPE constant, As following :, (*3)

$response = $client->getAccessToken(TOKEN_ENDPOINT, 'my_custom_grant_type', $params);

LICENSE

This Code is released under the GNU LGPL, (*4)

Please do not change the header of the file(s)., (*5)

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version., (*6)

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE., (*7)

See the GNU Lesser General Public License for more details., (*8)

The Versions

04/10 2017

dev-master

9999999-dev

Light PHP wrapper for the OAuth 2.0 protocol (based on OAuth 2.0 Authorization Protocol draft-ietf-oauth-v2-15)

  Sources   Download

LGPL-2.1

The Requires

  • php >=5.3.0

 

by Berejeb Anis
by Charron Pierrick

03/08 2015

1.3.0

1.3.0.0

Light PHP wrapper for the OAuth 2.0 protocol (based on OAuth 2.0 Authorization Protocol draft-ietf-oauth-v2-15)

  Sources   Download

LGPL-2.1

The Requires

  • php >=5.3.0

 

by Berejeb Anis
by Charron Pierrick

20/05 2015

1.2.0

1.2.0.0

Light PHP wrapper for the OAuth 2.0 protocol (based on OAuth 2.0 Authorization Protocol draft-ietf-oauth-v2-15)

  Sources   Download

LGPL-2.1

The Requires

  • php >=5.3.0

 

by Berejeb Anis
by Charron Pierrick