CRM_Report_Form_Mailing_Bounce

Set context variable.

Class constructor.

Set translated fields.

This function is called from the class constructor, allowing us to set fields on the class that can't be set as properties due to need for translation or other non-input specific handling.

Add one or more css classes to the form.

Register all the standard rules that most forms potentially use.

Simple easy to use wrapper around addElement.

Deal with simple validation rules.

Pre process function.

Called prior to build form.

Post process function.

Main process wrapper.

Implemented so that we can call all the hook functions.

The postProcess hook is typically called by the framework.

However in a few cases, the form exits or redirects early in which case it needs to call this function so other modules can do the needful Calling this function directly should be avoided if possible. In general a better way is to do setUserContext so the framework does the redirect

Main build form function.

Set default values.

This is a virtual function that adds group and global rules to the form.

Keeping it distinct from the form to keep code small and localized in the form building code

Performs the server side validation.

Core function that builds the form.

We redefine this function here and expect all CRM forms to build their form in the function buildQuickForm.

Add default Next / Back buttons.

Getter function for Name.

Getter function for State.

Getter function for StateType.

Getter function for title.

Should be over-ridden by derived class.

Setter function for title.

Assign billing type id to bltID.

This if a front end form function for setting the payment processor.

It would be good to sync it with the back-end function on abstractEditPayment & use one everywhere.

Format the fields in $this->_params for the payment processor.

In order to pass fields to the payment processor in a consistent way we add some renamed parameters.

Format the fields in $params for the payment processor.

In order to pass fields to the payment processor in a consistent way we add some renamed parameters.

Handle Payment Processor switching for contribution and event registration forms.

This function is shared between contribution & event forms & this is their common class.

However, this should be seen as an in-progress refactor, the end goal being to also align the backoffice forms that action payments.

This function overlaps assignPaymentProcessor, in a bad way.

Handle pre approval for processors.

This fits with the flow where a pre-approval is done and then confirmed in the next stage when confirm is hit.

This function is shared between contribution & event forms & this is their common class.

However, this should be seen as an in-progress refactor, the end goal being to also align the backoffice forms that action payments.

Setter function for options.

Render form and return contents.

Getter function for renderer.

If renderer is not set create one and initialize it.

Use the form name to create the tpl file name.

A wrapper for getTemplateFileName.

This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.

Default extra tpl file basically just replaces .tpl with .extra.tpl.

i.e. we do not override.

Error reporting mechanism.

Store the variable with the value in the form scope.

Get the variable from the form scope.

Getter for action.

Setter for action.

Assign value to name in template.

Assign value to name in template by reference.

Appends values to template variables.

Returns an array containing template variables.

Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit

Add a search for a range using date picker fields.

Based on form action, return a string representing the api action.

Used by addField method.

Return string

Classes extending CRM_Core_Form should implement this method.

Classes extending CRM_Core_Form should implement this method.

TODO: Merge with CRM_Core_DAO::buildOptionsContext($context) and add validation.

Adds a select based on field metadata.

TODO: This could be even more generic and widget type (select in this case) could also be read from metadata Perhaps a method like $form->bind($name) which would look up all metadata for named field

Adds a field based on metadata.

Add a widget for selecting/editing/creating/copying a profile form

Add date.

Function that will add date and time.

Add a currency and money element to the form.

Add currency element to the form.

Create a single or multiple entity ref field.

Convert all date fields within the params to mysql date ready for the BAO layer. In this case fields are checked against the $_datefields defined for the form and if time is defined it is incorporated

Function that can be defined in Form to override or.

perform specific action on cancel action

Helper function to verify that required fields have been filled.

Typically called within the scope of a FormRule function

