Merge pull request #22533 from eileenmcnaughton/phpcs

More comments & style fixes

Merge pull request #22470 from eileenmcnaughton/isAdmin

Smarty notice fix on Email help

Merge pull request #22536 from eileenmcnaughton/regen

Re-run regen

Merge pull request #22535 from eileenmcnaughton/style

Fixes to spaces from phpcs

Re-run regen

Fixes to spaces from phpcs

Merge pull request #22531 from seamuslee001/example_regenerate

[NFC] Update test example template and regenerate examples

More comments & style fixes

This is mostly generated by code sniffer but I also added the deprecation to the isEnvironment function
as I wound up having to do cleanup on something never called....

Merge pull request #22530 from eileenmcnaughton/category

Remove category from case activity template

[NFC] Update test example template and regenerate examples

Merge pull request #22527 from eileenmcnaughton/phpcs2

Run stricter phpcs on Civi dir

Remove category from case activity template

Merge pull request #22528 from eileenmcnaughton/phpcs3

Run 'full drupal strictness' standard over api/v3/examples

Merge pull request #22444 from eileenmcnaughton/isform

Remove empty check

Merge pull request #22517 from eileenmcnaughton/skip

Move deprecated function back to the only class that calls it

Merge pull request #22526 from eileenmcnaughton/phpcs

Fix php comments

Run 'full drupal strictness' standard over api/v3/examples

I just removed all the rules we weren't enforcing cos too-hard from
our drupal code standard & ran phpcbf over the directory. I figure
we aren't really updating these so getting them to what strict phpcs will
tolerate could save time when we next tighten the noose
and if someone ever regenerates them
they can deal with re-running it or improving the tpl

Merge pull request #22482 from eileenmcnaughton/token

Add unit test on updateGreeting & remove deprecated fn call

Run stricter phpcs on Civi dir

Merge pull request #22520 from colemanw/contactTypeCleanup

[REF] - Use CRM_Contact_BAO_ContactType::basicTypes()

Remove empty check

We had to ensure this was always assigned for default modifier so remove the
empty to make it clear it is 'sorted'

Fix php comments

As per https://github.com/civicrm/civicrm-core/pull/22515

Merge pull request #22524 from braders/contacttype-types

[NFC] Fixes to the type definitions for contactType methods

Merge pull request #22525 from braders/remove-charts-colours

[Ref] Remove unused _colours property

Merge pull request #22522 from braders/phpdoc-fixes-2

Another set of PHPDoc fixes

Merge pull request #22521 from braders/phpdoc-links

Fix more phpdoc comments in member links functions

REF - Use CRM_Contact_BAO_ContactType::basicTypes() instead of hardcoded lists

Merge pull request #22518 from colemanw/cleanupBadCode

Remove unreachable, nonsensical code

Merge pull request #22515 from eileenmcnaughton/phpcs

Fix php comments

Merge pull request #22442 from demeritcowboy/tests-22429

Unit tests for 22429 and apply same treatment to other money format functions

[Ref] Remove unused _colours property

[NFC] Fixes to the type definitions for contactType methods

Another set of PHPDoc fixes

Fix more phpdoc comments in member links functions

Fix php comments

This commit contains 14 files worth of changes from the following steps

1) install https://github.com/civicrm/coder.git
2) comment out <rule ref=Drupal.Commenting.FunctionComment.IncorrectParamVarName><severity>0</severity></rule>
3) run phpcbf --standard=Drupal

This follows on from efforts from @braders - there are not many
instances (although I kept the comment small) and we could fairly easily get rid of them
all and enable that rule in CI - which would lift the bar a little

Merge pull request #22497 from eileenmcnaughton/mem_ids

Test cleanup - remove direct calls to BAO_Membership::add

Move deprecated function back to the only class that calls it

This function is only called from the importer (in core) - copy back there & noisily
deprecate (one known extension usage).

Note that I removed 2 parts of it in the copy back that are unreachable
as only specific params are passed in we know they don't include
case & always include skipRecent

https://github.com/civicrm/civicrm-core/blob/5484728757de4c85d44305a92bfa2aa35351fbce/CRM/Contact/Import/Parser/Contact.php#L880-L887

Merge pull request #22516 from eileenmcnaughton/legacy2

Merge function back into parent function

Remove unused frozen form blocks

These blocks appear to be unused because these forms are never displayed in frozen "view" mode.
If they were in use they would be broken because the urls are incorrectly output raw
instead of being properly passed to `CRM_Utils_System::url()`.

Remove unreachable, nonsensical code

This block of code appears to be unreachable, because the contribution page
wizard is never frozen in "view" mode.
If it were reachable, it would do nothing sensible, as the button would link
to a completely unrelated page (configure custom data) and the link would be
broken because it is incorrectly bypassing `CRM_Utils_System::url()`.

Merge function back into parent function

It isn't a logical separation of responsibility & doesn't reduce code

Merge pull request #22514 from braders/feature/report-statistics-docblock

Add type to phpdoc comment for report statistic function

