Comments: on this page. Click to read or post your own.

Class FormScaffolder

Description
Description | Vars (details) | Methods (details)

Located in /sapphire/forms/FormScaffolder.php (line 10) 

Object
   |
   --FormScaffolder
Variable Summary
Description | Vars (details) | Methods (details)
boolean $ajaxSafe
array $fieldClasses
boolean $includeRelations
DataObject $obj
array $restrictFields
boolean $tabbed
Method Summary
Description | Vars (details) | Methods (details)
FormScaffolder __construct (DataObject $obj, array $params)
FieldSet getFieldSet ()
array getParamsArray ()
Variables
Description | Vars (details) | Methods (details)
boolean $ajaxSafe = false (line 27)
  • access: public
array $fieldClasses (line 43)
  • var: Optional mapping of fieldnames to subclasses of FormField. By default the scaffolder will determine the field instance by DBField::scaffoldFormField().
  • todo: Implement fieldClasses for has_many and many_many relations
  • access: public
boolean $includeRelations = false (line 48)
  • var: Include has_one, has_many and many_many relations
  • access: public
DataObject $obj (line 16)
  • var: The object defining the fields to be scaffolded through its metadata like $db, $searchable_fields, etc.
  • access: protected
array $restrictFields (line 35)
  • var: Numeric array of a field name whitelist. If left blank, all fields from DataObject->db() will be included.
  • todo: Implement restrictions for has_many and many_many relations.
  • access: public
boolean $tabbed = false (line 22)
  • var: Return fields in a tabset, with all main fields in the path "Root.Main", relation fields in "Root.<relationname>" (if $includeRelations is enabled).
  • access: public

Inherited Variables

Inherited from Object

Object::$builtInMethods
 Object::$class
 Object::$classConstructed
 Object::$extensions
 Object::$extension_instances
 Object::$extraMethods
 Object::$extraStatics
 Object::$statics
 Object::$static_cached
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 54)
FormScaffolder __construct (DataObject $obj, array $params)
Redefinition of:
Object::__construct()
getFieldSet (line 66)

Gets the form fields as defined through the metadata on $obj and the custom parameters passed to FormScaffolder.

Depending on those parameters, the fields can be used in ajax-context, contain TabSets etc.

  • access: public
FieldSet getFieldSet ()
getParamsArray (line 177)

Return an array suitable for passing on to DBField->scaffoldFormField() without tying this call to a FormScaffolder interface.

  • access: protected
array getParamsArray ()

Inherited Methods

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()
blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:41:13 +1300 by phpDocumentor 1.3.2