fidictionary.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

\fiDictionary
jump to top

Abstracts storage of values of posted fields and fields set by hooks.

package
formit

Properties

Propertypublicarray  $config= 'array'

A configuration array

Default valuearrayDetails
Type
array
Propertypublicarray  $fields= 'array'

An array of key->name pairs storing the fields passed

Default valuearrayDetails
Type
array
Propertypublic\FormIt  $formit= ''

A reference to the FormIt instance

Details
Type
\FormIt
Propertypublic\modX  $modx= ''

A reference to the modX instance

Details
Type
\modX

Methods

methodpublic  __construct( \FormIt $formit, array $config = array ) :
Parameters
Name Type Description
$formit \FormIt
$config array
methodpublic  erase( ) : boolean
Erase the stored fields
Returns
Type Description
boolean
methodpublic  fromArray( array $array ) : void
Set a variable number of fields by passing in a key->name pair array
Parameters
Name Type Description
$array array
methodpublic  gather( array $fields = array ) : void
Get the fields from POST
Parameters
Name Type Description
$fields array A default set of fields to load
methodpublic  get( string $field ) : mixed
Get a field value
Parameters
Name Type Description
$field string
Returns
Type Description
mixed
methodpublic  remove( string $key ) : void
Remove a field from the stack
Parameters
Name Type Description
$key string
methodpublic  reset( ) : void
methodpublic  retrieve( ) : mixed
Retrieve the fields from the cache
Returns
Type Description
mixed
methodpublic  set( string $field, mixed $value ) : void
Set a value
Parameters
Name Type Description
$field string
$value mixed
methodpublic  store( ) : void
Stash the fields into the cache
methodpublic  toArray( ) : array
Return all field values in an array of key->name pairs
Returns
Type Description
array
Documentation was generated by DocBlox 0.13-DEV.