PHP Class Xpressengine\Captcha\Services\GoogleRecaptcha

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: implements Xpressengine\Captcha\CaptchaInterface
Show file Open project: xpressengine/xpressengine

Protected Properties

Property Type Description
$captcha ReCaptcha\ReCaptcha ReCaptcha instance
$frontend Xpressengine\Presenter\Html\FrontendHandler FrontendHandler instance
$input string Captcha input name
$request Illuminate\Http\Request Http Request instance
$response ReCaptcha\Response ReCaptcha response instnace
$secret string Api secret key
$siteKey string Api site key

Public Methods

Method Description
__construct ( string $siteKey, string $secret, Illuminate\Http\Request $request, FrontendHandler $frontend ) Constructor
available ( ) : mixed Determine if captcha is available
errors ( ) : array Message of fails
getInputName ( ) : string Captcha input name
render ( ) : string For UI object display
verify ( ) : boolean Verify captcha

Protected Methods

Method Description
create ( ) : ReCaptcha\ReCaptcha Create captcha instance

Method Details

__construct() public method

Constructor
public __construct ( string $siteKey, string $secret, Illuminate\Http\Request $request, FrontendHandler $frontend )
$siteKey string Api site key
$secret string Api secret key
$request Illuminate\Http\Request Http Request instance
$frontend Xpressengine\Presenter\Html\FrontendHandler FrontendHandler instance

available() public method

Determine if captcha is available
public available ( ) : mixed
return mixed

create() protected method

Create captcha instance
protected create ( ) : ReCaptcha\ReCaptcha
return ReCaptcha\ReCaptcha

errors() public method

Message of fails
public errors ( ) : array
return array

getInputName() public method

Captcha input name
public getInputName ( ) : string
return string

render() public method

For UI object display
public render ( ) : string
return string

verify() public method

Verify captcha
public verify ( ) : boolean
return boolean

Property Details

$captcha protected property

ReCaptcha instance
protected ReCaptcha,ReCaptcha $captcha
return ReCaptcha\ReCaptcha

$frontend protected property

FrontendHandler instance
protected FrontendHandler,Xpressengine\Presenter\Html $frontend
return Xpressengine\Presenter\Html\FrontendHandler

$input protected property

Captcha input name
protected string $input
return string

$request protected property

Http Request instance
protected Request,Illuminate\Http $request
return Illuminate\Http\Request

$response protected property

ReCaptcha response instnace
protected Response,ReCaptcha $response
return ReCaptcha\Response

$secret protected property

Api secret key
protected string $secret
return string

$siteKey protected property

Api site key
protected string $siteKey
return string