Skip to main content
P
ProjectedSurplus
Inspiring
December 19, 2008
Question

Application.cfc

  • December 19, 2008
  • 2 replies
  • 521 views
In my Application.cfc file (which I started based on something found on the web and/or in Ben Forta's WACK) the following code seems (to me) non-useful yet deleting it causes problems. Could someone take a shot at explaining what the "thePage" argument does and whether it is simply a mandatory/needed bit of code? Thanks in advance:

<!--- Run before the request is processed --->
<cffunction name="onRequestStart" returnType="boolean" output="false">
<cfargument name="thePage" type="string" required="true">
<cfreturn true>
</cffunction>

<!--- Runs before request as well, after onRequestStart --->
<cffunction name="onRequest" returnType="void">
<cfargument name="thePage" type="string" required="true">
<cfinclude template="#arguments.thePage#">
</cffunction>

<!--- Runs at end of request --->
<cffunction name="onRequestEnd" returnType="void" output="false">
<cfargument name="thePage" type="string" required="true">
</cffunction>
    This topic has been closed for replies.

    2 replies

    -
    -__cfSearching__-
    Inspiring
    December 20, 2008
    There are a lot of possibilities. Though you might not need these functions in every application.

    As far as usage, there are some pretty good examples in the documentation. So rather than my re-inventing the wheel I am going to point you there ;-)
    http://livedocs.adobe.com/coldfusion/7/htmldocs/00000694.htm#1190269
    -
    -__cfSearching__-
    Inspiring
    December 20, 2008
    ProjectedSurplus wrote:
    > explaining what the "thePage" argument does
    > and whether it is simply a mandatory/needed bit of code

    "thePage" represents the path of whatever page you requested. That is useful information if you want to execute code when a request event is triggered. The examples above are just that: examples. I think they are simply trying to show the correct syntax for the different request functions. With the exception of onRequest, the other functions do nothing. So you are correct in thinking they serve no additional purpose here.

    > yet deleting it causes problems

    Those three functions are all optional. So removing the entire _function_ should not cause problems. However, removing the argument might. For example in the code above the <cfinclude> inside onRequest is what causes the page you requested to be displayed. If you removed that argument, nothing would happen and you probably just get a blank screen.

    So in summary, you do not have to use any of the request functions. But if you _do_ use them, do not remove the "thePage" argument.
    P
    ProjectedSurplusAuthor
    Inspiring
    December 20, 2008
    OK, so I deleted all three functions and everything still seems to be working so thank you.

    Could you extrapolate if possible on uses for each of the three? I assume that for example I could put an

    isDefined("SESSION.auth.IsSignedIn") into onRequestStart or onRequest but currently have those in an cfif on my index page which seems more logical

    Alternatively I guess I could write the IP address of each request for stats purposes or compare the IP vs. IP_used_2_sign_In to prevent cross site scripting (???) but I can't really think of any additional uses.

    D
    Dan_Bracuk
    Inspiring
    December 21, 2008
    quote:
    Originally posted by: ProjectedSurplus

    Could you extrapolate if possible on uses for each of the three? I assume that for example I could put an

    isDefined("SESSION.auth.IsSignedIn") into onRequestStart or onRequest but currently have those in an cfif on my index page which seems more logical

    Read the WACK again for the interaction between onRequest and onRequestStart. Personally, I just use onRequestStart.

    The use of onRequestStart and onRequestEnd is to execute code at the start or end of any page request in the application. The code is up to you.
    Terms & ConditionsAccessibility statement
    Using the community Terms of use Privacy Cookie preferences Do not sell or share my personal information ad choicesAdChoices