Changes between Version 3 and Version 4 of ReferenceMaterials/EventApi

Timestamp:

07/07/09 21:56:24 (17 years ago)

Author:

DanWilson (IP: 76.182.36.62)

Comment:

--

ReferenceMaterials/EventApi

@@ -121 +121 @@
 ==== Description: ====
 
-Returns a value from the viewstate, such as a form or url variable.
+Returns a value from the event context, such as a form or url variable.
 
 ==== Returns: ====
@@ -131 +131 @@
 Name (required) - The name of the value to retrieve
 
-Default (optional) - If the value does not exist, a default value to set into the viewstate and then return
+Default (optional) - If the value does not exist, a default value to set into the event context and then return
 
 == !GetView(name:string) ==
@@ -147 +147 @@
 Name (required) - The name of the view to retrieve
 
+== !LinkTo(eventName:string, [append:list], [anchor:string]) ==
+
+==== Description: ====
+
+Creates a link with information from Model-Glue such as the event name, any desired parameters along with respective values. The Link Manager is designed to abstract URL formatting so that SES URLS and other custom linking strategies can be handled by ModelGlue. You can define your own LinkManager by providing a component definition in your application specific ColdSpring.xml confguration by using the Bean ID: 'modelglue.urlManager'. At a minimum, your component must meet the method definitions of /ModelGlue/gesture/eventrequest/url/UrlManager.cfc.
+
+==== Returns: ====
+
+A link. This replaces the following construct from the Pre-MG:3 application architecture.
+{{{
+<cfset someLink = myself & "SomeEvent" /> 
+}}}
+
+
+==== Arguments: ====
+
+EventName (Required) - Name of the event to forward to.
+
+Append (Optional) A list of values to append to the link.
+
+Anchor (Optional) Any anchor text for the link.
+
+==== Example: ====
+
+For a given URL: 
+{{{
+model-glue.com?event=EntryDisplay&entryID=75
+}}}
+and a given linking statement: 
+{{{
+<cfset handleEntryClicked = event.linkTo( "Entry.Form", "entryID" )/>
+}}}
+
+The value of handleEntryClicked after processing will be:
+
+http://model-glue.com/index.cfm?event=Entry.Form&EntryID=75
+
 == !MakeEventBean(type:any, [fields:list]) ==
 
 ==== Description: ====
 
-Loops over a CFC instance, looking for any methods whose names start with set.  For any setter methods where a like-named value exists in the viewstate, the setter will be called, passing this value.
+Loops over a CFC instance, looking for any methods whose names start with set.  For any setter methods where a like-named value exists in the viewstate, the setter will be called, passing this value.
 
 ==== Returns: ====
@@ -159 +196 @@
 ==== Arguments: ====
 
-Type (Required) - If a string is passed, it will instantiate a CFC of the type passed and attempt to call a function named "init" if one exists.  If a CFC instance is passed, it will use the instance.
+Type (Required) - If a string is passed, it will instantiate a CFC of the type passed and attempt to call a function named "init" if one exists.  If a CFC instance is passed, it will use the instance.
 
 Fields (Optional) - If a list of fields is passed, it will only attempt to set the properties listed.