Class Quform_Element_Captcha

Quform_Element

Extended by

Quform_Element_Field

Extended by

Quform_Element_Captcha

Copyright: Copyright (c) 2009-2022 ThemeCatcher (https://www.themecatcher.net)
Located at Quform/Element/Captcha.php

Methods summary
`public`	# `__construct( integer $id, Quform_Form $form, Quform_Session $session )` Parameters `$id` `$form` `$session` Overrides `Quform_Element::__construct()`
`protected array`	# `getImageAttributes( )` Get the HTML attributes for the image tag Get the HTML attributes for the image tag Returns array
`protected string`	# `getImageHtml( )` Get the HTML for the captcha image Get the HTML for the captcha image Returns string
`protected array`	# `getFieldAttributes( array $context = array() )` Get the HTML attributes for the field Get the HTML attributes for the field Parameters `$context` Returns array
`protected array`	# `getFieldClasses( array $context = array() )` Get the classes for the field Get the classes for the field Parameters `$context` Returns array
`protected string`	# `getFieldHtml( array $context = array() )` Get the HTML for the field Get the HTML for the field Parameters `$context` Returns string
`protected string`	# `getInputHtml( array $context = array() )` Get the HTML for the element input wrapper Get the HTML for the element input wrapper Parameters `$context` Returns string Overrides `Quform_Element_Field::getInputHtml()`
`protected string`	# `generateCode( integer $length )` Generates a string of characters of the given length Generates a string of characters of the given length Parameters `$length` Returns string
`public string`	# `generateImageData( )` Get the complete base64 encoded image data for use in an <img> tag and set generated code in session Get the complete base64 encoded image data for use in an <img> tag and set generated code in session Returns string
`protected string`	# `getFontPath( string $font )` Get the path to the given font Get the path to the given font Copies the font file to a temporary folder it is a Windows server Parameters `$font` The filename of the font Returns string The full path to the font
`protected boolean`	# `supportsDynamicImageGeneration( )` Returns boolean
`protected string`	# `generateDynamicImage( string $code )` Generate the captcha image from the given code Generate the captcha image from the given code Parameters `$code` The code to generate Returns string
`protected string`	# `getStaticImageData( )` Base 64 encoded captcha image when dynamic image generation is not available Base 64 encoded captcha image when dynamic image generation is not available Displays the string 'catch' Returns string The image data as base 64
`protected string`	# `renderCss( array $context = array() )` Render the CSS for this element Render the CSS for this element Parameters `$context` Returns string Overrides `Quform_Element_Field::renderCss()`
`public static array`	# `getDefaultConfig( string\|null $key = null )` Get the default element configuration Get the default element configuration Parameters `$key` Get the config by key, if omitted the full config is returned Returns array

Methods inherited from Quform_Element_Field
addError(), addFilter(), addValidator(), clearError(), clearErrors(), clearFilters(), clearValidators(), convertValueFromStorage(), filterValue(), filterValueRecursive(), getAdminLabel(), getBelongsTo(), getConvertedValueForStorage(), getCssSelectors(), getDefaultValue(), getDescriptionHtml(), getEditLabelHtml(), getElementClasses(), getEmptyValue(), getError(), getErrorArray(), getErrorHtml(), getErrors(), getFieldIconsHtml(), getFilter(), getFilters(), getFullyQualifiedName(), getIdentifier(), getInnerClasses(), getInputClasses(), getLabel(), getLabelHtml(), getName(), getSubLabelHtml(), getTooltip(), getUniqueId(), getValidator(), getValidators(), getValue(), getValueForStorage(), getValueHtml(), getValueRaw(), getValueText(), hasDefaultValue(), hasError(), hasFilter(), hasFilters(), hasValidator(), hasValidators(), hasValue(), isEmpty(), isLogicRuleMatch(), isLogicValueMatch(), isMultiple(), isRequired(), isValid(), isValidValue(), prepareDynamicValue(), removeFilter(), removeValidator(), render(), reset(), setBelongsTo(), setDefaultValue(), setDynamicDefaultValue(), setError(), setIsMultiple(), setValue(), setValueFromStorage(), shouldConvertToHidden()

Methods inherited from Quform_Element
`config(), getCss(), getCssSelector(), getForm(), getId(), getTranslation(), hasNonVisibleAncestor(), isConditionallyHidden(), isHidden(), isVisible(), prepareContext(), setConditionallyHidden(), setConfig(), setForm(), setHasNonVisibleAncestor(), setId(), setUniqueId()`

Properties summary
`protected Quform_Session`	`$session`	#

Properties inherited from Quform_Element_Field
`$belongsTo, $defaultValue, $errors, $filters, $isMultiple, $validators, $value`

Properties inherited from Quform_Element
`$config, $form, $hasNonVisibleAncestor, $id, $isConditionallyHidden, $uniqueId`