HTML_QuickForm2_Captcha
[ class tree: HTML_QuickForm2_Captcha ] [ index: HTML_QuickForm2_Captcha ] [ all elements ]

Class: HTML_QuickForm2_Element_Captcha_Session

Source Location: /HTML_QuickForm2_Captcha-0.1.2/HTML/QuickForm2/Element/Captcha/Session.php

Class Overview


HTML_QuickForm2 Captcha session storage


Author(s):

Version:

  • Release: 0.1.2

Variables

Methods


Child classes:

HTML_QuickForm2_Element_Captcha_Session_Mock
HTML_QuickForm2 Captcha dummy session storage

Inherited Variables

Inherited Methods


Class Details

[line 26]
HTML_QuickForm2 Captcha session storage


[ Top ]


Class Variables

$varname =  null

[line 33]

Session variable name.
  • Access: protected

Type:   string


[ Top ]



Method Detail

clear   [line 68]

void clear( )

Clears the data stored in this session.
  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_Captcha_Session_Mock::clear()
Clears the data stored in this session.

[ Top ]

getSessionId   [line 91]

string getSessionId( )

Return session ID
  • Return: ID that identifies the session
  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_Captcha_Session_Mock::getSessionId()
Return session ID

[ Top ]

hasData   [line 81]

boolean hasData( )

If the session already has data
  • Return: True if there are data, false if the session has not been used yet.
  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_Captcha_Session_Mock::hasData()
If the session already has data

[ Top ]

setVarname   [line 50]

void setVarname( string $varname)

Initializes the captcha session.

Separate from __construct() because the variable name of a form element may change its ID until the form gets used.

  • Throws: HTML_QuickForm2_Element_Captcha_Exception When the session has not been started
  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_Captcha_Session_Mock::setVarname()
Initializes the captcha session.

Parameters:

string   $varname     Session variable name to use

[ Top ]

__get   [line 103]

mixed __get( string $varname)

Returns a session variable.
  • Return: The value of the variable, null if not set.
  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_Captcha_Session_Mock::__get()
Returns a session variable.

Parameters:

string   $varname     Name of the variable to retrieve

[ Top ]

__set   [line 120]

void __set( string $varname, string $value)

Sets the value of a session variable.
  • Access: public

Overridden in child classes as:

HTML_QuickForm2_Element_Captcha_Session_Mock::__set()
Sets the value of a session variable.

Parameters:

string   $varname     Name of the session variable to retrieve
string   $value     Value for the variable

[ Top ]


Documentation generated on Mon, 04 Nov 2013 14:00:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.