HtmlEditorManager Class Reference

Provides a central management class for event handlers and common functionality for the html_editor component. More...

Public Member Functions
	HtmlEditorManager ()

Static Public Member Functions
static	registerPlugin ($title, $plugin)
static	registerAdditionalPlugin ($title, $plugin)
static	registerActionFilter ($filter)
static	upgradeComponent ($version)
static	setDefaults ()
static	registerSerializationHandler ()
static	onInitialize ()
static	handleActionFilters ($context)
static	applyCustomCSS ($template)
static	formatSnippetParameters ($snippet)

Static Public Attributes
static	$plugins = array()
static	$additionalPlugins = array()
static	$actionFilters = array()

Detailed Description

Provides a central management class for event handlers and common functionality for the html_editor component.

Definition at line 12 of file html_editor_manager.inc.

Member Function Documentation

applyCustomCSS()

static HtmlEditorManager::applyCustomCSS (   $template )

static

Definition at line 91 of file html_editor_manager.inc.

     {
          if (Settings::getValue("html_editor", "enable_custom_css"))
          {
               $template = str_replace("</head>", "  <link href='/action/html_editor/custom_css' rel='stylesheet'/>\n</head>", $template);
          }    
          return $template;
     }

formatSnippetParameters()

static HtmlEditorManager::formatSnippetParameters (   $snippet )

static

Definition at line 100 of file html_editor_manager.inc.

     {
          $matches = array();
          if (preg_match_all("/{([^}]+)}/", $snippet->snippet, $matches, PREG_PATTERN_ORDER))
          {
               $fields = array_unique($matches[1]);
               
               ?>
               <h4>Snippet Parameters</h4>
               <table class='form' id='snippet_parameters'>
                
               <?
               foreach($fields as $field)
               {
               ?>
               <tr><td class='label'><label><?echo $field?></label></td>
               <td class='value'><input type='text' name='<?echo $field?>' class='snippet_parameter' id='snippet_parameter_{$i}' value='' size='75'/></td></tr>
               <?
               }
               ?>
               </table>
               <br/>
               <?
          }
     }

handleActionFilters()

static HtmlEditorManager::handleActionFilters (   $context )

static

Definition at line 82 of file html_editor_manager.inc.

     {
          foreach(HTMLEditorManager::$actionFilters as $filter)
          {
               $context = $filter($context);
          }
          return $context;
     }

HtmlEditorManager()

HtmlEditorManager::HtmlEditorManager

(

)

Definition at line 18 of file html_editor_manager.inc.

     {
 
     }

onInitialize()

static HtmlEditorManager::onInitialize ( )

static

Definition at line 59 of file html_editor_manager.inc.

     {
          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;
          
          ComponentManager::fireEvent("RegisterHTMLEditorPlugins");
          ComponentManager::fireEvent("RegisterHTMLEditorActionFilters");
          
          $tiny_mce_application_plugins = implode(",", array_keys(HtmlEditorManager::$plugins));
          $tiny_mce_application_toolbar_section = implode(" ", array_keys(HtmlEditorManager::$plugins)) . " |";
          $tiny_mce_application_context_menu_section = implode(" ", array_keys(HtmlEditorManager::$plugins)) . " |";
          $tiny_mce_content_css = Settings::getValue("html_editor", "CSS_files");
          $tiny_mce_body_class = Settings::getValue("html_editor", "body_class");
          
          if (count(HtmlEditorManager::$actionFilters) > 0)
          {
               HTMLFieldRenderer::$actionFilter = 'HTMLEditorManager::handleActionFilters';
          }
     }

registerActionFilter()

static HtmlEditorManager::registerActionFilter (   $filter )

static

Definition at line 33 of file html_editor_manager.inc.

     {
          HtmlEditorManager::$actionFilters[] = $filter; 
     }

registerAdditionalPlugin()

static HtmlEditorManager::registerAdditionalPlugin (   $title,   $plugin  )

static

Definition at line 28 of file html_editor_manager.inc.

     {
          HtmlEditorManager::$additionalPlugins[$plugin] = $title;
     }

registerPlugin()

static HtmlEditorManager::registerPlugin (   $title,   $plugin  )

static

Definition at line 23 of file html_editor_manager.inc.

     {
          HtmlEditorManager::$plugins[$plugin] = $title;    
     }

registerSerializationHandler()

static HtmlEditorManager::registerSerializationHandler ( )

static

Definition at line 53 of file html_editor_manager.inc.

     {
          SerializationManager::registerHandler("snippets", "Snippets", new SimpleSerializationHandler(Snippet));
          return true;
     }

setDefaults()

static HtmlEditorManager::setDefaults ( )

static

Definition at line 44 of file html_editor_manager.inc.

     {
          Settings::setDefaultValue("html_editor", "CSS_files", "", Text, "List of CSS files to apply within the editor. Put each CSS file on a separate line.", "Appearance");
          Settings::setDefaultValue("html_editor", "body_class", "", String, "Body class to be applied to content within the editor - use this to override inappropriate styles", "Appearance");
 
          Settings::setDefaultValue("html_editor", "enable_custom_CSS", false, Boolean, "", "Custom CSS", null, 1);
          Settings::setDefaultValue("html_editor", "custom_CSS", "", Text, "This setting can be used to provide custom CSS styles, configurable from the HTML editor. A link tag to /action/html_editor/custom_styles must be added to your site's template files.", "Custom CSS", null, 2);
     }

upgradeComponent()

static HtmlEditorManager::upgradeComponent (   $version )

static

Definition at line 38 of file html_editor_manager.inc.

     {
          $mgr = new HtmlEditorUpgradeManager();
          $mgr->upgrade($version);
     }

Member Data Documentation

$actionFilters

HtmlEditorManager::$actionFilters = array()

static

Definition at line 16 of file html_editor_manager.inc.

$additionalPlugins

HtmlEditorManager::$additionalPlugins = array()

static

Definition at line 15 of file html_editor_manager.inc.

$plugins

HtmlEditorManager::$plugins = array()

static

Definition at line 14 of file html_editor_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/html_editor/html_editor_manager.inc