AutoFormLayout Class Reference

AutoFormLayout provides the abstract base class for form layout engine classes. More...

Inheritance diagram for AutoFormLayout:

Public Member Functions
	__construct ($form)
	getGroupClass ($name, $collapsible, $collapsed, $additionalClass="")
	startGroup ($name, $collapsible=false, $collapsed=false)
	endGroup ()
	startField ($field, $renderer, $colspan=1, $styles="")
	endField ($field, $renderer)
	printLabel ($field, $renderer, $styles="", $annotation="")
	getLabel ($field, $renderer, $addSuffix=true)
	getLabelID ($field)
	startUngrouped ()
	endUngrouped ()
	startButtonLine ()
	endButtonLine ()
	errorBox ()
	requiredFields ($text)
	finalizeLayout ()

Static Public Member Functions
static	create ($type, $form)

Public Attributes
	$form
	$externalErrorBox = false
	Flag indicating whether the error box should be rendered inside the form grouping. More...

Detailed Description

AutoFormLayout provides the abstract base class for form layout engine classes.

When a form is constructed as an AutoForm object, the layout engine provides the HTML structure that the form fields are rendered within. Fakoli provides a number of layout engines for different application styles. You can specify a default layout in your applications config or settings, and can override this value on any AutoForm via the AutoForm::setLayout() method.

Author

andy

Definition at line 15 of file auto_form_layout.inc.

Constructor & Destructor Documentation

__construct()

AutoFormLayout::__construct

(

$form

)

Reimplemented in FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, SelectableTableRowFormLayout, TableRowFormLayout, SelectableTableHeaderFormLayout, TableHeaderFormLayout, MobileUngroupedFormLayout, UngroupedFormLayout, and TableBasedFormLayout.

Definition at line 21 of file auto_form_layout.inc.

     {
          $this->form = $form;
     }

Member Function Documentation

create()

static AutoFormLayout::create (   $type,   $form  )

static

Definition at line 88 of file auto_form_layout.inc.

     {
          switch($type)
          {
          case "mobile":
               return new MobileFormLayout($form);
 
          case "table_header":
               return new TableHeaderFormLayout($form);
               
          case "table_row":
               return new TableRowFormLayout($form);
          
          case "selectable_table_header":
               return new SelectableTableHeaderFormLayout($form);
               
          case "selectable_table_row":
               return new SelectableTableRowFormLayout($form);
               
               
          case "spreadsheet":
               return new SpreadsheetFormLayout($form);
               
          case "simple":
               return new SimpleFormLayout($form);
               
          case "table":
     
          default:
               return new TableBasedFormLayout($form);
          }
     }

endButtonLine()

AutoFormLayout::endButtonLine ( )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

endField()

AutoFormLayout::endField (   $field,   $renderer  )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

endGroup()

AutoFormLayout::endGroup ( )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, MobileUngroupedFormLayout, UngroupedFormLayout, and TableBasedFormLayout.

endUngrouped()

AutoFormLayout::endUngrouped ( )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

errorBox()

AutoFormLayout::errorBox ( )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

finalizeLayout()

AutoFormLayout::finalizeLayout

(

)

Reimplemented in TemplateFormLayout.

Definition at line 121 of file auto_form_layout.inc.

     {
     }

getGroupClass()

AutoFormLayout::getGroupClass	(		$name,
			$collapsible,
			$collapsed,
			$additionalClass = ""
	)

Definition at line 26 of file auto_form_layout.inc.

     {
          $class = $this->form->getGroupCSSClass($name);
          if ($additionalClass) $class = trim("{$additionalClass} $class");
          
          if ($collapsible)
          {
               $class = ($class) ? "{$class} collapsible" : "collapsible";
               $class .= $collapsed ? " collapsed" : " expanded";
          }
          
          if ($class)
          {
               $class = " class='$class'";
          }
          
          return $class;
     }

getLabel()

AutoFormLayout::getLabel	(		$field,
			$renderer,
			$addSuffix = true
	)

Reimplemented in SpreadsheetFormLayout, TableRowFormLayout, and TableHeaderFormLayout.

Definition at line 53 of file auto_form_layout.inc.

     {
          $label = isset($renderer->label) ? $renderer->label : $this->form->prettifyFieldName($field);
          
          if ($renderer->parent->markRequiredFields &&
              $renderer->parent->isRequired($field))
          {
          $label .= "*";
         }
 
         $label .= $renderer->labelSuffix;
          
         if ($renderer->parent->onFormatLabel)
         {
          $fn = $renderer->parent->onFormatLabel;
          $label = $fn($renderer->parent, $field, $label);
         }
         
         return $label;
     }

getLabelID()

AutoFormLayout::getLabelID

(

$field

)

Definition at line 74 of file auto_form_layout.inc.

     {
          return "{$this->form->id}_{$field}_label";        
     }

printLabel()

AutoFormLayout::printLabel (   $field,   $renderer,   $styles = "",   $annotation = ""  )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

requiredFields()

AutoFormLayout::requiredFields (   $text )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

startButtonLine()

AutoFormLayout::startButtonLine ( )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

startField()

AutoFormLayout::startField (   $field,   $renderer,   $colspan = 1,   $styles = ""  )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

startGroup()

AutoFormLayout::startGroup (   $name,   $collapsible = false,   $collapsed = false  )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, TableRowFormLayout, TableHeaderFormLayout, MobileUngroupedFormLayout, UngroupedFormLayout, and TableBasedFormLayout.

startUngrouped()

AutoFormLayout::startUngrouped ( )

abstract

Reimplemented in TemplateFormLayout, FilterFormLayout, SimpleFormLayout, MobileFormLayout, SpreadsheetFormLayout, SelectableTableRowFormLayout, TableRowFormLayout, SelectableTableHeaderFormLayout, TableHeaderFormLayout, and TableBasedFormLayout.

Member Data Documentation

$externalErrorBox

AutoFormLayout::$externalErrorBox = false

Flag indicating whether the error box should be rendered inside the form grouping.

Definition at line 19 of file auto_form_layout.inc.

$form

AutoFormLayout::$form

Definition at line 17 of file auto_form_layout.inc.

---

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

• C:/code/cms.sonjara.com/framework/auto_form_layout.inc