wheels/model/onmissingmethod.cfm @@ -72,7 +72,9 @@ var key = ""; variables.wheels.class.associations[arguments.name] = {}; for (key in arguments) + { if (key != "name") variables.wheels.class.associations[arguments.name][key] = arguments[key]; + } </cfscript> </cffunction> \ No newline at end of file wheels/model/associations.cfm @@ -1,7 +1,6 @@ <!--- PUBLIC MODEL CLASS METHODS ---> -<cffunction name="average" returntype="numeric" access="public" output="false" - hint="Calculates the average value for a given property. Uses the SQL function `AVG`." +<cffunction name="average" returntype="numeric" access="public" output="false" hint="Calculates the average value for a given property. Uses the SQL function `AVG`." examples= ' <!--- Get the average salary for all employees ---> @@ -18,8 +17,7 @@ <cfreturn $calculate(argumentCollection=arguments)> </cffunction> -<cffunction name="count" returntype="numeric" access="public" output="false" - hint="Returns the number of rows that match the arguments (or all rows if no arguments are passed in). Uses the SQL function `COUNT`." +<cffunction name="count" returntype="numeric" access="public" output="false" hint="Returns the number of rows that match the arguments (or all rows if no arguments are passed in). Uses the SQL function `COUNT`." examples= ' <!--- Count how many authors there are in the table ---> @@ -32,7 +30,7 @@ <cfset authorWithBooksOnACount = model("author").count(include="books", where="title LIKE ''A%''")> <!--- Count the number of comments on a specific post (a `hasMany` association from `post` to `comment` is required) ---> - <!--- The `commentCount` method below will call `model("comment").count(where="postId=##post.id##")` internally ---> + <!--- The `commentCount` method will call `model("comment").count(where="postId=##post.id##")` internally ---> <cfset aPost = model("post").findByKey(params.postId)> <cfset amount = aPost.commentCount()> ' @@ -55,8 +53,7 @@ <cfreturn $calculate(argumentCollection=arguments)> </cffunction> -<cffunction name="maximum" returntype="numeric" access="public" output="false" - hint="Calculates the maximum value for a given property. Uses the SQL function `MAX`." +<cffunction name="maximum" returntype="numeric" access="public" output="false" hint="Calculates the maximum value for a given property. Uses the SQL function `MAX`." examples= ' <!--- Get the amount of the highest salary for all employees ---> @@ -72,8 +69,7 @@ <cfreturn $calculate(argumentCollection=arguments)> </cffunction> -<cffunction name="minimum" returntype="numeric" access="public" output="false" - hint="Calculates the minimum value for a given property. Uses the SQL function `MIN`." +<cffunction name="minimum" returntype="numeric" access="public" output="false" hint="Calculates the minimum value for a given property. Uses the SQL function `MIN`." examples= ' <!--- Get the amount of the lowest salary for all employees ---> @@ -89,8 +85,7 @@ <cfreturn $calculate(argumentCollection=arguments)> </cffunction> -<cffunction name="sum" returntype="numeric" access="public" output="false" - hint="Calculates the sum of values for a given property. Uses the SQL function `SUM`." +<cffunction name="sum" returntype="numeric" access="public" output="false" hint="Calculates the sum of values for a given property. Uses the SQL function `SUM`." examples= ' <!--- Get the sum of all salaries ---> wheels/model/calculations.cfm @@ -1,28 +1,39 @@ <!--- PUBLIC MODEL INITIALIZATION METHODS ---> -<cffunction name="afterNew" returntype="void" access="public" output="false" hint="Register method(s) that should be called after a new object has been initialized (usually done with the @new method)." +<cffunction name="afterNew" returntype="void" access="public" output="false" hint="Registers method(s) that should be called after a new object has been initialized (usually done with the @new method)." examples= ' <!--- Instruct Wheels to call the `fixObj` method ---> <cfset afterNew("fixObj")> ' categories="model-initialization,callbacks" chapters="object-callbacks" functions="afterCreate,afterDelete,afterFind,afterInitialization,afterSave,afterUpdate,afterValidation,afterValidationOnCreate,afterValidationOnUpdate,beforeCreate,beforeDelete,beforeSave,beforeUpdate,beforeValidation,beforeValidationOnCreate,beforeValidationOnUpdate"> - <cfargument name="methods" type="string" required="false" default="" hint="Method name or list of method names (can also be called with the `method` argument)."> + <cfargument name="methods" type="string" required="false" default="" hint="Method name or list of method names that should be called when this callback event occurs in an object's life cycle (can also be called with the `method` argument)."> <cfset $registerCallback(type="afterNew", argumentCollection=arguments)> </cffunction> -<cffunction name="afterFind" returntype="void" access="public" output="false" hint="Register method(s) that should be called after an existing object has been initialized (usually done with the findByKey or findOne method)." +<cffunction name="afterFind" returntype="void" access="public" output="false" hint="Registers method(s) that should be called after an existing object has been initialized (usually done with the @findByKey or @findOne method)." examples= ' - <!--- Instruct Wheels to call the `fixObj` method ---> - <cfset afterFind("fixObj")> + <!--- Instruct Wheels to call the `setTime` method after getting objects or records with one of the finder methods ---> + <cffunction name="init"> + <cfset afterFind("setTime")> + </cffunction> + + <cffunction name="setTime"> + <cfif StructIsEmpty(arguments)> + <cfset this.fetchedAt = Now()> + <cfelse> + <cfset arguments.fetchedAt = Now()> + <cfreturn arguments> + </cfif> + </cffunction> ' categories="model-initialization,callbacks" chapters="object-callbacks" functions="afterCreate,afterDelete,afterInitialization,afterNew,afterSave,afterUpdate,afterValidation,afterValidationOnCreate,afterValidationOnUpdate,beforeCreate,beforeDelete,beforeSave,beforeUpdate,beforeValidation,beforeValidationOnCreate,beforeValidationOnUpdate"> <cfargument name="methods" type="string" required="false" default="" hint="See documentation for @afterNew."> <cfset $registerCallback(type="afterFind", argumentCollection=arguments)> </cffunction> -<cffunction name="afterInitialization" returntype="void" access="public" output="false" hint="Register method(s) that should be called after an object has been initialized." +<cffunction name="afterInitialization" returntype="void" access="public" output="false" hint="Registers method(s) that should be called after an object has been initialized." examples= ' <!--- Instruct Wheels to call the `fixObj` method ---> @@ -33,7 +44,7 @@ <cfset $registerCallback(type="afterInitialization", argumentCollection=arguments)> </cffunction> -<cffunction name="beforeValidation" returntype="void" access="public" output="false" hint="Register method(s) that should be called before an object is validated." +<cffunction name="beforeValidation" returntype="void" access="public" output="false" hint="Registers method(s) that should be called before an object is validated." examples= ' <!--- Instruct Wheels to call the `fixObj` method ---> wheels/model/callbacks.cfm @@ -1,11 +1,12 @@ -<cffunction name="addError" returntype="void" access="public" output="false" - hint="Adds an error on a specific property." +<!--- PUBLIC MODEL OBJECT METHODS ---> + +<cffunction name="addError" returntype="void" access="public" output="false" hint="Adds an error on a specific property." examples= ' <!--- Add an error to the `email` property ---> <cfset addError(property="email", message="Sorry, you are not allowed to use that email, try again please.")> ' - categories="model-object" chapters="object-validation" functions="addErrorToBase,allErrors,clearErrors,errorCount,errorsOn,errorsOnBase,hasErrors"> + categories="model-object,errors" chapters="object-validation" functions="addErrorToBase,allErrors,clearErrors,errorCount,errorsOn,errorsOnBase,hasErrors"> <cfargument name="property" type="string" required="true" hint="The name of the property you want to add an error for."> <cfargument name="message" type="string" required="true" hint="The error message (such as ""Please enter a correct name in the form field"" for example)."> <cfargument name="name" type="string" required="false" default="" hint="A name to identify the error by (useful when you need to distinguish one error from another one set on the same object and you don't want to use the error message itself for that)."> @@ -14,14 +15,13 @@ </cfscript> </cffunction> -<cffunction name="addErrorToBase" returntype="void" access="public" output="false" - hint="Adds an error on the object as a whole (not related to any specific property)." +<cffunction name="addErrorToBase" returntype="void" access="public" output="false" hint="Adds an error on the object as a whole (not related to any specific property)." examples= ' <!--- Add an error on the object ---> <cfset addError(message="Your email address has to be the same as your domain name.")> ' - categories="model-object" chapters="object-validation" functions="addError,allErrors,clearErrors,errorCount,errorsOn,errorsOnBase,hasErrors"> + categories="model-object,errors" chapters="object-validation" functions="addError,allErrors,clearErrors,errorCount,errorsOn,errorsOnBase,hasErrors"> <cfargument name="message" type="string" required="true" hint="See documentation for @addError."> <cfargument name="name" type="string" required="false" default="" hint="See documentation for @addError."> <cfscript> @@ -30,35 +30,31 @@ </cfscript> </cffunction> -<cffunction name="allErrors" returntype="array" access="public" output="false" - hint="Returns an array of all the errors on the object." +<cffunction name="allErrors" returntype="array" access="public" output="false" hint="Returns an array of all the errors on the object." examples= ' <!--- Get all the errors for the `user` object ---> <cfset errorInfo = user.allErrors()> ' - categories="model-object" chapters="object-validation" functions="addError,addErrorToBase,clearErrors,errorCount,errorsOn,errorsOnBase,hasErrors"> - <cfscript> - var loc = {}; - loc.returnValue = variables.wheels.errors; - </cfscript> - <cfreturn loc.returnValue> + categories="model-object,errors" chapters="object-validation" functions="addError,addErrorToBase,clearErrors,errorCount,errorsOn,errorsOnBase,hasErrors"> + <cfreturn variables.wheels.errors> </cffunction> -<cffunction name="clearErrors" returntype="void" access="public" output="false" - hint="Clears out all errors set on the object or only the ones set for a specific property or name." +<cffunction name="clearErrors" returntype="void" access="public" output="false" hint="Clears out all errors set on the object or only the ones set for a specific property or name." examples= ' <!--- Clear all errors on `firstName` ---> <cfset clearErrors("firstName")> ' - categories="model-object" chapters="object-validation" functions="addError,addErrorToBase,allErrors,errorCount,errorsOn,errorsOnBase,hasErrors"> + categories="model-object,errors" chapters="object-validation" functions="addError,addErrorToBase,allErrors,errorCount,errorsOn,errorsOnBase,hasErrors"> <cfargument name="property" type="string" required="false" default="" hint="Specify a property name here if you want to clear all errors set on that property."> <cfargument name="name" type="string" required="false" default="" hint="Specify an error name here if you want to clear all errors set with that error name."> <cfscript> var loc = {}; if (!Len(arguments.property) && !Len(arguments.name)) + { ArrayClear(variables.wheels.errors); + } else { loc.iEnd = ArrayLen(variables.wheels.errors); @@ -69,8 +65,7 @@ </cfscript> </cffunction> -<cffunction name="errorCount" returntype="numeric" access="public" output="false" - hint="Returns the number of errors this object has associated with it. Specify `property` or `name` if you wish to count only specific errors." +<cffunction name="errorCount" returntype="numeric" access="public" output="false" hint="Returns the number of errors this object has associated with it. Specify `property` or `name` if you wish to count only specific errors." examples= ' <!--- Check how many errors are set on the object ---> @@ -78,27 +73,26 @@ <!--- Do something to deal with this very erroneous author here... ---> </cfif> ' - categories="model-object" chapters="object-validation" functions="addError,addErrorToBase,allErrors,clearErrors,errorsOn,errorsOnBase,hasErrors"> + categories="model-object,errors" chapters="object-validation" functions="addError,addErrorToBase,allErrors,clearErrors,errorsOn,errorsOnBase,hasErrors"> <cfargument name="property" type="string" required="false" default="" hint="Specify a property name here if you want to count only errors set on a specific property."> <cfargument name="name" type="string" required="false" default="" hint="Specify an error name here if you want to count only errors set with a specific error name."> <cfscript> - var loc = {}; - if(!len(arguments.property) && !len(arguments.name)) - loc.returnValue = ArrayLen(variables.wheels.errors); + var returnValue = ""; + if (!Len(arguments.property) && !Len(arguments.name)) + returnValue = ArrayLen(variables.wheels.errors); else - loc.returnValue = ArrayLen(errorsOn(argumentCollection=arguments)); + returnValue = ArrayLen(errorsOn(argumentCollection=arguments)); </cfscript> - <cfreturn loc.returnValue> + <cfreturn returnValue> </cffunction> -<cffunction name="errorsOn" returntype="array" access="public" output="false" - hint="Returns an array of all errors associated with the supplied property (and error name when passed in)." +<cffunction name="errorsOn" returntype="array" access="public" output="false" hint="Returns an array of all errors associated with the supplied property (and error name when passed in)." examples= ' <!--- Get all errors related to the email address of the user object ---> <cfset errors = user.errorsOn("emailAddress")> ' - categories="model-object" chapters="object-validation" functions="addError,addErrorToBase,allErrors,clearErrors,errorCount,errorsOnBase,hasErrors"> + categories="model-object,errors" chapters="object-validation" functions="addError,addErrorToBase,allErrors,clearErrors,errorCount,errorsOnBase,hasErrors"> <cfargument name="property" type="string" required="true" hint="Specify the property name to return errors for here."> <cfargument name="name" type="string" required="false" default="" hint="If you want to return only errors on the above property set with a specific error name you can specify it here."> <cfscript> @@ -112,25 +106,21 @@ <cfreturn loc.returnValue> </cffunction> -<cffunction name="errorsOnBase" returntype="array" access="public" output="false" - hint="Returns an array of all errors associated with the object as a whole (not related to any specific property)." +<cffunction name="errorsOnBase" returntype="array" access="public" output="false" hint="Returns an array of all errors associated with the object as a whole (not related to any specific property)." examples= ' <!--- Get all general type errors for the user object ---> <cfset errors = user.errorsOnBase()> ' - categories="model-object" chapters="object-validation" functions="addError,addErrorToBase,allErrors,clearErrors,errorCount,errorsOn,hasErrors"> + categories="model-object,errors" chapters="object-validation" functions="addError,addErrorToBase,allErrors,clearErrors,errorCount,errorsOn,hasErrors"> <cfargument name="name" type="string" required="false" default="" hint="Specify an error name here to only return errors for that error name."> <cfscript> - var loc = {}; arguments.property = ""; - loc.returnValue = errorsOn(argumentCollection=arguments); </cfscript> - <cfreturn loc.returnValue> + <cfreturn errorsOn(argumentCollection=arguments)> </cffunction> -<cffunction name="hasErrors" returntype="boolean" access="public" output="false" - hint="Returns `true` if the object has any errors. You can also limit to only check a specific property and name for errors." +<cffunction name="hasErrors" returntype="boolean" access="public" output="false" hint="Returns `true` if the object has any errors. You can also limit to only check a specific property and name for errors." examples= ' <!--- Check if the post object has any errors set on it ---> @@ -138,15 +128,13 @@ <!--- Send user to a form to correct the errors... ---> </cfif> ' - categories="model-object" chapters="object-validation" functions="addError,addErrorToBase,allErrors,clearErrors,errorCount,errorsOn,errorsOnBase"> + categories="model-object,errors" chapters="object-validation" functions="addError,addErrorToBase,allErrors,clearErrors,errorCount,errorsOn,errorsOnBase"> <cfargument name="property" type="string" required="false" default="" hint="Name of the property to check if there are any errors set on."> <cfargument name="name" type="string" required="false" default="" hint="Error name to check if there are any errors set with."> <cfscript> - var loc = {}; + var returnValue = false; if (errorCount(argumentCollection=arguments) > 0) - loc.returnValue = true; - else - loc.returnValue = false; + returnValue = true; </cfscript> - <cfreturn loc.returnValue> + <cfreturn returnValue> </cffunction> \ No newline at end of file wheels/model/errors.cfm @@ -5,5 +5,6 @@ <cfinclude template="errors.cfm"> <cfinclude template="initialization.cfm"> <cfinclude template="miscellaneous.cfm"> +<cfinclude template="onmissingmethod.cfm"> <cfinclude template="properties.cfm"> <cfinclude template="validations.cfm"> \ No newline at end of file wheels/model/functions.cfm @@ -1,16 +1,6 @@ -<cffunction name="columnNames" returntype="string" access="public" output="false" - hint="Returns a list of column names in the table mapped to this model. The list is ordered according to the columns ordinal position in the database table." - examples= - ' - <!--- Get a list of all the column names in the table mapped to the author model ---> - <cfset columns = model("author").columnNames()> - ' - categories="model-class" chapters="object-relational-mapping" functions="dataSource,property,propertyNames,table,tableName"> - <cfreturn variables.wheels.class.columnList> -</cffunction> +<!--- PUBLIC MODEL INITIALIZATION METHODS ---> -<cffunction name="dataSource" returntype="void" access="public" output="false" - hint="Use this method to override the data source connection information for this model." +<cffunction name="dataSource" returntype="void" access="public" output="false" hint="Use this method to override the data source connection information for this model." examples= ' <!--- In models/User.cfc ---> @@ -19,7 +9,7 @@ <cfset dataSource("users_source")> </cffunction> ' - categories="model-initialization" chapters="object-relational-mapping" functions="columnNames,property,propertyNames,table,tableName"> + categories="model-initialization,general" chapters="object-relational-mapping" functions="columnNames,property,propertyNames,table,tableName"> <cfargument name="datasource" type="string" required="true" hint="The data source name to connect to."> <cfargument name="username" type="string" required="false" default="" hint="The username for the data source."> <cfargument name="password" type="string" required="false" default="" hint="The password for the data source."> @@ -28,8 +18,7 @@ </cfscript> </cffunction> -<cffunction name="table" returntype="void" access="public" output="false" - hint="Use this method to tell Wheels what database table to connect to for this model. You only need to use this method when your table naming does not follow the standard Wheels convention of a singular object name mapping to a plural table name." +<cffunction name="table" returntype="void" access="public" output="false" hint="Use this method to tell Wheels what database table to connect to for this model. You only need to use this method when your table naming does not follow the standard Wheels convention of a singular object name mapping to a plural table name." examples= ' <!--- In models/User.cfc ---> @@ -38,267 +27,41 @@ <cfset table("tbl_USERS")> </cffunction> ' - categories="model-initialization" chapters="object-relational-mapping" functions="columnNames,dataSource,property,propertyNames,tableName"> + categories="model-initialization,general" chapters="object-relational-mapping" functions="columnNames,dataSource,property,propertyNames,tableName"> <cfargument name="name" type="string" required="true" hint="Name of the table to map this model to."> <cfscript> variables.wheels.class.tableName = arguments.name; </cfscript> </cffunction> -<cffunction name="tableName" returntype="string" access="public" output="false" - hint="Returns the name of the database table that this model is mapped to." +<!--- PUBLIC MODEL CLASS METHODS ---> + +<cffunction name="columnNames" returntype="string" access="public" output="false" hint="Returns a list of column names in the table mapped to this model. The list is ordered according to the columns ordinal position in the database table." examples= ' - <!--- Check what table the user model uses ---> - <cfset whatAmIMappedTo = model("user").tableName()> + <!--- Get a list of all the column names in the table mapped to the author model ---> + <cfset columns = model("author").columnNames()> ' - categories="model-class" chapters="object-relational-mapping" functions="columnNames,dataSource,property,propertyNames,table"> - <cfreturn variables.wheels.class.tableName> -</cffunction> - -<cffunction name="onMissingMethod" returntype="any" access="public" output="false" hint="This method handles dynamic finders, property and association methods. It is not part of the public API."> - <cfargument name="missingMethodName" type="string" required="true"> - <cfargument name="missingMethodArguments" type="struct" required="true"> - <cfscript> - var loc = {}; - if (Right(arguments.missingMethodName, 10) == "hasChanged") - loc.returnValue = hasChanged(property=ReplaceNoCase(arguments.missingMethodName, "hasChanged", "")); - else if (Right(arguments.missingMethodName, 11) == "changedFrom") - loc.returnValue = changedFrom(property=ReplaceNoCase(arguments.missingMethodName, "changedFrom", "")); - else if (Left(arguments.missingMethodName, 9) == "findOneBy" || Left(arguments.missingMethodName, 9) == "findAllBy") - { - if (StructKeyExists(server, "railo")) - loc.finderProperties = ListToArray(LCase(ReplaceNoCase(ReplaceNoCase(ReplaceNoCase(arguments.missingMethodName, "And", "|"), "findAllBy", ""), "findOneBy", "")), "|"); // since Railo passes in the method name in all upper case we have to do this here - else - loc.finderProperties = ListToArray(ReplaceNoCase(ReplaceNoCase(Replace(arguments.missingMethodName, "And", "|"), "findAllBy", ""), "findOneBy", ""), "|"); - loc.firstProperty = loc.finderProperties[1]; - loc.secondProperty = IIf(ArrayLen(loc.finderProperties) == 2, "loc.finderProperties[2]", ""); - - // throw an error when more than one argument is passed in but not `value` (for single property) or `values` (for multiple properties) - // this means that model("artist").findOneByName("U2") will still work but not model("artist").findOneByName(values="U2", returnAs="query"), need to pass in just `value` there instead. - if (application.wheels.showDebugInformation) - { - if (StructCount(arguments.missingMethodArguments) > 1) - { - if (Len(loc.secondProperty)) - { - if (!StructKeyExists(arguments.missingMethodArguments, "values")) - $throw(type="Wheels.IncorrectArguments", message="The `values` argument is required but was not passed in.", extendedInfo="Pass in a list of values to the dynamic finder in the `values` argument."); - } - else - { - if (!StructKeyExists(arguments.missingMethodArguments, "value")) - $throw(type="Wheels.IncorrectArguments", message="The `value` argument is required but was not passed in.", extendedInfo="Pass in a value to the dynamic finder in the `value` argument."); - } - } - } - - if (StructCount(arguments.missingMethodArguments) == 1) - loc.firstValue = Trim(ListFirst(arguments.missingMethodArguments[1])); - else if (StructKeyExists(arguments.missingMethodArguments, "value")) - loc.firstValue = arguments.missingMethodArguments.value; - else if (StructKeyExists(arguments.missingMethodArguments, "values")) - loc.firstValue = Trim(ListFirst(arguments.missingMethodArguments.values)); - loc.addToWhere = "#loc.firstProperty# = '#loc.firstValue#'"; - if (Len(loc.secondProperty)) - { - if (StructCount(arguments.missingMethodArguments) == 1) - loc.secondValue = Trim(ListLast(arguments.missingMethodArguments[1])); - else if (StructKeyExists(arguments.missingMethodArguments, "values")) - loc.secondValue = Trim(ListLast(arguments.missingMethodArguments.values)); - loc.addToWhere = loc.addToWhere & " AND #loc.secondProperty# = '#loc.secondValue#'"; - } - arguments.missingMethodArguments.where = IIf(StructKeyExists(arguments.missingMethodArguments, "where"), "'(' & arguments.missingMethodArguments.where & ') AND (' & loc.addToWhere & ')'", "loc.addToWhere"); - StructDelete(arguments.missingMethodArguments, "1"); - StructDelete(arguments.missingMethodArguments, "value"); - StructDelete(arguments.missingMethodArguments, "values"); - loc.returnValue = IIf(Left(arguments.missingMethodName, 9) == "findOneBy", "findOne(argumentCollection=arguments.missingMethodArguments)", "findAll(argumentCollection=arguments.missingMethodArguments)"); - } - else - { - for (loc.key in variables.wheels.class.associations) - { - loc.method = ""; - if (StructKeyExists(variables.wheels.class.associations[loc.key], "shortcut") && arguments.missingMethodName == variables.wheels.class.associations[loc.key].shortcut) - { - loc.method = "findAll"; - loc.joinAssociation = $expandedAssociations(include=loc.key); - loc.joinAssociation = loc.joinAssociation[1]; - loc.joinClass = loc.joinAssociation.class; - loc.info = model(loc.joinClass).$expandedAssociations(include=ListFirst(variables.wheels.class.associations[loc.key].through)); - loc.info = loc.info[1]; - loc.include = ListLast(variables.wheels.class.associations[loc.key].through); - if (StructKeyExists(arguments.missingMethodArguments, "include")) - loc.include = "#loc.include#(#arguments.missingMethodArguments.include#)"; - arguments.missingMethodArguments.include = loc.include; - loc.where = $keyWhereString(properties=loc.joinAssociation.foreignKey, keys=variables.wheels.class.keys); - if (StructKeyExists(arguments.missingMethodArguments, "where")) - loc.where = "(#loc.where#) AND (#arguments.missingMethodArguments.where#)"; - arguments.missingMethodArguments.where = loc.where; - if (!StructKeyExists(arguments.missingMethodArguments, "returnIncluded")) - arguments.missingMethodArguments.returnIncluded = false; - } - else if (ListFindNoCase(variables.wheels.class.associations[loc.key].methods, arguments.missingMethodName)) - { - loc.info = $expandedAssociations(include=loc.key); - loc.info = loc.info[1]; - loc.where = $keyWhereString(properties=loc.info.foreignKey, keys=variables.wheels.class.keys); - if (StructKeyExists(arguments.missingMethodArguments, "where")) - loc.where = "(#loc.where#) AND (#arguments.missingMethodArguments.where#)"; - if (loc.info.type == "hasOne") - { - loc.name = ReplaceNoCase(arguments.missingMethodName, loc.key, "object"); // create a generic method name (example: "hasProfile" becomes "hasObject") - if (loc.name == "object") - { - loc.method = "findOne"; - arguments.missingMethodArguments.where = loc.where; - } - else if (loc.name == "hasObject") - { - loc.method = "exists"; - arguments.missingMethodArguments.where = loc.where; - } - else if (loc.name == "newObject") - { - loc.method = "new"; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey); - } - else if (loc.name == "createObject") - { - loc.method = "create"; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey); - } - else if (loc.name == "removeObject") - { - loc.method = "updateOne"; - arguments.missingMethodArguments.where = loc.where; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey, setToNull=true); - } - else if (loc.name == "deleteObject") - { - loc.method = "deleteOne"; - arguments.missingMethodArguments.where = loc.where; - } - else if (loc.name == "setObject") - { - loc.method = "updateByKey"; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey); - $setObjectOrNumberToKey(arguments.missingMethodArguments); - } - } - else if (loc.info.type == "hasMany") - { - loc.name = ReplaceNoCase(ReplaceNoCase(arguments.missingMethodName, loc.key, "objects"), singularize(loc.key), "object"); // create a generic method name (example: "hasComments" becomes "hasObjects") - if (loc.name == "objects") - { - loc.method = "findAll"; - arguments.missingMethodArguments.where = loc.where; - } - else if (loc.name == "addObject") - { - loc.method = "updateByKey"; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey); - $setObjectOrNumberToKey(arguments.missingMethodArguments); - } - else if (loc.name == "removeObject") - { - loc.method = "updateByKey"; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey, setToNull=true); - $setObjectOrNumberToKey(arguments.missingMethodArguments); - } - else if (loc.name == "deleteObject") - { - loc.method = "deleteByKey"; - $setObjectOrNumberToKey(arguments.missingMethodArguments); - } - else if (loc.name == "hasObjects") - { - loc.method = "exists"; - arguments.missingMethodArguments.where = loc.where; - } - else if (loc.name == "newObject") - { - loc.method = "new"; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey); - } - else if (loc.name == "createObject") - { - loc.method = "create"; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey); - } - else if (loc.name == "objectCount") - { - loc.method = "count"; - arguments.missingMethodArguments.where = loc.where; - } - else if (loc.name == "findOneObject") - { - loc.method = "findOne"; - arguments.missingMethodArguments.where = loc.where; - } - else if (loc.name == "removeAllObjects") - { - loc.method = "updateAll"; - arguments.missingMethodArguments.where = loc.where; - $setForeignKeyValues(missingMethodArguments=arguments.missingMethodArguments, keys=loc.info.foreignKey, setToNull=true); - } - else if (loc.name == "deleteAllObjects") - { - loc.method = "deleteAll"; - arguments.missingMethodArguments.where = loc.where; - } - } - else if (loc.info.type == "belongsTo") - { - loc.name = ReplaceNoCase(arguments.missingMethodName, loc.key, "object"); // create a generic method name (example: "hasAuthor" becomes "hasObject") - if (loc.name == "object") - { - loc.method = "findByKey"; - arguments.missingMethodArguments.key = $propertyValue(name=loc.info.foreignKey); - } - else if (loc.name == "hasObject") - { - loc.method = "exists"; - arguments.missingMethodArguments.key = $propertyValue(name=loc.info.foreignKey); - } - } - } - if (Len(loc.method)) - loc.returnValue = $invoke(componentReference=model(loc.info.class), method=loc.method, argumentCollection=arguments.missingMethodArguments); - } - } - if (!StructKeyExists(loc, "returnValue")) - $throw(type="Wheels.MethodNotFound", message="The method `#arguments.missingMethodName#` was not found in this model.", extendedInfo="Check your spelling or add the method to the model's CFC file."); - </cfscript> - <cfreturn loc.returnValue> + categories="model-class,miscellaneous" chapters="object-relational-mapping" functions="dataSource,property,propertyNames,table,tableName"> + <cfreturn variables.wheels.class.columnList> </cffunction> -<cffunction name="$setForeignKeyValues" returntype="void" access="public" output="false"> - <cfargument name="missingMethodArguments" type="struct" required="true"> - <cfargument name="keys" type="string" required="true"> - <cfargument name="setToNull" type="boolean" required="false" default="false"> - <cfscript> - var loc = {}; - loc.iEnd = ListLen(arguments.keys); - for (loc.i=1; loc.i <= loc.iEnd; loc.i++) - { - if (arguments.setToNull) - arguments.missingMethodArguments[ListGetAt(arguments.keys, loc.i)] = ""; - else - arguments.missingMethodArguments[ListGetAt(arguments.keys, loc.i)] = this[ListGetAt(variables.wheels.class.keys, loc.i)]; - } - </cfscript> +<cffunction name="primaryKey" returntype="string" access="public" output="false" hint="Returns the name of the primary key for this model's table. This is determined through database introspection. If composite primary keys have been used they will both be returned in a list." + examples= + ' + <!--- Get the name of the primary key of the table mapped to the `employee` model (the `employees` table by default) ---> + <cfset theKeyName = model("employee").primaryKey()> + ' + categories="model-class,miscellaneous" chapters="object-relational-mapping" functions=""> + <cfreturn variables.wheels.class.keys> </cffunction> -<cffunction name="$setObjectOrNumberToKey" returntype="void" access="public" output="false"> - <cfargument name="missingMethodArguments" type="struct" required="true"> - <cfscript> - var loc = {}; - loc.keyOrObject = arguments.missingMethodArguments[ListFirst(StructKeyList(arguments.missingMethodArguments))]; - StructDelete(arguments.missingMethodArguments, ListFirst(StructKeyList(arguments.missingMethodArguments))); - if (IsObject(loc.keyOrObject)) - arguments.missingMethodArguments.key = loc.keyOrObject.key(); - else - arguments.missingMethodArguments.key = loc.keyOrObject; - </cfscript> +<cffunction name="tableName" returntype="string" access="public" output="false" hint="Returns the name of the database table that this model is mapped to." + examples= + ' + <!--- Check what table the user model uses ---> + <cfset whatAmIMappedTo = model("user").tableName()> + ' + categories="model-class,miscellaneous" chapters="object-relational-mapping" functions="columnNames,dataSource,property,propertyNames,table"> + <cfreturn variables.wheels.class.tableName> </cffunction> \ No newline at end of file wheels/model/miscellaneous.cfm b4753516e8740e1db8d8f559619f65a7258d1bbd per.djurner per.djurner@d8ff095c-9719-0410-9cd3-1dd5d13d90f5 http://github.com/rip747/cfwheels/commit/11fa7904a675c32fd099d7c0234f28b5e81d4559 11fa7904a675c32fd099d7c0234f28b5e81d4559 2009-11-03T13:39:12-08:00 2009-11-03T13:39:12-08:00 Docs, syntax, file moves. git-svn-id: https://cfwheels.googlecode.com/svn/trunk@3645 d8ff095c-9719-0410-9cd3-1dd5d13d90f5 4afc1c5eeed41f8322361a9a4b4bbb9091882130 per.djurner per.djurner@d8ff095c-9719-0410-9cd3-1dd5d13d90f5