module/fistateoptions.class.php

FormIt

Copyright 2009-2011 by Shaun McCormick shaun@modx.com

FormIt is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

FormIt is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with FormIt; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package
formit

\fiStateOptions

Loads a option list of states

Extends from
\fiModule
package
formit
subpackage
modules

Properties

Propertypublicarray  $list= 'array'

Default valuearrayDetails
Type
array
Propertypublicarray  $states= 'array'

Default valuearrayDetails
Type
array

Methods

methodpublic  __construct( \FormIt $formit, array $config = array ) :
Inherited from: \fiModule::__construct()
Parameters
Name Type Description
$formit \FormIt
$config array
methodpublic  getData( ) : array
Load the country list
Returns
Type Description
array
methodpublic  getOption( string $key, mixed $default = null, string $method = !empty ) : null
Inherited from: \fiModule::getOption()
Parameters
Name Type Description
$key string
$default mixed
$method string
Returns
Type Description
null
methodpublic  initialize( ) : void
Runs after instantiation of the module
methodpublic  iterate( ) : void
iterate over lists
methodpublic  output( ) : string
Handle output generation
Returns
Type Description
string
methodprotected  setDefaultOptions( array $defaults = array ) : void
Set the default options for this moduleInherited from: \fiModule::setDefaultOptions()
Parameters
Name Type Description
$defaults array
methodpublic  setOption( string $key, mixed $value ) : void
Set an option for this moduleInherited from: \fiModule::setOption()
Parameters
Name Type Description
$key string
$value mixed
methodpublic  setOptions( array $array ) : void
Set an array of optionsInherited from: \fiModule::setOptions()
Parameters
Name Type Description
$array array
Documentation was generated by DocBlox 0.13-DEV.