Zend Framework  3.0
Public Member Functions | Public Attributes | Protected Attributes | List of all members
ReCaptcha Class Reference

ReCaptcha adapter. More...

Public Member Functions

 getPrivkey ()
 Retrieve ReCaptcha Private key.
 
 getPubkey ()
 Retrieve ReCaptcha Public key.
 
 setPrivkey ($privkey)
 Set ReCaptcha Private key.
 
 setPubkey ($pubkey)
 Set ReCaptcha public key.
 
 __construct ($options=null)
 Constructor.
 
 setService (ReCaptchaService $service)
 Set service object.
 
 getService ()
 Retrieve ReCaptcha service object.
 
 setOption ($key, $value)
 Set option.
 
 generate ()
 Generate captcha.
 
 isValid ($value, $context=null)
 Validate captcha.
 
 getHelperName ()
 Get helper name used to render captcha.
 
- Public Member Functions inherited from AbstractAdapter
 getName ()
 Get name.
 
 setName ($name)
 Set name.
 
 setOption ($key, $value)
 Set single option for the object.
 
 setOptions ($options=[])
 Set object state from options array.
 
 getOptions ()
 Retrieve options representing object state.
 
 getHelperName ()
 Get helper name used to render captcha.
 
- Public Member Functions inherited from AbstractValidator
 __construct ($options=null)
 Abstract constructor for all validators A validator should accept following parameters:
 
 getOption ($option)
 Returns an option.
 
 getOptions ()
 Returns all available options.
 
 setOptions ($options=[])
 Sets one or multiple options.
 
 getMessages ()
 Returns array of validation failure messages.
 
 __invoke ($value)
 Invoke as command.
 
 getMessageVariables ()
 Returns an array of the names of variables that are used in constructing validation failure messages.
 
 getMessageTemplates ()
 Returns the message templates from the validator.
 
 setMessage ($messageString, $messageKey=null)
 Sets the validation failure message template for a particular key.
 
 setMessages (array $messages)
 Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.
 
 __get ($property)
 Magic function returns the value of the requested property, if and only if it is the value or a message variable.
 
 setValueObscured ($flag)
 Set flag indicating whether or not value should be obfuscated in messages.
 
 isValueObscured ()
 Retrieve flag indicating whether or not value should be obfuscated in messages.
 
 setTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
 Set translation object.
 
 getTranslator ()
 Return translation object.
 
 hasTranslator ()
 Does this validator have its own specific translator?
 
 setTranslatorTextDomain ($textDomain= 'default')
 Set translation text domain.
 
 getTranslatorTextDomain ()
 Return the translation text domain.
 
 setTranslatorEnabled ($flag=true)
 Indicate whether or not translation should be enabled.
 
 isTranslatorEnabled ()
 Is translation enabled?
 
- Public Member Functions inherited from TranslatorAwareInterface
 setTranslator (TranslatorInterface $translator=null, $textDomain=null)
 Sets translator to use in helper.
 
- Public Member Functions inherited from ValidatorInterface
 isValid ($value)
 Returns true if and only if $value meets the validation requirements.
 

Public Attributes

const MISSING_VALUE = 'missingValue'
 #@+ Error codes
 
const ERR_CAPTCHA = 'errCaptcha'
 
const BAD_CAPTCHA = 'badCaptcha'
 

Protected Attributes

 $CHALLENGE = 'recaptcha_challenge_field'
 
 $RESPONSE = 'recaptcha_response_field'
 
 $service
 
 $serviceParams = []
 
 $serviceOptions = []
 
 $messageTemplates
 
- Protected Attributes inherited from AbstractAdapter
 $name
 
 $options = []
 
 $skipOptions
 
- Protected Attributes inherited from AbstractValidator
 $value
 
 $abstractOptions
 

Additional Inherited Members

- Static Public Member Functions inherited from AbstractValidator
static setDefaultTranslator (Translator\TranslatorInterface $translator=null, $textDomain=null)
 Set default translation object for all validate objects.
 
static getDefaultTranslator ()
 Get default translation object for all validate objects.
 
static hasDefaultTranslator ()
 Is there a default translation object set?
 
static setDefaultTranslatorTextDomain ($textDomain= 'default')
 Set default translation text domain for all validate objects.
 
static getDefaultTranslatorTextDomain ()
 Get default translation text domain for all validate objects.
 
static getMessageLength ()
 Returns the maximum allowed message length.
 
static setMessageLength ($length=-1)
 Sets the maximum allowed message length.
 
- Protected Member Functions inherited from AbstractValidator
 createMessage ($messageKey, $value)
 Constructs and returns a validation failure message with the given message key and value.
 
 error ($messageKey, $value=null)
 
 getValue ()
 Returns the validation value.
 
 setValue ($value)
 Sets the value to be validated and clears the messages and errors arrays.
 
 translateMessage ($messageKey, $message)
 Translate a validation message.
 
- Static Protected Attributes inherited from AbstractValidator
static $defaultTranslator
 
static $defaultTranslatorTextDomain = 'default'
 
static $messageLength = -1
 

Detailed Description

ReCaptcha adapter.

Allows to insert captchas driven by ReCaptcha service

See Also
http://recaptcha.net/apidocs/captcha/

Constructor & Destructor Documentation

__construct (   $options = null)

Constructor.

Parameters
null | array | Traversable$options

Member Function Documentation

generate ( )

Generate captcha.

See Also
AbstractAdapter::generate()
Returns
string

Implements AdapterInterface.

getHelperName ( )

Get helper name used to render captcha.

Returns
string

Implements AdapterInterface.

getPrivkey ( )

Retrieve ReCaptcha Private key.

Returns
string
getPubkey ( )

Retrieve ReCaptcha Public key.

Returns
string
getService ( )

Retrieve ReCaptcha service object.

Returns
ReCaptchaService
isValid (   $value,
  $context = null 
)

Validate captcha.

See Also
::isValid()
Parameters
mixed$value
mixed$context
Returns
bool
setOption (   $key,
  $value 
)

Set option.

If option is a service parameter, proxies to the service. The same goes for any service options (distinct from service params)

Parameters
string$key
mixed$value
Returns
ReCaptcha
setPrivkey (   $privkey)

Set ReCaptcha Private key.

Parameters
string$privkey
Returns
ReCaptcha
setPubkey (   $pubkey)

Set ReCaptcha public key.

Parameters
string$pubkey
Returns
ReCaptcha
setService ( ReCaptchaService  $service)

Set service object.

Parameters
ReCaptchaService$service
Returns
ReCaptcha

Member Data Documentation

$CHALLENGE = 'recaptcha_challenge_field'
protected
$messageTemplates
protected
Initial value:
= [
self::MISSING_VALUE => 'Missing captcha fields'
$RESPONSE = 'recaptcha_response_field'
protected
$service
protected
$serviceOptions = []
protected
$serviceParams = []
protected
const BAD_CAPTCHA = 'badCaptcha'
const ERR_CAPTCHA = 'errCaptcha'
const MISSING_VALUE = 'missingValue'

#@+ Error codes