hasManyCheckBox()

Signature

hasManyCheckBox() — returns string

Available in: controller Category: Form Association Functions

Description

Used as a shortcut to output the proper form elements for an association. Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.

Parameters

Name	Type	Required	Default	Description
objectName	string	yes	—	Name of the variable containing the parent object to represent with this form field.
association	string	yes	—	Name of the association set in the parent object to represent with this form field.
keys	string	yes	—	Keys of the join row for this form field: the parent key, then the other key (for example a post key and a tag id). For a composite-key join model, list them in the order of its primary key columns. A surrogate-id join model works too: the keys are matched on its belongsTo foreign keys. Either way, declare a belongsTo association on the join model for each key column.
label	string	no	—	The label text to use in the form control.
labelPlacement	string	no	—	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using aroundLeft or aroundRight.
prepend	string	no	—	String to prepend to the form control. Useful to wrap the form control with HTML tags.
append	string	no	—	String to append to the form control. Useful to wrap the form control with HTML tags.
prependToLabel	string	no	—	String to prepend to the form control’s label. Useful to wrap the form control with HTML tags.
appendToLabel	string	no	—	String to append to the form control’s label. Useful to wrap the form control with HTML tags.
errorElement	string	no	—	HTML tag to wrap the form control with when the object contains errors.
errorClass	string	no	—	The class name of the HTML tag that wraps the form control when there are errors.
encode	any	no	true	Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content.
id	string	no	—	Optional. Explicit ID for the generated checkbox input. If not provided, an ID will be generated automatically.

Examples

// 1. Show check boxes for associating authors with the current book
<cfloop query="authors">
    #hasManyCheckBox(
        label=authors.fullName,
        objectName="book",
        association="bookAuthors",
        keys="#book.key()#,#authors.id#"
    )#
</cfloop>

// 2. Wrap each checkbox and label in a div using prepend/append
<cfloop query="authors">
    #hasManyCheckBox(
        label=authors.fullName,
        labelPlacement="after",
        objectName="book",
        association="bookAuthors",
        keys="#book.key()#,#authors.id#",
        prepend="<div class=""author-option"">",
        append="</div>"
    )#
</cfloop>

// 3. Supply an explicit ID and custom error styling
<cfloop query="tags">
    #hasManyCheckBox(
        label=tags.name,
        objectName="post",
        association="postTags",
        keys="#post.key()#,#tags.id#",
        id="tag-#tags.id#",
        errorElement="span",
        errorClass="field-error"
    )#
</cfloop>