CRM_Campaign_Form_Search

Set context variable.

Constructor for the basic form page.

We should not use QuickForm directly. This class provides a lot of default convenient functions, rules and buttons

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.

Processing needed for buildForm and later.

The post processing of the form gets done here.

Key things done during post processing are - check for reset or next request. if present, skip post procesing. - now check if user requested running a saved search, if so, then the form values associated with the saved search are used for searching. - if user has done a submit with new values the regular post submissing is done. The processing consists of using a Selector / Controller framework for getting the search results.

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

Build the form object.

Load the default survey for all actions.

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.

Return a descriptive name for the page, used in wizard header

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.

Explicitly declare the form context for addField().

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 search 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.

Builds the list of tasks or actions that a searcher can perform on a result set.

To modify the task list, child classes should alter $this->_taskList, preferably by extending this method.

Set the form values based on input and preliminary processing.

Add any fields described in metadata to the form.

The goal is to describe all fields in metadata and handle from metadata rather than existing ad hoc handling.

Global validation rules for the form.

Get the validation rule to apply to a function.

Alphanumeric is designed to always be safe & for now we just return that but in future we can use tighter rules for types like int, bool etc.

Get the defaults for the entity for any fields described in metadata.

Convert any submitted text fields to use 'like' rather than '=' as the operator.

This excludes any with options.

Note this will only pick up fields declared via metadata.

Add checkboxes for each row plus a master checkbox.

Add the sort-name field to the form.

There is a setting to determine whether email is included in the search & we look this up to determine which text to choose.

Note that for translation purposes the full string works better than using 'prefix' hence we use override-able functions to define the string.

Get the label for the sortName field if email searching is on.

(email searching is a setting under search preferences).

Get the label for the sortName field if email searching is off.

(email searching is a setting under search preferences).

Add generic fields that specify the contact.

Get the label for the group field.

Get the label for the tag field.

We do this in a function so the 'ts' wraps the whole string to allow better translation.

we allow the controller to set force/reset externally, useful when we are being driven by the wizard framework

Get user submitted values.

Get it from controller only if form has been submitted, else preProcess has set this

Get the form values.

Set the metadata for the form.

Handle force=1 in the url.

Search field metadata is normally added in buildForm but we are bypassing that in this flow (I've always found the flow kinda confusing & perhaps that is the problem but this mitigates)