aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/captcha/captcha_plugin.php
blob: 3e8e508206bdd473934871199358ac4deb668c9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<?php

interface phpbb_captcha_plugin
{
	/**
	* Initiates the CAPTCHA to validate codes.
	* @param int $type the type as defined in constants.php
	*/
	function init($type);


	/**
	* Returns true if the captcha will work on the current install
	*/
	static function is_available();

	/**
	* Returns the translated pretty name of the captcha.
	*/
	static function get_name();

	/**
	* Returns the class name of the captcha.
	*/
	static function get_class_name();

	/**
	* Returns an instance; does not have to be the same instance twice.
	*/
	static function get_instance();

	/**
	* Returns the HTML needed to embed the captcha in another template
	*/
	function get_template();


	/**
	* Delivers the image of image based captchas; not required for text/remote etc CAPTCHAs
	*/
	function execute();

	/**
	* Returns the HTML needed to display a demo of the captcha
	*/
	function get_demo_template($id);


	/**
	* Delivers the demo image of image based captchas; not required for text/remote etc CAPTCHAs
	*/
	function execute_demo();

	/**
	* Clears leftover entries in the database.
	*/
	static function garbage_collect($type);


	/**
	* Clears all entries from the database if the CAPTCHA is replaced
	*/
	function uninstall();

	/**
	* Sets up the CAPTCHA when it is selected in the ACP.
	*/
	function install();


	/**
	* Checks the captcha; returns false if the code was correct; a translated error string otherwise
	*/
	function validate();

	/**
	* Prepares the captcha to ask a new question; required call on failed answers
	*/
	function reset();

	/**
	* Displays the configuration options in the ACP
	*/
	function acp_page($id, &$module);

	/**
	* Returns the entries for the hidden field array needed to preserve the current state.
	*/
	function get_hidden_fields();


	/**
	* Returns the number of solving attempts of the current user
	*/
	function get_attempt_count();
}

?>