GenCode, Cache::cleanKey() - Fix deploop during clean initialization

[totten]

Overview

Suppose you have a clean codebase with no DAO files, and you try to run xml/GenCode.php.
This currently crashes.

The problem is not symptomatic day-to-day because we commit DAOs, so it's
very rare to run a full/clean initialization. However, it does get in the
way of stress-testing the correctness of GenCode.

These are the steps I've used to try GenCode with a (relatively) clean slate:

rm CRM/*/DAO/*.php -f
git checkout -- CRM/Contact/DAO/Factory.php CRM/Core/DAO/AllCoreTables.php CRM/Core/DAO/Factory.php CRM/Core/DAO/permissions.php
./bin/setup.sh -g

Before

Running setup.sh above crashes:

[bknix-min:~/bknix/build/dmaster/sites/all/modules/civicrm] ./bin/setup.sh -g
+ '[' -n '' ']'
+ '[' -n 1 -a -d /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/./bin/../xml ']'
+ pushd /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/./bin/../xml
~/bknix/build/dmaster/sites/all/modules/civicrm/xml ~/bknix/build/dmaster/sites/all/modules/civicrm
+ '[' -z 3307 ']'
+ PHP_MYSQL_HOSTPORT=127.0.0.1:3307
+ php -d mysql.default_host=127.0.0.1:3307 -d mysql.default_user=dmasterciv_mqc44 -d mysql.default_password=NOTREALLYTHIS GenCode.php schema/Schema.xml '' Drupal

civicrm_domain.version := 5.17.alpha1

Parsing schema description schema/Schema.xml
Extracting database information
Extracting table information
PHP Fatal error:  Class 'CRM_Core_DAO_Cache' not found in /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Core/BAO/Cache.php on line 41
PHP Stack trace:
PHP   1. {main}() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/xml/GenCode.php:0
PHP   2. CRM_Core_CodeGen_Main->main() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/xml/GenCode.php:55
PHP   3. CRM_Core_CodeGen_Main->getTasks() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Core/CodeGen/Main.php:109
PHP   4. CRM_Core_CodeGen_Schema->__construct() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Core/CodeGen/Main.php:127
PHP   5. CRM_Core_CodeGen_Schema->findLocales() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Core/CodeGen/Schema.php:15
PHP   6. CRM_Core_Config::singleton() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Core/CodeGen/Schema.php:113
PHP   7. Civi\Core\Container::boot() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Core/Config.php:113
PHP   8. CRM_Utils_Cache::create() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/Civi/Core/Container.php:503
PHP   9. spl_autoload_call() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Utils/Cache.php:186
PHP  10. CRM_Core_ClassLoader->loadClass() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Utils/Cache.php:186
PHP  11. require_once() /Users/totten/bknix/build/dmaster/sites/all/modules/civicrm/CRM/Core/ClassLoader.php:221

Since 76e697a, CRM_Utils_Cache::create() calls CRM_Core_BAO_Cache::cleanKey(). However, the class CRM_Core_BAO_Cache cannot be loaded because its parent (CRM_Core_DAO_Cache) does not yet exist.

After

• The utility function CRM_Core_BAO_Cache::cleanKey() is migrated to CRM_Utils_Cache::cleanKey().
• Thus, CRM_Utils_Cache::create() no longer loads CRM_Core_BAO_Cache or CRM_Core_DAO_Cache. Thus, it works.

[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).

[eileenmcnaughton]

I confirmed this really is just moving a function (by doing it myself). I prefer that we deprecate functions more noisily so in 6-12 months we can remove them but that is non-blocking

Rationale makes sense & there is lots of cover on this