HybridAuth

Last updated Apr 30th, 2019 | Page history | Improve this page | Report an issue

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

Budget

$301 per month—let's make that $500!

Learn more

An integration of open source social sign on php library HybridAuth into MODX Revolution.

The main goal of HybridAuth library is to act as an abstract api between your application and various social apis and identities providers such as Facebook, Twitter, MySpace, LinkedIn, Google and Yahoo.

HybridAuth enable developers to easily build social applications to engage websites vistors and customers on a social level by implementing social signin, social sharing, users profiles, friends list, activities stream, status updates and more.

In MODX we can log in to site and link our accounts on remote services to one user profile.

Installation¶

First of all watch this video

1. Register and get api keys from needed services. For example, create twitter application - https://dev.twitter.com/apps/new 2. Open system settings in manager, switch to hybridauth and make\update ha.keys.Servicename. In our example it will be ha.keys.Twitter 3. You need to set your keys as json string with array.

{"key":"your key from twitter","secret":"secret from twitter"}

It is needed for proper initialization of the library ( http://hybridauth.sourceforge.net/userguide/Configuration.html).

4. Now you can run snippet [[!HybridAuth?providers=Twitter]] on any page.

If there are any errors on library initialization - it will be logged in system log.

Parameters¶

Param	Description	Default
providers	Comma separated list of a providers for authentification. All available providers are here /core/components/hybridauth/model/hybridauth/lib/Providers/. For example, &providers=`Google,Twitter,Facebook`.	none
rememberme	If true, user will be remembered for a long time.	true
groups	Comma separated list of existing user groups for joining by user at the first login. For example, &groups=`Users:1` will add new user to group "Users" with role "member"	none
action	Mode of work. By default it loads chunks for user according to his status.	loadTpl

loginTpl	This chunk will see any anonymous user.	tpl.HybridAuth.login
logoutTpl	This chunk will see any authenticated user.	tpl.HybridAuth.logout
profileTpl	Chunk for display and edit user profile.	tpl.HybridAuth.profile

loginContext	Main context for authentication. By default - it is current context.	current
addContexts	Comma separated list of additional contexts for authentication. For example &addContexts=`web,ru,en`	none

profileFields	Chunk for display and edit user profile.	username:25,email:50,fullname:50...
requiredFields	Comma separated list of required user fields when update. This fields must be filled for successful update of profile. For example, &requiredFields=`username,fullname,email`.	username,email,fullname

loginResourceId	Resource id to redirect to on successful login. By default, it is 0 - redirect to self.	0
logoutResourceId	Resource id to redirect to on successful logout. By default, it is 0 - redirect to self.	0

Examples¶

[[!HybridAuth? providers=`Google,Twitter,Facebook` &groups=`Users`]]

Update profile

[[!HybridAuth? providers=`Google,Twitter,Facebook` &action=`UpdateProfile`]]

Update profile with required photo

[[!HybridAuth? providers=`Google,Twitter,Facebook` &action=`UpdateProfile` &requiredFields=`username,email,photo` &profileFields=`username,fullname,email,photo`]]

Known issues¶

Error " You cannot access this page directly" occurs when user session is cached by opcode-cacher, such as php-apc. For example, at MODXCloud this error always occurs.

For solving this, you need to add to the /index.php at the root of site this line for disabling apc caching:

ini_set('apc.cache_by_default', 0);

Otherwise, your session will be cached and snippet will not working properly.

Integration of service¶