(dev/core#873) civi.api.prepare - Allow dynamic wrappers

Overview
--------

Allow extensions to dynamically wrap an API. There are some existing mechanisms which sort-of allow wrapping, but
this enables additional use-cases.

Before
------

There are a few techniques for wrapping or overriding an API, but none is suitable to my current use-case. Limitations:

* `hook_civicrm_apiWrappers` - This allows registering things before and after the API call, but it does not allow
   changing the underlying API call.
* `civi.api.{authorize,prepare,respond}` events - Same as above. These are a bit more nuanced/fine-grained, but still does not allow changing
* `civi.api.resolve` event with `AdhocProvider` - This allows you to swap an API completely, but it doesn't allow you
  to delegate back to the original API call (if you've got nothing to add).

After
------

One may subscribe to `civi.api.prepare` and then call the `wrapApi()` helper:

```php
function onPrepare($event) {
  if ($event->getApiRequestSig() === '3.widget.frobnicate') {
    $event->wrapApi(function($apiRequest, $continue){
      echo "Hello\n";
      $r = $continue($apiRequest);
      echo "Goodbye\n";
      return $r;
    });
  }
}
```

Key characteristics:

* The wrapper only applies if you register it specifically for the given API call.
* The wrapper allows you to defer to the original implementation (`$continue`).
* The wrapper allows you to perform logic before and after.
* The wrapper allows you to *conditionally* replace -- you might call `$continue` or something entirely different.

The style here is more event-oriented, but you can see the same concept in OOP systems, such as PHP's function-override notation.
This would be analogous:

```php
class MyChild extends MyParent {
  function frobnicate($arg1) {
    echo "Hello\n";
    $r = parent::frobnicate($arg1);
    echo "Goodbye\n";
    return $r;
  }
}
```

Merge pull request #14044 from totten/master-test-trait-2

(REF; dev/core#873) CiviUnitTestCase - Extract traits to facilitate extension testing

ContactTestTrait::createLoggedInUser() - Fix domain_id error when running from extension

Move helpers from CiviUnitTestCase to MailingTestTrait

* `createMailing(...)`
* `deleteMailing(...)`

Move helpers from CiviUnitTestCase to DbTestTrait

* `assertDBState(...)`
* `assertDBNotNull(...)`
* `assertDBNull(...)`
* `assertDBRowNotExist(...)`
* `assertDBRowExist(...)`
* `assertDBCompareValue(...)`
* `assertDBCompareValues(...)`
* `assertDBQuery(...)`

Move helpers from CiviUnitTestCase to GenericAssertionsTrait

* `assertType(...)`
* `assertTreeEquals(...)`
* `assertApproxEquals(...)`
* `assertAttributesEquals(...)`
* `assertArrayKeyExists(...)`
* `assertArrayValueNotNull(...)`
* `assertArrayValuesEqual(...)`

Move helpers from CiviUnitTestCase to ContactTestTrait

* `createLoggedInUser(...)`
* `organizationCreate(...)`
* `individualCreate(...)`
* `householdCreate(...)`
* `sampleContact(...)`
* `_contactCreate(...)`
* `contactDelete(...)`
* `groupContactCreate(...)`
* `groupCreate(...)`
* `groupDelete(...)`

Merge pull request #14041 from colemanw/fieldTitles

Add pseudoconstant to UFField dao

Merge pull request #14028 from yashodha/dev-865

(dev/core#865) Result filter criteria doesn't show IS NULL/IS NOT NUL…

Merge pull request #14039 from eileenmcnaughton/cont_recur

Remove deprecated function

Add pseudoconstant to UFField dao

add missing assignment

Merge pull request #14037 from colemanw/dev/core#562

dev/core#562 - Remove dao->free from api

Remove deprecated function

This was deprecated in May 2018 as not called from within core  - this removes

dev/core#562 - Remove dao->free from api

Merge pull request #14035 from civicrm/5.13

5.13 to master

Merge pull request #14034 from eileenmcnaughton/5.13

dev/core#859 - Dedupe fails on address field in 5.12

Merge pull request #14031 from seamuslee001/phpcs_disable_mcrypt

Disable phpcs checking in the Crypt files where mcrypt functions are

Merge pull request #14032 from seamuslee001/ingore_eval

(NFC) Ensure phpcs ignores eval notice in these files as it is required

add test

fix array and notice

(NFC) Ensure phpcs ignores eval notice in these files as it is required

Disable phpcs checking in the Crypt files where mcrypt functions are

(dev/core#865) Result filter criteria doesn't show IS NULL/IS NOT NULL for operations

Merge pull request #14027 from civicrm/5.13

5.13

Merge pull request #14025 from seamuslee001/coder_lint_alt_php

(NFC) Lint additional php files up to the new coder standard

(NFC) Lint additional php files up to the new coder standard

Merge pull request #14026 from seamuslee001/5.13

Port Code Style Fixes to 5.13 from master

(NFC) Minor code style fixes

(NFC) Update CRM/Contact to match new coder style

Merge pull request #14024 from civicrm/5.13

5.13

Merge pull request #14023 from seamuslee001/core_dedupe_custom

(NFC) Update CRM/Core CRM/Custom CRM/Dedupe to match the new coder style

Merge pull request #14022 from seamuslee001/contact_new_coder

(NFC) Update CRM/Contact to match new coder style

Merge pull request #14019 from seamuslee001/event_new_style

(NFC) Update CRM/Event folder for the new coder style

Merge pull request #14021 from seamuslee001/contribute_new_coder

(NFC) update CRM/Contribute to be the new coder standard

(NFC) Update CRM/Core CRM/Custom CRM/Dedupe to match the new coder style

(NFC) Update CRM/Contact to match new coder style

Merge pull request #14016 from seamuslee001/mailing_group_grant_friend_new_style

(NFC) Update CRM/Friend CRM/Grant CRM/Group CRM/Mailing to be up to d…

Merge pull request #14017 from seamuslee001/batch_campaign_case_new_style

(NFC) Update CRM/Badge CRM/Campaign CRM/Case to be up to date with a …

Merge pull request #14018 from seamuslee001/financial_extension_export_cxn_dashlet

(NFC) Update CRM/Cxn CRM/Dashlet CRM/Export CRM/Extension and CRM/Fin…

(NFC) update CRM/Contribute to be the new coder standard

(NFC) Update CRM/Friend CRM/Grant CRM/Group CRM/Mailing to be up to date to a future coder version

(NFC) Update CRM/Cxn CRM/Dashlet CRM/Export CRM/Extension and CRM/Financial files to new coder style

(NFC) Update CRM/Event folder for the new coder style

(NFC) Update CRM/Badge CRM/Campaign CRM/Case to be up to date with a newer coder

Merge pull request #14015 from seamuslee001/nfc_code_style_fixes

(NFC) Minor code style fixes

(NFC) Minor code style fixes

Set version to 5.14.alpha1

Set version to 5.13.beta1

Merge pull request #13551 from eileenmcnaughton/ext_up

Load hooks during upgrade mode

Added myself

Load hooks during upgrade mode

For unknown, svn, reasons extension hooks are not loaded during upgrade
(this doesn't apply to drupal modules) - this causes some fairly serious problems
1) settings are re-loaded & cached with settings from extensions being lost
2) trigger alter hooks are lost this means
 - the summary fields triggers are frequently lost on upgrade
 - hooks that unset various tables to prevent them from being logged can fail, resulting in those log tables being created
 - hooks that specify the table should be innodb can fail to run, resulting in archive format.

I can't think WHY we do this? Presumably there was some problem that would have been better solved another
way but which was solved this way?

Fix "Load hooks during upgrade mode" (45312e1e64dd6af0281fe5fb7f96dbd8be39e524)

In my testing, the commit doesn't do what it says because the symbols are wrong.

Merge pull request #14005 from colemanw/shortSettings

[NFC] Short array syntax - auto convert settings dir

Merge pull request #13995 from eileenmcnaughton/loc_title

dev/financial#2 Update new payment_processor.title field to be localisable

Merge pull request #14007 from colemanw/colorTest

Improve test coverage for CRM_Utils_Color::getRgb()

Merge pull request #14009 from eileenmcnaughton/recur_flush

Improve flushing after creating a processor so it can be used for a recurring in the same run

Merge pull request #14008 from totten/master-hook

(REF) CRM_Core_Resources - Move hook declaration from addCoreResources() to Container.php

Merge pull request #14006 from eileenmcnaughton/payment_pay

Include lower level data when throwing an exception on payment processor.pay

Merge pull request #14002 from colemanw/menuConfig

Menu config screen improvements

Improve flushing after creating a processor so it can be used for a recurring in the same run

Mostly affects tests....

Merge pull request #14000 from eileenmcnaughton/recur_fn

Add unit testing for activity creation when cancelling a recurring, related cleanup

Short array syntax - auto convert settings dir

Update new payment_processor.title field to be localisable

Re-order upgrade to fix upgrade process and ensure there is the runSql step

colorTest

(REF) CRM_Core_Resources - Move hook declaration from addCoreResources() to Container.php

tldr: It's easier to declare `hook_civicrm_buildAsset` listeners at a high-level.

Asset building can use two modes -- production mode writes a static file to
disk when it's being reference.  Debug mode just generates a URL for a
web-service (which in turn dynamically renders the content in a separate
page-view).

If the only mode were production mode, then the code would be on pretty
solid ground.  We could even simplify things a lot by changing the
AssetBuilder contract to replace the hooks with callbacks, as in:

```php
Civi::service('asset_builder')->getUrl('crm-menu.css', function() {
  return '...the css code...';
});
```

Why have a hook?  Because hooks are generally context-free and
always-available.  If we use debug-mode (or if we add a feature to warm-up
the caches during deployment), then we'll want to fire that hook from a
different context (e.g.  web-service or CLI), and the hook-listener needs to
be available in those other contexts.

It would be nice if we could declare hooks generally without needing to edit
the `Container.php` mega-file (e.g.  maybe some kind of annotation).  But,
for the moment, I think this is the best spot that we have in `civicrm-core`
for ensuring that hook listeners are fully/consistently registered.

Merge pull request #13996 from colemanw/menuColor

Configurable menubar color

Include lower level data when throwing an exception on payment processor.pay

Pass menubar preference as a param. Simplify cache mechanics. (#8)

Ex: If an admin uses an API call (CLI/REST) to change the menubar color,
then they don't need to follow-up with a cache-clear.  The new setting just
goes live.

Ex: If a customization (via `civicrm.settings.php` or via extension) decides
on the color scheme programmatically (e.g.  per-domain or per-role or
per-user-preference), then they don't need to clear cache.  Multiple color
schemes can coexist.

Merge pull request #14003 from seamuslee001/sl_fix_4_7_31_upgrade

Fix 4.7.31 Upgrade in multilingual mode

Add unit testing for activity creation when cancelling a recurring, related cleanup

Fix 4.7.31 Upgrade in multilingual mode

Configurable menubar color

Navigation admin - live refresh and links to related settings

Navigation admin - fix icon picker & use select2

Merge pull request #13998 from demeritcowboy/fix-formRule

PHP warnings on Case Dashboard and Find Cases

Use asset-builder to render menubar css

Merge pull request #13999 from eileenmcnaughton/recur_fn

Add unit test for api ContributionRecur.cancel, add support for cancel_reason

Add unit test for api ContributionRecur.cancel, add support for cancel_reason

fix formRule signature

Merge pull request #13992 from seamuslee001/member_node_import_logging_price

(NFC) Update CRM/Member CRM/Note CRM/Logging CRM/Import and CRM/Price…

Merge pull request #13991 from eileenmcnaughton/noisy_guzzle

dev/core#855 Fix guzzle noisiness

Merge pull request #13990 from seamuslee001/admin_activity_batch_new_coder

(NFC) Update CRM/Activity CRM/Admin and CRM/Batch folders to be the f…

(NFC) Update CRM/Member CRM/Note CRM/Logging CRM/Import and CRM/Price folders to be a future coder standard

Fix guzzle noisiness

There is no reason to echo the failure here

(NFC) Update CRM/Activity CRM/Admin and CRM/Batch folders to be the future coder standard

Merge pull request #13987 from seamuslee001/new_coder_pcp_pledge_profile_queue_report

(NFC) Update coding style in PCP, Pledge, Profile, Queue, Report folders

Merge pull request #13986 from seamuslee001/coder_upgrade_uf_tag_sms

(NFC) Update CRM/SMS/ CRM/UF/ CRM/Upgrade/ CRM/Tag/ to be up to speed…

Merge pull request #13985 from seamuslee001/new_coder_crm_utils

(NFC) Bring CRM/Utils folder up to future coder standards

Merge pull request #13988 from seamuslee001/coder_upgrade_dao_files

(NFC) Set _log and _tableName variables to be public

(NFC) Update coding style in PCP, Pledge, Profile, Queue, Report folders

(NFC) Bring CRM/Utils folder up to future coder standards

Merge pull request #13983 from seamuslee001/new_coder_tests

Update Unit test styling to cover the future coder version

(NFC) tests/ - Cleanup phpcbf oddities

(NFC) Set _log and _table_name variables to be public

(NFC) Update CRM/SMS/ CRM/UF/ CRM/Upgrade/ CRM/Tag/ to be up to speed with the new coder standard

Update Unit test styling to cover the future coder version

Merge pull request #13984 from seamuslee001/nfc_comment_fix_ang

(NFC) Fix location of comment to match future coder version

Fix location of comment to match future coder version

Merge pull request #13980 from seamuslee001/new_coder_style_check_api

(NFC) Bring up API folder to style of future coder checker

Merge pull request #13982 from colemanw/then

Encourage developers to use .then instead of .done