BlueShoes Application Framework

made with PHP

http://www.blueshoes.org/

File: C:/usr/local/lib/php/blueshoes-4.2/core/html/form/specialfields/Bs_FormFieldEmail.class.php

BlueShoes Application Framework - Form

Bs_FormFieldEmail

Bs_Object
   |
  +-- Bs_FormElement
     |
    +-- Bs_FormField
       |
      +-- Bs_FormFieldTxt
         |
        +-- Bs_FormFieldText
           |
          +-- Bs_FormFieldEmail

E-Mail Form Field Class

public class Bs_FormFieldEmail extends Bs_FormFieldText

E-Mail Form Field Class
dependencies: Bs_FormFieldText

Authors andrej arn <andrej@arn.li>

Version 4.0.$id$

Copyright blueshoes.org

Methods inherited from Bs_FormFieldText

bs_formfieldtext

Methods inherited from Bs_FormFieldTxt

bs_formfieldtxt

Methods inherited from Bs_FormField

bs_formfield, &getelement, getfield, addenforcecheckbox, isexplodable, getadvancedstyle, getadvancedstylehelper, setexplode, getlabel, inputmanipulate, inputvalidate, validatemust, validateonlyoneof, validateonlyif, validateminlength, validatemaxlength, validatemuststartwith, validatenotstartwith, validatemustendwith, validatenotendwith, validatemustcontain, validatenotcontain, validateequalto, validatenotequalto, validatedatatype, validateregularexpression, validateadditionalcheck, validatemustbeunique, getvisibility, getonenterbehavior, getonentercode, applyonenterbehavior, shouldpersist, getdbdatatype, getdbfieldname, _getmaxlength, _gettagstringevents, getvalue, _gettagstringvalue, _gettagstringstyles, _gettagstringadditionaltags, getcaption, getcaptionforformoutput, geterror, gethelp, _highlightaccesskey, _getaccesskey, getfieldashidden, _getfieldnameforhtml, hasjavascript, ismust, _anyifcase, _markasused, _getbsdatainfonumber, isfilledin, _evalwrap, unpersisttrigger, geterrormessage, &serialize, unserialize, &encrypt, &decrypt, initfrompost

Methods inherited from Bs_FormElement

bs_formelement, hasformobject, setformobject, getcaption, getelement, getlevel, _doelementstringformat, _getparamvalue, getlanguagedependentvalue

Methods inherited from Bs_Object

isex, isexception, tostring, tohtml, persist, unpersist, bs_object, bbsetoutput, bbawake, bbisawake, bbxmsg, bbxfunctionstart, bbxfunctionend, bbxecho, bbxvar, bbxvardump, bbforcetrace, bbbufferstart, bbbufferget, bbbufferendflush, bbbufferendclean

Public Method Summary
void	disallowFreemail() blocks freemail providers.
void	Bs_FormFieldEmail() Warning: documentation is missing.

Private Method Summary
void	&getField([ mixed $explodeKey, bool $addEnforceCheckbox ]) overwrites and uses parent method. look there.Warning: documentation is missing.

Fields inherited from Bs_FormFieldTxt

Fields inherited from Bs_FormField

$_bs_string, $_bs_array, $_bs_htmlutil, $_bs_date, $fieldtype, $caption, $defaulterrormessage, $errormessage, $errortype, $level, $editability, $accessrights, $visibility, $isused, $valuedefault, $valuedefaulttype, $valuereceived, $valuedisplay, $valueinternal, $savetodb, $dbfieldname, $dbdatatype, $dbnotnull, $dbprimarykey, $dbkey, $dbindexfulltext, $dbautoincrement, $dbunique, $dbforeignkey, $dbattributes, $explodeeval, $_explodearray, $direction, $styles, $advancedstyles, $events, $onenter, $additionaltags, $bsdatatype, $bsdatainfo, $bsdatamanipulation, $bsdatamanipvar, $enforce, $_must, $must, $mustif, $mustoneof, $mustoneofif, $onlyoneof, $onlyif, $onlyoneofif, $minlength, $maxlength, $muststartwith, $notstartwith, $mustendwith, $notendwith, $mustcontain, $notcontain, $equalto, $notequalto, $mustbeunique, $regularexpression, $additionalcheck, $trim, $remove, $removei, $replace, $replacei, $case, $codepostreceive, $codepostload, $this, $charsrule

Fields inherited from Bs_FormElement

$persister, $persisterid, $_form, $name, $elementtype, $formid, $container, $orderid, $elementstringformat, $persistervarsettings, $this

Public Field Summary
int	$checkOnChange tells if and how we should check the given address when the user
string	$checkOnChangeUrl the url to submit to on the onChange event.

Private Constant Summary
BS_FORMFIELDEMAIL_VERSION	>>`4.0.$x$`<<	Warning: documentation is missing.

Public Method Details
disallowFreemail
public void disallowFreemail( )
	blocks freemail providers.
Returns	void

Bs_FormFieldEmail
public void Bs_FormFieldEmail( )
	Warning: documentation is missing.
Returns	void

Private Method Details

&getField

private void &getField( [ mixed $explodeKey, bool $addEnforceCheckbox ] )

overwrites and uses parent method. look there.
we just do it a bit different in 'normal' display mode. see code :)

Warning: documentation is missing.

Parameter

mixed	$explodeKey	`= >>NULL,<<`
	(int or string)

bool	$addEnforceCheckbox	`= >>TRUE<<`
	default is TRUE. adds the enforce checkbox automatically, if needed. see (parent::)addEnforceCheckbox().

Returns

void

Public Field Details
$checkOnChange
public int $checkOnChange >><< tells if and how we should check the given address when the user changes it (or types it) immediatly.this is a clientside/serverside feature using an iframe.possible values:1 = syntax check2 = syntax check + host check3 = syntax check + host check + account checkdefault: do nothing.
See Also	$checkOnChangeUrl

$checkOnChangeUrl
public string $checkOnChangeUrl >><< the url to submit to on the onChange event.
See Also	$checkOnChange

Private Constant Details
BS_FORMFIELDEMAIL_VERSION `define( BS_FORMFIELDEMAIL_VERSION, >>4.0.$x$<< )` Case: default: case sensitive

PHPDoc 1.0beta