CReport

CReport class is used to handle reports.

Class	Description	Available from version
Update	Updates an existing report.
Add	Adds new report.
GetList	Retrieves list of reports.
Delete	Deleted existing report.
setViewParams	Saves view parameters for the report of the current user.
getViewParams	Allows to retrieve view parameters for the report of the current user.
generateChains	Generates object tree with full set of all fields, necessary to create data selection query for each available report field.
generateColumnTree	Generates tree with description of fields, available in the report with entity fields bindings.
clearViewParams	Clears all saved view parameters of report with the `id` for the current user.
attachLangToColumnTree	Uploads language phrases for report fields, using entity descriptions and report's helper class.
fillFilterReferenceColumns	Verifies the correct value of filters that refer to entities with the use of fillFilterReferenceColumn helper class method.
GetCountInt	Allows to retrieve the number of user reports, corresponding with `ownerId`, or all reports for a specific user, if `ownerId` if not specified.
getFullColumnTitle	Supplements report column name with suffixes that correspond to settings of this column.
prepareSelectViewElement	Creates an alias and expression for a field, with account of options, selected for it in the report settings.
isColumnPercentable	Defines whether the percentage is computed for the specified report column.
rewriteUserShortName	Converts fields with composite user names into names returned in the specified format, computed at the database level.
generateValueUrl	Generates links, displayed in the report on the basis of templates, generated by the appendHrefSelectElements method and the specific values data.
appendHrefSelectElements	Adds information, necessary to generate links for values, displayed in a report.
getUniqueFieldsByTree	Generates full list of fields, available in the report from the main and binded entities on the basis of information, returned by the generateColumnTree method.
isValidFilterCompareVariation	Verifies applicability of comparison operation for a report field in the filter.
addFreshDefaultReports	Adds the by default reports.
isColumnTotalCountable	Defines if total value can be calculated for the specified report column.
sqlizeFilter	Converts filter from the internal format of the report module into the presentation, suitable to be used in the setFilter method of the \Bitrix\Main\Entity\Query class with retention of the filter treelike structure.
makeSingleFilter	Converts filter from the internal format of the report module into the presentation, suitable to be used in the setFilter method of the \Bitrix\Main\Entity\Query class with conversion of treelike structure into sequential structure.
collectFullHumanTitles	Generates array of names for all available report fields on the basis of information, returned by the generateColumnTree method.
getFormattedNameExpr	Generates presentation of the field, computed for the rewriteUserShortName method in accordance with user name specified format.