Merge pull request #22513 from braders/phpdoc-self

Update phpdoc references to $self to include type

Add type to phpdoc comment for report statistic function

Update phpdoc references to $self to include type

Merge pull request #22512 from colemanw/weightTest

[test] - Add test coverage for adjusting custom group weights

[test] - Add test coverage for adjusting custom group weights

Merge pull request #22471 from eileenmcnaughton/noticesm

Enotice fixes

Merge pull request #22505 from colemanw/fixSelect2Collapsible

Select2 - Fix auto-expanding collapsible optgroups for multi-selects

Merge pull request #22511 from totten/master-ref-getEntityRefMetadata

(REF) CRM_Core_Resources - Limit visibility of `getEntityRefMetadata`

tests for 22429 and apply same treatment to other functions

Merge pull request #22509 from braders/phpdoc-fixes

Various phpdoc fixes

Merge pull request #22510 from eileenmcnaughton/legacy2

(REF) ContactUtils - Rename local variables

(REF) CRM_Core_Resources - Limit visibility of `getEntityRefMetadata`

Before
------

* `CRM_Core_Resources::getEntityRefMetadata()` is nominally `public`.
* The only callers are within `CRM_Core_Resources` and `CRM_Core_ResourcesTest`.
* It seems likely that the method was `public` to support that unit-test.
* This seems like a weird place for the method to live.

After
------

* `CRM_Core_Resources::getEntityRefMetadata()` no longer `public`.
* The method is still in a weird place, but at least no one will expect it to remain there.

Merge pull request #22506 from colemanw/cleanupRes

[REF] CoreResources - Simplify disabled component check

Various phpdoc fixes

Rename variable

[REF] CoreResources - Simplify disabled component check

Now that component DAOs have a COMPONENT defined, checks like this are much easier.

Select2 - Fix auto-expanding collapsible optgroups for multi-selects

Fixes dev/core#3032

Merge pull request #22495 from eileenmcnaughton/fin2

Move permission checks from Query & BAO to financialacl extension

Merge pull request #22491 from eileenmcnaughton/legacy2

Rationalise relationship validation

Merge pull request #22503 from totten/master-pipe-nfc

(NFC) Civi::pipe - Swap various quotes

Merge pull request #22501 from mattwire/alterdisplayname

NFC: Clean up description for alterDisplayName hook

(NFC) Civi::pipe - Swap various quotes

These are just some double-quoted PHP strings that need double-quotes.

Merge pull request #22262 from totten/master-pipe

Civi::pipe - Add support for background worker-processes with JSON pipes

Merge pull request #22502 from eileenmcnaughton/add_test

Port test form earlier PR

Merge pull request #22343 from totten/master-gencode-mailqueue

MailingEventQueue - Use consistent CamelCaseName. Prevent conflicts.

Port test form earlier PR

The test from this PR is now passing

https://github.com/civicrm/civicrm-core/pull/20095

So, I've rescued the test & cleaned up the class - assume
an interim fix addressed the bug

Civi::pipe - Comply with newer `authx_login()` contract. Declare flow names.

1. The original Civi::pipe() patch was built on a draft version of `authx_login()`. The
   signature changed during review.
2. The original Civi::pipe() patch hacked the `flow` name - ie it used the
   flow name `xheader` even though it wasn't HTTP-based. Now, it
   uses either the existing `script` flow (for trusted/backend/principal-asserted runtimes)
   or the new `pipe` flow (for untrusted/credential-based runtimes).

Clean up description for alterDisplayName hook

Merge pull request #22355 from colemanw/searchKitAddJoins

SearchKit - Enable joins for custom fields and option groups

Civi::pipe - Flip default for $apiError from `array` to `exception`

My initial use-case will likely benefit from `array`; however, for bespoke
code that works with a pipe, the `exception` is probably easier.

(REF) Civi::pipe() - Add authentication tests to AllFlowsTest

(REF) Civi::pipe - Extract `BasicPipeClient` from `CliRunnerTest`.

Make it is easier to use in other tests.

(REF) Civi::pipe - Add test coverage for interaction of (un)trusted & checkPermissions

(REF) Civi::pipe - Tighten up docblocks and type-hints

Civi::pipe - Convet from service-registry to negotation-flags

How will the protocol evolve? This changes the planned mechanism that will allow evoluation.

_Previous/Original_: Protocol had a version number.

_Previous/Interm_: Any change to the protocol requires registering a new service.  New
connections must strictly choose between one service XOR another service.

_Now_: Any change to the protocol requires defining a flag.  There is a list
of default flags, but callers may request alternative flags.  The header
line indicates success or failure of these flags.

Comment: Handy characteristics of this design:

