Model Class Statistics Functions any model
Calculates the sum of values for a given property.
Uses the SQL function SUM.
If no records can be found to perform the calculation on you can use the ifNull argument to decide what should be returned.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| property | string | Yes | Name of the property to get the sum for (must be a property of a numeric data type). | |
| where | string | No | Maps to the WHERE clause of the query (or HAVING when necessary). The following operators are supported: =, !=, <>, <, <=, >, >=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, and OR (note that the key words need to be written in upper case). You can also use parentheses to group statements. You do not need to specify the table name(s); CFWheels will do that for you. |
|
| include | string | No | Associations that should be included in the query using INNER or LEFT OUTER joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. department,addresses,emails). You can build more complex include strings by using parentheses when the association is set on an included model, like album(artist(genre)), for example. These complex include strings only work when returnAs is set to query though. |
|
| distinct | boolean | No | false | When true, SUM returns the sum of unique values only. |
| parameterize | any | No | true | Set to true to use cfqueryparam on all columns, or pass in a list of property names to use cfqueryparam on those only. |
| ifNull | any | No | The value returned if no records are found. Common usage is to set this to 0 to make sure a numeric value is always returned instead of a blank string. |
|
| includeSoftDeletes | boolean | No | false | Set to true to include soft-deleted records in the queries that this method runs. |
| group | string | No | Maps to the GROUP BY clause of the query. You do not need to specify the table name(s); CFWheels will do that for you. |
// Get the sum of all salaries
allSalaries = model("employee").sum("salary");
// Get the sum of all salaries for employees in a given country
allAustralianSalaries = model("employee").sum(property="salary", include="country", where="countryname='Australia'");
// Make sure a numeric value is always returned, even if there are no records analyzed by the query
salarySum = model("employee").sum(property="salary", where="salary BETWEEN #params.min# AND #params.max#", ifNull=0);