PHP Класс RecaptchaComponent

Наследование: extends Component
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$Controller string Name
$actions array Actions that should automatically checked for a recaptcha input
$apiUrl string Recaptcha API Url
$error string Error coming back from Recaptcha
$privateKey string Private API Key
$settings array Settings

Защищенные свойства (Protected)

Свойство Тип Описание
$_defaults array Default Options

Открытые методы

Метод Описание
__construct ( ComponentCollection $collection, array $settings = [] ) : RecaptchaComponent Constructor
initialize ( Controller $controller, array $settings = [] ) : void Callback
startup ( Controller $controller ) : void Callback
verify ( ) : boolean Verifies the recaptcha input

Защищенные методы

Метод Описание
_getApiResponse ( ) : HttpSocketResponse Queries the Recaptcha API and and returns the raw response

Описание методов

__construct() публичный Метод

Constructor
public __construct ( ComponentCollection $collection, array $settings = [] ) : RecaptchaComponent
$collection ComponentCollection A ComponentCollection this component can use to lazy load its components
$settings array Array of configuration settings
Результат RecaptchaComponent

_getApiResponse() защищенный Метод

Queries the Recaptcha API and and returns the raw response
protected _getApiResponse ( ) : HttpSocketResponse
Результат HttpSocketResponse

initialize() публичный Метод

Callback
public initialize ( Controller $controller, array $settings = [] ) : void
$controller Controller Controller with components to initialize
$settings array Array of configuration settings
Результат void

startup() публичный Метод

Callback
public startup ( Controller $controller ) : void
$controller Controller Controller with components to initialize
Результат void

verify() публичный Метод

Please note that you still have to pass the result to the model and do the validation there to make sure the data is not saved!
public verify ( ) : boolean
Результат boolean True if the response was correct

Описание свойств

$Controller публичное свойство

Name
public string $Controller
Результат string

$_defaults защищенное свойство

Default Options
protected array $_defaults
Результат array

$actions публичное свойство

Actions that should automatically checked for a recaptcha input
public array $actions
Результат array

$apiUrl публичное свойство

Recaptcha API Url
public string $apiUrl
Результат string

$error публичное свойство

Error coming back from Recaptcha
public string $error
Результат string

$privateKey публичное свойство

Private API Key
public string $privateKey
Результат string

$settings публичное свойство

Settings
public array $settings
Результат array