CRM_Contact_Form_Search_Builder
class CRM_Contact_Form_Search_Builder extends CRM_Contact_Form_Search
This class is for search builder processing.
Constants
ATTR_SPACING |
Constants for attributes for various form elements attempt to standardize on the number of variations that we use of the below form elements |
CB_PREFIX |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIY |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIZ |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
CB_PREFIX_LEN |
All checkboxes are defined with a common prefix. This allows us to have the same javascript to check / clear all the checkboxes etc If u have multiple groups of checkboxes, you will need to give them different ids to avoid potential name collision |
Properties
protected object | $_state | The state object that this form belongs to | from CRM_Core_Form |
protected string | $_name | The name of this form | from CRM_Core_Form |
protected string | $_title | The title of this form | from CRM_Core_Form |
array | $_defaults | The default values for the form. | from CRM_Core_Form |
mixed | $_options | (QUASI-PROTECTED) The options passed into this form | from CRM_Core_Form |
int | $_action | (QUASI-PROTECTED) The mode of operation for this form | from CRM_Core_Form |
protected array | $_paymentProcessors | Available payment processors. | from CRM_Core_Form |
array | $_paymentProcessorIDs | Available payment processors (IDS). | from CRM_Core_Form |
protected int | $_paymentProcessorID | Default or selected processor id. | from CRM_Core_Form |
protected int | $_is_pay_later_enabled | Is pay later enabled for the form. | from CRM_Core_Form |
protected object | $_renderer | The renderer used for this form | from CRM_Core_Form |
protected array | $_dateFields | An array to hold a list of datefields on the form so that they can be converted to ISO in a consistent manner | from CRM_Core_Form |
static protected CRM_Core_Smarty | $_template | Cache the smarty template for efficiency reasons | from CRM_Core_Form |
protected | $unsavedChangesWarn | Indicate if this form should warn users of unsaved changes | from CRM_Core_Form |
array | $ajaxResponse | What to return to the client if in ajax mode (snippet=json) | from CRM_Core_Form |
array | $urlPath | Url path used to reach this page | from CRM_Core_Form |
CRM_Core_Controller | $controller | from CRM_Core_Form | |
static array | $html5Types | Extra input types we support via the "add" method | from CRM_Core_Form |
protected int | $_force | Are we forced to run a search | from CRM_Core_Form_Search |
protected string | $_searchButtonName | Name of search button | from CRM_Core_Form_Search |
protected string | $_actionButtonName | Name of action button | from CRM_Core_Form_Search |
array | $_formValues | Form values that we will be using | from CRM_Core_Form_Search |
protected boolean | $_done | Have we already done this search | from CRM_Core_Form_Search |
protected string | $_context | What context are we being invoked from | from CRM_Core_Form_Search |
protected array | $_taskList | The list of tasks or actions that a searcher can perform on a result set. | from CRM_Core_Form_Search |
protected array | $entityReferenceFields | Declare entity reference fields as they will need to be converted to using 'IN'. | from CRM_Contact_Form_Search |
static array | $_validContext | list of valid contexts. | from CRM_Contact_Form_Search |
static array | $_modeValues | List of values used when we want to display other objects. | from CRM_Contact_Form_Search |
protected array | $_contextMenu | The contextMenu. | from CRM_Contact_Form_Search |
int | $_groupID | The groupId retrieved from the GET vars. | from CRM_Contact_Form_Search |
protected int | $_amtgID | The Group ID belonging to Add Member to group ID. | from CRM_Contact_Form_Search |
protected int | $_ssID | The saved search ID retrieved from the GET vars. | from CRM_Contact_Form_Search |
array | $_group | The group elements. | from CRM_Contact_Form_Search |
$_groupElement | from CRM_Contact_Form_Search | ||
array | $_tag | The tag elements. | from CRM_Contact_Form_Search |
$_tagElement | from CRM_Contact_Form_Search | ||
protected array | $_params | The params used for search. | from CRM_Contact_Form_Search |
protected array | $_returnProperties | The return properties used for search. | from CRM_Contact_Form_Search |
protected string | $_sortByCharacter | The sort by character. | from CRM_Contact_Form_Search |
protected integer | $_ufGroupID | The profile group id used for display. | from CRM_Contact_Form_Search |
static array | $csv | Csv - common search values | from CRM_Contact_Form_Search |
protected string | $_componentMode | from CRM_Contact_Form_Search | |
protected string | $_operator | from CRM_Contact_Form_Search | |
protected | $_modeValue | from CRM_Contact_Form_Search | |
static | $_selectorName | Name of the selector to use. | from CRM_Contact_Form_Search |
protected | $_customSearchID | from CRM_Contact_Form_Search | |
protected | $_customSearchClass | from CRM_Contact_Form_Search | |
protected | $_openedPanes | from CRM_Contact_Form_Search | |
int | $_columnCount | Number of columns in where. | |
int | $_blockCount | Number of blocks to be shown. |
Methods
Constructor for the basic form page.
Simple easy to use wrapper around addElement.
Build the form object.
Process the uploaded file.
Build quick form.
This virtual function is used to set the default values of various form elements.
Add local and global form rules.
Return a descriptive name for the page, used in wizard header
This if a front end form function for setting the payment processor.
Format the fields for the payment processor.
Handle Payment Processor switching for contribution and event registration forms.
Default extra tpl file basically just replaces .tpl with .extra.tpl.
Store the variable with the value in the form scope.
Assign value to name in template by reference.
Appends values to template variables.
Returns an array containing template variables.
No description
No description
No description
Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit
No description
Adds a select based on field metadata.
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
Helper function to verify that required fields have been filled.
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?)
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
Add the options appropriate to cid = zero - ie. autocomplete
Set default values on form for given contact (or no contact defaults)
Create a chain-select target field. All settings are optional; the defaults usually work.
Assign billing name to the template.
Builds the list of tasks or actions that a searcher can perform on a result set.
Add checkboxes for each row plus a master checkbox.
Get the label for the sortName field if email searching is on.
Get the label for the sortName field if email searching is off.
Define the set of valid contexts that the search form operates on.
Get return properties.
Normalise form values.
Convert form values.
Get fields.
CRM-9434 Hackish function to fetch fields with options.
CRM-10338 tags and groups use array keys for selection list.
Details
in CRM_Core_Form at line 239
CRM_Core_Form
__construct(object $state = NULL, const|enum|int $action = CRM_Core_Action::NONE, string $method = 'post', string $name = NULL)
Constructor for the basic form page.
We should not use QuickForm directly. This class provides a lot of default convenient functions, rules and buttons
in CRM_Core_Form at line 279
addClass(string $className)
Add one or more css classes to the form.
in CRM_Core_Form at line 287
registerRules()
Register all the standard rules that most forms potentially use.
in CRM_Core_Form at line 340
HTML_QuickForm_Element
add(string $type, string $name, string $label = '', string|array $attributes = '', bool $required = FALSE, array $extra = NULL)
Simple easy to use wrapper around addElement.
Deal with simple validation rules.
at line 56
preProcess()
Build the form object.
at line 335
postProcess()
Process the uploaded file.
in CRM_Core_Form at line 446
mainProcess(bool $allowAjax = TRUE)
Main process wrapper.
Implemented so that we can call all the hook functions.
in CRM_Core_Form at line 473
postProcessHook()
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
at line 92
buildQuickForm()
Build quick form.
in CRM_Core_Form at line 492
array|NULL
setDefaultValues()
This virtual function is used to set the default values of various form elements.
at line 141
addRules()
Add local and global form rules.
in CRM_Core_Form at line 512
bool
validate()
Performs the server side validation.
in CRM_Core_Form at line 540
buildForm()
Core function that builds the form.
We redefine this function here and expect all CRM forms to build their form in the function buildQuickForm.
in CRM_Core_Form at line 599
addButtons(array $params)
Add default Next / Back buttons.
in CRM_Core_Form at line 668
string
getName()
Getter function for Name.
in CRM_Core_Form at line 677
object
getState()
Getter function for State.
in CRM_Core_Form at line 686
int
getStateType()
Getter function for StateType.
in CRM_Contact_Form_Search at line 886
string
getTitle()
Return a descriptive name for the page, used in wizard header
in CRM_Core_Form at line 707
setTitle(string $title)
Setter function for title.
in CRM_Core_Form at line 716
assignBillingType()
Assign billing type id to bltID.
in CRM_Core_Form at line 731
protected
assignPaymentProcessor(bool $is_pay_later_enabled)
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.
in CRM_Core_Form at line 769
protected array
formatParamsForPaymentProcessor(array $fields)
Format the fields for the payment processor.
In order to pass fields to the payment processor in a consistent way we add some renamed parameters.
in CRM_Core_Form at line 807
protected
preProcessPaymentOptions()
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.
in CRM_Core_Form at line 860
protected
handlePreApproval(array $params)
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.
in CRM_Core_Form at line 885
setOptions(mixed $options)
Setter function for options.
in CRM_Core_Form at line 894
string
toSmarty()
Render form and return contents.
in CRM_Core_Form at line 912
object
getRenderer()
Getter function for renderer.
If renderer is not set create one and initialize it.
in CRM_Core_Form at line 924
string
getTemplateFileName()
Use the form name to create the tpl file name.
in CRM_Core_Form at line 947
getHookedTemplateFileName()
A wrapper for getTemplateFileName.
This includes calling the hook to prevent us from having to copy & paste the logic of calling the hook.
in CRM_Core_Form at line 960
string
overrideExtraTemplateFileName()
Default extra tpl file basically just replaces .tpl with .extra.tpl.
i.e. we do not override.
in CRM_Core_Form at line 974
error(string $message, int $code = NULL, CRM_Core_DAO $dao = NULL)
Error reporting mechanism.
in CRM_Core_Form at line 992
set(string $name, mixed $value)
Store the variable with the value in the form scope.
in CRM_Core_Form at line 1004
mixed
get(string $name)
Get the variable from the form scope.
in CRM_Core_Form at line 1013
int
getAction()
Getter for action.
in CRM_Core_Form at line 1023
setAction(int $action)
Setter for action.
in CRM_Core_Form at line 1035
assign(string $var, mixed $value = NULL)
Assign value to name in template.
in CRM_Core_Form at line 1047
assign_by_ref(string $var, mixed $value)
Assign value to name in template by reference.
in CRM_Core_Form at line 1059
append(array|string $tpl_var, mixed $value = NULL, bool $merge = FALSE)
Appends values to template variables.
in CRM_Core_Form at line 1070
array
get_template_vars(string $name = NULL)
Returns an array containing template variables.
in CRM_Core_Form at line 1084
HTML_QuickForm_group
addRadio(string $name, $title, $values, array $attributes = array(), null $separator = NULL, bool $required = FALSE)
in CRM_Core_Form at line 1110
addYesNo(int $id, $title, bool $allowClear = FALSE, null $required = NULL, array $attributes = array())
in CRM_Core_Form at line 1136
addCheckBox(int $id, $title, $values, null $other = NULL, null $attributes = NULL, null $required = NULL, null $javascriptMethod = NULL, string $separator = '<br />', bool $flipValues = FALSE)
in CRM_Core_Form at line 1179
resetValues()
in CRM_Core_Form at line 1195
addDefaultButtons(string $title, string $nextType = 'next', string $backType = 'back', bool|string $submitOnce = FALSE)
Simple shell that derived classes can call to add buttons to the form with a customized title for the main Submit
in CRM_Core_Form at line 1226
addDateRange(string $name, string $from = '_from', string $to = '_to', string $label = 'From:', string $dateFormat = 'searchDate', bool $required = FALSE, bool $displayTime = FALSE)
in CRM_Contact_Form_Search at line 166
getDefaultEntity()
Explicitly declare the entity api name.
in CRM_Core_Form_Search at line 198
getDefaultContext()
Explicitly declare the form context for addField().
in CRM_Core_Form at line 1291
HTML_QuickForm_Element
addSelect($name, array $props = array(), bool $required = FALSE)
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
in CRM_Core_Form at line 1372
HTML_QuickForm_Element
addField($name, array $props = array(), bool $required = FALSE, bool $legacyDate = TRUE)
Adds a field based on metadata.
in CRM_Core_Form at line 1553
addProfileSelector(string $name, string $label, string $allowCoreTypes, string $allowSubTypes, array $entities, bool $default = FALSE, string $usedFor = NULL)
Add a widget for selecting/editing/creating/copying a profile form
in CRM_Core_Form at line 1572
null
getRootTitle()
in CRM_Core_Form at line 1579
string
getCompleteTitle()
in CRM_Core_Form at line 1586
static CRM_Core_Smarty
getTemplate()
in CRM_Core_Form at line 1593
addUploadElement($elementName)
in CRM_Core_Form at line 1623
null
getVar($name)
in CRM_Core_Form at line 1631
setVar($name, $value)
in CRM_Core_Form at line 1650
addDate(string $name, string $label, bool $required = FALSE, array $attributes = NULL)
deprecated
deprecated
Add date.
in CRM_Core_Form at line 1739
addDateTime(string $name, string $label, bool $required = FALSE, null $attributes = NULL)
deprecated
deprecated
Function that will add date and time.
in CRM_Core_Form at line 1765
HTML_QuickForm_Element
addMoney(string $name, string $label, bool $required = FALSE, null $attributes = NULL, bool $addCurrency = TRUE, string $currencyName = 'currency', null $defaultCurrency = NULL, bool $freezeCurrency = FALSE)
Add a currency and money element to the form.
in CRM_Core_Form at line 1795
addCurrency(string $name = 'currency', null $label = NULL, bool $required = TRUE, string $defaultCurrency = NULL, bool $freezeCurrency = FALSE, bool $setDefaultCurrency = TRUE)
Add currency element to the form.
in CRM_Core_Form at line 1845
HTML_QuickForm_Element
addEntityRef(string $name, string $label = '', array $props = array(), bool $required = FALSE)
Create a single or multiple entity ref field.
in CRM_Core_Form at line 1894
convertDateFieldsToMySQL(array $params)
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
in CRM_Core_Form at line 1914
removeFileRequiredRules($elementName)
in CRM_Core_Form at line 1932
cancelAction()
Function that can be defined in Form to override or.
perform specific action on cancel action
in CRM_Core_Form at line 1944
static
validateMandatoryFields(array $fields, array $values, array $errors)
Helper function to verify that required fields have been filled.
Typically called within the scope of a FormRule function
in CRM_Core_Form at line 1963
protected NULL|int
setContactID()
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?)
in CRM_Core_Form at line 2018
int|NULL
getContactID()
Get the contact id that the form is being submitted for.
in CRM_Core_Form at line 2025
getLoggedInUserContactID()
Get the contact id of the logged in user.
in CRM_Core_Form at line 2054
addAutoSelector(array $profiles = array(), array $autoCompleteField = array())
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}
in CRM_Core_Form at line 2079
canUseAjaxContactLookups()
in CRM_Core_Form at line 2097
addCIDZeroOptions($onlinePaymentProcessorEnabled)
Add the options appropriate to cid = zero - ie. autocomplete
in CRM_Core_Form at line 2123
array
getProfileDefaults(mixed $profile_id = 'Billing', int $contactID = NULL)
Set default values on form for given contact (or no contact defaults)
in CRM_Core_Form at line 2142
preventAjaxSubmit()
Sets form attribute.
in CRM_Core_Form at line 2150
allowAjaxSubmit()
Sets form attribute.
in CRM_Core_Form at line 2158
setPageTitle(string $entityLabel)
Sets page title based on entity and action.
in CRM_Core_Form at line 2187
HTML_QuickForm_Element
addChainSelect(string $elementName, array $settings = array())
Create a chain-select target field. All settings are optional; the defaults usually work.
in CRM_Core_Form_Search at line 147
addTaskMenu(array $tasks)
Add actions menu to search results form.
in CRM_Core_Form at line 2337
string
assignBillingName(array $params = array())
Assign billing name to the template.
in CRM_Contact_Form_Search at line 327
array
buildTaskList()
Builds the list of tasks or actions that a searcher can perform on a result set.
in CRM_Core_Form_Search at line 107
buildQuickform()
Common buildForm tasks required by all searches.
in CRM_Core_Form_Search at line 131
addRowSelectors(array $rows)
Add checkboxes for each row plus a master checkbox.
in CRM_Core_Form_Search at line 164
protected
addSortNameField()
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.
in CRM_Core_Form_Search at line 180
protected string
getSortNameLabelWithEmail()
Get the label for the sortName field if email searching is on.
(email searching is a setting under search preferences).
in CRM_Core_Form_Search at line 191
protected string
getSortNameLabelWithOutEmail()
Get the label for the sortName field if email searching is off.
(email searching is a setting under search preferences).
in CRM_Contact_Form_Search at line 176
static array
validContext()
Define the set of valid contexts that the search form operates on.
in CRM_Contact_Form_Search at line 196
static bool
isSearchContext($context)
in CRM_Contact_Form_Search at line 201
static
setModeValues()
in CRM_Contact_Form_Search at line 285
static mixed
getModeValue(int $mode = 1)
in CRM_Contact_Form_Search at line 298
static array
getModeSelect()
in CRM_Contact_Form_Search at line 740
array
getFormValues()
at line 328
NULL
returnProperties()
Get return properties.
at line 155
static array
formRule(array $values, array $files, CRM_Core_Form $self)
Global validation rules for the form.
at line 309
normalizeFormValues()
Normalise form values.
at line 319
array
convertFormValues(array $formValues)
Convert form values.
at line 422
static array
fields()
Get fields.
at line 440
static array
fieldOptions()
CRM-9434 Hackish function to fetch fields with options.
FIXME: When our core fields contain reliable metadata this will be much simpler.
at line 509
static null
checkArrayKeyEmpty(string $val)
CRM-10338 tags and groups use array keys for selection list.
if using IS NULL/NOT NULL, an array with no array key is created convert that to simple NULL so processing can proceed