This module allows users to connect and register with social networks such as Facebook, Google, LinkedIn...
Installation
Manually
- Copy the module into
<thelia_root>/local/modules/directory and be sure that the name of the module is TheliaHybridAuth. - Activate it in your thelia administration panel
Composer
Add it in your main thelia composer.json file
composer require thelia/thelia-hybrid-auth-module:~1.0.0
Implementation in a website
The first thing to do after the installation is to create an application on a social network (ex: developers.facebook.com) and enable it (view the Usage section for more information).
Login template
- Check that hooks "login.top-form", "login.main-bottom" and "login.javascript-initialization" are available on your login template.
- You can change the pop-up templates by overriding them in templates/frontOffice/default/modules/TheliaHybridAuth
Registration template
Here you need to override the "register-hybrid-auth" template in templates/frontOffice/default. For this, use your actual register template and follow these steps :
- Check that the hook "register.top" is available on your register template AND new register-hybrid-auth template
- Change form name for "register.hybrid.auth"
- Change the form action to "register/hybridauth"
- Find the password and password_confirm fields and change their types to "hidden" and add "value="{$value}"" in the input tag
Account template
Make sure the hookblock "account-additional" and the hook "account.after-javascript-include" are available in your template. You can override default templates in templates/frontOffice/default/modules/TheliaHybridAuth
Usage
First of all, to enable a provider, you need to create an app on the provider website. (for more information, contact the provider)
Then configure your module in modules, TheliaHybridAuth, configuration.
You need to enter the id and secret of your app in your module configuration. Use the edit button to do so.
It is then strongly advised to test the connection before to enable your provider (with the test button). Your website will try to connect you to the provider, you may be redirected to the provider website and have to authenticate.
If the test fail, you likely have typed a wrong id/secret or haven't enabled your website on the provider app configuration.
If it still fails, you may need to authorize an address looking like this : https://your-website/login/hybridauth?provider=the-provider-name in the provider configuration page. ("your-website" and "the-provider-name" are to be replaced by what it refers to, of course).
A default list of providers is available :
- OpenID
- Yahoo
- Foursquare
But you can add any other provider that are in the following list :
- Windows Live
- GitHub
- LastFM
- Vimeo
- Identica
- Tumblr
- Goodreads
- Sina
- Murmur
- Pixnet
- Plurk
- Skyrock
- Geni
- FamilySearch
- MyHeritage
- 500px
- Vkontakte
- Mail.ru
- Yandex
- Odnoklassniki
- Twitch.tv
- Steam Community
- Dribbble
Loop
[providers.list]
Input arguments
| Argument | Description |
|---|---|
| enabled | A boolean value. If set to true, return only activated providers, if set to false, return only non active providers, if set to *, return all providers. default : true example : enabled="*" |
| customer_id | An int value. Allows to get the providers associated with this customer id. |
| exclude | A string containing all the providers you want to exclude from the loop. example : exclude="Facebook,Twitter,AOL" |
Output arguments
| Variable | Description |
|---|---|
| $NAME | the name of the Provider |
| $ENABLED | boolean value. true if the provider is enabled, false else |