10 | #selectTag(name="roleid", options=roles, includeBlank="All Roles", selected=params.roleid, label="Role", prependToLabel="
", labelClass="sr-only")#
11 |
12 |
13 | #selectTag(name="status", options="Active,Pending,Disabled,All", selected=params.status, label="Status", prependToLabel="
", labelClass="sr-only")#
14 |
15 |
16 |
17 | #textFieldTag(name="q", value=params.q, label="Keyword Search", labelClass="sr-only", placeholder="Keyword")#
18 |
19 |
20 |
21 | #submitTag(value="Filter", class="btn btn-info")#
22 |
23 |
24 | #endFormTag()#
25 |
26 |
--------------------------------------------------------------------------------
/views/admin/users/edit.cfm:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | #pageHeader(title="Edit User", btn=linkTo(route="users", text=" Cancel", class="btn btn-info btn-xs", encode="attributes"))#
5 |
6 |
7 | #errorMessagesFor("user")#
8 | #startFormTag(id="userEditForm", route="User", method="patch", key=params.key)#
9 | #includePartial("form/details")#
10 | #includePartial("form/role")#
11 | #submitTag(value="Update User", class="mt-4 btn btn-success")#
12 | #endFormTag()#
13 |
14 |
--------------------------------------------------------------------------------
/views/admin/users/form/_auth.cfm:
--------------------------------------------------------------------------------
1 |
2 | #panel(title="Initial Password", class="mb-2")#
3 |
4 |
5 | #passwordField(objectName="user", property="password", label="Password")#
6 |
7 |
8 |
9 | #passwordField(objectName="user", property="passwordConfirmation", label="Confirm Password")#
10 |
11 |
4 |
5 | #textField(objectName="user", property="firstname", label="First Name")#
6 |
7 |
8 | #textField(objectName="user", property="lastname", label="Last Name")#
9 |
10 |
12 |
13 | #textField(objectName="user", property="email", label="Email Address")#
14 |
15 |
18 |
19 | #textArea(objectName="user", property="adminNotes", label="Administrative Notes")#
20 | These can only be seen by those with the appropriate permission
21 |
22 |
4 |
5 | #select(objectName="user", property="roleid", options=roles, label="Role")#
6 |
7 |
8 | #checkBox(objectname="user", property="verified", label="Verified")#
9 | #checkbox(objectName="user", property="passwordchangerequired", label="Require Change of Password on Next Login")#
10 |
11 |
Password Reset
6 |
7 | Hi #user.firstname#,
8 |
We've received a request to reset your password. Click the link below to reset your password:
9 |
#linkto(route="editPasswordreset", onlyPath=false, token=user.passwordResetToken)#
10 |
If you did not request a password reset, please ignore this message. Your password will remain the same.
11 |
12 | #includePartial("/emails/footer")#
13 |
14 |
15 |
--------------------------------------------------------------------------------
/views/emails/passwordResetAdmin.cfm:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | #includePartial("/emails/header")#
5 |
6 | Your New Temporary Password
7 |
8 | Hi #user.firstname#,
9 |
An administrator has reset your password to:
10 |
#tempPassword#
11 |
You will be required to change this password on your next login.
12 |
13 | #includePartial("/emails/footer")#
14 |
15 |
16 |
--------------------------------------------------------------------------------
/views/emails/passwordResetAdminPlain.cfm:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | Your New Temporary Password
5 |
6 | Hi #user.firstname#,
7 |
8 | An administrator has reset your password to:
9 |
10 | #tempPassword#
11 |
12 | You will be required to change this password on your next login.
13 |
14 |
15 |
--------------------------------------------------------------------------------
/views/emails/passwordResetPlain.cfm:
--------------------------------------------------------------------------------
1 |
2 |
3 | Password Reset
4 |
5 | Hi #user.firstname#,
6 |
7 | We've received a request to reset your password. Visit the link below to reset your password:
8 |
9 | #urlFor(route="editPasswordreset", onlyPath=false, token=user.passwordResetToken)#
10 |
11 | If you did not request a password reset, please ignore this message. Your password will remain the same.
12 |
13 |
--------------------------------------------------------------------------------
/views/emails/verify.cfm:
--------------------------------------------------------------------------------
1 |
2 | #includePartial("/emails/header")#
3 |
4 | Account Verification
5 |
6 | Hi #user.firstname#,
7 |
Thank you for taking the time to create an account.
8 |
In order to complete your registration, we need to verify your email address. Please use the link below to verify your account:
9 |
#linkto(route="verify", onlyPath=false, token=user.verificationToken)#
10 |
11 | #includePartial("/emails/footer")#
12 |
13 |
--------------------------------------------------------------------------------
/views/emails/verifyPlain.cfm:
--------------------------------------------------------------------------------
1 |
2 | Account Verification
3 |
4 | Hi #user.firstname#,
5 | Thank you for taking the time to create an account.
6 | In order to complete your registration, we need to verify your email address. Please use the link below to verify your account:
7 | #linkto(route="verify", onlyPath=false, token=user.verificationToken)#
8 |
9 |
--------------------------------------------------------------------------------
/views/layout/_footer.cfm:
--------------------------------------------------------------------------------
1 |
4 |
5 |
10 |
11 |
--------------------------------------------------------------------------------
/views/main/index.cfm:
--------------------------------------------------------------------------------
1 |
2 |
3 | #pageHeader(title="Welcome")#
4 |
5 | This is an example App using CFWheels 2.x and some Bootstrap
6 |
7 | Why don't you #linkTo(route="login", text="Login?")#
8 |
9 | Cool beans bro. Check out your #linkTo(route="account", text="Account")#.
10 |
11 |
12 |
--------------------------------------------------------------------------------
/views/passwordresets/edit.cfm:
--------------------------------------------------------------------------------
1 |
4 |
5 |
6 |
7 |
8 | #errorMessagesFor("user")#
9 | #panel(title="Reset Password")#
10 | #startFormTag(route="updatePasswordreset", method="put", token=params.token)#
11 | #passwordField(objectname="user", property="password", label="Password *", required="true")#
12 | #passwordField(objectname="user", property="passwordConfirmation", label="Confirm Password *", required="true")#
13 | #submitTag(value="Update Password", class="btn btn-block btn-primary")#
14 | #endFormTag()#
15 | #panelEnd()#
16 |
17 |
6 |
7 | #panel(title="Reset Password")#
8 | #startFormTag(route="Passwordreset")#
9 | #textFieldTag(name="email", label="Email")#
10 | #submitTag(value="Send Password Reset Email", class="btn btn-block btn-primary")#
11 | #endFormTag()#
12 |
#linkTo(route="root", text="Cancel")#
13 |
14 |
13 |
14 |
15 | #panel(title="Your Details", class="mb-4")#
16 |
17 |
18 | #textField(objectName="user", property="firstname", label="First Name")#
19 |
20 |
21 | #textField(objectName="user", property="lastname", label="Last Name")#
22 |
23 |
24 |
25 | #textField(objectName="user", property="email", label="Email Address")#
26 | #passwordField(objectName="user", property="password", label="Password")#
27 | #passwordField(objectName="user", property="passwordConfirmation", label="Confirm Password")#
28 |
29 | #checkBox(objectName="user", property="terms", label="I agree to the terms and conditions")#
30 |
31 | #submitTag(value="Create Account", class="mt-4 btn btn-success")#
32 |
33 | #panelEnd()#
34 |
35 |
7 |
#user.photos[i].title#:
8 |
9 | #checkBox(objectName="user", association="photos", position=i, property="isPublic", label="Display this photo publicly.")#
10 |
11 |
My Sidebar Text
4 |
5 |
6 |
7 |
8 |
9 |
10 | My Site
11 |
12 |
13 |
14 | #includeContent("sidebar")#
15 | #includeContent()#
16 |
17 |
18 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/contentforlayout.txt:
--------------------------------------------------------------------------------
1 |
2 | #contentForLayout()#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/controller.txt:
--------------------------------------------------------------------------------
1 | testController = controller("users", params);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/csrfmetatags.txt:
--------------------------------------------------------------------------------
1 |
2 | #csrfMetaTags()#
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/cycle.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | | Name |
6 | Phone |
7 |
8 |
9 |
10 |
11 |
12 | | #employees.name# |
13 | #employees.phone# |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 | rank = cycle(values="president,vice-president,director,manager,specialist,intern", name="position")>
25 | - #categories.categoryName#
26 | resetCycle("emphasis")>
27 |
28 |
29 |
11 |
12 | Don't forget to tweet about this post!
13 |
14 |
15 | This is an error message.
16 |
17 |
18 | Your post was successfully submitted.
19 |
20 |
28 |
29 | Your post was successfully submitted.
30 |
31 |
39 |
40 | Your post was successfully submitted.
41 |
42 |
43 | Don't forget to tweet about this post!
44 |
45 |
5 | #includePartial(categories)#
6 |
7 |
8 |
9 | contentFor(sidebar=categoriesSidebar);
10 |
11 |
12 | #includeLayout("/layout.cfm")#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/includepartial.txt:
--------------------------------------------------------------------------------
1 |
2 | // If we're in the "sessions" controller, CFWheels will include the file "views/sessions/_login.cfm".
3 | #includePartial("login")#
4 |
5 | // CFWheels will include the file "views/shared/_button.cfm".
6 | #includePartial(partial="/shared/button")#
7 |
8 | // If we're in the "posts" controller and the "posts" variable includes a query result set, CFWheels will loop through the record set and include the file "views/posts/_post.cfm" for each record.
9 |
10 | #includePartial(posts)#
11 |
12 | // We can also override the template file loaded for the example above.
13 | #includePartial(partial="/shared/post", query=posts)#
14 |
15 | // The same works when passing a model instance.
16 | #includePartial(post)#
17 | #includePartial(partial="/shared/post", object=post)#
18 |
19 | // The same works when passing an array of model objects.
20 |
21 | #includePartial(posts)#
22 | #includePartial(partial="/shared/post", objects=posts)#
23 |
24 |
25 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/isajax.txt:
--------------------------------------------------------------------------------
1 | requestIsAjax = isAjax();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/isget.txt:
--------------------------------------------------------------------------------
1 | requestIsGet = isGet();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/ispost.txt:
--------------------------------------------------------------------------------
1 | requestIsPost = isPost();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/issecure.txt:
--------------------------------------------------------------------------------
1 | // Redirect non-secure connections to the secure version
2 | if (!isSecure())
3 | {
4 | redirectTo(protocol="https");
5 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/javascriptincludetag.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | #javaScriptIncludeTag("main")#
5 |
6 |
7 | #javaScriptIncludeTag("blog,accordion")#
8 |
9 |
10 | #javaScriptIncludeTag("https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js")#
11 |
12 |
13 |
14 |
15 | #javaScriptIncludeTag(source="tabs", head=true)#
16 |
17 |
18 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/linkto.txt:
--------------------------------------------------------------------------------
1 | #linkTo(text="Log Out", controller="account", action="logout")#
2 |
3 |
4 |
5 | #linkTo(text="Log Out", action="logout")#
6 |
7 |
8 | #linkTo(text="View Post", controller="blog", action="post", key=99)#
9 |
10 |
11 | #linkTo(text="View Settings", action="settings", params="show=all&sort=asc")#
12 |
13 |
14 |
15 | #linkTo(text="Joe's Profile", route="userProfile", userName="joe")#
16 |
17 |
18 |
19 | #linkTo(text="ColdFusion Framework", href="http://cfwheels.org/")#
20 |
21 |
22 |
23 | #linkTo(text="Delete Post", action="delete", key=99, class="delete", id="delete-99")#
24 |
25 |
26 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/mailto.txt:
--------------------------------------------------------------------------------
1 | #mailTo(emailAddress="webmaster@yourdomain.com", name="Contact our Webmaster")#
2 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/mimetypes.txt:
--------------------------------------------------------------------------------
1 | // Get the internally-stored MIME type for `xls`
2 | mimeType = mimeTypes("xls");
3 |
4 | // Get the internally-stored MIME type for a dynamic value. Fall back to a MIME type of `text/plain` if it's not found
5 | mimeType = mimeTypes(extension=params.type, fallback="text/plain");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/minuteselecttag.txt:
--------------------------------------------------------------------------------
1 | // This "Tag" version of the function accepts a `name` and `selected` instead of binding to a model object
2 |
3 | #minuteSelectTag(name="minuteOfMeeting", value=params.minuteOfMeeting)#
4 |
5 |
6 | // Only show 15-minute intervals
7 |
8 | #minuteSelectTag(name="minuteOfMeeting", value=params.minuteOfMeeting, minuteStep=15)#
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/model.txt:
--------------------------------------------------------------------------------
1 | // The `model("author")` part of the code below gets a reference to the model from the application scope, and then the `findByKey` class level method is called on it
2 | authorObject = model("author").findByKey(1);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/monthselecttag.txt:
--------------------------------------------------------------------------------
1 | // This "Tag" version of the function accepts a `name` and `selected` instead of binding to a model object
2 |
3 | #monthSelectTag(name="monthOfBirthday", selected=params.monthOfBirthday)#
4 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/obfuscateparam.txt:
--------------------------------------------------------------------------------
1 | // Obfuscate the primary key value `99`
2 | newValue = obfuscateParam(99);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/onlyprovides.txt:
--------------------------------------------------------------------------------
1 | // This will only provide the `html` type and will ignore what was defined in the call to `provides()` in the `config()` function
2 | onlyProvides("html");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/pagination.txt:
--------------------------------------------------------------------------------
1 | allAuthors = model("author").findAll(page=1, perPage=25, order="lastName", handle="authorsData");
2 | paginationData = pagination("authorsData");
3 |
4 | #pagination().currentPage#
5 | #pagination().totalPages#
6 | #pagination().totalRecords#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/passwordfield.txt:
--------------------------------------------------------------------------------
1 | // Provide a `label` and the required `objectName` and `property`
2 |
3 | #passwordField(label="Password", objectName="user", property="password")#
4 |
5 |
6 | // Display fields for passwords provided by the `passwords` association and nested properties
7 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/passwordfieldtag.txt:
--------------------------------------------------------------------------------
1 | // Basic usage usually involves a `label`, `name`, and `value`
2 |
3 | #passwordFieldTag(label="Password", name="password", value=params.password)#
4 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/pluginnames.txt:
--------------------------------------------------------------------------------
1 | // Check if the Scaffold plugin is installed
2 |
3 | // do something cool
4 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/pluralize.txt:
--------------------------------------------------------------------------------
1 | // Pluralize a word, will result in "people"
2 | #pluralize("person")#
3 |
4 | // Pluralize based on the count passed in
5 | Your search returned #pluralize(word="person", count=users.RecordCount)#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/provides.txt:
--------------------------------------------------------------------------------
1 | provides("html,xml,json");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/radiobutton.txt:
--------------------------------------------------------------------------------
1 | // Basic example view code.
2 |
3 |
8 |
9 |
10 | // Shows radio buttons for selecting the genders for all committee members provided by the `members` association and nested properties.
11 |
12 |
13 |
14 |
#committee.members[i].fullName#:
15 |
16 | #radioButton(objectName="committee", association="members", position=i, property="gender", tagValue="m", label="Male")#
17 | #radioButton(objectName="committee", association="members", position=i, property="gender", tagValue="f", label="Female")#
18 |
19 |
4 |
5 |
6 | rank = cycle(values="president,vice-president,director,manager,specialist,intern", name="position")>
7 | - #categories.categoryName#
8 | resetCycle("emphasis")>
9 |
10 |
11 |
", append="
", appendToLabel="
"):
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/setfilterchain.txt:
--------------------------------------------------------------------------------
1 | // Set filter chain directly in an array.
2 | setFilterChain([
3 | {through="restrictAccess"},
4 | {through="isLoggedIn, checkIPAddress", except="home, login"},
5 | {type="after", through="logConversion", only="thankYou"}
6 | ]);
7 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/setresponse.txt:
--------------------------------------------------------------------------------
1 | setResponse(newReponse);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/setverificationchain.txt:
--------------------------------------------------------------------------------
1 | // Set verification chain directly in an array.
2 | setVerificationChain([
3 | {only="handleForm", post=true},
4 | {only="edit", get=true, params="userId", paramsTypes="integer"},
5 | {only="edit", get=true, params="userId", paramsTypes="integer", handler="index", error="Invalid userId"}
6 | ]);
7 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/simpleformat.txt:
--------------------------------------------------------------------------------
1 |
2 | #simpleFormat(post.bodyText)#
3 |
4 |
5 |
6 | I love this post!
7 |
8 | Here's why:
9 | * Short
10 | * Succinct
11 | * Awesome
12 |
13 | #simpleFormat(comment)#
14 |
15 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/singularize.txt:
--------------------------------------------------------------------------------
1 | // Singularize a word, will result in "language"
2 | #singularize("languages")#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/startformtag.txt:
--------------------------------------------------------------------------------
1 |
2 | #startFormTag(action="create")#
3 |
4 | #endFormTag()#
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/striplinks.txt:
--------------------------------------------------------------------------------
1 |
2 | #stripLinks('Wheels is a framework for ColdFusion.')#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/striptags.txt:
--------------------------------------------------------------------------------
1 |
2 | #stripTags('Wheels is a framework for ColdFusion.')#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/stylesheetlinktag.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | #styleSheetLinkTag("styles")#
5 |
6 | #styleSheetLinkTag("blog,comments")#
7 |
8 | #styleSheetLinkTag(sources="print", media="print")#
9 |
10 | #styleSheetLinkTag("http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.0/themes/cupertino/jquery-ui.css")#
11 |
12 |
13 |
14 |
15 | #styleSheetLinkTag(sources="tabs", head=true)#
16 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/submittag.txt:
--------------------------------------------------------------------------------
1 | #startFormTag(action="something")#
2 |
3 | #submitTag()#
4 | #endFormTag()#
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/textarea.txt:
--------------------------------------------------------------------------------
1 |
2 | #textArea(label="Overview", objectName="article", property="overview")#
3 |
4 |
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/textareatag.txt:
--------------------------------------------------------------------------------
1 |
2 | #textAreaTag(label="Description", name="description", content=params.description)#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/textfield.txt:
--------------------------------------------------------------------------------
1 |
2 | #textField(label="First Name", objectName="user", property="firstName")#
3 |
4 |
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/textfieldtag.txt:
--------------------------------------------------------------------------------
1 |
2 | #textFieldTag(label="Search", name="q", value=params.q)#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/timeagoinwords.txt:
--------------------------------------------------------------------------------
1 | // Controller code.
2 | aWhileAgo = DateAdd("d", -90, Now());
3 |
4 | // View code.
5 |
6 | #timeAgoInWords(aWhileAgo)#
7 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/timeselect.txt:
--------------------------------------------------------------------------------
1 |
2 | #timeSelect(objectName="business", property="openUntil")#
3 |
4 |
5 | #timeSelect(objectName="business", property="openUntil", order="hour,minute")#
6 |
7 |
8 | #timeSelect(objectName="appointment", property="dateTimeStart", minuteStep=15)#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/timeselecttags.txt:
--------------------------------------------------------------------------------
1 |
2 | #timeSelectTags(name="timeOfMeeting" selected=params.timeOfMeeting)#
3 |
4 |
5 | #timeSelectTags(name="timeOfMeeting", selected=params.timeOfMeeting, order="hour,minute")#
6 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/timeuntilinwords.txt:
--------------------------------------------------------------------------------
1 | // Controller code.
2 | aLittleAhead = DateAdd("d", 365, Now());
3 |
4 | // View code.
5 |
6 | #timeUntilInWords(aLittleAhead)#
7 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/titleize.txt:
--------------------------------------------------------------------------------
1 |
2 | #titleize("CFWheels is a framework for ColdFusion")#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/truncate.txt:
--------------------------------------------------------------------------------
1 |
2 | #truncate(text="CFWheels is a framework for ColdFusion", length=20)#
3 |
4 |
5 | #truncate(text="CFWheels is a framework for ColdFusion", truncateString=" (more)")#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/urlfor.txt:
--------------------------------------------------------------------------------
1 |
2 | #urlFor(controller="account", action="logOut")#
3 |
4 |
5 | #urlFor(action="comments", anchor="comment10")#
6 |
7 |
8 | #urlFor(route="product", categorySlug="accessories", productSlug="battery-charger")#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/useslayout.txt:
--------------------------------------------------------------------------------
1 | // We want this layout to be used as the default throughout the
2 | // entire controller, except for the `myAjax` action.
3 | usesLayout(template="myLayout", except="myAjax");
4 |
5 | // Use a custom layout for these actions but use the default
6 | // `layout.cfm` for the rest.
7 | usesLayout(template="myLayout", only="termsOfService,shippingPolicy");
8 |
9 | // Define a custom function to decide which layout to display.
10 | // The `setLayout` function should return the name of the layout
11 | // to use or `true` to use the default one.
12 | usesLayout("setLayout");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/verificationchain.txt:
--------------------------------------------------------------------------------
1 | // Get verification chain, remove the first item, and set it back.
2 | myVerificationChain = verificationChain();
3 | ArrayDeleteAt(myVerificationChain, 1);
4 | setVerificationChain(myVerificationChain);
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/verifies.txt:
--------------------------------------------------------------------------------
1 | // Tell CFWheels to verify that the `handleForm` action is always a `POST` request when executed.
2 | verifies(only="handleForm", post=true);
3 |
4 | // Make sure that the edit action is a `GET` request, that `userId` exists in the `params` struct, and that it's an integer.
5 | verifies(only="edit", get=true, params="userId", paramsTypes="integer");
6 |
7 | // Just like above, only this time we want to invoke a custom function in our controller to handle the request when it is invalid.
8 | verifies(only="edit", get=true, params="userId", paramsTypes="integer", handler="myCustomFunction");
9 |
10 | // Just like above, only this time instead of specifying a handler, we want to `redirect` the visitor to the index action of the controller and show an error in The Flash when the request is invalid.
11 | verifies(only="edit", get=true, params="userId", paramsTypes="integer", action="index", error="Invalid userId");
12 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/wordtruncate.txt:
--------------------------------------------------------------------------------
1 |
2 | #wordTruncate(text="CFWheels is a framework for ColdFusion", length=4)#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/controller/yearselecttag.txt:
--------------------------------------------------------------------------------
1 |
2 | #yearSelectTag(name="yearOfBirthday", selected=params.yearOfBirthday)#
3 |
4 | // Only allow selection of year to be for the past 50 years, minimum being 18 years ago
5 | fiftyYearsAgo = Now() - 50;
6 | eighteenYearsAgo = Now() - 18;
7 |
8 |
9 | #yearSelectTag(name="yearOfBirthday", selected=params.yearOfBirthday, startYear=fiftyYearsAgo, endYear=eighteenYearsAgo)#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/deprecated/findorcreateby[property].txt:
--------------------------------------------------------------------------------
1 | // Return the first object that matches "Timberlake" in the last name column. If there is no match, create a new one and set firstName to "Justin".
2 | newArtist = model("artist").findOrCreateByLastName(lastName="Timberlake", firstName="Justin");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/collection.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | mapper()
5 | // Create a route like `photos/search`
6 | .resources(name="photos", nested=true)
7 | .collection()
8 | .get("search")
9 | .end()
10 | .end()
11 | .end();
12 |
13 |
14 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/delete.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | // Route name: articleReview
5 | // Example URL: /articles/987/reviews/12542
6 | // Controller: Reviews
7 | // Action: delete
8 | .delete(name="articleReview", pattern="articles/[articleKey]/reviews/[key]", to="reviews##delete")
9 |
10 | // Route name: cookedBooks
11 | // Example URL: /cooked-books
12 | // Controller: CookedBooks
13 | // Action: delete
14 | .delete(name="cookedBooks", controller="cookedBooks", action="delete")
15 |
16 | // Route name: logout
17 | // Example URL: /logout
18 | // Controller: Sessions
19 | // Action: delete
20 | .delete(name="logout", to="sessions##delete")
21 |
22 | // Route name: clientsStatus
23 | // Example URL: /statuses/4918
24 | // Controller: clients.Statuses
25 | // Action: delete
26 | .delete(name="statuses", to="statuses##delete", package="clients")
27 |
28 | // Route name: blogComment
29 | // Example URL: /comments/5432
30 | // Controller: blog.Comments
31 | // Action: delete
32 | .delete(
33 | name="comment",
34 | pattern="comments/[key]",
35 | to="comments##delete",
36 | package="blog"
37 | )
38 | .end();
39 |
40 |
41 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/end.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | .namespace("admin")
5 | .resources("products")
6 | .end() // Ends the `namespace` block.
7 |
8 | .scope(package="public")
9 | .resources(name="products", nested=true)
10 | .resources("variations")
11 | .end() // Ends the nested `resources` block.
12 | .end() // Ends the `scope` block.
13 | .end(); // Ends the `mapper` block.
14 |
15 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/mapper.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | .namespace("admin")
5 | .resources("users")
6 | .end()
7 |
8 | .resource("profile")
9 |
10 | .get(name="login", to="sessions##new")
11 | .post(name="auth", to="sessions##create")
12 | .delete(name="logout", to="sessions##delete")
13 | .end();
14 |
15 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/member.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | // Create a route like `photos/1/preview`
5 | .resources(name="photos", nested=true)
6 | .member()
7 | .get("preview")
8 | .end()
9 | .end()
10 | .end();
11 |
12 |
13 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/namespace.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | .namespace("api")
5 | .namespace("v2")
6 | // Route name: apiV2Products
7 | // Example URL: /api/v2/products/1234
8 | // Controller: api.v2.Products
9 | .resources("products")
10 | .end()
11 |
12 | .namespace("v1")
13 | // Route name: apiV1Users
14 | // Example URL: /api/v1/users
15 | // Controller: api.v1.Users
16 | .get(name="users", to="users##index")
17 | .end()
18 | .end()
19 |
20 | .namespace(name="foo", package="foos", path="foose")
21 | // Route name: fooBars
22 | // Example URL: /foose/bars
23 | // Controller: foos.Bars
24 | .post(name="bars", to="bars##create")
25 | .end()
26 | .end();
27 |
28 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/package.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | .package("public")
5 | // Example URL: /products/1234
6 | // Controller: public.Products
7 | .resources("products")
8 | .end()
9 |
10 | // Example URL: /users/4321
11 | // Controller: Users
12 | .resources(name="users", nested=true)
13 | // Calling `package` here is useful to scope nested routes for the `users`
14 | // resource into a subfolder.
15 | .package("users")
16 | // Example URL: /users/4321/profile
17 | // Controller: users.Profiles
18 | .resource("profile")
19 | .end()
20 | .end()
21 | .end();
22 |
23 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/resource.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | // With default arguments
5 | .resource("checkout")
6 |
7 | // Point auth URL to controller at `controllers/sessions/Auth.cfc`
8 | .resource(name="auth", controller="sessions.auth")
9 |
10 | // Limited list of routes generated by `only` argument.
11 | .resource(name="profile", only="show,edit,update")
12 |
13 | // Limited list of routes generated by `except` argument.
14 | .resource(name="cart", except="new,create,edit,delete")
15 |
16 | // Nested resource
17 | .resource(name="preferences", only="index", nested=true)
18 | .get(name="editPassword", to="passwords##edit")
19 | .patch(name="password", to="passwords##update")
20 |
21 | .resources("foods")
22 | .end()
23 |
24 | // Overridden `path`
25 | .resource(name="blogPostOptions", path="blog-post/options")
26 | .end();
27 |
28 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/resources.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | // With default arguments
5 | .resources("admins")
6 |
7 | // Point authors URL to controller at `controllers/Users.cfc`
8 | .resources(name="authors", controller="users")
9 |
10 | // Limited list of routes generated by `only` argument.
11 | .resources(name="products", only="index,show,edit,update")
12 |
13 | // Limited list of routes generated by `except` argument.
14 | .resources(name="orders", except="delete")
15 |
16 | // Nested resources
17 | .resources(name="stories", nested=true)
18 | .resources("heroes")
19 | .resources("villains")
20 | .end()
21 |
22 | // Overridden `path`
23 | .resources(name="blogPostsOptions", path="blog-posts/options")
24 | .end();
25 |
26 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/root.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | .namespace("api")
5 | // Map the root of the `api` folder to the `index` action of the `apis`
6 | // controller.
7 | .root(controller="apis", action="index")
8 | .end()
9 |
10 | // Map the root of the application to the `show` action of the `dashboards`
11 | // controller.
12 | .root(to="dashboards##show")
13 | .end();
14 |
15 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/scope.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | // All routes inside will use the `freeForAll` controller.
5 | .scope(controller="freeForAll")
6 | .get(name="bananas", action="bananas")
7 | .root(action="index")
8 | .end()
9 |
10 | // All routes's controllers inside will be inside the `public` package/subfolder.
11 | .scope(package="public")
12 | .resource(name="search", only="show,create")
13 | .end()
14 |
15 | // All routes inside will be prepended with a URL path of `phones/`.
16 | .scope(path="phones")
17 | .get(name="newest", to="phones##newest")
18 | .get(name="sortOfNew", to="phones##sortOfNew")
19 | .end()
20 | .end();
21 |
22 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/mapper/wildcard.txt:
--------------------------------------------------------------------------------
1 |
2 |
3 | mapper()
4 | // Enables `[controller]` and `[controller]/[action]`, only via `GET` requests.
5 | .wildcard()
6 |
7 | // Enables `[controller]/[action]/[key]` as well.
8 | .wildcard(mapKey=true)
9 |
10 | // Also enables patterns like `[controller].[format]` and
11 | // `[controller]/[action].[format]`
12 | .wildcard(mapFormat=true)
13 |
14 | // Allow additional methods beyond just `GET`
15 | //
16 | // Note that this can open some serious security holes unless you use `verifies`
17 | // in the controller to make sure that requests changing data can only occur
18 | // with a `POST` method.
19 | .wildcard(methods="get,post")
20 | .end();
21 |
22 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/addcolumn.txt:
--------------------------------------------------------------------------------
1 | addColumn(table='members', columnType='string', columnName='status', limit=50);
2 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/addindex.txt:
--------------------------------------------------------------------------------
1 | addIndex(table='members', columnNames='username', unique=true);
2 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/addrecord.txt:
--------------------------------------------------------------------------------
1 | addRecord(table='people',
2 | id = 1,
3 | title = "Mr",
4 | firstname = "Bruce",
5 | lastname = "Wayne",
6 | email = "bruce@wayneenterprises.com",
7 | tel = "555-67869099",
8 | );
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/changecolumn.txt:
--------------------------------------------------------------------------------
1 | changeColumn(table='members', columnType='string', columnName='status', limit=50);
2 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/changetable.txt:
--------------------------------------------------------------------------------
1 | t = changeTable(name='employees');
2 | t.string(columnNames="fullName", default="", null=true, limit="255");
3 | t.change();
4 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/createtable.txt:
--------------------------------------------------------------------------------
1 | // Example: create a users table
2 | t = createTable(name='users');
3 | t.string(columnNames='firstname,lastname', default='', null=false, limit=50);
4 | t.string(columnNames='email', default='', null=false, limit=255);
5 | t.string(columnNames='passwordHash', default='', null=true, limit=500);
6 | t.string(columnNames='passwordResetToken,verificationToken', default='', null=true, limit=500);
7 | t.boolean(columnNames='passwordChangeRequired,verified', default=false);
8 | t.datetime(columnNames='passwordResetTokenAt,passwordResetAt,loggedinAt', default='', null=true);
9 | t.integer(columnNames='roleid', default=0, null=false, limit=3);
10 | t.timestamps();
11 | t.create();
12 |
13 | // Example: Create a table with a different Primary Key
14 | t = createTable(name='tokens', id=false);
15 | t.primaryKey(name='id', null=false, type="string", limit=35 );
16 | t.datetime(columnNames="expiresAt", null=false);
17 | t.integer(columnNames='requests', default=0, null=false);
18 | t.timestamps();
19 | t.create();
20 |
21 | // Example: Create a Join Table with composite primary keys
22 | t = createTable(name='userkintins', id=false);
23 | t.primaryKey(name="userid", null=false, limit=11);
24 | t.primaryKey(name='profileid', type="string", limit=11 );
25 | t.create();
26 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/down.txt:
--------------------------------------------------------------------------------
1 | function down() {
2 | transaction {
3 | try {
4 | // your code goes here
5 | dropTable('myTable');
6 | } catch (any e) {
7 | local.exception = e;
8 | }
9 |
10 | if (StructKeyExists(local, "exception")) {
11 | transaction action="rollback";
12 | throw(errorCode="1", detail=local.exception.detail, message=local.exception.message, type="any");
13 | } else {
14 | transaction action="commit";
15 | }
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/removeindex.txt:
--------------------------------------------------------------------------------
1 | removeIndex(table='members',indexName='members_username');
2 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migration/up.txt:
--------------------------------------------------------------------------------
1 | function up() {
2 | transaction {
3 | try {
4 | // your code goes here
5 | t = createTable(name='myTable');
6 | t.timestamps();
7 | t.create();
8 | } catch (any e) {
9 | local.exception = e;
10 | }
11 |
12 | if (StructKeyExists(local, "exception")) {
13 | transaction action="rollback";
14 | throw(errorCode="1", detail=local.exception.detail, message=local.exception.message, type="any");
15 | } else {
16 | transaction action="commit";
17 | }
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migrator/createmigration.txt:
--------------------------------------------------------------------------------
1 | // Create an empty migration file
2 | result=application.wheels.migrator.createMigration("MyMigrationFile");
3 |
4 | // Or Create a migration file from the create-table template
5 | result=application.wheels.migrator.createMigration("MyMigrationFile","create-table");
6 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migrator/getavailablemigrations.txt:
--------------------------------------------------------------------------------
1 | // Get array of available migrations
2 | migrations = application.wheels.migrator.getAvailableMigrations();
3 |
4 | if(ArrayLen(migrations)){
5 | latestVersion = migrations[ArrayLen(migrations)].version;
6 | } else {
7 | latestVersion = 0;
8 | }
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migrator/getcurrentmigrationversion.txt:
--------------------------------------------------------------------------------
1 | // Get current database version
2 | currentVersion = application.wheels.migrator.getCurrentMigrationVersion();
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/migrator/migrateto.txt:
--------------------------------------------------------------------------------
1 | // Migrate to a specific version
2 | // Returns a message with the result
3 | result=application.wheels.migrator.migrateTo(version);
4 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/accessibleproperties.txt:
--------------------------------------------------------------------------------
1 | // Make `isActive` the only property that can be set through mass assignment operations like `updateAll()`.
2 | config() {
3 | accessibleProperties("isActive");
4 | }
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/adderror.txt:
--------------------------------------------------------------------------------
1 | // Add an error to the `email` property.
2 | this.addError(property="email", message="Sorry, you are not allowed to use that email. Try again, please.");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/adderrortobase.txt:
--------------------------------------------------------------------------------
1 | // Add an error on the object that's not specific to a single property.
2 | this.addErrorToBase(message="Your email address must be the same as your domain name.");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/aftercreate.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after an object has been created.
2 | afterCreate("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/afterdelete.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after an object has been deleted.
2 | afterDelete("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/afterfind.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `setTime` method after getting objects or records with one of the finder methods.
2 | config() {
3 | afterFind("setTime");
4 | }
5 |
6 | function setTime(){
7 | arguments.fetchedAt = Now();
8 | return arguments;
9 | }
10 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/afterinitialization.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after an object has been initialized (i.e. after creating it or fetching it with a finder method).
2 | afterInitialization("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/afternew.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after a new object has been created.
2 | afterNew("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/aftersave.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after an object has been saved.
2 | afterSave("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/afterupdate.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after an object has been updated.
2 | afterUpdate("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/aftervalidation.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after an object has been validated.
2 | afterValidation("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/aftervalidationoncreate.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after a new object has been validated.
2 | afterValidationOnCreate("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/aftervalidationonupdate.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method after an existing object has been validated.
2 | afterValidationOnUpdate("fixObj");
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/allchanges.txt:
--------------------------------------------------------------------------------
1 | // Get an object, change it, and then ask for its changes (will return a struct containing the changes, both property names and their values).
2 | member = model("member").findByKey(params.memberId);
3 | member.firstName = params.newFirstName;
4 | member.email = params.newEmail;
5 | allChanges = member.allChanges();
6 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/allerrors.txt:
--------------------------------------------------------------------------------
1 | // Get all the errors for the `user` object.
2 | errorInfo = user.allErrors();
3 |
4 | // Sample return of method.
5 | [
6 | {
7 | message: 'Username must not be blank.',
8 | name: 'usernameError',
9 | property: 'username'
10 | },
11 | {
12 | message: 'Password must not be blank.',
13 | name: 'passwordError',
14 | property: 'password'
15 | }
16 | ]
17 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/automaticvalidations.txt:
--------------------------------------------------------------------------------
1 | // Disable automatic validations (for example when automatic validations are enabled globally, but we want to disable just for this model).
2 | config() {
3 | automaticValidations(false);
4 | }
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/average.txt:
--------------------------------------------------------------------------------
1 | // Get the average salary for all employees.
2 | avgSalary = model("employee").average("salary");
3 |
4 | // Get the average salary for employees in a given department.
5 | avgSalary = model("employee").average(property="salary", where="departmentId=#params.key#");
6 |
7 | // Make sure a numeric value is always returned if no records are calculated.
8 | avgSalary = model("employee").average(property="salary", where="salary BETWEEN #params.min# AND #params.max#", ifNull=0);
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/beforecreate.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method
2 | beforeCreate("fixObj");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/beforedelete.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method
2 | beforeDelete("fixObj");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/beforesave.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method
2 | beforeSave("fixObj");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/beforeupdate.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method
2 | beforeUpdate("fixObj");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/beforevalidation.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method
2 | beforeValidation("fixObj");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/beforevalidationoncreate.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method
2 | beforeValidationOnCreate("fixObj");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/beforevalidationonupdate.txt:
--------------------------------------------------------------------------------
1 | // Instruct CFWheels to call the `fixObj` method
2 | beforeValidationOnUpdate("fixObj");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/belongsto.txt:
--------------------------------------------------------------------------------
1 | // Specify that instances of this model belong to an author. (The table for this model should have a foreign key set on it, typically named `authorid`.)
2 | belongsTo("author");
3 |
4 | // Same as above, but because we have broken away from the foreign key naming convention, we need to set `modelName` and `foreignKey`.
5 | belongsTo(name="bookWriter", modelName="author", foreignKey="authorId");
6 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/changedfrom.txt:
--------------------------------------------------------------------------------
1 | // Get a member object and change the `email` property on it
2 | member = model("member").findByKey(params.memberId);
3 | member.email = params.newEmail;
4 |
5 | // Get the previous value (what the `email` property was before it was changed)
6 | oldValue = member.changedFrom("email");
7 |
8 | // The above can also be done using a dynamic function like this
9 | oldValue = member.emailChangedFrom();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/changedproperties.txt:
--------------------------------------------------------------------------------
1 | // Get an object, change it, and then ask for its changes (will return a list of the property names that have changed, not the values themselves)
2 | member = model("member").findByKey(params.memberId);
3 | member.firstName = params.newFirstName;
4 | member.email = params.newEmail;
5 | changedProperties = member.changedProperties();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/clearchangeinformation.txt:
--------------------------------------------------------------------------------
1 | // Convert startTime to UTC (maybe done in an "after find" call back) but then tell CFWheels to clear the information about this change (but not the change itself) so that it won't attempt to save the new value to the database, report it as being changed when calling hasChanged() etc.
2 |
3 | this.startTime = DateConvert("Local2UTC", this.startTime);
4 | this.clearChangeInformation(property="startTime");
5 |
6 | // Clear information for all properties
7 | this.clearChangeInformation();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/clearerrors.txt:
--------------------------------------------------------------------------------
1 | // Clear all errors on the object as a whole
2 | this.clearErrors();
3 |
4 | // Clear all errors on `firstName`
5 | this.clearErrors("firstName");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/count.txt:
--------------------------------------------------------------------------------
1 | // Count how many authors there are in the table
2 | authorCount = model("author").count();
3 |
4 | // Count how many authors that have a last name starting with an "A"
5 | authorOnACount = model("author").count(where="lastName LIKE 'A%'");
6 |
7 | // Count how many authors that have written books starting with an "A"
8 | authorWithBooksOnACount = model("author").count(include="books", where="booktitle LIKE 'A%'");
9 |
10 | // Count the number of comments on a specific post (a `hasMany` association from `post` to `comment` is required)
11 | // The `commentCount` method will call `model("comment").count(where="postId=#post.id#")` internally
12 | aPost = model("post").findByKey(params.postId);
13 | amount = aPost.commentCount();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/create.txt:
--------------------------------------------------------------------------------
1 | // Create a new author and save it to the database
2 | newAuthor = model("author").create(params.author);
3 |
4 | // Same as above using named arguments
5 | newAuthor = model("author").create(firstName="John", lastName="Doe");
6 |
7 | // Same as above using both named arguments and a struct
8 | newAuthor = model("author").create(active=1, properties=params.author);
9 |
10 | // If you have a `hasOne` or `hasMany` association setup from `customer` to `order`, you can do a scoped call. (The `createOrder` method below will call `model("order").create(customerId=aCustomer.id, shipping=params.shipping)` internally.)
11 | aCustomer = model("customer").findByKey(params.customerId);
12 | anOrder = aCustomer.createOrder(shipping=params.shipping);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/datasource.txt:
--------------------------------------------------------------------------------
1 | // In models/User.cfc.
2 | config() {
3 | // Tell Wheels to use the data source named `users_source` instead of the default one whenever this model makes SQL calls.
4 | dataSource("users_source");
5 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/delete.txt:
--------------------------------------------------------------------------------
1 | // Get a post object and then delete it from the database.
2 | post = model("post").findByKey(33);
3 | post.delete();
4 |
5 | // If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `deleteComment` method below will call `comment.delete()` internally.)
6 | post = model("post").findByKey(params.postId);
7 | comment = model("comment").findByKey(params.commentId);
8 | post.deleteComment(comment);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/deleteall.txt:
--------------------------------------------------------------------------------
1 | // Delete all inactive users without instantiating them (will skip validation and callbacks).
2 | recordsDeleted = model("user").deleteAll(where="inactive=1", instantiate=false);
3 |
4 | // If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `deleteAllComments` method below will call `model("comment").deleteAll(where="postId=#post.id#")` internally.)
5 | post = model("post").findByKey(params.postId);
6 | howManyDeleted = post.deleteAllComments();
7 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/deletebykey.txt:
--------------------------------------------------------------------------------
1 | // Delete the user with the primary key value of `1`.
2 | result = model("user").deleteByKey(1);
3 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/deleteone.txt:
--------------------------------------------------------------------------------
1 | // Delete the user that signed up last.
2 | result = model("user").deleteOne(order="signupDate DESC");
3 |
4 | // If you have a `hasOne` association setup from `user` to `profile` you can do a scoped call (the `deleteProfile` method below will call `model("profile").deleteOne(where="userId=#aUser.id#")` internally).
5 | aUser = model("user").findByKey(params.userId);
6 | aUser.deleteProfile();
7 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/errorcount.txt:
--------------------------------------------------------------------------------
1 | // Check how many errors are set on the object
2 | if(author.errorCount() GTE 10){
3 | // Do something to deal with this very erroneous author here...
4 | }
5 |
6 | // Check how many errors are associated with the `email` property
7 | if(author.errorCount("email") gt 0){
8 | // Do something to deal with this erroneous author here...
9 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/errormessageon.txt:
--------------------------------------------------------------------------------
1 |
2 | #errorMessageOn(objectName="user", property="email")#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/errormessagesfor.txt:
--------------------------------------------------------------------------------
1 |
2 | #errorMessagesFor(objectName="user")#
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/errorson.txt:
--------------------------------------------------------------------------------
1 | // Get all errors related to the email address of the user object
2 | errors = user.errorsOn("emailAddress");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/errorsonbase.txt:
--------------------------------------------------------------------------------
1 | // Get all general type errors for the user object
2 | errors = user.errorsOnBase();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/exists.txt:
--------------------------------------------------------------------------------
1 | // Checking if Joe exists in the database
2 | result = model("user").exists(where="firstName = 'Joe'");
3 |
4 | // Checking if a specific user exists based on a primary key valued passed in through the URL/form in an if statement
5 | if (model("user").exists(keyparams.key))
6 | {
7 | // Do something
8 | }
9 |
10 | // If you have a `belongsTo` association setup from `comment` to `post`, you can do a scoped call. (The `hasPost` method below will call `model("post").exists(comment.postId)` internally.)
11 | comment = model("comment").findByKey(params.commentId);
12 | commentHasAPost = comment.hasPost();
13 |
14 | // If you have a `hasOne` association setup from `user` to `profile`, you can do a scoped call. (The `hasProfile` method below will call `model("profile").exists(where="userId=#user.id#")` internally.)
15 | user = model("user").findByKey(params.userId);
16 | userHasProfile = user.hasProfile();
17 |
18 | // If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `hasComments` method below will call `model("comment").exists(where="postid=#post.id#")` internally.)
19 | post = model("post").findByKey(params.postId);
20 | postHasComments = post.hasComments();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/findallkeys.txt:
--------------------------------------------------------------------------------
1 | // basic usage
2 | primaryKeyList = model("artist").findAllKeys();
3 |
4 | // Quote values, use a different delimiter and filter results with the "where" argument
5 | primaryKeyList = model("artist").findAllKeys(quoted=true, delimiter="-", where="active=1");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/findbykey.txt:
--------------------------------------------------------------------------------
1 | // Getting the author with the primary key value `99` as an object
2 | auth = model("author").findByKey(99);
3 |
4 | // Getting an author based on a form/URL value and then checking if it was found
5 | auth = model("author").findByKey(params.key);
6 | if(!isObject(auth)){
7 | flashInsert(message="Author #params.key# was not found");
8 | redirectTo(back=true);
9 | }
10 |
11 | // If you have a `belongsTo` association setup from `comment` to `post`, you can do a scoped call. (The `post` method below will call `model("post").findByKey(comment.postId)` internally)
12 | comment = model("comment").findByKey(params.commentId);
13 | post = comment.post();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/findone.txt:
--------------------------------------------------------------------------------
1 | // Getting the most recent order as an object from the database
2 | order = model("order").findOne(order="datePurchased DESC");
3 |
4 | // Using a dynamic finder to get the first person with the last name `Smith`. Same as calling `model("user").findOne(where"lastName='Smith'")`
5 | person = model("user").findOneByLastName("Smith");
6 |
7 | // Getting a specific user using a dynamic finder. Same as calling `model("user").findOne(where"email='someone@somewhere.com' AND password='mypass'")`
8 | user = model("user").findOneByEmailAndPassword("someone@somewhere.com,mypass");
9 |
10 | // If you have a `hasOne` association setup from `user` to `profile`, you can do a scoped call. (The `profile` method below will call `model("profile").findOne(where="userId=#user.id#")` internally)
11 | user = model("user").findByKey(params.userId);
12 | profile = user.profile();
13 |
14 | // If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `findOneComment` method below will call `model("comment").findOne(where="postId=#post.id#")` internally)
15 | post = model("post").findByKey(params.postId);
16 | comment = post.findOneComment(where="text='I Love Wheels!'");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/gettablenameprefix.txt:
--------------------------------------------------------------------------------
1 | // Get the table name prefix for this user when running a custom query.
2 |
3 |
4 | SELECT *
5 | FROM #this.getTableNamePrefix()#users
6 | WHERE disabled = 1
7 |
8 |
9 |
10 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/haschanged.txt:
--------------------------------------------------------------------------------
1 | // Get a member object and change the `email` property on it
2 | member = model("member").findByKey(params.memberId);
3 | member.email = params.newEmail;
4 |
5 | // Check if the `email` property has changed
6 | if(member.hasChanged("email")){
7 | // Do something...
8 | }
9 |
10 | // The above can also be done using a dynamic function like this
11 | if(member.emailHasChanged()){
12 | // Do something...
13 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/haserrors.txt:
--------------------------------------------------------------------------------
1 | // Check if the post object has any errors set on it
2 | if(post.hasErrors()){
3 | // Send user to a form to correct the errors...
4 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/hasmany.txt:
--------------------------------------------------------------------------------
1 | // Specify that instances of this model has many comments (the table for the associated model, not the current, should have the foreign key set on it).
2 | hasMany("comments");
3 |
4 | // Specify that this model (let's call it `reader` in this case) has many subscriptions and setup a shortcut to the `publication` model (useful when dealing with many-to-many relationships).
5 | hasMany(name="subscriptions", shortcut="publications");
6 |
7 | // Automatically delete all associated `comments` whenever this object is deleted.
8 | hasMany(name="comments", dependent="deleteAll");
9 |
10 | // When not following CFWheels naming conventions for associations, it can get complex to define how a `shortcut` works.
11 | // In this example, we are naming our `shortcut` differently than the actual model's name.
12 |
13 | // In the models/Customer.cfc `config()` method.
14 | hasMany(name="subscriptions", shortcut="magazines", through="publication,subscriptions");
15 |
16 | // In the models/Subscription.cfc `config()` method.
17 | belongsTo("customer");
18 | belongsTo("publication");
19 |
20 | // In the models/Publication `config()` method.
21 | hasMany("subscriptions");
22 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/hasone.txt:
--------------------------------------------------------------------------------
1 | // Specify that instances of this model has one profile. (The table for the associated model, not the current, should have the foreign key set on it.)
2 | hasOne("profile");
3 |
4 | // Same as above but setting the `joinType` to `inner`, which basically means this model should always have a record in the `profiles` table.
5 | hasOne(name="profile", joinType="inner");
6 |
7 | // Automatically delete the associated `profile` whenever this object is deleted.
8 | hasMany(name="comments", dependent="delete");
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/hasproperty.txt:
--------------------------------------------------------------------------------
1 | // Get an object, set a value and then see if the property exists
2 | employee = model("employee").new();
3 | employee.firstName = "dude";
4 | employee.hasProperty("firstName"); // returns true
5 |
6 | // This is also a dynamic method that you could do
7 | employee.hasFirstName();
8 |
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/invokewithtransaction.txt:
--------------------------------------------------------------------------------
1 | // This is the method to be run inside a transaction.
2 | public boolean function transferFunds(required any personFrom, required any personTo, required numeric amount) {
3 | if (arguments.personFrom.withdraw(arguments.amount) && arguments.personTo.deposit(arguments.amount)) {
4 | return true;
5 | } else {
6 | return false;
7 | }
8 | }
9 |
10 | local.david = model("Person").findOneByName("David");
11 | local.mary = model("Person").findOneByName("Mary");
12 | invokeWithTransaction(method="transferFunds", personFrom=local.david, personTo=local.mary, amount=100);
13 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/isclass.txt:
--------------------------------------------------------------------------------
1 | // Use the passed in `id` when we're already in an instance
2 | function memberIsAdmin(){
3 | if(isClass()){
4 | return this.findByKey(arguments.id).admin;
5 | } else {
6 | return this.admin;
7 | }
8 | }
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/isinstance.txt:
--------------------------------------------------------------------------------
1 | // Use the passed in `id` when we're not already in an instance
2 | function memberIsAdmin(){
3 | if(isInstance()){
4 | return this.admin;
5 | } else {
6 | return this.findByKey(arguments.id).admin;
7 | }
8 | }
9 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/isnew.txt:
--------------------------------------------------------------------------------
1 | // Create a new object and then check if it is new (yes, this example is ridiculous. It makes more sense in the context of callbacks for example)
2 | employee = model("employee").new()>
3 |
4 | // Do something...
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/key.txt:
--------------------------------------------------------------------------------
1 | // Get an object and then get the primary key value(s)
2 | employee = model("employee").findByKey(params.key);
3 | val = employee.key();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/maximum.txt:
--------------------------------------------------------------------------------
1 | // Get the amount of the highest salary for all employees
2 | highestSalary = model("employee").maximum("salary");
3 |
4 | // Get the amount of the highest salary for employees in a given department
5 | highestSalary = model("employee").maximum(property="salary", where="departmentId=#params.key#");
6 |
7 | // Make sure a numeric value is always returned, even if no records are found to calculate the maximum for
8 | highestSalary = model("employee").maximum(property="salary", where="salary > #params.minSalary#", ifNull=0);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/minimum.txt:
--------------------------------------------------------------------------------
1 | // Get the amount of the lowest salary for all employees
2 | lowestSalary = model("employee").minimum("salary");
3 |
4 | // Get the amount of the lowest salary for employees in a given department
5 | lowestSalary = model("employee").minimum(property="salary", where="departmentId=#params.key#");
6 |
7 | // Make sure a numeric amount is always returned, even when there were no records analyzed by the query
8 | lowestSalary = model("employee").minimum(property="salary", where="salary BETWEEN #params.min# AND #params.max#", ifNull=0);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/nestedproperties.txt:
--------------------------------------------------------------------------------
1 | // In `models/User.cfc`, allow for `groupEntitlements` to be saved and deleted through the `user` object.
2 | function config(){
3 | hasMany("groupEntitlements");
4 | nestedProperties(association="groupEntitlements", allowDelete=true);
5 | }
6 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/new.txt:
--------------------------------------------------------------------------------
1 | // Create a new author in memory (not saved to the database)
2 | newAuthor = model("author").new();
3 |
4 | // Create a new author based on properties in a struct
5 | newAuthor = model("author").new(params.authorStruct);
6 |
7 | // Create a new author by passing in named arguments
8 | newAuthor = model("author").new(firstName="John", lastName="Doe");
9 |
10 | // If you have a `hasOne` or `hasMany` association setup from `customer` to `order`, you can do a scoped call. (The `newOrder` method below will call `model("order").new(customerId=aCustomer.id)` internally.)
11 | aCustomer = model("customer").findByKey(params.customerId);
12 | anOrder = aCustomer.newOrder(shipping=params.shipping);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/primarykey.txt:
--------------------------------------------------------------------------------
1 | // Get the name of the primary key of the table mapped to the `employee` model (which is the `employees` table by default)
2 | keyName = model("employee").primaryKey();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/primarykeys.txt:
--------------------------------------------------------------------------------
1 | // Get a list of the names of the primary keys in the table mapped to the `employee` model (which is the `employees` table by default)
2 | keyNames = model("employee").primaryKeys();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/properties.txt:
--------------------------------------------------------------------------------
1 | // Get a structure of all the properties for an object
2 | user = model("user").findByKey(1);
3 | props = user.properties();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/property.txt:
--------------------------------------------------------------------------------
1 | // Tell Wheels that when we are referring to `firstName` in the CFML code, it should translate to the `STR_USERS_FNAME` column when interacting with the database instead of the default (which would be the `firstname` column)
2 | property(name="firstName", column="STR_USERS_FNAME");
3 |
4 | // Tell Wheels that when we are referring to `fullName` in the CFML code, it should concatenate the `STR_USERS_FNAME` and `STR_USERS_LNAME` columns
5 | property(name="fullName", sql="STR_USERS_FNAME + ' ' + STR_USERS_LNAME");
6 |
7 | // Tell Wheels that when displaying error messages or labels for form fields, we want to use `First name(s)` as the label for the `STR_USERS_FNAME` column
8 | property(name="firstName", label="First name(s)");
9 |
10 | // Tell Wheels that when creating new objects, we want them to be auto-populated with a `firstName` property of value `Dave`
11 | property(name="firstName", defaultValue="Dave");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/propertyispresent.txt:
--------------------------------------------------------------------------------
1 | // Get an object, set a value and then see if the property exists
2 | employee = model("employee").new();
3 | employee.firstName = "dude";
4 | return employee.propertyIsPresent("firstName"); // Returns true
5 |
6 | employee.firstName = "">
7 | return employee.propertyIsPresent("firstName"); // Returns false
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/propertynames.txt:
--------------------------------------------------------------------------------
1 | // Get a list of the property names in use in the user model
2 | propNames = model("user").propertyNames();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/protectedproperties.txt:
--------------------------------------------------------------------------------
1 | // In `models/User.cfc`, `firstName` and `lastName` cannot be changed through mass assignment operations like `updateAll()`.
2 | function config(){
3 | protectedProperties("firstName,lastName");
4 | }
5 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/reload.txt:
--------------------------------------------------------------------------------
1 | // Get an object, call a method on it that could potentially change values, and then reload the values from the database
2 | employee = model("employee").findByKey(params.key);
3 | employee.someCallThatChangesValuesInTheDatabase();
4 | employee.reload();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/save.txt:
--------------------------------------------------------------------------------
1 | // Save the user object to the database (will automatically do an `INSERT` or `UPDATE` statement depending on if the record is new or already exists
2 | user.save();
3 |
4 | // Save the user object directly in an if statement without using `cfqueryparam` and take appropriate action based on the result
5 | if(user.save(parameterize=false)){
6 | flashInsert(notice="The user was saved!");
7 | redirectTo(action="edit");
8 | } else {
9 | flashInsert(alert="Error, please correct!");
10 | renderView(action="edit");
11 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/setprimarykey.txt:
--------------------------------------------------------------------------------
1 | // In `models/User.cfc`, define the primary key as a column called `userID`.
2 | function config(){
3 | setPrimaryKey("userID");
4 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/setprimarykeys.txt:
--------------------------------------------------------------------------------
1 | // In `models/Subscription.cfc`, define the primary key as composite of the columns `customerId` and `publicationId`.
2 | function config(){
3 | setPrimaryKeys("customerId,publicationId");
4 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/setproperties.txt:
--------------------------------------------------------------------------------
1 | // Update the properties of the object with the params struct containing the values of a form post
2 | user = model("user").findByKey(1);
3 | user.setProperties(params.user);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/settablenameprefix.txt:
--------------------------------------------------------------------------------
1 | // In `models/User.cfc`, add a prefix to the default table name of `tbl`.
2 | function config(){
3 | setTableNamePrefix("tbl");
4 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/sum.txt:
--------------------------------------------------------------------------------
1 | // Get the sum of all salaries
2 | allSalaries = model("employee").sum("salary");
3 |
4 | // Get the sum of all salaries for employees in a given country
5 | allAustralianSalaries = model("employee").sum(property="salary", include="country", where="countryname='Australia'");
6 |
7 | // Make sure a numeric value is always returned, even if there are no records analyzed by the query
8 | salarySum = model("employee").sum(property="salary", where="salary BETWEEN #params.min# AND #params.max#", ifNull=0);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/table.txt:
--------------------------------------------------------------------------------
1 | // In models/User.cfc.
2 | function config() {
3 | // Tell Wheels to use the `tbl_USERS` table in the database for the `user` model instead of the default (which would be `users`).
4 | table("tbl_USERS");
5 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/tablename.txt:
--------------------------------------------------------------------------------
1 | // Check what table the user model uses
2 | whatAmIMappedTo = model("user").tableName();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/toggle.txt:
--------------------------------------------------------------------------------
1 | // Get an object, and toggle a boolean property
2 | user = model("user").findByKey(58);
3 | isSuccess = user.toggle("isActive"); // returns whether the object was saved properly
4 |
5 | // You can also use a dynamic helper for this
6 | isSuccess = user.toggleIsActive();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/update.txt:
--------------------------------------------------------------------------------
1 | // Get a post object and then update its title in the database
2 | post = model("post").findByKey(33);
3 | post.update(title="New version of Wheels just released");
4 |
5 | // Get a post object and then update its title and other properties based on what is pased in from the URL/form
6 | post = model("post").findByKey(params.key);
7 | post.update(title="New version of Wheels just released", properties=params.post);
8 |
9 | // If you have a `hasOne` association setup from `author` to `bio`, you can do a scoped call. (The `setBio` method below will call `bio.update(authorId=anAuthor.id)` internally.)
10 | author = model("author").findByKey(params.authorId);
11 | bio = model("bio").findByKey(params.bioId);
12 | author.setBio(bio);
13 |
14 | // If you have a `hasMany` association setup from `owner` to `car`, you can do a scoped call. (The `addCar` method below will call `car.update(ownerId=anOwner.id)` internally.)
15 | anOwner = model("owner").findByKey(params.ownerId);
16 | aCar = model("car").findByKey(params.carId);
17 | anOwner.addCar(aCar);
18 |
19 | // If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `removeComment` method below will call `comment.update(postId="")` internally.)
20 | aPost = model("post").findByKey(params.postId);
21 | aComment = model("comment").findByKey(params.commentId);
22 | aPost.removeComment(aComment); // Get an object, and toggle a boolean property
23 | user = model("user").findByKey(58);
24 | isSuccess = user.toggle("isActive"); // returns whether the object was saved properly
25 |
26 | // You can also use a dynamic helper for this
27 | isSuccess = user.toggleIsActive();
28 |
29 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/updateall.txt:
--------------------------------------------------------------------------------
1 | // Update the `published` and `publishedAt` properties for all records that have `published=0`
2 | recordsUpdated = model("post").updateAll( published=1, publishedAt=Now(), where="published=0" );
3 |
4 | // If you have a `hasMany` association setup from `post` to `comment`, you can do a scoped call. (The `removeAllComments` method below will call `model("comment").updateAll(postid="", where="postId=#post.id#")` internally.)
5 | post = model("post").findByKey(params.postId);
6 | post.removeAllComments();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/updatebykey.txt:
--------------------------------------------------------------------------------
1 | // Updates the object with `33` as the primary key value with values passed in through the URL/form
2 | result = model("post").updateByKey(33, params.post);
3 |
4 | // Updates the object with `33` as the primary key using named arguments
5 | result = model("post").updateByKey(key=33, title="New version of Wheels just released", published=1);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/updateone.txt:
--------------------------------------------------------------------------------
1 | // Sets the `new` property to `1` on the most recently released product
2 | result = model("product").updateOne(order="releaseDate DESC", new=1);
3 |
4 | // If you have a `hasOne` association setup from `user` to `profile`, you can do a scoped call. (The `removeProfile` method below will call `model("profile").updateOne(where="userId=#aUser.id#", userId="")` internally.)
5 | aUser = model("user").findByKey(params.userId);
6 | aUser.removeProfile();
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/updateproperty.txt:
--------------------------------------------------------------------------------
1 | // Sets the `new` property to `1` through updateProperty()
2 | product = model("product").findByKey(56);
3 | product.updateProperty("new", 1);
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/valid.txt:
--------------------------------------------------------------------------------
1 | // Check if a user is valid before proceeding with execution
2 | user = model("user").new(params.user);
3 |
4 | if user.valid(){
5 | // Do something here
6 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validate.txt:
--------------------------------------------------------------------------------
1 | function config() {
2 | // Register the `checkPhoneNumber` method below to be called to validate objects before they are saved.
3 | validate("checkPhoneNumber");
4 | }
5 |
6 | function checkPhoneNumber() {
7 | // Make sure area code is `614`.
8 | return Left(this.phoneNumber, 3) == "614";
9 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validateoncreate.txt:
--------------------------------------------------------------------------------
1 | function config(){
2 | // Register the `checkPhoneNumber` method below to be called to validate new objects before they are inserted.
3 | validateOnCreate("checkPhoneNumber");
4 | }
5 |
6 | function checkPhoneNumber(){
7 | // Make sure area code is `614`.
8 | return Left(this.phoneNumber, 3) == "614";
9 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validateonupdate.txt:
--------------------------------------------------------------------------------
1 | function config(){
2 | // Register the `check` method below to be called to validate existing objects before they are updated.
3 | validateOnUpdate("checkPhoneNumber");
4 | }
5 |
6 | function checkPhoneNumber(){
7 | // Make sure area code is `614`
8 | return Left(this.phoneNumber, 3) == "614";
9 | }
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validatesconfirmationof.txt:
--------------------------------------------------------------------------------
1 | // Make sure that the user has to confirm their password correctly the first time they register (usually done by typing it again in a second form field)
2 | validatesConfirmationOf(property="password", when="onCreate", message="Your password and its confirmation do not match. Please try again.");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validatesexclusionof.txt:
--------------------------------------------------------------------------------
1 | // Do not allow "PHP" or "Fortran" to be saved to the database as a cool language
2 | validatesExclusionOf(property="coolLanguage", list="php,fortran", message="Haha, you can not be serious. Try again, please.");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validatesformatof.txt:
--------------------------------------------------------------------------------
1 | // Make sure that the user has entered a correct credit card validatesFormatOf(property="cc", type="creditcard"); /* * Make sure that the user has entered an email address ending with the * `.se` domain when the `ipCheck()` method returns `true`, and it's not * Sunday. Also supply a custom error message that overrides the CFWheels * default one */ validatesFormatOf( property="email", regEx="^.*@.*\.se$", condition="ipCheck()", unless="DayOfWeek() eq 1" message="Sorry, you must have a Swedish email address to use this website." );
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validatesinclusionof.txt:
--------------------------------------------------------------------------------
1 | // Make sure that the user selects either "CFWheels" or "Rails" as their framework
2 | validatesInclusionOf(property="frameworkOfChoice", list="cfwheels,rails", message="Please try again, and this time, select a decent framework!" );
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validateslengthof.txt:
--------------------------------------------------------------------------------
1 | // Make sure that the `firstname` and `lastName` properties are not more than
2 | // 50 characters and use square brackets to dynamically insert the property
3 | // name when the error message is displayed to the user. (The `firstName`
4 | // property will be displayed as "first name".)
5 | validatesLengthOf(
6 | properties="firstName,lastName",
7 | maximum=50,
8 | message="Please shorten your [property] please (50 characters max)."
9 | );
10 |
11 | // Make sure that the `password` property is between 4 and 15 characters
12 | validatesLengthOf(
13 | property="password",
14 | within="4,20",
15 | message="The password length must be between 4 and 20 characters."
16 | );
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validatesnumericalityof.txt:
--------------------------------------------------------------------------------
1 | // Make sure that the score is a number with no decimals but only when a score is supplied. (Tetting `allowBlank` to `true` means that objects are allowed to be saved without scores, typically resulting in `NULL` values being inserted in the database table)
2 | validatesNumericalityOf(property="score", onlyInteger=true, allowBlank=true, message="Please enter a correct score.");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validatespresenceof.txt:
--------------------------------------------------------------------------------
1 | // Make sure that the user data can not be saved to the database without the `emailAddress` property. (It must exist and not be an empty string)
2 | validatesPresenceOf("emailAddress");
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validatesuniquenessof.txt:
--------------------------------------------------------------------------------
1 | // Make sure that two users with the same username won't ever exist in the database table
2 | validatesUniquenessOf(property="username", message="Sorry, that username is already taken.");
3 |
4 | // Same as above but allow identical usernames as long as they belong to a different account
5 | validatesUniquenessOf(property="username", scope="accountId");
6 |
7 |
--------------------------------------------------------------------------------
/wheels/public/docs/reference/model/validationtypeforproperty.txt:
--------------------------------------------------------------------------------
1 | // first name is a varchar(50) column
2 | employee = model("employee").new();
3 |
4 |
5 | #employee.validationTypeForProperty("firstName")#
6 |
--------------------------------------------------------------------------------
/wheels/public/functions.cfm:
--------------------------------------------------------------------------------
1 |
2 | include "initialization.cfm";
3 |
4 |
--------------------------------------------------------------------------------
/wheels/public/initialization.cfm:
--------------------------------------------------------------------------------
1 |
2 | /**
3 | * Internal function.
4 | */
5 | public struct function $init() {
6 | return this;
7 | }
8 |
9 |
--------------------------------------------------------------------------------
/wheels/public/layout/_footer_simple.cfm:
--------------------------------------------------------------------------------
1 |
4 |