Hybrid_Auth class provide a simple way to authenticate users via OpenID and OAuth.

Generally, Hybrid_Auth is the only class you should instanciate and use throughout your application.

Using Hybrid_Auth

Hybrid_Auth constructor will require either a valid config array or a path for a configuration file as parameter. To know more please refer to the Configuration section.

---

Ex1: Initialize Hybrid_Auth with an array:

$config_array = array(
   "base_url" => "http://mywebsite.com/path/to/hybridauth/",
       "providers" => array (
       "Twitter" => array (
           "enabled" => true, "keys" => array ( "key" => "", "secret" => "" )
       ),
       "Facebook" => array (
           "enabled" => true, "keys" => array ( "id" => "", "secret" => "" )
       ),
       "OpenID" => array (
           "enabled" => true
       )
   )
);
 
$hybridauth = new Hybrid_Auth( $config_array );

Ex2: Initialize Hybrid_Auth with a configuration file path:

$config_file_path = '/path/to/library/hybridauth.php';
 
$hybridauth = new Hybrid_Auth( $config_file_path );

Constructor options

Name	type	description
config	array, string	It can be a config array or the path of a configuration file

Methods

authenticate()

Try to authenticate the user with a given provider.

If the user is already connected we just return and instance of the provider adapter Hybrid_Provider_Adapter, ELSE, try to authenticate and or authorize the user with this provider.

When a user login via a given provider using Hybrid_Auth::authenticate(), HybridAuth Library creates a login session for the user. By default the session and will stay as long as the current PHP Sessions is still active or until Hybrid_Provider_Adapter::logout() method is called. To know more refer to the HybridAuth Sessions section.

Hybrid_Auth::authenticate( provider, params  )

Name	type	description
provider	string	$provider is an the provider name to connect to.
params	optional, array	$params is an Optional array which generally contain some extra info in order for the provider to work, Ex. : hauth_return_to: URL to call back after authentication is done openid_identifier: The OpenID identity provider identifier

getAdapter()

Return the adapter instance of an authenticated provider adapter Hybrid_Provider_Adapter.

Hybrid_Auth::getAdapter(provider)

isConnectedWith()

Return a true or false if the current user is connected to a given provider. Hybrid_Auth::isConnectedWith() use PHP Sessions. To know more refer to the HybridAuth Sessions section.

Hybrid_Auth::isConnectedWith(provider)

getConnectedProviders()

Return list of Authenticated providers. Hybrid_Auth::getConnectedProviders() use PHP Sessions. To know more refer to the HybridAuth Sessions section.

Hybrid_Auth::getConnectedProviders()

getSessionData()

Get the session stored data. To be used on case you want to store session on a more persistent backend. Return a serialized array.

Hybrid_Auth::getSessionData()

restoreSessionData()

Restore HybridAuth session from a given [serialized] array.

Hybrid_Auth::restoreSessionData(array)

logoutAllProviders()

A generic function to logout all connected providers at once.

Hybrid_Auth::logoutAllProviders()

redirect()

Utility function, redirect to a given url with php header function

Hybrid_Auth::redirect(url)

getCurrentUrl()

Utility function, return the current url of the request web page.

Hybrid_Auth::getCurrentUrl()

Hybrid_Provider_Adapter is the basic class which Hybrid_Auth will use to connect users to a given provider. Basically Hybrid_Provider_Adapter will create a bridge from your php application to the provider api.

There is a different Adapter for each providers HybridAuth support.

// hybridauth will try to authenticate the user, then return an instance of Twitter adapter
$twitter_adapter = $hybridauth->authenticate( "Twitter" );
 
// get the user profile
$twitter_user_profile = $twitter_adapter->getUserProfile();
 
// disconnect the user form twitter
$twitter_adapter->logout();

Hybrid_Provider_Adapter::isUserConnected()

Hybrid_Provider_Adapter::getUserProfile()

Hybrid_Provider_Adapter::setUserStatus( $status )

Hybrid_Provider_Adapter::getUserContacts()

Hybrid_Provider_Adapter::getUserContacts( $stream )

Hybrid_Provider_Adapter::logout()

Hybrid_Provider_Adapter::getAccessToken()

Hybrid_Provider_Adapter::api()