| Package: MachII.framework |
| Base Event component. |
| Method Summary | |
|---|---|
| public void | init([string name=""], [struct args="#StructNew()#"]) |
| public any | getArg(string name, [any defaultValue=""]) |
| public struct | getArgs() |
| public string | getArgType(string argName) |
| public string | getName() |
| public boolean | isArgDefined(string name) |
| public void | removeArg(string name) |
| public void | setArg(string name, any value, [string argType]) |
| public void | setArgs(struct args) |
| public void | setArgType(string argName, string argType) |
| public void | setName(string name) |
| Method Detail |
|---|
| getArg |
|---|
public any getArg( string name, [any defaultValue=""] )
Parameters:
| string name |
| [any defaultValue=""] |
Code:
<cffunction name="getArg" access="public" returntype="any" output="false"> <cfargument name="name" type="string" required="true" /> <cfargument name="defaultValue" type="any" required="false" default="" /> <cfif StructKeyExists(variables.args, arguments.name)> <cfreturn variables.args[arguments.name] /> <cfelse> <cfreturn arguments.defaultValue /> </cfif> </cffunction>
| getArgs |
|---|
public struct getArgs( )
Parameters:
Code:
<cffunction name="getArgs" access="public" returntype="struct" output="false"> <cfreturn variables.args /> </cffunction>
| getArgType |
|---|
public string getArgType( string argName )
Parameters:
| string argName |
Code:
<cffunction name="getArgType" access="public" returntype="string" output="false"> <cfargument name="argName" type="string" required="true" /> <cfif StructKeyExists(variables.argTypes, arguments.argName)> <cfreturn variables.argTypes[arguments.argName] /> <cfelse> <cfreturn "" /> </cfif> </cffunction>
| getName |
|---|
public string getName( )
Parameters:
Code:
<cffunction name="getName" access="public" returntype="string" output="false"> <cfreturn variables.name /> </cffunction>
| init |
|---|
public void init( [string name=""], [struct args="#StructNew()#"] )
Parameters:
| [string name=""] |
| [struct args="#StructNew()#"] |
Code:
<cffunction name="init" access="public" returntype="void" output="false"> <cfargument name="name" type="string" required="false" default="" /> <cfargument name="args" type="struct" required="false" default="#StructNew()#" /> <cfset setName(arguments.name) /> <cfset setArgs(arguments.args) /> </cffunction>
| isArgDefined |
|---|
public boolean isArgDefined( string name )
Parameters:
| string name |
Code:
<cffunction name="isArgDefined" access="public" returntype="boolean" output="false"> <cfargument name="name" type="string" required="true" /> <cfreturn StructKeyExists(variables.args, arguments.name) /> </cffunction>
| removeArg |
|---|
public void removeArg( string name )
Parameters:
| string name |
Code:
<cffunction name="removeArg" access="public" returntype="void" output="false"> <cfargument name="name" type="string" required="true" /> <cfset StructDelete(variables.args, arguments.name) /> </cffunction>
| setArg |
|---|
public void setArg( string name, any value, [string argType] )
Parameters:
| string name |
| any value |
| [string argType] |
Code:
<cffunction name="setArg" access="public" returntype="void" output="false"> <cfargument name="name" type="string" required="true" /> <cfargument name="value" type="any" required="true" /> <cfargument name="argType" type="string" required="false" /> <cfset variables.args[arguments.name] = arguments.value /> <cfif StructKeyExists(arguments, 'argType')> <cfset setArgType(arguments.name, arguments.argType) /> </cfif> </cffunction>
| setArgs |
|---|
public void setArgs( struct args )
Parameters:
| struct args |
Code:
<cffunction name="setArgs" access="public" returntype="void" output="false"> <cfargument name="args" type="struct" required="true" /> <cfset var key = 0 /> <cfloop collection="#arguments.args#" item="key"> <cfset setArg(key, arguments.args[key]) /> </cfloop> </cffunction>
| setArgType |
|---|
public void setArgType( string argName, string argType )
Parameters:
| string argName |
| string argType |
Code:
<cffunction name="setArgType" access="public" returntype="void" output="false"> <cfargument name="argName" type="string" required="true" /> <cfargument name="argType" type="string" required="true" /> <cfset variables.argTypes[arguments.argName] = arguments.argType /> </cffunction>
| setName |
|---|
public void setName( string name )
Parameters:
| string name |
Code:
<cffunction name="setName" access="public" returntype="void" output="false"> <cfargument name="name" type="string" required="true" /> <cfset variables.name = arguments.name /> </cffunction>