docs.modx.pro
HybridAuth
Snippet outputs formula for authorization on the site.
Parameters
| Name | Default value | Description |
|---|---|---|
| &activeProviderTpl | tpl.HybridAuth.provider.active | chunk to output icons of a bound service. |
| &addContexts | additional contexts, separated by commas. E.g. &addContexts=`web,ru,en` | |
| &groups | list of groups to register the user, separated by commas. User role can be indicated in the group with colon. E.g. &groups=Users:1 will add user to group "Users" with role "member". | |
| &loginContext | current context | main context for authorization. On default – current. |
| &loginResourceId | 0 | identifier of a resource on which user should be sent after end of the session. On default 0 renews the current page. |
| &loginTpl | tpl.HybridAuth.login | this chunk will be pointed to an anonymous user, i.e. to any guest. |
| &logoutResourceId | 0 | resource identifier, where a user is sent after the end of the session. On default, 0 updates a current page. |
| &logoutTpl | tpl.HybridAuth.logout | this chunk will be shown to an anonymous user. |
| &providerTpl | tpl.HybridAuth.provider | chunk to output links for authorization, or binding of server to the account. |
| &providers | all available | list of providers for authorization, separated by commas. All available providers are here {core_path}components/hybridauth/model/hybridauth/lib/Providers/. For example, &providers=Google,Twitter,Facebook. |
| &rememberme | 1 | remembers users for a long time. |
Samples
Snippet should be activated uncached, because it outputs different chunks depending on users authorization.
On usual activation snippet will output all providers registered in the system.
modx
[[!HybridAuth]][[!HybridAuth]]They can be limited indicating them as a list, separated by commas:
modx
[[!HybridAuth?
&providers=`Yandex,Google,Twitter,Facebook,Vkontakte`
]][[!HybridAuth?
&providers=`Yandex,Google,Twitter,Facebook,Vkontakte`
]]Authorization in 2 contexts at once:
modx
[[!HybridAuth?
&providers=`Yandex,Google`
&loginContext=`web`
&addContexts=`en`
]][[!HybridAuth?
&providers=`Yandex,Google`
&loginContext=`web`
&addContexts=`en`
]]Provider settings
Individual system setting with prefix ha.keys. is indicated for every provider of authorization:
Value of setting is JSON array which content depends on the provider.
E.g. id and secret should be indicated for Google, but for Twitter – key and secret.
That is why pay attention to the settings which will be given to you during registration.
Link for registration from providers
Keys from providers need to be derived to work of the component, and it is not understandable at once where you should look for them. That’s is why there are some main links:
Contexts
If you have several individual contexts on the website, you can authorize them through the same providers, but for different domains.
For this you need to indicate keys directly in settings of the context, but not in general settings of the system.
For proper work of snippet it is better to include friendly url.