group()

Signature

group() — returns struct

Available in: mapper Category: Routing

Description

Group routes together with shared attributes like path prefix, name prefix, and constraints without implying a controller package or namespace. Unlike namespace() (which maps to a subfolder and URL prefix) or package() (which maps to a subfolder), group() is a pure organizational grouping mechanism.

Parameters

Name	Type	Required	Default	Description
name	string	no	—	Name to prepend to child route names for use when building links, forms, and other URLs.
path	string	no	—	URL path prefix to apply to all child routes.
constraints	struct	no	—	Variable patterns (regex constraints) to apply to all child routes.
callback	any	no	—	A callback function to define nested routes within this group. If provided, the group is automatically closed when the callback completes.

Examples

<cfscript>

// 1. Group routes under a shared path prefix (open/close style)
mapper()
    .group(path="admin")
        // Route URL: /admin/dashboard
        .get(name="dashboard", to="dashboard##index")
        // Route URL: /admin/reports
        .get(name="reports", to="reports##index")
    .end()
.end();

// 2. Group with both a path prefix and a name prefix
mapper()
    .group(path="account", name="account")
        // Route name:  accountSettings
        // Example URL: /account/settings
        .get(name="settings", to="settings##show")

        // Route name:  accountBilling
        // Example URL: /account/billing
        .get(name="billing", to="billing##show")
    .end()
.end();

// 3. Group with regex constraints applied to all child routes
mapper()
    .group(path="products", constraints={id: "\d+"})
        // Only matches numeric :id segments
        .get(name="productShow", pattern="[id]", to="products##show")
        .put(name="productUpdate", pattern="[id]", to="products##update")
    .end()
.end();

// 4. Group using a callback function (auto-closes the group)
mapper()
    .group(
        path    = "reports",
        name    = "report",
        callback = function(mapper) {
            // Route name:  reportSales
            // Example URL: /reports/sales
            mapper.get(name="sales", to="reports##sales");

            // Route name:  reportExpenses
            // Example URL: /reports/expenses
            mapper.get(name="expenses", to="reports##expenses");
        }
    )
.end();

</cfscript>