module/fimodule.class.php
Classes
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
\fiModule
Abstract class for all FormIt modules
- package
- formit
- subpackage
- modules
Properties
Methods
__construct(
\FormIt $formit, array $config
=
array
)
:
| Name | Type | Description |
|---|---|---|
| $formit | \FormIt | |
| $config | array |
getOption(
string $key, mixed $default
=
null, string $method
=
!empty
)
:
null
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $default | mixed | |
| $method | string |
| Type | Description |
|---|---|
| null |
initialize(
)
:
void
abstractRuns after instantiation of the module
- abstract
output(
)
:
void
abstractReturns the output of the module
- abstract
setDefaultOptions(
array $defaults
=
array
)
:
voidSet the default options for this module
| Name | Type | Description |
|---|---|---|
| $defaults | array |
setOption(
string $key, mixed $value
)
:
voidSet an option for this module
| Name | Type | Description |
|---|---|---|
| $key | string | |
| $value | mixed |
setOptions(
array $array
)
:
voidSet an array of options
| Name | Type | Description |
|---|---|---|
| $array | array |