dev/core#4213 Make frontend_title, name required for Group entity

This follows up on having done this for contribution_page recently. It will mean we can consistently refer to frontend_title in tokens and other places where what we really mean is ... frontend_title.
civicrm · Jun 16, 2023 · 138e389 · 138e389
1 parent 34558a5
commit 138e389
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 16 deletions.
diff --git a/CRM/Contact/BAO/Group.php b/CRM/Contact/BAO/Group.php
@@ -1105,12 +1105,8 @@ public static function getGroupsHierarchy(
       $title = $dao->title;
       $description = $dao->description;
       if ($public) {
-        if (!empty($dao->frontend_title)) {
-          $title = $dao->frontend_title;
-        }
-        if (!empty($dao->frontend_description)) {
-          $description = $dao->frontend_description;
-        }
+        $title = $dao->frontend_title;
+        $description = $dao->frontend_description;
       }
       if ($dao->parents) {
         $parentArray = explode(',', $dao->parents);

diff --git a/CRM/Contact/DAO/Group.php b/CRM/Contact/DAO/Group.php
@@ -6,7 +6,7 @@
  *
  * Generated from xml/schema/CRM/Contact/Group.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:e98767d560ee98268e800a2aec983cea)
+ * (GenCodeChecksum:5cb6d58b6f91122093003d8c0db4fab1)
  */
 
 /**
@@ -68,7 +68,7 @@ class CRM_Contact_DAO_Group extends CRM_Core_DAO {
   /**
    * Internal name of Group.
    *
-   * @var string|null
+   * @var string
    *   (SQL type: varchar(64))
    *   Note that values will be retrieved from the database as a string.
    */
@@ -77,7 +77,7 @@ class CRM_Contact_DAO_Group extends CRM_Core_DAO {
   /**
    * Name of Group.
    *
-   * @var string|null
+   * @var string
    *   (SQL type: varchar(255))
    *   Note that values will be retrieved from the database as a string.
    */
@@ -134,6 +134,7 @@ class CRM_Contact_DAO_Group extends CRM_Core_DAO {
    * @var string|null
    *   (SQL type: text)
    *   Note that values will be retrieved from the database as a string.
+   * @deprecated
    */
   public $where_clause;
 
@@ -143,6 +144,7 @@ class CRM_Contact_DAO_Group extends CRM_Core_DAO {
    * @var string|null
    *   (SQL type: text)
    *   Note that values will be retrieved from the database as a string.
+   * @deprecated
    */
   public $select_tables;
 
@@ -152,6 +154,7 @@ class CRM_Contact_DAO_Group extends CRM_Core_DAO {
    * @var string|null
    *   (SQL type: text)
    *   Note that values will be retrieved from the database as a string.
+   * @deprecated
    */
   public $where_tables;
 
@@ -238,7 +241,7 @@ class CRM_Contact_DAO_Group extends CRM_Core_DAO {
   /**
    * Alternative public title for this Group.
    *
-   * @var string|null
+   * @var string
    *   (SQL type: varchar(255))
    *   Note that values will be retrieved from the database as a string.
    */
@@ -324,6 +327,7 @@ public static function &fields() {
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Group Name'),
           'description' => ts('Internal name of Group.'),
+          'required' => TRUE,
           'maxlength' => 64,
           'size' => CRM_Utils_Type::BIG,
           'usage' => [
@@ -344,6 +348,7 @@ public static function &fields() {
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Group Title'),
           'description' => ts('Name of Group.'),
+          'required' => TRUE,
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'usage' => [
@@ -494,6 +499,7 @@ public static function &fields() {
           'entity' => 'Group',
           'bao' => 'CRM_Contact_BAO_Group',
           'localizable' => 0,
+          'deprecated' => TRUE,
           'readonly' => TRUE,
           'add' => '1.6',
         ],
@@ -514,6 +520,7 @@ public static function &fields() {
           'bao' => 'CRM_Contact_BAO_Group',
           'localizable' => 0,
           'serialize' => self::SERIALIZE_PHP,
+          'deprecated' => TRUE,
           'readonly' => TRUE,
           'add' => '1.6',
         ],
@@ -534,6 +541,7 @@ public static function &fields() {
           'bao' => 'CRM_Contact_BAO_Group',
           'localizable' => 0,
           'serialize' => self::SERIALIZE_PHP,
+          'deprecated' => TRUE,
           'readonly' => TRUE,
           'add' => '1.6',
         ],
@@ -756,6 +764,7 @@ public static function &fields() {
           'type' => CRM_Utils_Type::T_STRING,
           'title' => ts('Public Group Title'),
           'description' => ts('Alternative public title for this Group.'),
+          'required' => TRUE,
           'maxlength' => 255,
           'size' => CRM_Utils_Type::HUGE,
           'usage' => [
@@ -765,7 +774,6 @@ public static function &fields() {
             'token' => FALSE,
           ],
           'where' => 'civicrm_group.frontend_title',
-          'default' => NULL,
           'table_name' => 'civicrm_group',
           'entity' => 'Group',
           'bao' => 'CRM_Contact_BAO_Group',

diff --git a/CRM/Core/CodeGen/GenerateData.php b/CRM/Core/CodeGen/GenerateData.php
@@ -1141,7 +1141,7 @@ private function addGroup() {
     // add the 3 groups first
     foreach ($this->sampleData['group'] as $groupName) {
       $group = new CRM_Contact_BAO_Group();
-      $group->name = $group->title = $groupName;
+      $group->name = $group->title = $group->frontend_title = $groupName;
       $group->group_type = "12";
       $group->visibility = 'Public Pages';
       $group->is_active = 1;

diff --git a/CRM/Core/I18n/SchemaStructure.php b/CRM/Core/I18n/SchemaStructure.php
@@ -92,8 +92,8 @@ public static function &columns() {
           'description' => "text COMMENT 'Optional description.'",
         ],
         'civicrm_group' => [
-          'title' => "varchar(255) COMMENT 'Name of Group.'",
-          'frontend_title' => "varchar(255) DEFAULT NULL COMMENT 'Alternative public title for this Group.'",
+          'title' => "varchar(255) NOT NULL COMMENT 'Name of Group.'",
+          'frontend_title' => "varchar(255) NOT NULL COMMENT 'Alternative public title for this Group.'",
           'frontend_description' => "text DEFAULT NULL COMMENT 'Alternative public description of the group.'",
         ],
         'civicrm_contribution_page' => [
@@ -416,9 +416,11 @@ public static function &widgets() {
         'civicrm_group' => [
           'title' => [
             'type' => "Text",
+            'required' => "true",
           ],
           'frontend_title' => [
             'type' => "Text",
+            'required' => "TRUE",
           ],
           'frontend_description' => [
             'type' => "TextArea",

diff --git a/CRM/Group/Form/Edit.php b/CRM/Group/Form/Edit.php
@@ -67,7 +67,7 @@ protected function setEntityFields() {
         'required' => TRUE,
       ],
       'description' => ['name' => 'description'],
-      'frontend_title' => ['name' => 'frontend_title'],
+      'frontend_title' => ['name' => 'frontend_title', 'required' => TRUE],
       'frontend_description' => ['name' => 'frontend_description'],
     ];
   }

diff --git a/CRM/Upgrade/Incremental/php/FiveSixtyFour.php b/CRM/Upgrade/Incremental/php/FiveSixtyFour.php
@@ -29,6 +29,10 @@ class CRM_Upgrade_Incremental_php_FiveSixtyFour extends CRM_Upgrade_Incremental_
    */
   public function upgrade_5_64_alpha1($rev): void {
     $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
+    $this->addTask('Make Group.name required', 'alterColumn', 'civicrm_group', 'name', "varchar(255) NOT NULL COMMENT 'Unique name for identifying contribution page'");
+    $this->addTask('Make Group.title required', 'alterColumn', 'civicrm_group', 'title', "varchar(255) NOT NULL COMMENT 'Contribution Page title. For top of page display'", TRUE);
+    $this->addTask('Make Group.frontend_title required', 'alterColumn', 'civicrm_group', 'frontend_title', "varchar(255) NOT NULL COMMENT 'Contribution Page Public title'", TRUE);
+
   }
 
 }
diff --git a/CRM/Upgrade/Incremental/sql/5.64.alpha1.mysql.tpl b/CRM/Upgrade/Incremental/sql/5.64.alpha1.mysql.tpl
@@ -6,3 +6,19 @@ ALTER TABLE civicrm_uf_group
 CHANGE `post_URL` `post_url` varchar(255) DEFAULT NULL COMMENT 'Redirect to URL on submit.',
 CHANGE `cancel_URL` `cancel_url` varchar(255) DEFAULT NULL COMMENT 'Redirect to URL when Cancel button clicked.'
 ;
+
+-- Ensure new name field is not null/unique. Setting to ID is a bit lazy - but it works.
+UPDATE civicrm_group SET `name` = `id` WHERE name IS NULL;
+
+-- Add name field, make frontend_title required (in conjunction with php function)
+{if $multilingual}
+    {foreach from=$locales item=locale}
+      UPDATE `civicrm_group`
+      SET `frontend_title_{$locale}` = `title_{$locale}`
+      WHERE `frontend_title_{$locale}` IS NULL OR `frontend_title_{$locale}` = '';
+    {/foreach}
+{else}
+  UPDATE `civicrm_group`
+  SET `frontend_title` = `title`
+  WHERE `frontend_title` IS NULL OR `frontend_title` = '';
+{/if}
diff --git a/xml/schema/Contact/Group.xml b/xml/schema/Contact/Group.xml
@@ -35,6 +35,7 @@
     <type>varchar</type>
     <title>Group Name</title>
     <length>64</length>
+    <required>true</required>
     <comment>Internal name of Group.</comment>
     <add>1.1</add>
   </field>
@@ -43,6 +44,7 @@
     <type>varchar</type>
     <title>Group Title</title>
     <length>255</length>
+    <required>true</required>
     <localizable>true</localizable>
     <comment>Name of Group.</comment>
     <add>1.1</add>
@@ -121,6 +123,7 @@
     <title>Group Where Clause</title>
     <comment>the sql where clause if a saved search acl</comment>
     <readonly>true</readonly>
+    <deprecated>true</deprecated>
     <add>1.6</add>
   </field>
   <field>
@@ -130,11 +133,13 @@
     <comment>the tables to be included in a select data</comment>
     <readonly>true</readonly>
     <serialize>PHP</serialize>
+    <deprecated>true</deprecated>
     <add>1.6</add>
   </field>
   <field>
     <name>where_tables</name>
     <type>text</type>
+    <deprecated>true</deprecated>
     <title>Tables For Where Clause</title>
     <comment>the tables to be included in the count statement</comment>
     <readonly>true</readonly>
@@ -295,7 +300,7 @@
     <length>255</length>
     <localizable>true</localizable>
     <comment>Alternative public title for this Group.</comment>
-    <default>NULL</default>
+    <required>TRUE</required>
     <add>5.31</add>
     <html>
       <type>Text</type>