Merge pull request #68 from arlen/feature-cfm205-personOverview

Creating central branch for collaborating on CFM-205, ajax-driven person canvas

app/resources/locales/en_US/field.po

@@ -29,8 +29,8 @@
 # When adding entries to this file, group non-model specific translations at the top,
 # then model specific translations alphabetically by model.
 
-msgid "action"
-msgstr "Action"
+msgid "actions"
+msgstr "{0,plural,=1{Action} other{Actions}}"
 
 msgid "actor"
 msgstr "Actor"
@@ -159,6 +159,9 @@ msgstr "Plugin"
 msgid "postal_code"
 msgstr "Postal Code"
 
+msgid "primary"
+msgstr "Primary"
+
 msgid "primary_name"
 msgstr "Primary Name"
 
@@ -243,6 +246,9 @@ msgstr "Value"
 msgid "verified"
 msgstr "Verified"
 
+msgid "unverified"
+msgstr "Unverified"
+
 msgid "ApiUsers.privileged.desc"
 msgstr "A privileged API user has full access to the CO. Unprivileged API users may be granted specific permissions where supported."
 

app/resources/locales/en_US/information.po

@@ -56,3 +56,9 @@ msgstr "There are no records to display."
 
 msgid "global.title.none"
 msgstr "No title"
+
+msgid "global.value.none"
+msgstr "No value"
+
+msgid "global.visit.link"
+msgstr "Visit link"

app/resources/locales/en_US/operation.po

@@ -27,6 +27,9 @@
 msgid "activate"
 msgstr "Activate"
 
+msgid "add"
+msgstr "Add"
+
 msgid "add.a"
 msgstr "Add a New {0}"
 

app/src/Controller/PeopleController.php

@@ -76,4 +76,66 @@ public function beforeRender(\Cake\Event\EventInterface $event) {
 
     return parent::beforeRender($event);
   }
+
+  /**
+   * Person overview / canvas
+   *
+   * @since  COmanage Registry v5.0.0
+   */
+
+  public function canvas(string $id) {
+    /* XXX Simply including parent::edit() is nearly all that's required - but we need
+       to delve a little deeper to get data from underlying relationships. We might send a contains() 
+       override to parent::edit() which would allow this to be more DRY 
+    // Keep the following as an example for now.
+    parent::edit($id, false);
+    
+    // We've just set the vv_supertitle in the parent controller. 
+    // Pass it to the title for use in the breadcrumbs. 
+    $this->set('vv_title', $this->viewBuilder()->getVar('vv_supertitle'));
+    */
+
+    /* The following is nearly identical to parent::edit/view */
+    $modelsName = $this->name;
+    $table = $this->$modelsName;
+    $tableName = $table->getTable();
+    $query = $table->findById($id);
+
+    // This contain() directive is the primary deviation from standard edit()/view().
+    // We need to drill down to deeper related models for display.
+    $query = $query->contain([
+        'PrimaryName',
+        'Names' => ['Types'],
+        'Addresses' => ['Types'],
+        'AdHocAttributes',
+        'EmailAddresses' => ['Types'],
+        'GroupMembers',
+        'GroupOwners',
+        'Identifiers' => ['Types'],
+        'PersonRoles' => ['Cous','Types'],
+        'Pronouns',
+        'TelephoneNumbers' => ['Types'],
+        'Urls' => ['Types']
+      ]);
+
+    try {
+      // Pull the current record
+      $obj = $query->firstOrFail();
+    } catch(\Exception $e) {
+      // findById throws Cake\Datasource\Exception\RecordNotFoundException
+      $this->Flash->error($e->getMessage());
+      // XXX This redirects to an Exception page because $id is not found.
+      // XXX A 404 with error would be better.
+      return $this->generateRedirect((int)$id);
+    }
+
+    $this->set('vv_obj', $obj);
+    $this->getPrimaryLink();
+    $this->populateAutoViewVars($obj);
+
+    $this->set('vv_title', $table->generateDisplayField($obj));
+    $this->set('vv_supertitle', $table->generateDisplayField($obj));
+    // Pass the display field also into subtitle for dealing with External IDs
+    $this->set('vv_subtitle', $table->generateDisplayField($obj));
+  }
 }

app/src/Controller/StandardController.php

