civimix-schema: Define backportable DAO class

[totten]

Overview

(This is corollary/dependency for totten/civix#331.)

Define a variation on CRM_Core_DAO_Base which is suitable for backports.

Technical Details

CiviMix\Schema\*\DAO is basically identical to CRM_Core_DAO_Base, with the following adjustments:

1. It uses an anonymous/dynamic class-name that makes it amenable to multi-version.

2. Instead of calling EntityRepository, it directly reads the '*.entityType.php' file.

3. The helper methods getDefaultSize() and getCrmTypeFromSqlType() are duplicated within the class.

4. The helper method getDAONameForEntity() is wrapped to deal with flipfloppery in core's function naming.

5. It replaces a couple php74-isms

Comments

I've tested this for an extension-entity in v5.45 / php73 with api3 and api4. I also used it to store hieroglyphics, but I had trouble finding a suitable font to test on an Ubuntu workstation. Fortunately, MacOS has better support for ancient Egyptian scripts. As long your workstation has compatible font, this DAO-base class will allow you to read+write hieroglyphics.

[civibot]

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...

• If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
• A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
• A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
• If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
• Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
• A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
• To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
• For more information about contributing, see CONTRIBUTING.md.

Quick links for reviewers...

• ➡️ PR Demo site (can be rebuilt with the command test this please).
• 📖 Review standards
• 🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

[seamuslee001]

@totten I thought there was going to be a class alias somewhere as well?

[totten]

@seamuslee001 yeah, here's the distinction:

• CiviMix\Schema\*\DAO is the portable/dynamic/wildcard/reloadable polyfill. It's distributed as part of [email protected].
• CRM_MyExtension_DAO_Base is a logical/per-extension convention.
  • Defining CRM_MyExtension_DAO_Base is up to the extension.
  • The civix template defines CRM_MyExtension_DAO_Base as an alias for either CRM_Core_DAO_Base or CiviMix\Schema\*\DAO. The commit to do is part of #331 -- currently, it's totten/civix@50297da. (The commit has longer explanatory message.)

[colemanw]

Makes sense 👍🏻