Changes between Version 1 and Version 2 of ReferenceMaterials/ModelGlueXmlReference

Show
Ignore:
Timestamp:
05/05/09 09:33:15 (17 years ago)
Author:
davidhenry@… (IP: 174.99.26.254)
Comment:

Added event-types, event-type, before, after tags for Typed Events feature in MG3

Legend:

Unmodified
Added
Removed
Modified

  • ReferenceMaterials/ModelGlueXmlReference

    v1 v2  
    55All Model-Glue applications are configured via at least one XML file that follows the "Model-Glue" XML format described in this document. 
    66 
    7 == <argument> == 
    8  
    9 A string value passed to a function registered to listen for a given message as part of the function's Event argument. Its value can be acessed through the Event API's getArgument() method. 
    10  
    11 ==== Attributes ==== 
    12  
    13   1. Name (Required) - Defines the name of the argument. 
    14   1. Value (Required) - Defines the value of this argument. 
    15  
    16 ==== Child Tags ==== 
    17  
    18 None 
    19  
    20 == <broadcasts> == 
    21  
    22 Contains a list of <message> tags. The <message> tags ''will be broadcast in the order in which they are defined.'' 
    23  
    24 ==== Attributes ==== 
    25  
    26 None 
    27  
    28 ==== Child Tags ==== 
    29  
    30   1. <message> 
    31  
    32 == <config> == 
    33  
    34 Used in Model-Glue XML fragments to define additional settings and by legacy Model-Glue 1.x applications to define settings. 
    35  
    36 ''This tag is largely unused in Model-Glue 2.0+! '' 
    37  
    38 ==== Attributes ==== 
    39  
    40 None 
    41  
    42 ==== Child Tags ==== 
    43  
    44   1. <setting> 
    45  
    46 == <controller> == 
    47  
    48 Defines a CFC that will act as a Controller in the application. 
    49  
    50 ==== Attributes ==== 
    51  
    52   1. Name (Required) - A unique name for this controller. A Model-Glue application where multiple controllers are added with the same name will currently confuse the framework (as of 2.0 Beta 1). This will eventually be resolved. 
    53   1. Type (Required) - The CFC to use for a controller in the same format that you'd use in a !CreateObject() call, such as "myapplication.controller.!MyController" 
    54  
    55 ==== Child Tags ==== 
    56  
    57 None 
    58  
    59 == <controllers> == 
    60  
    61 Contains a list of <controller> tags. 
    62  
    63 ==== Attributes ==== 
    64  
    65 None 
    66  
    67 ==== Child Tags ==== 
    68  
    69   1. <controller> 
    70  
    71 == <event-handler> == 
    72  
    73 Defines an event or "page" in the application. 
    74  
    75 ==== Attributes ==== 
    76  
    77   1. Name (Required) - A unique name for the event handler. This defines how the event will be accessed through the URL, such as "index.cfm?event=!MyEvent". [[BR]][[BR]]''If an <event-handler> is added whose NAME attribute is in use by another event-handler, it will overwrite the previous event-handler, except in the case of the predefined modelglue.onRequestStart, modelglue.onQueueComplete, and modelglue.onRequestEnd event-handlers. In this case, any messages, views, or results defined will be added to the predefined event handlers.''[[BR]][[BR]] 
    78   1. Access (Optional, defaults to "public") - If set to "private," the event handler cannot be accessed directly through the URL. 
    79  
    80 ==== Child Tags ==== 
    81  
     7== <after> == 
     8Part of a typed event. See [wiki:HowToUseTypedEvents How To Use Typed Events] for more information. 
     9=== Attributes === 
     10 
     11None 
     12 
     13=== Child Tags === 
    8214  1. <broadcasts> 
    8315  1. <results> 
    8416  1. <views> 
     17== <argument> == 
     18 
     19A string value passed to a function registered to listen for a given message as part of the function's Event argument. Its value can be acessed through the Event API's getArgument() method. 
     20 
     21==== Attributes ==== 
     22 
     23  1. Name (Required) - Defines the name of the argument. 
     24  1. Value (Required) - Defines the value of this argument. 
     25 
     26==== Child Tags ==== 
     27 
     28None 
     29 
     30== <before> == 
     31 
     32Part of a typed event. See [wiki:HowToUseTypedEvents How To Use Typed Events] for more information. 
     33 
     34=== Attributes === 
     35 
     36None 
     37 
     38=== Child Tags === 
     39 
     40  1. <broadcasts> 
     41  1. <results> 
     42  1. <views> 
     43 
     44== <broadcasts> == 
     45 
     46Contains a list of <message> tags. The <message> tags ''will be broadcast in the order in which they are defined.'' 
     47 
     48==== Attributes ==== 
     49 
     50None 
     51 
     52==== Child Tags ==== 
     53 
     54  1. <message> 
     55 
     56== <config> == 
     57 
     58Used in Model-Glue XML fragments to define additional settings and by legacy Model-Glue 1.x applications to define settings. 
     59 
     60''This tag is largely unused in Model-Glue 2.0+! '' 
     61 
     62==== Attributes ==== 
     63 
     64None 
     65 
     66==== Child Tags ==== 
     67 
     68  1. <setting> 
     69 
     70== <controller> == 
     71 
     72Defines a CFC that will act as a Controller in the application. 
     73 
     74==== Attributes ==== 
     75 
     76  1. Name (Required) - A unique name for this controller. A Model-Glue application where multiple controllers are added with the same name will currently confuse the framework (as of 2.0 Beta 1). This will eventually be resolved. 
     77  1. Type (Required) - The CFC to use for a controller in the same format that you'd use in a !CreateObject() call, such as "myapplication.controller.!MyController" 
     78 
     79==== Child Tags ==== 
     80 
     81None 
     82 
     83== <controllers> == 
     84 
     85Contains a list of <controller> tags. 
     86 
     87==== Attributes ==== 
     88 
     89None 
     90 
     91==== Child Tags ==== 
     92 
     93  1. <controller> 
     94 
     95== <event-handler> == 
     96 
     97Defines an event or "page" in the application. 
     98 
     99==== Attributes ==== 
     100 
     101  1. Name (Required) - A unique name for the event handler. This defines how the event will be accessed through the URL, such as "index.cfm?event=!MyEvent". [[BR]][[BR]]''If an <event-handler> is added whose NAME attribute is in use by another event-handler, it will overwrite the previous event-handler, except in the case of the predefined modelglue.onRequestStart, modelglue.onQueueComplete, and modelglue.onRequestEnd event-handlers. In this case, any messages, views, or results defined will be added to the predefined event handlers.''[[BR]][[BR]] 
     102  1. Access (Optional, defaults to "public") - If set to "private," the event handler cannot be accessed directly through the URL. 
     103 
     104==== Child Tags ==== 
     105 
     106  1. <broadcasts> 
     107  1. <results> 
     108  1. <views> 
    85109 
    86110== <event-handlers> == 
    … …  
    96120  1. <event-handler> 
    97121  1. <scaffold> 
     122 
     123== <event-types> == 
     124 
     125Defines a collection of event types.  See [wiki:HowToUseTypedEvents How To Use Typed Events] for more information. 
     126 
     127=== Attributes === 
     128 
     129None 
     130 
     131=== Child Tags === 
     132 
     133  1. <event-type> 
     134 
     135== <event-type> ==  
     136 
     137Defines a custom event type.  Makes applying configuration selectively to specific events quite easy.  See [wiki:HowToUseTypedEvents How To Use Typed Events] for more information. 
     138 
     139=== Attributes === 
     140 
     1411. Name (Required) - A unique name for the event type. 
     142 
     143=== Child Tags === 
     144 
     145  1. <before> 
     146  1. <after> 
    98147 
    99148== <include> (child tag of <modelglue>) ==