SimpleCaptchaPlugin.php

Summary
SimpleCaptchaPlugin.php
SimpleCaptchaPluginPlugin that implements a rudimentary captcha interface
SimpleCaptchaPluginMain class for the SimpleCaptcha plugin
initializeInitializes the plugin.
onEndRegistrationFormDataDisplay the capcha form on the registration page.
getCaptchaTextUse the site’s name as the captcha text.
onStartRegistrationTryIf entered text doesn’t match the captcha text, record it in the log.
onPluginVersionModify a versions array to contain the version info of the plugin.

SimpleCaptchaPlugin

Plugin that implements a rudimentary captcha interface

postActiv

the micro-blogging software

Copyright

Copyright © 2016-2017, Maiyannah Bishop

Derived from code copyright various sources

  • GNU Social © 2013-2016, Free Software Foundation, Inc
  • StatusNet © 2008-2012, StatusNet, Inc

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program.  If not, see http://www.gnu.org/licenses/.

https://www.gnu.org/licenses/agpl.html

About

Plugin that implements a rudimentary captcha interface

PHP version

Tested with PHP 7

File Authors

Web

SimpleCaptchaPlugin

Main class for the SimpleCaptcha plugin

Summary
initializeInitializes the plugin.
onEndRegistrationFormDataDisplay the capcha form on the registration page.
getCaptchaTextUse the site’s name as the captcha text.
onStartRegistrationTryIf entered text doesn’t match the captcha text, record it in the log.
onPluginVersionModify a versions array to contain the version info of the plugin.

initialize

public function initialize()

Initializes the plugin.

onEndRegistrationFormData

public function onEndRegistrationFormData(Action $action)

Display the capcha form on the registration page.

Parameters

  • Action $action - form action

Returns

  • bool true on success

getCaptchaText

protected function getCaptchaText()

Use the site’s name as the captcha text.

Returns

  • string containing the site’s name

onStartRegistrationTry

public function onStartRegistrationTry(Action $action)

If entered text doesn’t match the captcha text, record it in the log.

Parameters

  • Action $action - form action

Returns

  • bool true

onPluginVersion

public function onPluginVersion(array &$versions)

Modify a versions array to contain the version info of the plugin.

Parameters

  • array $versions - an array to contain the version info

Returns

  • boolean hook value
public function initialize()
Initializes the plugin.
public function onEndRegistrationFormData(Action $action)
Display the capcha form on the registration page.
protected function getCaptchaText()
Use the site’s name as the captcha text.
public function onStartRegistrationTry(Action $action)
If entered text doesn’t match the captcha text, record it in the log.
public function onPluginVersion(array &$versions)
Modify a versions array to contain the version info of the plugin.