This class represents a captcha input in a property form. More...

Inheritance diagram for ilCaptchaInputGUI:

Collaboration diagram for ilCaptchaInputGUI:

Public Member Functions
	__construct ($a_title= '', $a_postvar= '')
	Constructor.
	setValue ($a_value)
	Set Value.
	getValue ()
	Get Value.
	setImageHeight ($image_height)
	getImageHeight ()
	setImageWidth ($image_width)
	getImageWidth ()
	setSize ($size)
	getSize ()
	checkInput ()
	Check input, strip slashes etc.
	insert (ilTemplate $a_tpl)
	setValueByArray ($a_values)
	Set value by array.
Public Member Functions inherited from ilFormPropertyGUI
&	executeCommand ()
	Execute command.
	getType ()
	Get Type.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setPostVar ($a_postvar)
	Set Post Variable.
	getPostVar ()
	Get Post Variable.
	getFieldId ()
	Get Post Variable.
	setInfo ($a_info)
	Set Information Text.
	getInfo ()
	Get Information Text.
	setAlert ($a_alert)
	Set Alert Text.
	getAlert ()
	Get Alert Text.
	setRequired ($a_required)
	Set Required.
	getRequired ()
	Get Required.
	setDisabled ($a_disabled)
	Set Disabled.
	getDisabled ()
	Get Disabled.
	setParentForm ($a_parentform)
	Set Parent Form.
	getParentForm ()
	Get Parent Form.
	setParent ($a_val)
	Set Parent GUI object.
	getParent ()
	Get Parent GUI object.
	getSubForm ()
	Get sub form html.
	hideSubForm ()
	Sub form hidden on init?
	setHiddenTitle ($a_val)
	Set hidden title (for screenreaders)
	getHiddenTitle ()
	Get hidden title.
	getItemByPostVar ($a_post_var)
	Get item by post var.
	serializeData ()
	serialize data
	unserializeData ($a_data)
	unserialize data
	writeToSession ()
	Write to session.
	clearFromSession ()
	Clear session value.
	readFromSession ()
	Read from session.
	getHiddenTag ($a_post_var, $a_value)
	Get hidden tag (used for disabled properties)
	setMulti ($a_multi, $a_sortable=false, $a_addremove=true)
	Set Multi.
	getMulti ()
	Get Multi.
	setMultiValues (array $a_values)
	Set multi values.
	getMultiValues ()
	Get multi values.
	getContentOutsideFormTag ()
	Get content that has to reside outside of the parent form tag, e.g.

Protected Attributes
	$value
	$size = 20
	$image_width = 215
	$image_height = 80
Protected Attributes inherited from ilFormPropertyGUI
	$type
	$title
	$postvar
	$info
	$alert
	$required = false
	$parentgui
	$parentform
	$hidden_title = ""
	$multi = false
	$multi_sortable = false
	$multi_addremove = true
	$multi_values

Additional Inherited Members
Protected Member Functions inherited from ilFormPropertyGUI
	setType ($a_type)
	Set Type.
	getMultiIconsHTML ()
	Get HTML for multiple value icons.

Detailed Description

This class represents a captcha input in a property form.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

Definition at line 13 of file class.ilCaptchaInputGUI.php.

Constructor & Destructor Documentation

ilCaptchaInputGUI::__construct	(	$a_title = `''`,
		$a_postvar = `''`
	)

Constructor.

Parameters

string	$a_title	Title
string	$a_postvar	Post Variable

Reimplemented from ilFormPropertyGUI.

Definition at line 40 of file class.ilCaptchaInputGUI.php.

References $lng, and ilFormPropertyGUI\setType().

        {
                global $lng;
                parent::__construct($a_title, $a_postvar);
                $this->setType('captcha');
                if($lng instanceof ilLanguage)
                {
                        $lng->loadLanguageModule('cptch');
                }
        }

Here is the call graph for this function:

Member Function Documentation

ilCaptchaInputGUI::checkInput ( )

Check input, strip slashes etc.

set alert, if input is not ok.

Returns: boolean Input ok, true/false

Reimplemented from ilFormPropertyGUI.

Definition at line 122 of file class.ilCaptchaInputGUI.php.

