Index view improvements (CFM-189):

- Move index row actions into an "actions.inc" file; - Move actions into a dropdown menu to the left of the index rows; - Establish a convention for a row-link using the first link or relatedLink available in the indexColumns[]; - Add "bulk" action switch and checkboxes; - Remove Edit, View, and Delete from the default set of index actions: edit and view are available from the row-link, delete is available from entity edit page (or bulk actions).
COmanage · Aug 12, 2022 · 4ba3605 · 4ba3605
1 parent 3b6e559
commit 4ba3605
Show file tree

Hide file tree

Showing 29 changed files with 845 additions and 452 deletions.
diff --git a/app/templates/AdHocAttributes/columns.inc b/app/templates/AdHocAttributes/columns.inc
@@ -33,3 +33,8 @@ $indexColumns = [
     'type' => 'echo'
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];
diff --git a/app/templates/Addresses/columns.inc b/app/templates/Addresses/columns.inc
@@ -37,3 +37,8 @@ $indexColumns = [
     'class' => 'LanguageEnum'
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];
diff --git a/app/templates/ApiUsers/columns.inc b/app/templates/ApiUsers/columns.inc
@@ -59,3 +59,8 @@ if($vv_cur_co->id > 1) {
 $indexColumns['valid_through'] = [
   'type' => 'datetime'
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];
diff --git a/app/templates/Cos/actions.inc b/app/templates/Cos/actions.inc
@@ -0,0 +1,39 @@
+<?php
+/**
+ * COmanage Registry CO Actions Menu Configuration
+ *
+ * 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)
+ */
+
+// Index top-links appear as top links in the index view
+$indexTopLinks = [];
+
+// Actions appear as row-level menu items in the index view gear icon and as a tab menu or top-link menu on 
+// edit and view pages based on user permissions (TODO).
+$actions = [
+  [
+    'action' => 'duplicate',
+    'class'  => '',
+    'icon'   => 'content_copy'
+  ]
+];
diff --git a/app/templates/Cos/columns.inc b/app/templates/Cos/columns.inc
@@ -38,10 +38,7 @@ $indexColumns = [
   ]
 ];
 
-$indexActions = [
-  [
-    'action' => 'duplicate',
-    'class'  => '',
-    'icon'   => 'content_copy'
-  ]
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
 ];
diff --git a/app/templates/Cous/columns.inc b/app/templates/Cous/columns.inc
@@ -37,3 +37,8 @@ $indexColumns = [
     'type' => 'echo'
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];
diff --git a/app/templates/EmailAddresses/columns.inc b/app/templates/EmailAddresses/columns.inc
@@ -33,3 +33,8 @@ $indexColumns = [
     'type' => 'fk'
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];
diff --git a/app/templates/ExternalIdentities/columns.inc b/app/templates/ExternalIdentities/columns.inc
@@ -36,3 +36,8 @@ $indexColumns = [
     'sortable' => 'PrimaryName.family'
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];
diff --git a/app/templates/ExternalIdentityRoles/columns.inc b/app/templates/ExternalIdentityRoles/columns.inc
@@ -43,3 +43,8 @@ $indexColumns = [
     'sortable' => true
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];
diff --git a/app/templates/GroupMembers/columns.inc b/app/templates/GroupMembers/columns.inc
@@ -55,4 +55,9 @@ $indexColumns = [
   'valid_through' => [
     'type' => 'datetime'
   ]
+];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
 ];
diff --git a/app/templates/GroupNestings/columns.inc b/app/templates/GroupNestings/columns.inc
@@ -32,4 +32,9 @@ $indexColumns = [
     'model' => 'target_group',
     'field' => 'name'
   ]
+];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
 ];
diff --git a/app/templates/GroupOwners/columns.inc b/app/templates/GroupOwners/columns.inc
@@ -34,4 +34,9 @@ $indexColumns = [
 // XXX not clear how to sort on submodel, but maybe just leave it for UX revisions?
 //    'sortable' => 'PrimaryName.family'
   ]
+];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
 ];
diff --git a/app/templates/Groups/actions.inc b/app/templates/Groups/actions.inc
@@ -0,0 +1,73 @@
+<?php
+/**
+ * COmanage Registry Groups Actions Menu Configuration
+ *
+ * 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)
+ */
+
+// Index top-links appear as top links in the index view
+$indexTopLinks = [];
+
+// Actions appear as row-level menu items in the index view gear icon and as a tab menu or top-link menu on 
+// edit and view pages based on user permissions (TODO).
+
+// TODO: Merge this with tabs (and top-links) available on the add-edit-view page (CFM-192 (and CO-647))
+// TODO: Note that this is already marked up for 'tab' or 'topLink' for use in CFM-192. 
+$actions = [
+  [
+    'controller' => 'group_members',
+    'action' => 'index',
+    'icon' => 'people',
+    'type' => 'tab'
+  ],
+  [
+    'controller' => 'group_owners',
+    'action' => 'index',
+    'icon' => 'settings',
+    'type' => 'tab'
+  ],
+  [
+    'controller' => 'group_nestings',
+    'action' => 'index',
+    'icon' => 'group_add',
+    'type' => 'tab'
+  ],
+  [
+    'controller' => 'history_records',
+    'action' => 'index',
+    'icon' => 'history',
+    'type' => 'tab'
+  ],
+  [
+    'controller' => 'identifiers',
+    'action' => 'index',
+    'icon' => 'label',
+    'if' => 'notAutomatic',
+    'type' => 'tab'
+  ],
+  [
+    'action' => 'reconcile',
+    'icon' => 'sync',
+    'type' => 'top-link'
+  ]
+];
diff --git a/app/templates/Groups/columns.inc b/app/templates/Groups/columns.inc
@@ -39,38 +39,7 @@ $indexColumns = [
   ]
 ];
 
-// XXX This should show on fields.inc and more generally perhaps we should merge
-// this with the set of buttons available on the add-edit-view page (maybe just
-// have that page use $indexActions?) (CO-647)
-$indexActions = [
-  [
-    'controller' => 'group_members',
-    'action' => 'index',
-    'icon' => 'people',
-  ],
-  [
-    'controller' => 'group_owners',
-    'action' => 'index',
-    'icon' => 'settings'
-  ],
-  [
-    'controller' => 'group_nestings',
-    'action' => 'index',
-    'icon' => 'group_add'
-  ],
-  [
-    'controller' => 'history_records',
-    'action' => 'index',
-    'icon' => 'history'
-  ],
-  [
-    'controller' => 'identifiers',
-    'action' => 'index',
-    'icon' => 'label',
-    'if' => 'notAutomatic'
-  ],
-  [
-    'action' => 'reconcile',
-    'icon' => 'sync'
-  ]
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
 ];
diff --git a/app/templates/HistoryRecords/columns.inc b/app/templates/HistoryRecords/columns.inc
@@ -27,7 +27,7 @@
 
 $indexColumns = [
   'id' => [
-    'type' => 'echo'
+    'type' => 'link'
   ],
   'created' => [
     'type' => 'datetime'

diff --git a/app/templates/Identifiers/columns.inc b/app/templates/Identifiers/columns.inc
@@ -33,3 +33,8 @@ $indexColumns = [
     'type' => 'fk'
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];
diff --git a/app/templates/Names/actions.inc b/app/templates/Names/actions.inc
@@ -0,0 +1,39 @@
+<?php
+/**
+ * COmanage Registry Names Actions Menu Configuration
+ *
+ * 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)
+ */
+
+// Index top-links appear as top links in the index view
+$indexTopLinks = [];
+
+// Actions appear as row-level menu items in the index view gear icon and as a tab menu or top-link menu on 
+// edit and view pages based on user permissions.
+$actions = [
+  [
+    'action' => 'primary',
+    'icon' => 'publish',
+    'if' => 'notPrimary'
+  ]
+];
diff --git a/app/templates/Names/columns.inc b/app/templates/Names/columns.inc
@@ -39,10 +39,7 @@ $indexColumns = [
   ]
 ];
 
-$indexActions = [
-  [
-    'action' => 'primary',
-    'icon' => 'publish',
-    'if' => 'notPrimary'
-  ]
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
 ];
diff --git a/app/templates/People/columns.inc b/app/templates/People/columns.inc
@@ -39,3 +39,8 @@ $indexColumns = [
     'sortable' => true
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'expunge' => true
+];
diff --git a/app/templates/PersonRoles/columns.inc b/app/templates/PersonRoles/columns.inc
@@ -28,14 +28,14 @@
 // Which action to render as the main link for the row
 
 $indexColumns = [
-  'cou_id' => [
-    'type' => 'fk',
-    'sortable' => true
-  ],
   'title' => [
     'type' => 'link',
     'sortable' => true
   ],
+  'cou_id' => [
+    'type' => 'fk',
+    'sortable' => true
+  ],
   'affiliation_type_id' => [
     'type' => 'fk',
     'label' => __d('field', 'affiliation'),
@@ -47,3 +47,8 @@ $indexColumns = [
     'sortable' => true
   ]
 ];
+
+$bulkActions = [
+  // TODO: develop bulk actions. For now, use a placeholder. 
+  'delete' => true
+];