Merge pull request #20434 from colemanw/groupContact

SearchKit - Add static groups and organize main entity selector

Civi/Api4/ACL.php

@@ -30,7 +30,7 @@ namespace Civi\Api4;
  *
  * Creating a new ACL requires at minimum an entity table, entity ID and object_table.
  *
- * @searchable false
+ * @searchable none
  * @see https://docs.civicrm.org/user/en/latest/initial-set-up/permissions-and-access-control
  * @package Civi\Api4
  */

Civi/Api4/ActionSchedule.php

@@ -28,7 +28,7 @@ namespace Civi\Api4;
  *
  * Creating a new ActionSchedule requires at minimum a title, mapping_id and entity_value.
  *
- * @searchable false
+ * @searchable none
  * @see https://docs.civicrm.org/user/en/latest/email/scheduled-reminders/
  * @package Civi\Api4
  */

Civi/Api4/Activity.php

@@ -30,6 +30,7 @@ namespace Civi\Api4;
  * An activity is a record of some type of interaction with one or more contacts.
  *
  * @see https://docs.civicrm.org/user/en/latest/organising-your-data/activities/
+ * @searchable primary
  * @package Civi\Api4
  */
 class Activity extends Generic\DAOEntity {

Civi/Api4/Address.php

@@ -22,14 +22,15 @@ namespace Civi\Api4;
 /**
  * Address Entity.
  *
- * This entity holds the address informatiom of a contact. Each contact may hold
+ * This entity holds the address information of a contact. Each contact may hold
  * one or more addresses but must have different location types respectively.
  *
  * Creating a new address requires at minimum a contact's ID and location type ID
- *  and other attributes (although optional) like street address, city, country etc.
+ * and other attributes (although optional) like street address, city, country etc.
  *
  * @ui_join_filters location_type_id
  *
+ * @searchable secondary
  * @package Civi\Api4
  */
 class Address extends Generic\DAOEntity {

Civi/Api4/Batch.php

@@ -22,6 +22,7 @@ namespace Civi\Api4;
 /**
  * Batch entity.
  *
+ * @searchable secondary
  * @see https://docs.civicrm.org/user/en/latest/pledges/everyday-tasks/#batch-entry-of-pledges
  * @package Civi\Api4
  */

Civi/Api4/Campaign.php

@@ -23,6 +23,7 @@ namespace Civi\Api4;
  * Campaign entity.
  *
  * @see https://docs.civicrm.org/user/en/latest/campaign/what-is-civicampaign/
+ * @searchable secondary
  * @package Civi\Api4
  */
 class Campaign extends Generic\DAOEntity {

Civi/Api4/CiviCase.php

@@ -25,6 +25,7 @@ namespace Civi\Api4;
  * Note that the class for this entity is named "CiviCase" because "Case" is a keyword reserved by php.
  *
  * @see https://docs.civicrm.org/user/en/latest/case-management/what-is-civicase/
+ * @searchable primary
  * @package Civi\Api4
  */
 class CiviCase extends Generic\DAOEntity {

Civi/Api4/Contact.php

@@ -28,6 +28,7 @@ namespace Civi\Api4;
  * Creating a new contact requires at minimum a name or email address.
  *
  * @see https://docs.civicrm.org/user/en/latest/organising-your-data/contacts/
+ * @searchable primary
  * @package Civi\Api4
  */
 class Contact extends Generic\DAOEntity {

Civi/Api4/Contribution.php

@@ -15,6 +15,7 @@ namespace Civi\Api4;
 /**
  * Contribution entity.
  *
+ * @searchable primary
  * @package Civi\Api4
  */
 class Contribution extends Generic\DAOEntity {

Civi/Api4/ContributionPage.php

@@ -15,6 +15,7 @@ namespace Civi\Api4;
 /**
  * ContributionPage entity.
  *
+ * @searchable secondary
  * @package Civi\Api4
  */
 class ContributionPage extends Generic\DAOEntity {

Civi/Api4/ContributionRecur.php

@@ -15,6 +15,7 @@ namespace Civi\Api4;
 /**
  * ContributionRecur entity.
  *
+ * @searchable secondary
  * @package Civi\Api4
  */
 class ContributionRecur extends Generic\DAOEntity {

Civi/Api4/ContributionSoft.php

@@ -15,6 +15,7 @@ namespace Civi\Api4;
 /**
  * ContributionSoft entity.
  *
+ * @searchable secondary
  * @package Civi\Api4
  */
 class ContributionSoft extends Generic\DAOEntity {

Civi/Api4/CustomField.php

@@ -23,7 +23,7 @@ namespace Civi\Api4;
  * CustomField entity.
  *
  * @see https://docs.civicrm.org/user/en/latest/organising-your-data/creating-custom-fields/
- * @searchable false
+ * @searchable none
  * @package Civi\Api4
  */
 class CustomField extends Generic\DAOEntity {

Civi/Api4/CustomGroup.php

@@ -23,7 +23,7 @@ namespace Civi\Api4;
  * CustomGroup entity.
  *
  * @see https://docs.civicrm.org/user/en/latest/organising-your-data/creating-custom-fields/
- * @searchable false
+ * @searchable none
  * @package Civi\Api4
  */
 class CustomGroup extends Generic\DAOEntity {

Civi/Api4/CustomValue.php

@@ -142,7 +142,7 @@ class CustomValue {
     return [
       'class' => __CLASS__,
       'type' => ['CustomValue'],
-      'searchable' => TRUE,
+      'searchable' => 'secondary',
       'see' => [
         'https://docs.civicrm.org/user/en/latest/organising-your-data/creating-custom-fields/#multiple-record-fieldsets',
         '\Civi\Api4\CustomGroup',

Civi/Api4/Dashboard.php

@@ -28,7 +28,7 @@ namespace Civi\Api4;
  * Displaying an item to a user is done with the `DashboardContact` entity.
  *
  * @see \Civi\Api4\DashboardContact
- * @searchable false
+ * @searchable none
  * @package Civi\Api4
  */
 class Dashboard extends Generic\DAOEntity {

Civi/Api4/DashboardContact.php

@@ -24,7 +24,7 @@ namespace Civi\Api4;
  * This places a dashboard item on a user's home screen.
  *
  * @see \Civi\Api4\Dashboard
- * @searchable false
+ * @searchable none
  * @package Civi\Api4
  */
 class DashboardContact extends Generic\DAOEntity {

Civi/Api4/Domain.php

@@ -23,7 +23,7 @@ namespace Civi\Api4;
  * Domains - multisite instances of CiviCRM.
  *
  * @see https://docs.civicrm.org/sysadmin/en/latest/setup/multisite/
- * @searchable false
+ * @searchable none
  * @package Civi\Api4
  */
 class Domain extends Generic\DAOEntity {

Civi/Api4/Email.php

@@ -26,6 +26,7 @@ namespace Civi\Api4;
  *
  * Creating a new email address requires at minimum a contact's ID and email
  *
+ * @searchable secondary
  * @package Civi\Api4
  */
 class Email extends Generic\DAOEntity {

Civi/Api4/Entity.php

@@ -24,6 +24,7 @@ namespace Civi\Api4;
  *
  * @see \Civi\Api4\Generic\AbstractEntity
  *
+ * @searchable none
  * @package Civi\Api4
  */
 class Entity extends Generic\AbstractEntity {
@@ -90,7 +91,12 @@ class Entity extends Generic\AbstractEntity {
         ],
         [
           'name' => 'searchable',
-          'description' => 'Should this entity be selectable in search kit UI',
+          'description' => 'How should this entity be presented in search UIs',
+          'options' => [
+            'primary' => ts('Primary'),
+            'secondary' => ts('Secondary'),
+            'none' => ts('None'),
+          ],
         ],
         [
           'name' => 'paths',