Field renderer for HTML data fields. More...

Inheritance diagram for HTMLFieldRenderer:

Collaboration diagram for HTMLFieldRenderer:

Public Member Functions
	HTMLFieldRenderer (&$parent)

	setRTEParam ($key, $value)

	getRTEParam ($key)

	renderScript ($field)
	FieldRenderers can override this method to provide any Javascript that their control requires for an edit form. More...

	addEditorButton ($editor, $button)

	overrideEditorButton ($editor, $button)

	renderField ($field)
	FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field. More...

	renderReadOnly ($field)

	renderSearchField ($field, $mode="equal")
	FieldRenderers must override this method to provide the HTML implementation of the control displayed for the field in a search form. More...

	renderOnSubmitHandler ($field)
	FieldRenderers can override this method to provide any Javascript that must be executed when the form is submitted on the client. More...

Public Member Functions inherited from FieldRenderer
	FieldRenderer ($parent)
	Constructor. More...

	_printLabel ($field, $colspan=1, $styles="", $annotation="")
	Internal method to generate the HTML for the field label. More...

	_getLabel ($field, $addSuffix=true)

	_startField ($field, $styles="")
	Internal method to generate the starting HTML for the field (including the label) More...

	_endField ($field)
	Internal method to generate the closing HTML for the field. More...

	addValidatorsToForm ($field, $required=false)
	This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer. More...

	addSearchValidatorsToForm ($field, $mode, $required=false)
	For SearchForm, the validator field needs to match the name tag in the form which is in the format field:mode. More...

	formatName ($item, $name)
	Formats the given DataItem based on the supplied format string. More...

	renderSearchScript ($field, $mode)
	FieldRenderers can override this method to provide any Javascript that the control requires when being used in a search form. More...

	preProcess ($field="")
	FieldRenderers can override this method to provide behavior that occurs prior to the saving of the parent form's target object to the database. More...

	postProcess ($field="")
	FieldRenderers can override this method to provide behavior that occurs after the parent form's target object has been saved to the database. More...

Public Attributes
	$colspan = 2

	$hideStyleBar = false

	$width = "540px"

	$height = "200px"

	$featureButtons

	$rootBlock = "p"

	$baseURL = null

	$convertURLs = false

	$rteParams = array()

Public Attributes inherited from FieldRenderer
	$parent = null

	$labelSuffix = ""

	$colspan = 1

	$annotateBefore = false

	$annotateNextLine = true

	$hideLabel = false

	$onPreProcess = null
	callback hook for processing prior to saving the form's data object - individual renderers may override with custom processing More...

	$onPostProcess = null
	callback hook for processing after saving the form's data object - individual renderers may override with custom processing More...

Static Public Attributes
static	$_includedRTEScript = false

static	$actionFilter = null

Detailed Description

Field renderer for HTML data fields.

Renders with the Sonjara Rich Text Editor, which can be extended to provide custom toolbar buttons for application-specific features and enhancements.

Definition at line 46 of file html_field_renderer.inc.

Member Function Documentation

◆ addEditorButton()

HTMLFieldRenderer::addEditorButton	(	$editor,
		$button
	)

Definition at line 222 of file html_field_renderer.inc.

      {
           if ($button['url'])
           {
                echo "theEditors.$editor.addToolbarButton('{$button['name']}', '{$button['image']}', '{$button['tooltip']}', '{$button['url']}', '{$button['width']}', '{$button['height']}');\n";
           }
           else
           {
                echo "theEditors.$editor.addToolbarButton('{$button['name']}', '{$button['image']}', '{$button['tooltip']}', {$button['handler']});\n";
           }         
      }

◆ getRTEParam()

HTMLFieldRenderer::getRTEParam ( $key )

Definition at line 77 of file html_field_renderer.inc.

      {
           return $this->rteParams[$key];
      }

◆ HTMLFieldRenderer()

HTMLFieldRenderer::HTMLFieldRenderer ( & $parent )

Definition at line 63 of file html_field_renderer.inc.

      {
           $this->FieldRenderer($parent);
           $this->hideStyleBar = $parent->HTMLEditorHideStyleBar;
           $this->width = $parent->HTMLEditorDefaultWidth;
           $this->height = $parent->HTMLEditorDefaultHeight;
           $this->annotateBefore = true;
      }

◆ overrideEditorButton()

HTMLFieldRenderer::overrideEditorButton	(	$editor,
		$button
	)

Definition at line 234 of file html_field_renderer.inc.

      {
           echo "theEditors.$editor.overrideToolbarButton('{$button['name']}', {$button['handler']});\n";
      }