@@ -331,8 +331,9 @@ public function edit(string $id) {
     }
     catch(\Exception $e) {
       // findById throws Cake\Datasource\Exception\RecordNotFoundException
-
       $this->Flash->error($e->getMessage());
+      // XXX This redirects to an Exception page because $id is not found.
+      // XXX A 404 with error would be better.
       return $this->generateRedirect((int)$id);
     }
 
@@ -724,8 +725,9 @@ public function view($id = null) {
     }
     catch(\Exception $e) {
       // findById throws Cake\Datasource\Exception\RecordNotFoundException
-
       $this->Flash->error($e->getMessage());
+      // XXX This redirects to an Exception page because $id is not found.
+      // XXX A 404 with error would be better.
       return $this->generateRedirect((int)$id);
     }
 
@@ -742,6 +744,9 @@ public function view($id = null) {
       // We don't use a trait for this since each table will implement different logic
 
       $this->set('vv_title', __d('operation', 'view.ai', $table->generateDisplayField($obj)));
+      $this->set('vv_supertitle', $table->generateDisplayField($obj));
+      // Pass the display field also into subtitle for dealing with External IDs
+      $this->set('vv_subtitle', $table->generateDisplayField($obj));
     } else {
       // Default view title is the object display field
       $field = $table->getDisplayField();

app/src/Lib/Traits/PrimaryLinkTrait.php

@@ -46,7 +46,7 @@ trait PrimaryLinkTrait {
   private $unkeyedActions = ['add', 'index'];
 
   // Actions where the primary link can be obtained by looking up the record ID
-  private $lookupActions = ['delete', 'edit', 'view'];
+  private $lookupActions = ['delete', 'edit', 'canvas', 'view'];
 
   // Where to redirect on add or edit, can be 'self', 'index', or 'primaryLink'
   private $redirectGoal = 'index';

app/src/Lib/Util/StringUtilities.php

@@ -46,7 +46,7 @@ class StringUtilities {
   public static function columnKey($modelsName, $c, $tz=null, $useCustomClMdlLabel=false): string {
     if(strpos($c, "_id", strlen($c)-3)) {
       // Key is of the form field_id, use .ct label instead
-      $k = $this->foreignKeyToClassName($c);
+      $k = self::foreignKeyToClassName($c);
 
       return __d('controller', $k, [1]);
     }

app/src/Model/Table/PeopleTable.php

@@ -150,6 +150,7 @@ public function initialize(array $config): void {
       'entity' => [
         'delete' =>   ['platformAdmin', 'coAdmin'],
         'edit' =>     ['platformAdmin', 'coAdmin'],
+        'canvas' =>   ['platformAdmin', 'coAdmin'],
         'view' =>     ['platformAdmin', 'coAdmin']
       ],
       // Actions that operate over a table (ie: do not require an $id)

app/templates/AdHocAttributes/columns.inc

@@ -41,6 +41,6 @@ $bulkActions = [
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'ad_hoc_attributes'
 ];

app/templates/AdHocAttributes/fields-nav.inc

@@ -30,6 +30,6 @@ $topLinks = [];
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'ad_hoc_attributes'
 ];

app/templates/Addresses/columns.inc

@@ -45,6 +45,6 @@ $bulkActions = [
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'addresses'
 ];

app/templates/Addresses/fields-nav.inc

@@ -30,6 +30,6 @@ $topLinks = [];
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'addresses'
 ];

app/templates/EmailAddresses/columns.inc

@@ -41,6 +41,6 @@ $bulkActions = [
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'email_addresses'
 ];

app/templates/EmailAddresses/fields-nav.inc

@@ -30,6 +30,6 @@ $topLinks = [];
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes', // default for person. 'external identities' are special cased
+  'active' => 'person', // default for person. 'external identities' are special cased
   'subActive' => 'email_addresses'
 ];

app/templates/Identifiers/columns.inc

@@ -56,6 +56,6 @@ $bulkActions = [
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'identifiers'
 ];

app/templates/Identifiers/fields-nav.inc

@@ -30,6 +30,6 @@ $topLinks = [];
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'identifiers'
 ];

app/templates/Names/columns.inc

@@ -58,6 +58,6 @@ $bulkActions = [
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'names'
 ];

app/templates/Names/fields-nav.inc

@@ -30,6 +30,6 @@ $topLinks = [];
 
 $subnav = [
   'name' => 'person',
-  'active' => 'attributes',
+  'active' => 'person',
   'subActive' => 'names'
 ];