DUF: Declarative Ugly Forms  v0.1-94-g0b7957c
 All Classes Functions Variables Pages
Public Member Functions | Protected Attributes | List of all members
Toolbox Class Reference

Form gets everything it needs from this toolbox. More...

Public Member Functions

 __construct ($config, $context)
 Create a toolbox.
 
 updateFieldGroup ($generator_name, &$field_group)
 Use field group generator to generate complete field group from its partial definition.
 
 getFieldValidators ($field_type)
 Retrieve validator for given field type. More...
 
 getFieldValueProcessor ($field_type)
 Retrieve value processor for given field type.
 
 getFormRenderer ($renderer)
 Retrieve form renderer. More...
 
 getWidgetRenderer ($widget_shebang)
 Retrieve widget renderer. More...
 
 getFormCommonFieldRenderers ()
 Get common renderers for all fields in form. More...
 
 getLayoutRenderer ($layout_type)
 Retrieve layout renderer by layout type. More...
 
 getFieldRenderers ($field_type)
 Retrieve field renderers. More...
 
 getFieldRenderer ($field_type, $renderer_name)
 Retrieve field renderer. More...
 

Protected Attributes

 $config
 Toolbox configuration.
 
 $context
 Context.
 

Detailed Description

Form gets everything it needs from this toolbox.

Renderers starting with '@' are field renderers.

/

Todo:
Update docs.

/

Todo:
Check class interfaces.

Member Function Documentation

getFieldValidators (   $field_type)

Retrieve validator for given field type.

Returns
`array('validator_name' => 'Duf::FieldValidator::IFieldValidator class name'))`
getFormRenderer (   $renderer)

Retrieve form renderer.

Returns
function($form, $template_engine)
getWidgetRenderer (   $widget_shebang)

Retrieve widget renderer.

Returns
function($form, $template_engine, $widget_conf)
getFormCommonFieldRenderers ( )

Get common renderers for all fields in form.

These should be added to field-specific renderes of each field. Exact ordering of renderers after merge is not specified.

getLayoutRenderer (   $layout_type)

Retrieve layout renderer by layout type.

Returns
function($form, $layout_def, $template_engine)
getFieldRenderers (   $field_type)

Retrieve field renderers.

Each field has multiple renderers, i.e. one for label, another for input or errors.

Returns
array($renderer_name => function($form, $group_id, $field_id, $field_def, $value, $errors, $template_engine)))
getFieldRenderer (   $field_type,
  $renderer_name 
)

Retrieve field renderer.

Returns
array($renderer_name => function($form, $group_id, $field_id, $field_def, $value, $errors, $template_engine)))