References $_POST, $lng, $si, ilFormPropertyGUI\getPostVar(), ilFormPropertyGUI\getRequired(), ilFormPropertyGUI\setAlert(), and ilUtil\stripSlashes().

        {
                global $lng;
                $_POST[$this->getPostVar()] = ilUtil::stripSlashes($_POST[$this->getPostVar()]);
                if($this->getRequired() && trim($_POST[$this->getPostVar()]) == '')
                {
                        if($lng instanceof ilLanguage)
                        {
                                $this->setAlert($lng->txt('msg_input_is_required'));
                        }
                        return false;
                }
                include_once('./Services/Captcha/classes/class.ilSecurImage.php');
                $si = new ilSecurImage();
                if(!$si->check($_POST[$this->getPostVar()]))
                {
                        if($lng instanceof ilLanguage)
                        {
                                $this->setAlert($lng->txt('cptch_wrong_input'));
                        }
                        return false;
                }
                return true;
        }

Here is the call graph for this function:

ilCaptchaInputGUI::getImageHeight ( )

Returns: int

Definition at line 81 of file class.ilCaptchaInputGUI.php.

References $image_height.

        {
                return $this->image_height;
        }

ilCaptchaInputGUI::getImageWidth ( )

Returns: int

Definition at line 97 of file class.ilCaptchaInputGUI.php.

References $image_width.

        {
                return $this->image_width;
        }

ilCaptchaInputGUI::getSize ( )

Returns: int

Definition at line 113 of file class.ilCaptchaInputGUI.php.

References $size.

        {
                return $this->size;
        }

ilCaptchaInputGUI::getValue ( )

Get Value.

Returns: string Value

Definition at line 65 of file class.ilCaptchaInputGUI.php.

References $value.

        {
                return $this->value;
        }

ilCaptchaInputGUI::insert ( ilTemplate $a_tpl )

Parameters

ilTemplate $a_tpl

Definition at line 193 of file class.ilCaptchaInputGUI.php.

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

        {
                $html = $this->render();
                $a_tpl->setCurrentBlock('prop_generic');
                $a_tpl->setVariable('PROP_GENERIC', $html);
                $a_tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

ilCaptchaInputGUI::setImageHeight ( $image_height )

Parameters

int $image_height

Definition at line 73 of file class.ilCaptchaInputGUI.php.

References $image_height.

        {
                $this->image_height = $image_height;
        }

ilCaptchaInputGUI::setImageWidth ( $image_width )

Parameters

int $image_width

Definition at line 89 of file class.ilCaptchaInputGUI.php.

References $image_width.

        {
                $this->image_width = $image_width;
        }

ilCaptchaInputGUI::setSize ( $size )

Parameters

int $size

Definition at line 105 of file class.ilCaptchaInputGUI.php.

References $size.

        {
                $this->size = $size;
        }

ilCaptchaInputGUI::setValue ( $a_value )

Set Value.

Parameters

string $a_value Value

Definition at line 56 of file class.ilCaptchaInputGUI.php.

Referenced by setValueByArray().

        {
                $this->value = $a_value;
        }

Here is the caller graph for this function:

ilCaptchaInputGUI::setValueByArray ( $a_values )

Set value by array.

Parameters

array $a_values value array

Definition at line 206 of file class.ilCaptchaInputGUI.php.

References ilFormPropertyGUI\getPostVar(), and setValue().

        {
                $this->setValue($a_values[$this->getPostVar()]);
        }

Here is the call graph for this function:

Field Documentation

ilCaptchaInputGUI::$image_height = 80

protected

Definition at line 33 of file class.ilCaptchaInputGUI.php.

Referenced by getImageHeight(), and setImageHeight().

ilCaptchaInputGUI::$image_width = 215

protected

Definition at line 28 of file class.ilCaptchaInputGUI.php.

Referenced by getImageWidth(), and setImageWidth().

ilCaptchaInputGUI::$size = 20

protected

Definition at line 23 of file class.ilCaptchaInputGUI.php.

Referenced by getSize(), and setSize().

ilCaptchaInputGUI::$value

protected

Definition at line 18 of file class.ilCaptchaInputGUI.php.

Referenced by getValue().

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

Services/Captcha/classes/class.ilCaptchaInputGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation