From cd871c6d4ffee09f20d445e0d72018b7e060b79a Mon Sep 17 00:00:00 2001
From: Arlen Johnson <arlen@sphericalcowgroup.com>
Date: Wed, 5 Apr 2023 11:52:32 -0400
Subject: [PATCH 1/3] Move person canvas Add menu to the Person tab (CFM-260)

---
 app/templates/People/fields-nav.inc      |  59 +++++++++++
 app/templates/Standard/add-edit-view.php |  47 +--------
 app/templates/element/personCanvas.php   | 126 +++++++++++++++++++++++
 app/templates/element/subnavigation.php  |  89 ----------------
 app/webroot/css/co-base.css              |   6 ++
 5 files changed, 193 insertions(+), 134 deletions(-)
 create mode 100644 app/templates/element/personCanvas.php

diff --git a/app/templates/People/fields-nav.inc b/app/templates/People/fields-nav.inc
index cf904e33d..28c52d2aa 100644
--- a/app/templates/People/fields-nav.inc
+++ b/app/templates/People/fields-nav.inc
@@ -41,6 +41,65 @@ $topLinks = [
     'class' => ''
   ]
 ];
+  
+// $addMenuLinks is given slightly different treatment from the typical $topLinks found in most views: 
+// it is a page-global menu used for adding MVEAs to the person canvas.
+$addMenuLinks = [
+  [
+    'controller' => 'names',
+    'action' => 'add',
+    'icon' => 'account_box',
+    'iconClass' => 'material-icons-outlined'
+  ],
+  [
+    'controller' => 'email_addresses',
+    'action' => 'add',
+    'icon' => 'email',
+    'iconClass' => 'material-icons-outlined'
+  ],
+  [
+    'controller' => 'identifiers',
+    'action' => 'add',
+    'icon' => 'fingerprint'
+  ],
+  [
+    'controller' => 'person_roles',
+    'action' => 'add',
+    'icon' => 'emoji_people'
+  ],
+  [
+    'controller' => 'ad_hoc_attributes',
+    'action' => 'add',
+    'icon' => 'check_box',
+    'iconClass' => 'material-icons-outlined'
+  ],
+  [
+    'controller' => 'addresses',
+    'action' => 'add',
+    'icon' => 'contact_mail',
+    'iconClass' => 'material-icons-outlined'
+  ],
+  [
+    'controller' => 'history_records',
+    'action' => 'add',
+    'icon' => 'history'
+  ],
+  [
+    'controller' => 'pronouns',
+    'action' => 'add',
+    'icon' => 'transgender'
+  ],
+  [
+    'controller' => 'telephone_numbers',
+    'action' => 'add',
+    'icon' => 'phone'
+  ],
+  [
+    'controller' => 'urls',
+    'action' => 'add',
+    'icon' => 'link'
+  ]
+];
 
 $subnav = [
   'name' => 'person',
diff --git a/app/templates/Standard/add-edit-view.php b/app/templates/Standard/add-edit-view.php
index 3f84dd449..803acb082 100644
--- a/app/templates/Standard/add-edit-view.php
+++ b/app/templates/Standard/add-edit-view.php
@@ -79,52 +79,9 @@
 <?php /** Special case the Person "canvas" **/ ?>
 <?php if($modelsName == 'People' &&  $vv_action == 'edit'): ?>
   <?php
-  // Person Attributes to display.
-  $attributes = [
-    'names',
-    'email_addresses',
-    'identifiers',
-    'ad_hoc_attributes',
-    'addresses',
-    'telephone_numbers',
-    'urls',
-    'pronouns'
-  ];
-
-  // Count the number of widgets that will be displayed 
-  $widgetCount = 0;
-  foreach($attributes as $attr) {
-    if(!empty($vv_obj[$attr])) {
-      $widgetCount++;
-    }
-  }
-
-  $objId = null;
-  if(!empty($vv_obj)) {
-    $objId = $vv_obj->id;
-  }
+    // The person canvas has $addMenuLinks defined in templates/People/fields-nav.inc config. 
+    print $this->element('personCanvas', ['vv_add_menu_links' => $addMenuLinks]); 
   ?>
-  <div id="person-canvas" class="co-cards">
-    <!-- Person Attributes -->
-    <div id="person-canvas-attributes-js" class="row row-cols-1 g-4 <?= ($widgetCount > 1) ? 'row-cols-md-2' : ''?>">
-      <?php
-        foreach($attributes as $attr) {
-          if(!empty(($vv_obj[$attr]))) {
-            print $this->element(
-              'mveaJs',
-              [
-                'htmlId' => 'person-canvas-' . $attr . '-js',
-                'parentId' => $objId,
-                'mveaType' => $attr,
-                'entityType' => 'person'
-              ]
-            );
-          }
-        }
-        // XXX Add the DOB as its own special card.
-      ?>
-    </div>
-  </div>
 <?php else: /** normal output **/ ?>
   <div class="pageTitleContainer">
     <div class="pageTitle">
diff --git a/app/templates/element/personCanvas.php b/app/templates/element/personCanvas.php
new file mode 100644
index 000000000..dcdd4c987
--- /dev/null
+++ b/app/templates/element/personCanvas.php
@@ -0,0 +1,126 @@
+<?php
+  /**
+   * COmanage Registry Person Canvas Element
+   *
+   * Portions licensed to the University Corporation for Advanced Internet
+   * Development, Inc. ("UCAID") under one or more contributor license agreements.
+   * See the NOTICE file distributed with this work for additional information
+   * regarding copyright ownership.
+   *
+   * UCAID licenses this file to you under the Apache License, Version 2.0
+   * (the "License"); you may not use this file except in compliance with the
+   * License. You may obtain a copy of the License at:
+   *
+   * http://www.apache.org/licenses/LICENSE-2.0
+   *
+   * Unless required by applicable law or agreed to in writing, software
+   * distributed under the License is distributed on an "AS IS" BASIS,
+   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   * See the License for the specific language governing permissions and
+   * limitations under the License.
+   *
+   * @link          https://www.internet2.edu/comanage COmanage Project
+   * @package       registry
+   * @since         COmanage Registry v5.0.0
+   * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+   */
+  
+  // Get the object ID
+  if (!empty($vv_obj)) {
+    // This will work for most top-level edit views
+    // XXX we might produce the $vv_primary_link for edit views so the approach below could be deprecated
+    $curId = $vv_obj->id;
+    if(!empty($vv_person_id)) {
+      $curId = $vv_person_id;
+    } elseif(!empty($vv_primary_link_id)) {
+      $curId = $vv_primary_link_id;
+    }
+  }
+  
+  // Build the Add menu
+  $action_args = array();
+  $action_args['vv_attr_id'] =  $curId;
+  $action_args['vv_actions_type'] = 'person-actions-add-menu';
+  $action_args['vv_actions_title'] = __d('operation','add');
+  $action_args['vv_actions_icon'] = 'add_circle';
+  $action_args['vv_actions_class'] = 'person-actions-add-menu';
+  $actionOrderDefault = $this->Menu->getMenuOrder('Default');
+  $personAddMenuActions = $vv_add_menu_links;
+  foreach(($personAddMenuActions ?? []) as $a) {
+    $actionOrder = !empty($a['order']) ? $a['order'] : $actionOrderDefault++;
+    $actionIcon = !empty($a['icon']) ? $a['icon'] : $this->Menu->getMenuIcon('Default');
+    $actionIconClass = !empty($a['iconClass']) ? $a['iconClass'] : '';
+    $actionClass = !empty($a['class']) ? $a['class'] : '';
+    $actionUrl = $this->Url->build(
+      [
+        'controller' => $a['controller'],
+        'action' => $a['action'],
+        '?' => [
+          'person_id' => $curId
+        ]
+      ]
+    );
+    $actionLabel = __d('controller', Cake\Utility\Inflector::camelize($a['controller']), [1]);
+    $action_args['vv_actions'][] = [
+      'order' => $actionOrder,
+      'icon' => $actionIcon,
+      'iconClass' => $actionIconClass,
+      'url' => $actionUrl,
+      'class' => $actionClass,
+      'label' => $actionLabel
+    ];
+  }
+?>
+<div class="field-actions person-actions-add-menu-container">
+  <?= $this->element('menuAction', $action_args) ?>
+</div>
+
+
+<?php
+  // Construct the canvas using JavaScript components.
+  // Person Attributes to display.
+  $attributes = [
+    'names',
+    'email_addresses',
+    'identifiers',
+    'ad_hoc_attributes',
+    'addresses',
+    'telephone_numbers',
+    'urls',
+    'pronouns'
+  ];
+  
+  // Count the number of widgets that will be displayed 
+  $widgetCount = 0;
+  foreach($attributes as $attr) {
+    if(!empty($vv_obj[$attr])) {
+      $widgetCount++;
+    }
+  }
+  
+  $objId = null;
+  if(!empty($vv_obj)) {
+    $objId = $vv_obj->id;
+  }
+?>
+<div id="person-canvas" class="co-cards">
+  <!-- Person Attributes -->
+  <div id="person-canvas-attributes-js" class="row row-cols-1 g-4 <?= ($widgetCount > 1) ? 'row-cols-md-2' : ''?>">
+    <?php
+      foreach($attributes as $attr) {
+        if(!empty(($vv_obj[$attr]))) {
+          print $this->element(
+            'mveaJs',
+            [
+              'htmlId' => 'person-canvas-' . $attr . '-js',
+              'parentId' => $objId,
+              'mveaType' => $attr,
+              'entityType' => 'person'
+            ]
+          );
+        }
+      }
+      // XXX Add the DOB as its own special card.
+    ?>
+  </div>
+</div>
\ No newline at end of file
diff --git a/app/templates/element/subnavigation.php b/app/templates/element/subnavigation.php
index 09a43ad79..51721b8bc 100644
--- a/app/templates/element/subnavigation.php
+++ b/app/templates/element/subnavigation.php
@@ -98,95 +98,6 @@
     <?php if($name == 'person'): ?>
       <!-- Specialty person dropdown menus - ADD and global actions -->
       <nav id="person-actions">
-        <?php
-          // Build the Add menu
-          $action_args = array();
-          $action_args['vv_attr_id'] =  $curId;
-          $action_args['vv_actions_type'] = 'person-actions-add-menu';
-          $action_args['vv_actions_title'] = __d('operation','add');
-          $action_args['vv_actions_icon'] = 'add_circle';
-          $action_args['vv_actions_class'] = 'person-actions-add-menu';
-          $actionOrderDefault = $this->Menu->getMenuOrder('Default');
-          $personAddMenuActions = [
-            [
-              'controller' => 'names',
-              'action' => 'add',
-              'icon' => 'account_box',
-              'iconClass' => 'material-icons-outlined'
-            ],
-            [
-              'controller' => 'email_addresses',
-              'action' => 'add',
-              'icon' => 'email',
-              'iconClass' => 'material-icons-outlined'
-            ],
-            [
-              'controller' => 'identifiers',
-              'action' => 'add',
-              'icon' => 'fingerprint'
-            ],
-            [
-              'controller' => 'person_roles',
-              'action' => 'add',
-              'icon' => 'emoji_people'
-            ],
-            [
-              'controller' => 'ad_hoc_attributes',
-              'action' => 'add',
-              'icon' => 'check_box',
-              'iconClass' => 'material-icons-outlined'
-            ],
-            [
-              'controller' => 'addresses',
-              'action' => 'add',
-              'icon' => 'contact_mail',
-              'iconClass' => 'material-icons-outlined'
-            ],
-            [
-              'controller' => 'history_records',
-              'action' => 'add',
-              'icon' => 'history'
-            ],
-            [
-              'controller' => 'telephone_numbers',
-              'action' => 'add',
-              'icon' => 'phone'
-            ],
-            [
-              'controller' => 'urls',
-              'action' => 'add',
-              'icon' => 'link'
-            ]
-          ];
-          foreach(($personAddMenuActions ?? []) as $a) {
-            $actionOrder = !empty($a['order']) ? $a['order'] : $actionOrderDefault++;
-            $actionIcon = !empty($a['icon']) ? $a['icon'] : $this->Menu->getMenuIcon('Default');
-            $actionIconClass = !empty($a['iconClass']) ? $a['iconClass'] : '';
-            $actionClass = !empty($a['class']) ? $a['class'] : '';
-            $actionUrl = $this->Url->build(
-              [
-                'controller' => $a['controller'],
-                'action' => $a['action'],
-                '?' => [
-                  'person_id' => $curId
-                ]
-              ]
-            );
-            $actionLabel = __d('controller', Cake\Utility\Inflector::camelize($a['controller']), [1]);
-            $action_args['vv_actions'][] = [
-              'order' => $actionOrder,
-              'icon' => $actionIcon,
-              'iconClass' => $actionIconClass,
-              'url' => $actionUrl,
-              'class' => $actionClass,
-              'label' => $actionLabel
-            ];
-          }
-        ?>
-        <div class="field-actions person-actions-add-menu-container">
-          <?= $this->element('menuAction', $action_args) ?>
-        </div>
-            
         <?php
           // Build the global Person Actions menu
           $action_args = array();
diff --git a/app/webroot/css/co-base.css b/app/webroot/css/co-base.css
index 781e92ac3..b245c7fe2 100644
--- a/app/webroot/css/co-base.css
+++ b/app/webroot/css/co-base.css
@@ -1022,6 +1022,12 @@ table.index-table .form-check {
 #person-actions .action-menu-toggle {
   white-space: nowrap;
 }
+.person-actions-add-menu-container {
+  float: right;
+}
+#person-canvas {
+  clear: both;
+}
 #person-canvas-attributes,
 #person-canvas-attributes-js {
   margin-top: 0;

From 64126c750d1a3d1be5ebb1f060a42fe987c8673e Mon Sep 17 00:00:00 2001
From: Arlen Johnson <arlen@sphericalcowgroup.com>
Date: Wed, 5 Apr 2023 11:54:25 -0400
Subject: [PATCH 2/3] Remove "Person Role" from Add menu now that it is
 contextually connected only to the Person tab (CFM-260)

---
 app/templates/People/fields-nav.inc | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/app/templates/People/fields-nav.inc b/app/templates/People/fields-nav.inc
index 28c52d2aa..62db08e24 100644
--- a/app/templates/People/fields-nav.inc
+++ b/app/templates/People/fields-nav.inc
@@ -62,11 +62,6 @@ $addMenuLinks = [
     'action' => 'add',
     'icon' => 'fingerprint'
   ],
-  [
-    'controller' => 'person_roles',
-    'action' => 'add',
-    'icon' => 'emoji_people'
-  ],
   [
     'controller' => 'ad_hoc_attributes',
     'action' => 'add',

From a26dd5f583c385cdbe34d0bd4aed096cb43939ae Mon Sep 17 00:00:00 2001
From: Arlen Johnson <arlen@sphericalcowgroup.com>
Date: Wed, 5 Apr 2023 13:03:20 -0400
Subject: [PATCH 3/3] Ensure that the Person canvas menu link are built from
 $topLinks in config (CFM-260)

---
 app/templates/People/fields-nav.inc      | 10 +++++----
 app/templates/Standard/add-edit-view.php |  6 ++++-
 app/templates/element/subnavigation.php  | 28 ++++++++++--------------
 3 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/app/templates/People/fields-nav.inc b/app/templates/People/fields-nav.inc
index 62db08e24..5ee314e2f 100644
--- a/app/templates/People/fields-nav.inc
+++ b/app/templates/People/fields-nav.inc
@@ -26,6 +26,8 @@
  */
 
 // XXX: if CFM-218 (Make fields.inc configuration only) is accepted, move the contents of this file into fields.inc
+
+// Output for $topLinks from this specific configuration is presented in the Person canvas "Actions" menu.   
 $topLinks = [
   [
     'icon' => 'history',
@@ -37,13 +39,13 @@ $topLinks = [
       '?' => [
         'person_id' => $vv_obj->id
       ]
-    ],
-    'class' => ''
+    ]
   ]
 ];
   
-// $addMenuLinks is given slightly different treatment from the typical $topLinks found in most views: 
-// it is a page-global menu used for adding MVEAs to the person canvas.
+// $addMenuLinks is also given slightly different treatment from the typical $topLinks found in most views: 
+// it is a page-global menu used for adding MVEAs to the person canvas and is given special treatment in
+// element/personCanvas.php.
 $addMenuLinks = [
   [
     'controller' => 'names',
diff --git a/app/templates/Standard/add-edit-view.php b/app/templates/Standard/add-edit-view.php
index 803acb082..b1c2e2c3e 100644
--- a/app/templates/Standard/add-edit-view.php
+++ b/app/templates/Standard/add-edit-view.php
@@ -71,6 +71,10 @@
 if(!empty($subnav)) {
   // Include the $flashArgs for the subnavigation element
   $subnav['flashArgs'] = $flashArgs;
+  if(!empty($topLinks) && ($modelsName == 'People' &&  $vv_action == 'edit')) {
+    // We are in Person canvas mode: pass along the top links for building the Actions menu.
+    $subnav['topLinks'] = $topLinks;
+  }
   // Generate the subnavigation title and tabs
   print $this->element('subnavigation', $subnav);
 }
@@ -82,7 +86,7 @@
     // The person canvas has $addMenuLinks defined in templates/People/fields-nav.inc config. 
     print $this->element('personCanvas', ['vv_add_menu_links' => $addMenuLinks]); 
   ?>
-<?php else: /** normal output **/ ?>
+<?php else: /** Normal output **/ ?>
   <div class="pageTitleContainer">
     <div class="pageTitle">
       <?php if(empty($subnav)): ?>
diff --git a/app/templates/element/subnavigation.php b/app/templates/element/subnavigation.php
index 51721b8bc..34b0bec98 100644
--- a/app/templates/element/subnavigation.php
+++ b/app/templates/element/subnavigation.php
@@ -96,7 +96,7 @@
     </div>
     
     <?php if($name == 'person'): ?>
-      <!-- Specialty person dropdown menus - ADD and global actions -->
+      <!-- Specialty person dropdown menus - global actions -->
       <nav id="person-actions">
         <?php
           // Build the global Person Actions menu
@@ -106,22 +106,16 @@
           $action_args['vv_actions_title'] = __d('field','actions',[99]);
           $action_args['vv_actions_icon'] = 'settings';
           $action_args['vv_actions_class'] = 'person-actions-menu';
-          // history records
-          $actionUrl = $this->Url->build(
-            [
-              'controller' => 'history_records',
-              'action' => 'index',
-              '?' => [
-                'person_id' => $curId
-              ]
-            ]
-          );
-          $action_args['vv_actions'][] = array(
-            'order' => $this->Menu->getMenuOrder('Default'),
-            'icon' => 'history',
-            'url' => $actionUrl,
-            'label' => __d('operation', 'HistoryRecords')
-          );
+          if(!empty($topLinks)) {
+            foreach ($topLinks as $action) {
+              $action_args['vv_actions'][] = array(
+                'order' => $this->Menu->getMenuOrder($action['order']),
+                'icon' => $action['icon'],
+                'url' => $this->Url->build($action['link']),
+                'label' => $action['label']
+              );
+            }
+          }
           // delete
           $actionPostBtnArray = ['action' => 'delete', $curId];
           $actionUrl = $this->Url->build(['action' => 'delete', $curId]);