Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Classes

  • BlockForm
  • Button
  • ButtonTray
  • Captcha
  • Checkbox
  • ColorPicker
  • DateSelect
  • DateTime
  • DhtmlTextArea
  • Editor
  • Element
  • ElementFactory
  • ElementTray
  • File
  • Form
  • GroupCheckbox
  • GroupFormCheckbox
  • GroupPermissionForm
  • Hidden
  • Label
  • Mail
  • OptionElement
  • Password
  • Radio
  • RadioYesNo
  • Raw
  • Select
  • SelectCountry
  • SelectEditor
  • SelectGroup
  • SelectLanguage
  • SelectLocale
  • SelectMatchOption
  • SelectTheme
  • SelectTimeZone
  • SelectUser
  • SimpleForm
  • Tab
  • TableForm
  • TabTray
  • Text
  • TextArea
  • ThemeForm
  • Token
  • Url

Interfaces

  • ContainerInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class Captcha

Captcha - captcha form element

For form creation: Add form element where proper:

$xoopsform->addElement(new \Xoops\Form\Captcha($caption, $name, $skipmember, $configs));

For verification:

$xoopsCaptcha = \XoopsCaptcha::getInstance();
     if (! $xoopsCaptcha->verify() ) {
         echo $xoopsCaptcha->getMessage();
         ...
     }
ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable
Extended by Xoops\Html\Attributes implements Xoops\Core\AttributeInterface
Extended by Xoops\Form\Element
Extended by Xoops\Form\Captcha

Direct known subclasses

XoopsFormCaptcha
Namespace: Xoops\Form
Package: Xoops\Form
Category: Xoops\Form\Captcha
Copyright: 2008-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Taiwen Jiang phppp@users.sourceforge.net
Link: http://xoops.org
Located at oops_lib/Xoops/Form/Captcha.php
Methods summary
public
# __construct( string|array $caption = '', string $name = 'xoopscaptcha', boolean $skipmember = true, array $configs = array() )

__construct

__construct

Parameters

$caption
Caption (default defined in captcha/language/) or array of all attributes
$name
Name for the input box
$skipmember
Skip CAPTCHA check for members
$configs
key/value pairs

Overrides

Xoops\Form\Element::__construct()
public boolean
# setConfig( string $name, mixed $val )

setConfig

setConfig

Parameters

$name
name
$val
value

Returns

boolean
public string
# render( )

render

render

Returns

string
public string
# renderValidationJS( )

renderValidationJS

renderValidationJS

Returns

string

Overrides

Xoops\Form\Element::renderValidationJS()
Methods inherited from Xoops\Form\Element
addCustomValidationCode(), getAccessKey(), getAccessString(), getCaption(), getClass(), getDescription(), getExtra(), getName(), getPattern(), getPatternDescription(), getTitle(), getValue(), hasClassLike(), isDatalist(), isHidden(), isRequired(), renderAttributeString(), renderDatalist(), setAccessKey(), setCaption(), setClass(), setDatalist(), setDescription(), setExtra(), setHidden(), setIfNotEmpty(), setIfNotSet(), setName(), setPattern(), setRequired(), setTitle(), setValue(), setWithDefaults(), themeDecorateElement()
Methods inherited from Xoops\Html\Attributes
add(), clear(), doRender(), get(), getAll(), getAllLike(), getNames(), has(), remove(), set(), setAll(), setArrayItem(), setMerge(), suppressRender()
Methods inherited from ArrayObject
append(), asort(), count(), exchangeArray(), getArrayCopy(), getFlags(), getIterator(), getIteratorClass(), ksort(), natcasesort(), natsort(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), serialize(), setFlags(), setIteratorClass(), uasort(), uksort(), unserialize()
Constants inherited from ArrayObject
ARRAY_AS_PROPS, STD_PROP_LIST
Properties summary
public XoopsCaptcha $captchaHandler
#
Properties inherited from Xoops\Form\Element
$customValidationCode, $extra, $suppressList
Properties inherited from Xoops\Html\Attributes
$suppressRenderAttributes
API documentation generated by ApiGen