* Default info is generally more useful and skimmable.
* Addresses the current trusted/untrusted flag.
* Expands the default info to include (1) CiviCRM version and (2) whether logins are allowed.
* Allows augmenting or replacing jsonrpc-2.0 (if we don't like it).
* The `Civi::pipe()` shell statements remain pithy - even if they require extra flags.

(NFC) JsonRpc

Civi::pipe - Introduce `$trusted` flag and `$apiCheckPermissions` option

* `bool $trusted` is an immutable property of the session that determines whether you
  can request special operations like:
    * Bypassing API permissions
    * Setting the active user without credentials

* `bool $apiCheckPermissions` is a convenience option for `api3` and `api4`.
  This toggles the default value of `checkPermissions` / `check_permissions`
  on API calls.  (It is only applicable to trusted sessions.)

Civi::pipe - Comply more strictly with JSON-RPC v2.0. Don't allow scalar `params`.

(REF) Civi::pipe - Rename JsonRpcSession to PipeSession

Not supporting multiple session types

Civi::pipe - Extract class JsonRpc

Civi::pipe - Remove BasicJsonSession

Civi::pipe - Rename maxLines to bufferSize

Civi::pipe - Define option `apiError`

This option balances two interests:

- For generic plumbing code, it's easier to keep the API errors in their canonical format.
- For bespoke JSON-RPC client code, it's easier to bind errors into JSON-RPC errors. This way
  downstream clients can adapt the errors to their own convention (PHP exceptions, JS exceptions,
  promise-failures, ad nauseum)

Civi::pipe - Add top-level facade. Add E2E test.

Civi::pipe - JSON-RPC 2.0 session

Civi::pipe - Basic JSON session

Civi::pipe - Add some initial utilities

MailingEventQueue - Use consistent short/camel-name.

Unchanged
---------

* XML: `xml/schema/Mailing/Event/Queue.xml`
* DAO: `CRM/Mailing/Event/DAO/Queue.php`
* BAO: `CRM/Mailing/Event/BAO/Queue.php`
* APIv3: `api/v3/MailingEventQueue.php`

Changes: Before
---------------

* TLDR: Inconsistent mix of `MailingEventQueue` and `Queue`
* `AllCoreTables` lists the short/CamelCaseName as `Queue`, which
  does not match the APIv3 name (`api/v3/MailingEventQueue.php`).
* When formatting results for `MailingEventQueue.create`, it
  uses `_civicrm_api3_basic_create(...'Queue')`. Again, that
  name does not match `api/v3/MailingEventQueue.php`.
  (Substantively, this means that it may call `Queue.getfields`
  to read extra metadata. But this returns an empty list...)

Changes: After
---------------

* TLDR: Consistent use of `MailingEventQueue`
* `AllCoreTables` lists the short/CamleCaseName as `MailingEventQueue`
  which does match the `api/v3/MailingEventQueue.php`
* When formatting results for `MailingEventQueue.create`, it
  uses `_civicrm_api3_basic_create(...'MailingEventQueue')`.
  This matches. (Substantively, this means that it may call `MailingEventQueue.getfields`
  to read extra metadata. As before, this returns an empty list...)

Comments
--------

In reconciling the conflicted names, I looked at both APIv3 and APIv4.
APIv4 does not expose an entity for this; so the Before+After ocuses on APIv3.

GenCode - Allow overriding the short entity name

Before
------

The short entity-name must always be an exact match to the _last_ part of the class-name.

Ex: The class `CRM_Mailing_Event_BAO_Queue` has short entity-name of `Queue`.
This will cause a conflict if any other subsystem has a class ending in `Queue`
(eg `CRM_Contribute_BAO_Queue` or `CRM_Queue_Queue`).

After
-----

By default, the short entity-name matches the last part of the class-name.

But this can be overridden in `xml/schema/*`, eg

```xml
<table>
  <base>CRM/Mailing/Event</base>
  <class>Queue</class>
  <entity>MailingEventQueue</entity>
```

Comments
---------

To see that this change is generally safe (ie does not impact existing entity), I force-regenereated all DAOs

```
GENCODE_FORCE=1 ./bin/setup.sh -g
```

This produced no substantive change in existing DAOs -- because they do not have the `<entity>` tag.

Move permission checks from Query & BAO to financialacl extension

Clean up buildPermissionedWhereClause

Rationalise relationship validation

The previous relationship validation was
1) throw a message is no valid employer relationship - this seems to be done
in a place that would make the site unusable I've centralised this check into a
cached function that gets the id & throws the exception & is used from
places previously fetching it (there is one that
didn't throw an exception previously but I think enough places did
that extending to that place would not break the site any more if it didn't exist

2) complicated look up to determine if the contact types match the relationship's
expectations. Since we already know the relationship's expectations we
can simplify this to just check contact a is an individual and b is an org which is
much more reasonable. It doesn;t seem like this would ever actually be false so
I added a deprecation to be a bit vocal if it is

Function to get employer relationship type id

Merge pull request #22496 from civicrm/5.46

5.46

Merge pull request #22443 from eileenmcnaughton/download

Remove support for deprecated key

Merge pull request #22485 from eileenmcnaughton/ab

Fully remove contactAB function

Merge pull request #22498 from eileenmcnaughton/mem_act

Don't default membership type create to inactive

Merge pull request #22464 from colemanw/extRequirementCheck

Extensions - Add dependency status check