PHP Class CakeDC\Users\View\Helper\UserHelper

Inheritance: extends Cake\View\Helper
Show file Open project: cakedc/users

Public Properties

Property Type Description
$helpers

Protected Properties

Property Type Description
$_defaultConfig array Default configuration.

Public Methods

Method Description
addReCaptcha ( ) : mixed Add reCaptcha to the form
addReCaptchaScript ( ) : void Add reCaptcha script
isAuthorized ( string | array | null $url = null ) : boolean Returns true if the target url is authorized for the logged in user
link ( string $title, string | array | null $url = null, array $options = [] ) : string Generate a link if the target url is authorized for the logged in user
logout ( null $message = null, array $options = [] ) : string Logout link
socialLogin ( string $name, array $options = [] ) : string Social login link
socialLoginList ( ) : array All available Social Login Icons
welcome ( ) : mixed Welcome display

Method Details

addReCaptcha() public method

Add reCaptcha to the form
public addReCaptcha ( ) : mixed
return mixed

addReCaptchaScript() public method

Add reCaptcha script
public addReCaptchaScript ( ) : void
return void

isAuthorized() public method

Returns true if the target url is authorized for the logged in user
Deprecation: Since 3.2.1. Use AuthLinkHelper::link() instead
public isAuthorized ( string | array | null $url = null ) : boolean
$url string | array | null url that the user is making request.
return boolean

logout() public method

Logout link
public logout ( null $message = null, array $options = [] ) : string
$message null logout message info.
$options array Array with option data.
return string

socialLogin() public method

Social login link
public socialLogin ( string $name, array $options = [] ) : string
$name string name
$options array options
return string

socialLoginList() public method

All available Social Login Icons
public socialLoginList ( ) : array
return array Links to Social Login Urls

welcome() public method

Welcome display
public welcome ( ) : mixed
return mixed

Property Details

$_defaultConfig protected property

Default configuration.
protected array $_defaultConfig
return array

$helpers public property

public $helpers