ReCaptcha Class Reference

ReCaptcha Input
Display and check Google's ReCaptcha captcha. More...

Inheritance diagram for ReCaptcha:

Public Member Functions
	__construct ($path_type)
	initialise ($params=array())
	display ($layout='captcha')
	verify ()
	get_lastErrorCode ()
	get_lastError ()
	initialise_configDisplay ()
	display_configDisplay ()
	initialise_configEdition ($form)
	display_configEdition ()
	save_configuration ()
	get_cookieInformationData ()
Public Member Functions inherited from Input
	__construct ($name, $path_type)
	Input ($name, $path_type)
	display ()
	get_translation ($value, $data=null)
	set_selectedLayout ($layout='')
Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)
	get_version ()
	load_library ($library='')
	load_file ($file='')
	load_varFile ($file='')
	load_engineFile ($file='')
	get_engineFileURL ($file='', $path=false)
	get_fileURL ($file='', $path=null, $default='')
	get_varFileURL ($file='', $path=false, $default='')
	get_filePath ($file='')
	get_varFilePath ($file='')
	add_JSFile ($file)
	add_JSEngineFile ($file)
	add_JSExternFile ($file)
	add_JSScript ($script, $unique=false)
	add_JSPreScript ($script, $unique=false)
	add_JSWindowEventScript ($event, $script, $unique=false)
	add_JSLoadScript ($script, $unique=false)
	add_JSUnloadScript ($script, $unique=false)
	add_styleFile ($file, $media='', $condition='')
	add_styleScript ($css)
	add_styleIncludedFile ($file)
	add_StyleExternFile ($file, $media='', $condition='')
	set_RSSFeed ($title, $url)
	add_headerExtra ($content='')
	install ()
	uninstall ()
	is_installed ()
	update ($version, $more='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSInitialise ()
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	execute_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	execute_request ()
	get_varFile ($file)

Protected Attributes
	$isConfigLoaded = false
	Stores if the configuration is loaded. More...

Private Member Functions
	load_configuration ()
	is_cookieAccepted ()

Private Attributes
	$_lastError
	Plugin's last error. More...

Additional Inherited Members
Public Attributes inherited from Input
	$title
	Input title. More...
	$params = array()
	Input parameters. More...
	$selected_layout = 'input.html.inc'
	Input layout to use. More...
Public Attributes inherited from Plugin
	$name
	Plugin name. More...
	$version
	Plugin version. More...
	$active = false
	Plugin installation status. More...
	$plugin_package = ''
	Plugin package. More...
	$plugin_type
	Plugin type. More...
	$object_type
	Plugin type. More...
	$plugin_path
	Plugin path. More...
	$plugin_site_path
	Plugin site path (for element overwriting). More...
	$plugin_var_path
	Plugin var path. More...
	$plugin_url
	Plugin URL. More...
	$plugin_site_url
	Plugin site URL (for element overwriting). More...
	$plugin_var_url
	Plugin var URL. More...
	$path_type
	Plugin path type. More...
	$author_name
	Plugin author name. More...
	$author_mail
	Plugin author email. More...
	$author_group
	Plugin author group. More...
	$plugin_dependencies = array()
	Plugin dependencies. More...
Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')
	add_meta ($name, $content, $method='name')
	add_toHtaccess ($content='')
	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
	set_dependencies ()
	register_asSharedObject ($name)
&	get_sharedObject ($name)
	register_asExtension ($plugin)
	get_registeredExtensions ()
	register_asCaMykSEventHandler ($event)

Detailed Description

ReCaptcha Input
Display and check Google's ReCaptcha captcha.

Plugin / Input Engine

Author

CaMykS Team camyk.nosp@m.s.co.nosp@m.ntact.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Version

1.0.1

Date

Creation: Feb 2016

Modification: Mar 2021

Copyright

2016 - 2021 CaMykS Team

Note

This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. ReCaptcha Input class.

Constructor & Destructor Documentation

__construct()

ReCaptcha::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

initialise()

ReCaptcha::initialise

(

$params = array()

)

Initialise input.

Parameters

array

$params

Returns

void

Reimplemented from Input.

display()

ReCaptcha::display

(

$layout = 'captcha'

)

Display input.

Parameters

string

$layout

Returns

void

load_configuration()

ReCaptcha::load_configuration ( )

private

Load configuration.

Returns

void

verify()

ReCaptcha::verify

(

)

Verify captcha.

Returns

boolean result

get_lastErrorCode()

ReCaptcha::get_lastErrorCode

(

)

Return last error code.

Returns

string

get_lastError()

ReCaptcha::get_lastError

(

)

Return last error as text.

Returns

string

initialise_configDisplay()

ReCaptcha::initialise_configDisplay

(

)

Initialise object in Admin_Site / view configuration mode.

Returns

void

display_configDisplay()

ReCaptcha::display_configDisplay

(

)

Display object in Admin_Site / view configuration mode.

Returns

void

initialise_configEdition()

ReCaptcha::initialise_configEdition

(

$form

)

Initialise object in Admin_Site / edit configuration mode.

Parameters

Object

$form

Returns

void

display_configEdition()

ReCaptcha::display_configEdition

(

)

Display object in Admin_Site / edit configuration mode.

Returns

void

save_configuration()

ReCaptcha::save_configuration

(

)

Execute object in Admin_Site / save configuration mode.

Returns

void

get_cookieInformationData()

ReCaptcha::get_cookieInformationData

(

)

Return plugin information related to cookies.

Returns

void

is_cookieAccepted()

ReCaptcha::is_cookieAccepted ( )

private

Check if plugin is cookie accepted.

Returns

boolean

Member Data Documentation

$_lastError

ReCaptcha::$_lastError

private

Plugin's last error.

var string $_lastError

$isConfigLoaded

ReCaptcha::$isConfigLoaded = false

protected

Stores if the configuration is loaded.

var boolean isConfigLoaded

---

The documentation for this class was generated from the following file:

• CaMykS/plugin/input/ReCaptcha/ReCaptcha.php.inc