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

<circuits>

The circuits element defines each the circuits in a Fusebox application. There must be at least one circuit element within it and it is considered good practice to organize the circuits into [Model], [View] and [Controller] to separate the various functions. The circuits element contains one or more circuit elements. Each circuit has attributes to define that circuit's alias, path, and parent. You can have as many circuit elements as you need. Here is an example: 

    <circuits>
        <circuit alias="m" path="model/" parent=""/>
        <circuit alias="v" path="view/"  parent=""/>
        <circuit alias="main" path="controller/" parent=""/>
    </circuits>

<circuit>

Each circuit tag specifies:

Attribute Description
alias The name by which this circuit will be called.
path The path to the directory which contains the circuit’s own XML definition file. This is normally a relative path from the application root. As of Fusebox 5.1, you can specify an absolute (or mapped) path for a circuit which is either relative to the webroot or resolved via a mapping. To use an absolute (or mapped) path, you must specify relative="false". (The path should always end with a trailing slash "/".)
parent The name of a parent circuit if required. If specified, the parent circuit's prefuseaction and postfuseaction can be invoked by setting the callsuper parameter in the prefuseaction and postfuseaction elements within the circuit.xml file.
relative Introduced in Fusebox 5.1, this specifies whether the path attribute should be treated as a relative or absolute (mapped) path. If you specify relative="true" (the default), in strict mode, then the path attribute must not start with a "/" (or "\" on Windows). If you specify relative="false", then the path attribute must start with "/" (or "\" on Windows).