◆ renderField()

HTMLFieldRenderer::renderField ( $field )

FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 239 of file html_field_renderer.inc.

      {
           if ($this->parent->readOnlyForm || $this->parent->isReadOnly($field) || array_key_exists($field, $this->parent->hidden)) return "";
           echo "<div id='{$field}_container'></div>";
           
           $this->_startField($field);
  
           echo "<textarea id='{$this->parent->id}_{$field}' name='{$field}' style='width: {$this->width}; height: {$this->height}' class='richtext'>".htmlSafe($this->parent->data->get($field))."</textarea>\n";
           
           $this->_endField($field);
      }

◆ renderOnSubmitHandler()

HTMLFieldRenderer::renderOnSubmitHandler ( $field )

FieldRenderers can override this method to provide any Javascript that must be executed when the form is submitted on the client.

See HTMLFieldRenderer for an example of how this is used.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 285 of file html_field_renderer.inc.

      {
           // JDG 3/2/2011., no js for readonly field
           if ($this->parent->isReadOnly($field)) return "";
           
           $editor = $field."_editor";
           
           //echo "\ttheEditors.$editor.prepareForSubmit();\n";
      }

◆ renderReadOnly()

HTMLFieldRenderer::renderReadOnly ( $field )

Definition at line 251 of file html_field_renderer.inc.

      {
           $this->_startField($field);
  
           echo $this->parent->data->get($field);
           
           $this->_endField($field);
      }    

◆ renderScript()

HTMLFieldRenderer::renderScript ( $field )

FieldRenderers can override this method to provide any Javascript that their control requires for an edit form.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 82 of file html_field_renderer.inc.

      {
           global $config;
           
           if ($this->parent->readOnlyForm || $this->parent->isReadOnly($field)
                || array_key_exists($field, $this->parent->hidden)) return "";
  
           global $tiny_mce_application_plugins;
           global $tiny_mce_application_toolbar_section;
           global $tiny_mce_application_context_menu_section;
           global $tiny_mce_content_css;
           global $tiny_mce_body_class;
           
           $plugins = "advlist,lists,code,visualblocks,table,charmap,paste,contextmenu,searchreplace,fullscreen";
           if ($tiny_mce_application_plugins) $plugins .= ",".$tiny_mce_application_plugins;
           $contextMenu = "cut copy paste pastetext searchreplace removeformat | {$tiny_mce_application_context_menu_section} inserttable cell row column deletetable";
           $toolbar = "undo redo | cut copy paste pastetext searchreplace | styleselect | bold italic removeformat | bullist numlist outdent indent | table charmap | {$tiny_mce_application_toolbar_section} code visualblocks fullscreen";
           
           if (is_callable(HTMLFieldRenderer::$actionFilter))
           {
                $contextMenu = (HTMLFieldRenderer::$actionFilter)($contextMenu);
                $toolbar = (HTMLFieldRenderer::$actionFilter)($toolbar);
           }
           
           $https = Fakoli::checkSSL();
           
           $protocol = $https ? "https" : "http";
           
           $rootBlock = "";
           
           if ($this->rootBlock != "p")
           {
                if (!$this->rootBlock) 
                { 
                     $this->setRTEParam("forced_root_block", false);
                }
                else
                {
                     $this->setRTEParam("forced_root_block", $this->rootBlock);
                }
           }
  
           $baseURL = ($this->baseURL !== null) ? $this->baseURL : "{$protocol}://{$config['http_host']}";
           if (isset($config["convertURLs"]))
           {
                $convertURLs = $config["convertURLs"] ? true : false;
           }
           else
           {              
                $convertURLs = ($this->convertURLs) ? true : false;
           }
           
           if (!HTMLFieldRenderer::$_includedRTEScript)
           {
 ?>
  
      <script type='text/javascript'>
           tinymce.baseURL = "<?echo $protocol?>://<?echo $config['http_host']?>/fakoli/tinymce/";
      </script>
 <?        
                HTMLFieldRenderer::$_includedRTEScript = true;
           }
           
           $cssFiles = explode("\n", str_replace("\r", "", $tiny_mce_content_css));
           if (count($cssFiles) > 0)
           {
                $this->setRTEParam("content_css", $cssFiles);
           }
           else
           {
                $this->setRTEParam("content_css", "");
           }
  
           if (endsWith($this->width, "px"))
           {
                $w = substr($this->width, 0, -2);
  
                $this->setRTEParam("width", $w);
           }
                
           if (endsWith($this->height, "px"))
           {
                $h = substr($this->height, 0, -2);
                $this->setRTEParam("height", $h);
           }
  
           $this->setRTEParam("valid_elements", '*[*]');
           $this->setRTEParam("selector", "#{$this->parent->id}_{$field}");
           $this->setRTEParam("plugins", $plugins);
           $this->setRTEParam("contextmenu", $contextMenu);
           $this->setRTEParam("skin", 'fakoli');
           $this->setRTEParam("body_class", $tiny_mce_body_class);
           $this->setRTEParam("relative_urls", false);
           $this->setRTEParam("convert_urls", $convertURLs);
           $this->setRTEParam("document_base_url", $baseURL);
           $this->setRTEParam("menubar", false);
           $this->setRTEParam("toolbar", $toolbar);
           $this->setRTEParam("tools", 'inserttable');
           
           if ($this->customConfig) call_user_func($this->customConfig, $this);
 ?>        
      <script type='text/javascript'>
           tinymce.init(
           {
 <?
           echo $this->renderParameters();
 ?>
  });
      </script>
 <?        
      }

