Fix more phpdoc comments in member links functions

Merge pull request #22497 from eileenmcnaughton/mem_ids

Test cleanup - remove direct calls to BAO_Membership::add

Merge pull request #22516 from eileenmcnaughton/legacy2

Merge function back into parent function

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`

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

Test cleanup - remove direct calls to BAO_Membership::add

Don't default membership type create to inactive

We don't do this for any other entity...

Merge pull request #22494 from eileenmcnaughton/fin

Remove handling for impossible array

Merge pull request #22490 from colemanw/refreshButton

SearchKit - Facilitate popup forms

Merge pull request #22403 from colemanw/api4WriteRecords

[REF] Improve APIv4 save functions

Merge pull request #22493 from eileenmcnaughton/546

Cleanup test class

Merge pull request #22467 from colemanw/civigrantSearchKitTab

CiviGrant - Use SearchKit for contact summary tab

Merge pull request #22492 from braders/system-utils-docblock

Improve method phpdoc for CRM_Utils_System

Remove handling for impossible array

CRM_Financial_BAO_FinancialType::buildPermissionedClause is only called from one place
outside of tests. That place passes in this->_whereClause which is the result of calling
this->whereClause() a few lines earlier. As that function always returns a string
we know that it cannot be an array & can remove the handling

Cleanup test class

crmDialog - Add convenience binding to automatically launch a dialog when clicking an element

SearchKit - Auto-refresh search when popup forms submit

This expands the listener to the entire surrounding <form> element,
in case there are related popups on the Afform.

Improve method phpdoc for CRM_Utils_System

CiviGrant - Ensure dependencies are installed before running tests

Merge pull request #22486 from eileenmcnaughton/rel_check

Remove always-true-if

Remove always-true-if

We just ensured organization is numeric so .. it is

Fully remove contactAB function

The function was a really long winded way of doing what the 3 lines do.

Universe search did not reveal other usages and it is not the
sort of function we would expect to be used by extensions so
I'm straight removing it

Merge pull request #22468 from eileenmcnaughton/ab

Stop calling confusing function that doesn't do much .....

Merge pull request #22484 from civicrm/5.46

5.46 to master

Merge pull request #22479 from demeritcowboy/fulltext-quickfix-546

dev/core#3026 - 5.46 version of 22478

quickfix for fulltext search drupal block

Merge pull request #22469 from eileenmcnaughton/help

Remove seemingly unreachable help text

Merge pull request #22472 from eileenmcnaughton/import

Move function to the class that 'owns' it

Merge pull request #22451 from MegaphoneJon/member-count-fix

Crash when adding a relationship when CiviMember is disabled

Merge pull request #22474 from braders/incoming-mail-broken-fn-reference

Fix broken function reference

fix accessing member/contribution count when not enabled

Move function to the class that 'owns' it

Following https://github.com/civicrm/civicrm-core/commit/f54e87d9cf1e216036adf92f744cdbac3c1fe79e#diff-5864d6a1d03dffb7699b930837c1c222b41fba16dad7d0a5f73b4923ac53dd42R198
neither of these functions are called from outside their class (I did a universe search)
so making them private (& in one case moving off the parent) means a universe seach won't be needed
next time

Merge pull request #22473 from eileenmcnaughton/script

Remove broken script

Fix broken function reference

Merge pull request #22459 from mlutfy/core983acl

dev/core#983 Fix Access CiviCampaign permissions (instead of admin)

Remove broken script

Enotice fixes

I grepped for 'editor' being assigned & didn't find it. I think changed the editor to 'TextArea'
and didn't see the text inside the if so I concluded it is broken. Removing rather than
fixing cos no-one noticed it was broken so can't have been important (and probably the
wrong place for it)

Remove seemingly unreachable help text

This text is e-notice causing (with default modifiers on). I could not find the tpl file
or the potentially corresponding php file & concluded they were likely long-gone

(If I'm wrong some possibly-outdated help text disappears but I couldnt find it)

Stop calling confusing function that doesn't do much .....

Merge pull request #22448 from mattwire/recurid

Simplify getting contact_id from recurring contribution when generating subscription URLs

Merge pull request #22456 from eileenmcnaughton/legt

Remove & deprecate silly function

CiviGrant - Use SearchKit for contact summary tab

Merge pull request #22064 from colemanw/civigrant

Migrate CiviGrant component to an extension