|
|
|
File: C:/usr/local/lib/php/blueshoes-4.2/core/html/form/specialfields/Bs_FormFieldCountryList.class.php
BlueShoes Application Framework - Form
Bs_FormFieldCountryList
Bs_Object
|
+-- Bs_FormElement
|
+-- Bs_FormField
|
+-- Bs_FormFieldSelect
|
+-- Bs_FormFieldCountryList
Country List Select Form Field Class
|
public class Bs_FormFieldCountryList extends Bs_FormFieldSelect
Country List Select Form Field Class
no dependencies here.
| Authors | andrej arn <andrej@arn.li> |
| Version | 4.0.$id$ |
| Copyright | blueshoes.org |
|
| |
|
|
|
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_Object |
| isex, isexception, tostring, tohtml, persist, unpersist, bs_object, bbsetoutput, bbawake, bbisawake, bbxmsg, bbxfunctionstart, bbxfunctionend, bbxecho, bbxvar, bbxvardump, bbforcetrace, bbbufferstart, bbbufferget, bbbufferendflush, bbbufferendclean |
|
|
|
|
|
|
|
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 |
| array |
$staticCountryListthe country list to use. it's a static class var, so other instances |
| unknown |
$doOrderOnSpitif and how we should order the country list before we spit it out to the browser. |
| string |
$showCodewhether to show the country code or not. |
|
|
|
|
|
Public Method Details |
Bs_FormFieldCountryList |
|
public void Bs_FormFieldCountryList( )
|
| |
Constructor.
|
| Returns |
void |
|
addElement |
|
public void addElement( string $code, mixed $caption, [ string $location ] )
|
| |
adds an element to the country list output, not to the static list itself
(cause this might affect other instances of this class).
|
| Parameter |
|
|
|
| mixed |
$caption |
|
|
(string or hash cause it's language dependant.) |
|
|
| string |
$location |
= >>'end'<< |
|
(default and currently only supported is 'end'.) |
|
| Returns |
void |
|
loadCountryList |
|
public mixed loadCountryList( [ string $from, string $useCache, string $autoFallback ] )
|
| |
feel free to write other load methods. file, db.
param $autoFallback:if you try to load the fresh list from the db and that fails, it's a good idea to usethe hardcoded fallback data. the priorities are like this:1) db2) file3) hard(coded)4) return falsecheck the returned value.
|
| Parameter |
|
| string |
$from |
= >>'hard'<< |
|
('hard' is the only supported one.) |
|
|
| string |
$useCache |
= >>TRUE,<< |
|
(if we should use a previously loaded list, default ist TRUE.) |
|
|
| string |
$autoFallback |
= >>TRUE<< |
|
(default is TRUE. see above.) |
|
| Returns |
mixed (bool TRUE on success, bool FALSE on failure, string 'from' if a fallback source has been used.) |
|
|
Private Method Details |
_prepareOptionsData |
|
private void _prepareOptionsData( )
|
| |
overwrites and uses parent method. see there.
Warning: documentation is missing.
|
| Returns |
void |
|
_loadCountryListHard |
|
private void _loadCountryListHard( )
|
| |
|
| Returns |
void |
|
|
Public Field Details |
$staticCountryList |
|
public array $staticCountryList
>>
the country list to use. it's a static class var, so other instances
of this class may use the same one. keep that in mind when you want tomodify the values.
|
|
$doOrderOnSpit |
|
public unknown $doOrderOnSpit
>>
if and how we should order the country list before we spit it out to the browser.
|
|
$showCode |
|
public string $showCode
>>TRUE<<
whether to show the country code or not.
default is TRUE.
|
|
|
|
|
|
|
|
|
|
| PHPDoc 1.0beta |