◆ renderSearchField()

HTMLFieldRenderer::renderSearchField	(	$field,
		$mode = `"equal"`
	)

FieldRenderers must override this method to provide the HTML implementation of the control displayed for the field in a search form.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 260 of file html_field_renderer.inc.

      {
           // AJG - Override default colspan when rendering in a search form
           $this->colspan = 1;
           
           if ($mode == "range")
           {
                $from = $this->parent->params->get($field, "from");
                $to =  $this->parent->params->get($field, "to");
                
                echo "<tr>\n";
                $this->_printLabel($field);
                echo "<td>From <input type='text' name='$field:from' value='{$from}' size='25'> to <input type='text' name='$field:to' value='{$to}' size='25'></td>\n";        
                echo "</tr>\n";
           }
           else
           {
                $value = $this->parent->params->get($field, $mode);
                echo "<tr>\n";
                $this->_printLabel($field);
                echo "<td><input type='text' name='$field:$mode' value='{$value}' size='50'></td>\n";          
                echo "</tr>\n";
           }         
      }

◆ setRTEParam()

HTMLFieldRenderer::setRTEParam	(	$key,
		$value
	)

Definition at line 72 of file html_field_renderer.inc.

      {
           $this->rteParams[$key] = $value;
      }

Member Data Documentation

◆ $_includedRTEScript

HTMLFieldRenderer::$_includedRTEScript = false

static

Definition at line 57 of file html_field_renderer.inc.

◆ $actionFilter

HTMLFieldRenderer::$actionFilter = null

static

Definition at line 59 of file html_field_renderer.inc.

◆ $baseURL

HTMLFieldRenderer::$baseURL = null

Definition at line 54 of file html_field_renderer.inc.

◆ $colspan

HTMLFieldRenderer::$colspan = 2

Definition at line 48 of file html_field_renderer.inc.

◆ $convertURLs

HTMLFieldRenderer::$convertURLs = false

Definition at line 55 of file html_field_renderer.inc.

◆ $featureButtons

HTMLFieldRenderer::$featureButtons

Definition at line 52 of file html_field_renderer.inc.

◆ $height

HTMLFieldRenderer::$height = "200px"

Definition at line 51 of file html_field_renderer.inc.

◆ $hideStyleBar

HTMLFieldRenderer::$hideStyleBar = false

Definition at line 49 of file html_field_renderer.inc.

◆ $rootBlock

HTMLFieldRenderer::$rootBlock = "p"

Definition at line 53 of file html_field_renderer.inc.

◆ $rteParams

HTMLFieldRenderer::$rteParams = array()

Definition at line 61 of file html_field_renderer.inc.

◆ $width

HTMLFieldRenderer::$width = "540px"

Definition at line 50 of file html_field_renderer.inc.

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

C:/code/cms.sonjara.com/framework/field_renderers/html_field_renderer.inc

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ addEditorButton()

◆ getRTEParam()

◆ HTMLFieldRenderer()

◆ overrideEditorButton()

◆ renderField()

◆ renderOnSubmitHandler()

◆ renderReadOnly()

◆ renderScript()

◆ renderSearchField()

◆ setRTEParam()

Member Data Documentation

◆ $_includedRTEScript

◆ $actionFilter

◆ $baseURL

◆ $colspan

◆ $convertURLs

◆ $featureButtons

◆ $height

◆ $hideStyleBar

◆ $rootBlock

◆ $rteParams

◆ $width