Make world_region translate on advanced search field

[eileenmcnaughton]

Overview

Fixes lack of translation for world region on advanced search screen

Before

After

Technical Details

Per digging in #13127 - the getLabel function is being called with localizable = 0 even though

CRM_Core_DAO::buildOptionsContext

clearly specifies that localisation is by context and

    $contexts = array(
      'get' => "get: all options are returned, even if they are disabled; labels are translated.",
      'create' => "create: options are filtered appropriately for the object being created/updated; labels are translated.",
      'search' => "search: searchable options are returned; labels are translated.",
      'validate' => "validate: all options are returned, even if they are disabled; machine names are used in place of labels.",
      'abbreviate' => "abbreviate: enabled options are returned; labels are replaced with abbreviations.",
      'match' => "match: enabled options are returned using machine names as keys; labels are translated.",
    );

The key line is here - the various buildOptions functions call this

In the case of world_region the translation is done by gettext - the reason this issue is less obvious apart from this field is that most fields rely on option value overrides.

The issue came up because digging here #13127 suggest that in some cases we fall back on gettext - seemingly in export we do this when locale-specific options are not defined too

Comments

Note that even after this search builder shows the untranslated fields - that would require ALSO changing for context 'get' which I left our of scope in this round

@mlutfy @mattwire @colemanw @samuelsov ....

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[monishdeb]

@eileenmcnaughton can we directly use:

$params += array(
...
'localize' => (in_array($context, ['search'])),
);

as $localizeDefault isn't used anywhere else.

[eileenmcnaughton]

Yeah - but I kinda wanted to put a bunch of comments with it as this feels a little risky so doing it first gave me a space to do that

[monishdeb]

Hmm I see, no problem. It's a wise choice to get some comment space over reduce-variable-assignment.

[monishdeb]

Nice and this will eventually call

CRM_Core_PseudoConstant::get('CRM_Core_BAO_Country', $fieldName, 'region_id',[], $context);

@eileenmcnaughton can you pass the $props parameter too? i.e.

        return CRM_Core_BAO_Country::buildOptions('region_id', $context, $props);

just in case :)

[eileenmcnaughton]

done

[monishdeb]

Thanks

[monishdeb]

Agree

[monishdeb]

I agree with the patch, however, there are two minor changes needed in the PR, so I am tagging merge-ready.

[monishdeb]

Agree with the final patch. Tagging MoP

[seamuslee001]

Jenkins re test this please

[seamuslee001]

@eileenmcnaughton looks like test failures relate

All have the change of

-    'country' => 'country varchar(64)'
+    'country' => 'country varchar(16)'

[seamuslee001]

Jenkins re test this please

[seamuslee001]

Merging as per the tag