Get contact if for a form object. Prioritise - cid in URL if 0 (on behalf on someoneelse) (@todo consider setting a variable if onbehalf for clarity of downstream 'if's - logged in user id if it matches the one in the cid in the URL - contact id validated from a checksum from a checksum - cid from the url if the caller has ACL permission to view - fallback is logged in user (or ? NULL if no logged in user) (@todo wouldn't 0 be more intuitive?)

Get the contact id that the form is being submitted for.

Get the contact id of the logged in user.

Add autoselector field -if user has permission to view contacts If adding this to a form you also need to add to the tpl e.g

{if !empty($selectable)}

{/if}

Add the options appropriate to cid = zero - ie. autocomplete

Set default values on form for given contact (or no contact defaults)

Sets form attribute.

Sets form attribute.

Sets page title based on entity and action.

Create a chain-select target field. All settings are optional; the defaults usually work.

Add actions menu to results form.

Assign billing name to the template.

Get the currency for the form.

Is the form in view or edit mode.

The 'addField' function relies on the form action being one of a set list of actions. Checking for these allows for an early return.

Shared pre-process function.

If overriding preProcess function this should still be called.

Add bread crumb.

Get element from group.

Setter for $_params.

Getter for $_params.

Setter for $_id.

Setter for $_force.

Setter for $_limitValue.

Setter for $_offsetValue.

Setter for $addPaging.

Getter for $_defaultValues.

Remove any temporary tables.

Create a temporary table.

This function creates a table AND adds the details to the developer tab & $this->>temporary tables.

Add columns to report.

Add filters to report.

Function to assign the tabs to the template in the correct order.

We want the tabs to wind up in this order (if not overridden).

• Field Selection
• Group Bys
• Order Bys
• Other Options
• Filters

The intent is to add a tab for developers to view the sql.

Currently using dpm.

Add options defined in $this->_options to the report.

Add chart options to the report.

Add group by options to the report.

Add data for order by tab.

This adds the tab referred to as Title and Format, rendered through Instance.tpl.

Has this form been submitted already?

Get the actions for this report instance.

A form rule function for custom data.

The rule ensures that fields selected in group_by if any) should only be the ones present in display/select fields criteria; note: works if and only if any custom field selected in group_by.

Get operators to display on form.

Note: $fieldName param allows inheriting class to build operationPairs specific to a field.

Build the tag filter field to display on the filters tab.

Adds group filters to _columns (called from _Construct).

Get SQL operator from form text version.

Generate where clause.

This can be overridden in reports for special treatment of a field

Get SQL where clause for contact subtypes

Get SQL where clause for a date field.

Get values for from and to for date ranges.

Alter display of rows.

Iterate through the rows retrieved via SQL and make changes for display purposes, such as rendering contacts as links.

Alter the way in which custom data fields are displayed.

Remove duplicate rows.

Fix subtotal display.

Calculate grant total.

Format display output.

Generate the SELECT clause and set class variable $_select.

Build select clause for a single field.

Build where clause.

Store Where clauses into an array.

Breaking out this step makes over-riding more flexible as the clauses can be used in constructing a temp table that may not be part of the final where clause or added in other functions

Set output mode.

Post Processing function for Form.

postProcessCommon should be used to set other variables from input as the api accesses that function. This function is not accessed when the api calls the report.

BeginPostProcess function run in both report mode and non-report mode (api).

Build the report query.

Build group by clause.

Build order by clause.

Extract order by fields and store as an array.

In some cases other functions want to know which fields are selected for ordering by Separating this into a separate function allows it to be called separately from constructing the order by clause

Determine unselected columns.

Determine unselected columns.

Build output rows.

Calculate section totals.

When "order by" fields are marked as sections, this assigns to the template an array of total counts for each section. This data is used by the Smarty plugin {sectionTotal}.

Modify column headers.

Move totals columns to the right edge of the table.

It seems like a more logical layout to have any totals columns on the far right regardless of the location of the rest of their table.

Assign rows to the template.

Build report statistics.

Override this method to build your own statistics.

Add count statistics.

Add group by statistics.

Filter statistics.

End post processing.

Set store result set indicator to TRUE.

Get result set.

Get the sql used to generate the report.

Compile the report content.

Although this function is super-short it is useful to keep separate so it can be over-ridden by report classes.

Set limit.

Set pager.

Build a group filter with contempt for large data sets.

This function has been retained as it takes time to migrate the reports over to the new method which will not crash on large datasets.

Build where clause for groups.

Create a table of the contact ids included by the group filter.

This function is called by both the api (tests) and the UI.

Execute query and add it to the developer tab.

Build where clause for tags.

Generate membership organization clause.

Generate Membership Type SQL Clause.

Buld contact acl clause

Build the permision clause for all entities in this report

Add custom data to the columns.

Build custom data from clause.

Check if the field is selected.

Check if the field is used as a filter.

Check for empty order_by configurations and remove them.

Also set template to hide them.

Check if table name has columns in SELECT clause.

Check if table name has columns in WHERE or HAVING clause.

Fetch array of DAO tables having columns included in SELECT or ORDER BY clause.

If the array is unset it will be built.

Add campaign fields.

Add address fields.

Do AlterDisplay processing on Address Fields.

If there are multiple address field values then on basis of provided separator the code values are translated into respective labels

Do AlterDisplay processing on Address Fields.

Adjusts dates passed in to YEAR() for fiscal year.

Add Address into From Table if required.

Add Phone into From Table if required.

Add Address into From Table if required.

Prefix will be added to both tables as it is assumed you are using it to get address of a secondary contact.

Add Country into From Table if required.

Prefix will be added to both tables as it is assumed you are using it to get address of a secondary contact.

Add Phone into From Table if required.

Prefix will be added to both tables as it is assumed you are using it to get address of a secondary contact.

Add Email into From Table if required.

Prefix will be added to both tables as it is assumed you are using it to get address of a secondary contact.

Add Financial Transaction into From Table if required.

Get phone columns to add to array.

Get a standard set of contact fields.

Get a standard set of contact filters.

Add contact to group.

Apply common settings to entityRef fields.

Add link fields to the row.

Function adds the _link & _hover fields to the row.

Get label for show results buttons.

Determine the output mode from the url or input.

Output could be - pdf : Render as pdf - csv : Render as csv - print : Render in print format - save : save the report and display the new report - copy : save the report as a new instance and display that. - group : go to the add to group screen.

Potentially chart variations could also be included but the complexity is that we might print a bar chart as a pdf.

CRM-17793 - Alter DateTime section header to group by date from the datetime field.

Get an array of the columns that have been selected for display.

Add location tables to the query if they are used for filtering.

This is for when we are running the query separately for filtering and retrieving display fields.

Set the base table for the FROM clause.

Sets up the from clause, allowing for the possibility it might be a temp table pre-filtered by groups if a group filter is in use.

Join the temp table contacting contacts who are members of the filtered groups.

If we are using an IN filter we use an inner join, otherwise a left join.

Get all labels for fields that are used in a group concat.

Add statistics columns.

If a group by is in play then add columns for the statistics fields.

This would lead to a new field in the $row such as $fieldName_sum and a new, matching column header field.

Add a basic field to the select clause.

Set table alias.

Function to add columns to reports.

This is ported from extended reports, which also adds join filters to the options.

Get columns for contact table.

Get address columns to add to array.

Build the columns.

The normal report class needs you to remember to do a few things that are often erratic

1) use a unique key for any field that might not be unique (e.g. start date, label) - this class will prepend an alias to the key & set the 'name' if you don't set it yourself. You can suppress the alias with 'no_field_disambiguation' if transitioning existing reports. This means any saved filters / fields on saved report instances. This will mean that matching names from different tables may be ambigious, but it will smooth any code transition. - note that it assumes the value being passed in is the actual table field name

2) set the field & set it to no display if you don't want the field but you might want to use the field in other contexts - the code looks up the fields array for data - so it both defines the field spec & the fields you want to show

3) this function also sets the 'metadata' array - the extended report class now uses this in place of the fields array to reduce the issues caused when metadata is needed but 'fields' are not defined. Code in the core classes can start to move towards that.

Store group bys into array - so we can check elsewhere what is grouped.

Get the select clause for a field, wrapping in GROUP_CONCAT if appropriate.

Full group by mode dictates that a field must either be in the group by function or wrapped in a aggregate function. Here we wrap the field in GROUP_CONCAT if it is not in the group concat.

Generate clause for the selected filter.