Dataface_FormTool_ckeditor Class Reference

A Dataface_FormTool wrapper for building ckeditor widgets in Dataface_QuickForm forms. More...

Public Member Functions
&	buildWidget ($record, &$field, $form, $formFieldName, $new=false)

---

Detailed Description

A Dataface_FormTool wrapper for building ckeditor widgets in Dataface_QuickForm forms.

All widget types require a wrapper of this kind to implement the glue between the field and the database records. This particular wrapper only implements the buildWidget() method but it could also implement pushValue() and pullValue() methods to define how data should be treated when passing between Dataface_RecordObjects and the HTML_QuickForm widget.

Note that the modules_tagger class actually registers this class with Dataface_FormTool so that it knows of its existence.

Definition at line 34 of file widget.php.

---

Member Function Documentation

& buildWidget	(	$	record,
		&$	field,
		$	form,
		$	formFieldName,
		$	new = false
	)

Defines how a ckeditor widget should be built.

Parameters:

Dataface_Record	$record	The Dataface_Record that is being edited.
array	&$field	The field configuration data structure that the widget is being generated for.
	HTML_QuickForm	The form to which the field is to be added.
string	$formFieldName	The name of the field in the form.
boolean	$new	Whether this widget is being built for a new record form.

Returns:

HTML_QuickForm_element The element that can be added to a form.

Definition at line 47 of file widget.php.

---

The documentation for this class was generated from the following file:

• widget.php