FM / Documentation

/var/www/vhosts/ihelp.ro/httpdocs/vendor/cakedc/users/Docs/Documentation/

/var/www/vhosts/ihelp.ro/httpdocs/vendor/cakedc/users/Docs/Documentation

Name	Size	Mode	Actions
Migration/	-	0755	rm
OneTimePasswordAuthenticator/	-	0755	rm
Authentication.md	7279	0644	edit dl rm
Authorization.md	3104	0644	edit dl rm
Configuration.md	7934	0644	edit dl rm
Events.md	1122	0644	edit dl rm
Extending-the-Plugin.md	6827	0644	edit dl rm
Installation.md	3181	0644	edit dl rm
InterceptLoginAction.md	1480	0644	edit dl rm
Overview.md	658	0644	edit dl rm
SocialAuthentication.md	6158	0644	edit dl rm
Translations.md	577	0644	edit dl rm
Two-Factor-Authenticator.md	844	0644	edit dl rm
UserHelper.md	2111	0644	edit dl rm
Yubico-U2F.md	550	0644	edit dl rm

Edit: /var/www/vhosts/ihelp.ro/httpdocs/vendor/cakedc/users/Docs/Documentation/UserHelper.md (2111B)

UserHelper
=============

The User Helper has some methods that may be needed if you want to improve your templates and add features to your app in an easy way.

Setup
---------------

Enable the Helper in `src/view/AppView.php`:
```php
class AppView extends View
{
    public function initialize()
    {
        parent::initialize();
        $this->loadHelper('CakeDC/Users.User');
    }
}
```

Social Login
-----------------

You can use the helper included with the plugin to create Facebook/Twitter buttons:

In templates
```php
echo $this->User->socialLogin($provider); //provider is 'facebook', 'twitter', etc
```

We recommend the use of [Bootstrap Social](http://lipis.github.io/bootstrap-social/) in order to automatically apply styles to buttons. Anyway you can always add your own style to the buttons.

Connect Social Account
-----------------

You can use the helper included with the plugin to create some 'Connect with Facebook/Twitter' buttons:

In templates, call socialConnectLinkList method to get links for all social providers enabled
```php
echo $this->User->socialConnectLinkList($user->social_accounts); 
```

We recommend the use of [Bootstrap Social](http://lipis.github.io/bootstrap-social/) in order to automatically apply styles to buttons. Anyway you can always add your own style to the buttons.

The user must be allowed to access the urls "/link-social/[provider]" and "/callback-link-social/[provider]".

Logout link
-----------------

It allows to add a logout link anywhere in the app.

```php
$this->User->logout();
```

RBAC link
-----------------

This function validates if you have access to a link and it displays it based on that.

```php
$this->User->link();
```

Welcome and profile link
-----------------

It displays a welcome message for the user including the name and a link to the profile page

```php
$this->User->welcome();
```

reCaptcha
-----------------

Handles the reCaptcha input display:

```php
$this->User->addReCaptchaScript();

$this->User->addReCaptcha();
```

Note reCaptcha script is added to script block when `addReCaptcha` method is called.

UserHelper ============= The User Helper has some methods that may be needed if you want to improve your templates and add features to your app in an easy way. Setup --------------- Enable the Helper in `src/view/AppView.php`: ```php class AppView extends View { public function initialize() { parent::initialize(); $this->loadHelper('CakeDC/Users.User'); } } ``` Social Login ----------------- You can use the helper included with the plugin to create Facebook/Twitter buttons: In templates ```php echo $this->User->socialLogin($provider); //provider is 'facebook', 'twitter', etc ``` We recommend the use of [Bootstrap Social](http://lipis.github.io/bootstrap-social/) in order to automatically apply styles to buttons. Anyway you can always add your own style to the buttons. Connect Social Account ----------------- You can use the helper included with the plugin to create some 'Connect with Facebook/Twitter' buttons: In templates, call socialConnectLinkList method to get links for all social providers enabled ```php echo $this->User->socialConnectLinkList($user->social_accounts); ``` We recommend the use of [Bootstrap Social](http://lipis.github.io/bootstrap-social/) in order to automatically apply styles to buttons. Anyway you can always add your own style to the buttons. The user must be allowed to access the urls "/link-social/[provider]" and "/callback-link-social/[provider]". Logout link ----------------- It allows to add a logout link anywhere in the app. ```php $this->User->logout(); ``` RBAC link ----------------- This function validates if you have access to a link and it displays it based on that. ```php $this->User->link(); ``` Welcome and profile link ----------------- It displays a welcome message for the user including the name and a link to the profile page ```php $this->User->welcome(); ``` reCaptcha ----------------- Handles the reCaptcha input display: ```php $this->User->addReCaptchaScript(); $this->User->addReCaptcha(); ``` Note reCaptcha script is added to script block when `addReCaptcha` method is called.