Refactore SearchFilterTrait

COmanage · May 4, 2022 · f3e5aad · f3e5aad
1 parent 44766a2
commit f3e5aad
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 71 deletions.
diff --git a/app/src/Lib/Traits/SearchFilterTrait.php b/app/src/Lib/Traits/SearchFilterTrait.php
@@ -29,36 +29,12 @@
 
 namespace App\Lib\Traits;
 
+use Cake\Utility\Inflector;
+
 trait SearchFilterTrait {
   // Array (and configuration) of permitted search filters
   private $searchFilters = array();
-
-  /**
-   * Determine the UI label for the specified attribute.
-   *
-   * @since  COmanage Registry v5.0.0
-   * @param  string $attribute Attribute
-   * @return string            Label
-   * @todo   Merge this with _column_key from index.ctp
-   */
-
-  public function getLabel(string $attribute): string {
-    if(isset($this->searchFilters[$attribute]['label'])
-      && $this->searchFilters[$attribute]['label'] !== null) {
-      return $this->searchFilters[$attribute]['label'];
-    }
-
-    // Try to construct a label from the language key.
-    $l = __d('field', $attribute);
-
-    if($l != $attribute) {
-      return $l;
-    }
-
-    // If we make it here, just return $attribute
-    return $attribute;
-  }
-
+
   /**
    * Obtain the set of permitted search attributes.
    *
@@ -67,48 +43,28 @@ public function getLabel(string $attribute): string {
    */
 
   public function getSearchableAttributes(): array {
-    // Not every configuration element is necessary for the search form, and
-    // some need to be calculated, so we do that work here.
-
-    $ret = [];
-
-    foreach(array_keys($this->searchFilters) as $attr) {
-      $ret[ $attr ] = [
-        'label' => $this->getLabel($attr)
-      ];
-    }
-
-    return $ret;
-  }
-
-  /**
-   * Add a permitted search filters.
-   *
-   * @since  COmanage Registry v5.0.0
-   * @param  string $attribute     Attribute that filtering is permitted on (database name)
-   * @param  bool   $caseSensitive Whether this attribute is case sensitive
-   * @param  string $label         Label for this search field, or null to autocalculate
-   * @param  bool   $substring     Whether substring searching is permitted for this attribute
-   */
-
-  public function setSearchFilter(string $attribute,
-                                  bool   $caseSensitive=false,
-                                  string $label=null,
-                                  bool   $substring=true): void {
-//    $this->searchFilters[$attribute] = compact('caseSensitive', 'label', 'substring');
     foreach ($this->filterMetadataFields() as $column => $type) {
       // If the column is an array then we are accessing the Metadata fields. Skip
-      if(is_array($column)) {
+      if(is_array($type)) {
         continue;
       }
       $this->searchFilters[$column] = [
         'substring' => ($type === "string"),
-        'label' => null,
+        // todo: Probably the following line is redundant but i am leaving it for now
+        'label' => (__d('field', $column) ?? Inflector::humanize($column)),
         'caseSensitive' => false,
       ];
+
+      // Not every configuration element is necessary for the search form, and
+      // some need to be calculated, so we do that work here.
+      $ret[ $column ] = [
+        'label' => (__d('field', $column) ?? Inflector::humanize($column))
+      ];
     }
+
+    return $ret ?? [];
   }
-  
+
   /**
    * Build a query where() clause for the configured attribute.
    *
@@ -121,6 +77,7 @@ public function setSearchFilter(string $attribute,
 
   public function whereFilter(\Cake\ORM\Query $query, string $attribute, string $q): object {
     if(!empty($this->searchFilters[$attribute])) {
+      // todo: move caseSensitive into filter block itself
       $cs = (isset($this->searchFilters[$attribute]['caseSensitive'])
         && $this->searchFilters[$attribute]['caseSensitive']);
 

diff --git a/app/src/Model/Table/CousTable.php b/app/src/Model/Table/CousTable.php
@@ -72,11 +72,6 @@ public function initialize(array $config): void {
 
     $this->setPrimaryLink('co_id');
     $this->setRequiresCO(true);
-
-    // Set up the fields that may be filtered in the index view
-    $this->setSearchFilter('name', false, null, true);
-    $this->setSearchFilter('parent_id', true, null, false);
-    $this->setSearchFilter('description', false, null, true);
 
     $this->setPermissions([
       // Actions that operate over an entity (ie: require an $id)

diff --git a/app/src/Model/Table/TypesTable.php b/app/src/Model/Table/TypesTable.php
@@ -113,11 +113,6 @@ public function initialize(array $config): void {
         'class' => 'SuspendableStatusEnum'
       ]
     ]);
-
-    // Set up the fields that may be filtered in the index view
-    $this->setSearchFilter('display_name', false, null, true);
-    $this->setSearchFilter('attribute', true, null, false);
-    $this->setSearchFilter('statuses', false, null, true);
 
     $this->setPermissions([
       // Actions that operate over an entity (ie: require an $id)

diff --git a/app/templates/element/filter.php b/app/templates/element/filter.php
@@ -105,11 +105,14 @@
             'required' => false,
           ];
 
-          if(isset($$key)) {
+          // The populated variables are in plural while the column names are singular
+          // Convention: It is a prerequisite that the vvar should be the plural of the column name
+          $populated_vvar = Cake\Utility\Inflector::pluralize($key);
+          if(isset($$populated_vvar)) {
             // If we have an AutoViewVar matching the name of this key,
             // convert to a select
             $formParams['type'] = 'select';
-            $formParams['options'] = $$key;
+            $formParams['options'] = $$populated_vvar;
             // Allow empty so a filter doesn't require (eg) SOR
             $formParams['empty'] = true;
           }