TemplateFormLayout Class Reference

TemplateFormLayout provides support for custom form layouts. More...

Inheritance diagram for TemplateFormLayout:

Collaboration diagram for TemplateFormLayout:

Public Member Functions
	__construct ($form, $template, $showButtons=true)
	startGroup ($name, $collapsible=false, $collapsed=false)
	endGroup ()
	startField ($field, $renderer, $colspan=1, $styles="")
	endField ($field, $renderer)
	printLabel ($field, $renderer, $styles="", $annotation="")
	Internal method to generate the HTML for the field label. More...
	startUngrouped ()
	endUngrouped ()
	startButtonLine ()
	endButtonLine ()
	errorBox ()
	requiredFields ($text)
	finalizeLayout ()
Public Member Functions inherited from AutoFormLayout
	__construct ($form)
	getGroupClass ($name, $collapsible, $collapsed, $additionalClass="")
	getLabel ($field, $renderer, $addSuffix=true)
	getLabelID ($field)

Public Attributes
	$template
	$output
	$showButtons = true
Public Attributes inherited from AutoFormLayout
	$form
	$externalErrorBox = false
	Flag indicating whether the error box should be rendered inside the form grouping. More...

Additional Inherited Members
Static Public Member Functions inherited from AutoFormLayout
static	create ($type, $form)

Detailed Description

TemplateFormLayout provides support for custom form layouts.

Author

andy

Definition at line 1008 of file auto_form_layout.inc.

Constructor & Destructor Documentation

__construct()

TemplateFormLayout::__construct	(		$form,
			$template,
			$showButtons = true
	)

Definition at line 1014 of file auto_form_layout.inc.

     {
          trace("Using form template {$template}", 3);
          $this->template = file_get_contents($template);
          $this->showButtons = $showButtons;
          parent::__construct($form);
     }

Member Function Documentation

endButtonLine()

TemplateFormLayout::endButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 1116 of file auto_form_layout.inc.

     {
          if ($this->showButtons) 
          {
               $this->output .= ob_get_contents();
          }
          ob_end_clean();
          
          $this->output .=  "</div><br/>";
     }

endField()

TemplateFormLayout::endField	(		$field,
			$renderer
	)

Reimplemented from AutoFormLayout.

Definition at line 1041 of file auto_form_layout.inc.

     {
          $fieldContent = ob_get_contents();
          
          ob_end_clean();
          
          if ($renderer->parent->showAnnotations && !$renderer->annotateBefore && $renderer->parent->annotations[$field])
          {
               if ($renderer->annotateNextLine)
               {
                    $fieldContent .= "<br/>";
               }
               else
               {
                    $fieldContent .= "&nbsp;&nbsp;";
               }
               
               $fieldContent .= $renderer->parent->annotations[$field];
          }
          
          $this->template = str_replace("{".$field."}", $fieldContent, $this->template);       
     }

endGroup()

TemplateFormLayout::endGroup

(

)

Reimplemented from AutoFormLayout.

Definition at line 1028 of file auto_form_layout.inc.

     {
          $this->endUngrouped();
     }

endUngrouped()

TemplateFormLayout::endUngrouped

(

)

Reimplemented from AutoFormLayout.

Definition at line 1103 of file auto_form_layout.inc.

     {
     }

errorBox()

TemplateFormLayout::errorBox

(

)

Reimplemented from AutoFormLayout.

Definition at line 1127 of file auto_form_layout.inc.

     {
          $this->output .=  "<div id='{$this->form->id}__error' class='error' style='display: ".($this->form->msg ? 'table-cell' : 'none')."'>{$this->form->msg}</div>\n";
     }

finalizeLayout()

TemplateFormLayout::finalizeLayout

(

)

Reimplemented from AutoFormLayout.

Definition at line 1137 of file auto_form_layout.inc.

     {
          // Clear any unmapped fields
          foreach($this->form->data->getFields() as $field => $type)
          {
               $this->template = str_replace(array("{{$field}}", "{label:{$field}}"), array("", ""), $this->template);
          }
               
          $this->output = str_replace("{FORM}", $this->template, $this->output);
          echo $this->output;
     }

printLabel()

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

Internal method to generate the HTML for the field label.

Parameters

string	$field	the field name
int	$colspan	the number of columns to span
string	$styles	optional special styles that need to be applied
string	$annotation	annotation text for the field

Reimplemented from AutoFormLayout.

Definition at line 1072 of file auto_form_layout.inc.

     {
          if ($renderer->hideLabel && !$annotation) return;
          
          $label = $this->getLabel($field, $renderer);
          
          $labelHTML = "";
          
          if (!$renderer->hideLabel)
          {
               $labelHTML .= "<label id='".$this->getLabelID($field)."' for='$field'";
               if ($renderer->parent->labelCSS) $labelHTML .=  " class='{$renderer->parent->labelCSS}'";
               if ($styles) $labelHTML .=  " style='$styles'";
          
               $labelHTML .=  ">$label</label> ";
          }
          
          $labelHTML .=  "$annotation\n";
          
          $this->template = str_replace("{label:".$field."}", $labelHTML, $this->template);         
     }

requiredFields()

TemplateFormLayout::requiredFields

(

$text

)

Reimplemented from AutoFormLayout.

Definition at line 1132 of file auto_form_layout.inc.

     {
          $this->output .=  "<p class='required_text'>{$text}</p>\n";
     }

startButtonLine()

TemplateFormLayout::startButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 1107 of file auto_form_layout.inc.

     {
          $this->output .= "<br/>\n";
          $this->output .= " <div class='{$this->form->buttonLineCSS}' style='text-align: {$this->form->buttonAlignment}'><br/>";
          
          ob_start();
          
     }

startField()

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

Reimplemented from AutoFormLayout.

Definition at line 1033 of file auto_form_layout.inc.

     {
          $annotations = ($renderer->parent->showAnnotations && $renderer->annotateBefore) ? $renderer->parent->annotations[$field] : "";
          $this->printLabel($field, $renderer, $styles, $annotations);
          
          ob_start();
     }

startGroup()

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

Reimplemented from AutoFormLayout.

Definition at line 1022 of file auto_form_layout.inc.

     {
          // Groups are ignored when dealing with template form layouts
          $this->startUngrouped();
     }

startUngrouped()

TemplateFormLayout::startUngrouped

(

)

Reimplemented from AutoFormLayout.

Definition at line 1094 of file auto_form_layout.inc.

     {
          if (!$this->renderingForm)
          {
               $this->output .= "{FORM}";
               $this->renderingForm = true;
          }
     }

Member Data Documentation

$output

TemplateFormLayout::$output

Definition at line 1011 of file auto_form_layout.inc.

$showButtons

TemplateFormLayout::$showButtons = true

Definition at line 1012 of file auto_form_layout.inc.

$template

TemplateFormLayout::$template

Definition at line 1010 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