Table of Contents

  1. Welcome to the Fusebox Project Wiki
    1. Bug Tracker
    2. History
    3. Team Fusebox and TeraTech
  2. Documentation Overview
    1. Frequently Asked Questions
  3. Understanding the XML Files
    1. What are the Fusebox XML files?
    1. The fusebox.xml File
    1. The circuit.xml file
      1. circuit
      2. fuseaction
      3. prefuseaction, postfuseaction
  6. Circuit XML Grammar
    1. Overview
    2. The Builtin Verbs
    3. Gotchas
    4. Summary
  7. Extending the FB5 framework with Custom Lexicons
    1. What’s happening here?
    2. Built-in Verbs
    3. Writing Custom Verbs
    4. Example verbs
      1. <cf:abort>
      2. <cf:dump>
  8. Extending The FB5 Framework With Plugins
  9. FLiP Methodology Overview
  10. Fusebox 5.1 Release Notes
    1. Bugs fixed in Fusebox 5.1
    2. Enhancements added in Fusebox 5.1
    3. Other miscellaneous tickets closed in Fusebox 5.1
  11. Fusebox 5.1 Enhancements
    1. Globally Shared Files
      1. Globally Shared Circuits
      2. Globally Shared Plugins
      3. Globally Shared Error Templates
      4. Globally Shared Lexicons
    2. Search Engine Safe URLs
    3. Using event as an alternative to attributes

plugins

The last element in the fusebox.xml is the plugins element. Plugins are a way to extend the functionality of the Fusebox core files.

The plugins element can contain several phase elements which define six possible places where the fusebox core can be extended. 

    <plugins>
        <phase name="preProcess"></phase>
        <phase name="preFuseaction"></phase>
        <phase name="postFuseaction"></phase>
        <phase name="fuseactionException"></phase>
        <phase name="postProcess"></phase>
        <phase name="processError"></phase>
    </plugins>

An individual plugin can be declared like this inside any given phase: 

    <plugin name="pluginName" template="pluginFile"/>

This tells Fusebox to execute pluginFile.cfm during the appropriate phase of the request lifecycle. You can optionally specify a path attribute which specifies the path of the template relative to the plugins folder. As of Fusebox 5.1, you can specify an absolute (or mapped) path which then ignores the plugins folder and uses a path relative to the webroot or resolved via a mapping. The template attribute itself can specify an absolute (or mapped) path which will ignore the path attribute as well as the plugins folder.

As of Fusebox 5.1, the plugin declaration may also include custom attributes that use XML prefixes declared on the <fusebox> tag at the head of the Fusebox XML file.

For more details on this please read the Extending the framework with plugins page.