HexMakina / kadro

Controllers/ORMController.class.php

Spacing +50 added lines, -50 removed lines

@@ -27,19 +27,19 @@ 
     $custom_template = null;
     $method = $this->router()->target_method();
 
-    foreach(['prepare', "before_$method", $method, "after_$method"] as $step => $chainling)
+    foreach (['prepare', "before_$method", $method, "after_$method"] as $step => $chainling)
     {
       $this->search_and_execute_trait_methods($chainling);
-    	if(method_exists($this, $chainling) && empty($this->errors()))
+    	if (method_exists($this, $chainling) && empty($this->errors()))
       {
         $res = $this->$chainling();
 
-        if($this->logger()->has_halting_messages()) // logger handled a critical error during the chailing execution
+        if ($this->logger()->has_halting_messages()) // logger handled a critical error during the chailing execution
         {
           break; // dont go on with other
         }
 
-        if($chainling === $method)
+        if ($chainling === $method)
         {
 
           $custom_template = $res;
@@ -47,10 +47,10 @@ 
       }
     }
 
-    if(method_exists($this, 'conclude')) // conclude always executed, even with has_halting_messages
+    if (method_exists($this, 'conclude')) // conclude always executed, even with has_halting_messages
     	$this->conclude();
 
-    if(method_exists($this, 'display'))
+    if (method_exists($this, 'display'))
     	$template = $this->display($custom_template);
   }
 
@@ -58,7 +58,7 @@ 
   {
     parent::prepare();
 
-    if(!class_exists($this->model_class_name = $this->class_name()))
+    if (!class_exists($this->model_class_name = $this->class_name()))
       throw new \Exception("!class_exists($this->model_class_name)");
 
     $this->model_type = $this->model_class_name::model_type();
@@ -68,22 +68,22 @@ 
 
     $pk_values = [];
 
-    if($this->router()->submits())
+    if ($this->router()->submits())
     {
       $this->form_model->import($this->sanitize_post_data($this->router()->submitted()));
       $pk_values = $this->model_class_name::table()->primary_keys_match($this->router()->submitted());
 
       $this->load_model = $this->model_class_name::exists($pk_values);
     }
-    elseif($this->router()->requests())
+    elseif ($this->router()->requests())
     {
       $pk_values = $this->model_class_name::table()->primary_keys_match($this->router()->params());
 
-      if(!is_null($this->load_model = $this->model_class_name::exists($pk_values)))
+      if (!is_null($this->load_model = $this->model_class_name::exists($pk_values)))
         $this->form_model = clone $this->load_model;
     }
 
-    if(!is_null($this->load_model) && is_subclass_of($this->load_model, '\HexMakina\Crudites\Interfaces\TraceableInterface') && $this->load_model->traceable())
+    if (!is_null($this->load_model) && is_subclass_of($this->load_model, '\HexMakina\Crudites\Interfaces\TraceableInterface') && $this->load_model->traceable())
     {
       // $traces = $this->tracer()->traces_by_model($this->load_model);
       $traces = $this->tracer()->history_by_model($this->load_model);
@@ -99,7 +99,7 @@ 
   // ----------- META -----------
   public function class_name() : string
   {
-    if(is_null($this->model_class_name))
+    if (is_null($this->model_class_name))
     {
       $this->model_class_name = get_called_class();
       $this->model_class_name = str_replace('\Controllers\\', '\Models\\', $this->model_class_name);
@@ -112,12 +112,12 @@ 
   public function persist_model($model) : ?ModelInterface
   {
     $this->errors = $model->save($this->operator()->operator_id(), $this->tracer()); // returns [errors]
-    if(empty($this->errors()))
+    if (empty($this->errors()))
     {
       $this->logger()->nice(L('CRUDITES_INSTANCE_ALTERED', [L('MODEL_'.get_class($model)::model_type().'_INSTANCE')]));
       return $model;
     }
-    foreach($this->errors() as $field => $error_msg)
+    foreach ($this->errors() as $field => $error_msg)
       $this->logger()->warning(L($error_msg, [$field]));
 
     return null;
@@ -128,12 +128,12 @@ 
     return $this->listing(); //default dashboard is a listing
   }
 
-  public function listing($model=null,$filters=[],$options=[])
+  public function listing($model = null, $filters = [], $options = [])
   {
     $class_name = is_null($model) ? $this->model_class_name : get_class($model);
 
-    if(!isset($filters['date_start']))  $filters['date_start'] = $this->box('StateAgent')->filters('date_start');
-    if(!isset($filters['date_stop']))   $filters['date_stop'] = $this->box('StateAgent')->filters('date_stop');
+    if (!isset($filters['date_start']))  $filters['date_start'] = $this->box('StateAgent')->filters('date_start');
+    if (!isset($filters['date_stop']))   $filters['date_stop'] = $this->box('StateAgent')->filters('date_stop');
 
     // dd($filters);
     $listing = $class_name::filter($filters);
@@ -144,24 +144,24 @@ 
   public function viewport_listing($class_name, $listing, $listing_template)
   {
     $listing_fields = [];
-    if(empty($listing))
+    if (empty($listing))
     {
-      foreach($class_name::table()->columns() as $column)
+      foreach ($class_name::table()->columns() as $column)
       {
 
-        if(!$column->is_auto_incremented() && !$column->is_hidden())
-          $listing_fields[$column->name()]=L(sprintf('MODEL_%s_FIELD_%s', $class_name::model_type(), $column->name()));
+        if (!$column->is_auto_incremented() && !$column->is_hidden())
+          $listing_fields[$column->name()] = L(sprintf('MODEL_%s_FIELD_%s', $class_name::model_type(), $column->name()));
       }
     }
     else
     {
       $current = current($listing);
-      if(is_object($current))
+      if (is_object($current))
         $current = get_object_vars($current);
 
-      foreach(array_keys($current) as $field)
+      foreach (array_keys($current) as $field)
       {
-        $listing_fields[$field]=L(sprintf('MODEL_%s_FIELD_%s', $class_name::model_type(), $field));
+        $listing_fields[$field] = L(sprintf('MODEL_%s_FIELD_%s', $class_name::model_type(), $field));
       }
 
     }
@@ -183,13 +183,13 @@ 
     $this->edit();
   }
 
-  public function edit(){}
+  public function edit() {}
 
   public function save()
   {
     $model = $this->persist_model($this->form_model);
 
-    if(empty($this->errors()))
+    if (empty($this->errors()))
       $this->route_back($model);
     else
     {
@@ -200,21 +200,21 @@ 
 
   public function before_edit()
   {
-    if(!is_null($this->router()->params('id')) && is_null($this->load_model))
+    if (!is_null($this->router()->params('id')) && is_null($this->load_model))
     {
       $this->logger()->warning(L('CRUDITES_ERR_INSTANCE_NOT_FOUND', [L('MODEL_'.$this->model_class_name::model_type().'_INSTANCE')]));
       $this->router()->hop($this->model_class_name::model_type());
     }
   }
 
-  public function before_save() : array { return [];}
+  public function before_save() : array { return []; }
 
   // default: hop to altered object
-  public function after_save() {$this->router()->hop($this->route_back());}
+  public function after_save() {$this->router()->hop($this->route_back()); }
 
   public function destroy_confirm()
   {
-    if(is_null($this->load_model))
+    if (is_null($this->load_model))
     {
       $this->logger()->warning(L('CRUDITES_ERR_INSTANCE_NOT_FOUND', [L('MODEL_'.$this->model_type.'_INSTANCE')]));
       $this->router()->hop($this->model_type);
@@ -227,12 +227,12 @@ 
 
   public function before_destroy() // default: checks for load_model and immortality, hops back to object on failure
   {
-    if(is_null($this->load_model))
+    if (is_null($this->load_model))
     {
       $this->logger()->warning(L('CRUDITES_ERR_INSTANCE_NOT_FOUND', [L('MODEL_'.$this->model_type.'_INSTANCE')]));
       $this->router()->hop($this->model_type);
     }
-    elseif($this->load_model->immortal())
+    elseif ($this->load_model->immortal())
     {
 
       $this->logger()->warning(L('CRUDITES_ERR_INSTANCE_IS_IMMORTAL', [L('MODEL_'.$this->model_type.'_INSTANCE')]));
@@ -242,10 +242,10 @@ 
 
   public function destroy()
   {
-    if(!$this->router()->submits())
+    if (!$this->router()->submits())
       throw new \Exception('KADRO_ROUTER_MUST_SUBMIT');
 
-    if($this->load_model->destroy($this->operator()->operator_id(), $this->tracer()) === false)
+    if ($this->load_model->destroy($this->operator()->operator_id(), $this->tracer()) === false)
     {
       $this->logger()->info(L('CRUDITES_ERR_INSTANCE_IS_UNDELETABLE', [''.$this->load_model]));
       $this->route_back($this->load_model);
@@ -268,10 +268,10 @@ 
 
     $this->viewport('form_model_type', $this->model_type);
 
-    if(isset($this->load_model))
+    if (isset($this->load_model))
       $this->viewport('load_model', $this->load_model);
 
-    if(isset($this->form_model))
+    if (isset($this->form_model))
       $this->viewport('form_model', $this->form_model);
   }
 
@@ -283,15 +283,15 @@ 
 
     $header = false;
 
-    foreach($collection as $line)
+    foreach ($collection as $line)
     {
       $line = get_object_vars($line);
-      if($header === false)
+      if ($header === false)
       {
-        fputcsv($fp,array_keys($line));
+        fputcsv($fp, array_keys($line));
         $header = true;
       }
-      fputcsv($fp,$line);
+      fputcsv($fp, $line);
     }
     fclose($fp);
 
@@ -301,7 +301,7 @@ 
   public function export()
   {
     $format = $this->router()->params('format');
-    switch($format)
+    switch ($format)
     {
       case null:
         $filename = $this->model_type;
@@ -330,33 +330,33 @@ 
     $route_params = [];
 
     $route_name = get_class($model)::model_type().'_';
-    if($model->is_new())
-      $route_name.= 'new';
+    if ($model->is_new())
+      $route_name .= 'new';
     else
     {
-      $route_name.= 'default';
+      $route_name .= 'default';
       $route_params = ['id' => $model->get_id()];
     }
     $res = $this->router()->prehop($route_name, $route_params);
     return $res;
   }
 
-  public function route_factory($route=null, $route_params=[]) : string
+  public function route_factory($route = null, $route_params = []) : string
   {
-    if(is_null($route) && $this->router()->submits())
+    if (is_null($route) && $this->router()->submits())
       $route = $this->form_model;
 
-    if(!is_null($route) && is_subclass_of($route, '\HexMakina\Crudites\Interfaces\ModelInterface'))
+    if (!is_null($route) && is_subclass_of($route, '\HexMakina\Crudites\Interfaces\ModelInterface'))
       $route = $this->route_model($route);
 
     return parent::route_factory($route, $route_params);
   }
 
-  private function sanitize_post_data($post_data=[])
+  private function sanitize_post_data($post_data = [])
   {
-    foreach($this->model_class_name::table()->columns() as $col)
+    foreach ($this->model_class_name::table()->columns() as $col)
     {
-      if($col->type()->is_boolean())
+      if ($col->type()->is_boolean())
       {
           $post_data[$col->name()] = !empty($post_data[$col->name()]);
       }

Braces +57 added lines, -41 removed lines

@@ -34,9 +34,12 @@ 
       {
         $res = $this->$chainling();
 
-        if($this->logger()->has_halting_messages()) // logger handled a critical error during the chailing execution
+        if($this->logger()->has_halting_messages()) {
+          // logger handled a critical error during the chailing execution
         {
-          break; // dont go on with other
+          break;
+        }
+        // dont go on with other
         }
 
         if($chainling === $method)
@@ -47,19 +50,23 @@ 
       }
     }
 
-    if(method_exists($this, 'conclude')) // conclude always executed, even with has_halting_messages
+    if(method_exists($this, 'conclude')) {
+      // conclude always executed, even with has_halting_messages
     	$this->conclude();
+    }
 
-    if(method_exists($this, 'display'))
-    	$template = $this->display($custom_template);
+    if(method_exists($this, 'display')) {
+        	$template = $this->display($custom_template);
+    }
   }
 
   public function prepare()
   {
     parent::prepare();
 
-    if(!class_exists($this->model_class_name = $this->class_name()))
-      throw new \Exception("!class_exists($this->model_class_name)");
+    if(!class_exists($this->model_class_name = $this->class_name())) {
+          throw new \Exception("!class_exists($this->model_class_name)");
+    }
 
     $this->model_type = $this->model_class_name::model_type();
 
@@ -74,13 +81,13 @@ 
       $pk_values = $this->model_class_name::table()->primary_keys_match($this->router()->submitted());
 
       $this->load_model = $this->model_class_name::exists($pk_values);
-    }
-    elseif($this->router()->requests())
+    } elseif($this->router()->requests())
     {
       $pk_values = $this->model_class_name::table()->primary_keys_match($this->router()->params());
 
-      if(!is_null($this->load_model = $this->model_class_name::exists($pk_values)))
-        $this->form_model = clone $this->load_model;
+      if(!is_null($this->load_model = $this->model_class_name::exists($pk_values))) {
+              $this->form_model = clone $this->load_model;
+      }
     }
 
     if(!is_null($this->load_model) && is_subclass_of($this->load_model, '\HexMakina\Crudites\Interfaces\TraceableInterface') && $this->load_model->traceable())
@@ -117,8 +124,9 @@ 
       $this->logger()->nice(L('CRUDITES_INSTANCE_ALTERED', [L('MODEL_'.get_class($model)::model_type().'_INSTANCE')]));
       return $model;
     }
-    foreach($this->errors() as $field => $error_msg)
-      $this->logger()->warning(L($error_msg, [$field]));
+    foreach($this->errors() as $field => $error_msg) {
+          $this->logger()->warning(L($error_msg, [$field]));
+    }
 
     return null;
   }
@@ -132,8 +140,12 @@ 
   {
     $class_name = is_null($model) ? $this->model_class_name : get_class($model);
 
-    if(!isset($filters['date_start']))  $filters['date_start'] = $this->box('StateAgent')->filters('date_start');
-    if(!isset($filters['date_stop']))   $filters['date_stop'] = $this->box('StateAgent')->filters('date_stop');
+    if(!isset($filters['date_start'])) {
+      $filters['date_start'] = $this->box('StateAgent')->filters('date_start');
+    }
+    if(!isset($filters['date_stop'])) {
+      $filters['date_stop'] = $this->box('StateAgent')->filters('date_stop');
+    }
 
     // dd($filters);
     $listing = $class_name::filter($filters);
@@ -149,15 +161,16 @@ 
       foreach($class_name::table()->columns() as $column)
       {
 
-        if(!$column->is_auto_incremented() && !$column->is_hidden())
-          $listing_fields[$column->name()]=L(sprintf('MODEL_%s_FIELD_%s', $class_name::model_type(), $column->name()));
+        if(!$column->is_auto_incremented() && !$column->is_hidden()) {
+                  $listing_fields[$column->name()]=L(sprintf('MODEL_%s_FIELD_%s', $class_name::model_type(), $column->name()));
+        }
       }
-    }
-    else
+    } else
     {
       $current = current($listing);
-      if(is_object($current))
-        $current = get_object_vars($current);
+      if(is_object($current)) {
+              $current = get_object_vars($current);
+      }
 
       foreach(array_keys($current) as $field)
       {
@@ -189,9 +202,9 @@ 
   {
     $model = $this->persist_model($this->form_model);
 
-    if(empty($this->errors()))
-      $this->route_back($model);
-    else
+    if(empty($this->errors())) {
+          $this->route_back($model);
+    } else
     {
       $this->edit();
       return 'edit';
@@ -231,8 +244,7 @@ 
     {
       $this->logger()->warning(L('CRUDITES_ERR_INSTANCE_NOT_FOUND', [L('MODEL_'.$this->model_type.'_INSTANCE')]));
       $this->router()->hop($this->model_type);
-    }
-    elseif($this->load_model->immortal())
+    } elseif($this->load_model->immortal())
     {
 
       $this->logger()->warning(L('CRUDITES_ERR_INSTANCE_IS_IMMORTAL', [L('MODEL_'.$this->model_type.'_INSTANCE')]));
@@ -242,15 +254,15 @@ 
 
   public function destroy()
   {
-    if(!$this->router()->submits())
-      throw new \Exception('KADRO_ROUTER_MUST_SUBMIT');
+    if(!$this->router()->submits()) {
+          throw new \Exception('KADRO_ROUTER_MUST_SUBMIT');
+    }
 
     if($this->load_model->destroy($this->operator()->operator_id(), $this->tracer()) === false)
     {
       $this->logger()->info(L('CRUDITES_ERR_INSTANCE_IS_UNDELETABLE', [''.$this->load_model]));
       $this->route_back($this->load_model);
-    }
-    else
+    } else
     {
       $this->logger()->nice(L('CRUDITES_INSTANCE_DESTROYED', [L('MODEL_'.$this->model_type.'_INSTANCE')]));
       $this->route_back($this->model_type);
@@ -268,11 +280,13 @@ 
 
     $this->viewport('form_model_type', $this->model_type);
 
-    if(isset($this->load_model))
-      $this->viewport('load_model', $this->load_model);
+    if(isset($this->load_model)) {
+          $this->viewport('load_model', $this->load_model);
+    }
 
-    if(isset($this->form_model))
-      $this->viewport('form_model', $this->form_model);
+    if(isset($this->form_model)) {
+          $this->viewport('form_model', $this->form_model);
+    }
   }
 
   public function collection_to_csv($collection, $filename)
@@ -330,9 +344,9 @@ 
     $route_params = [];
 
     $route_name = get_class($model)::model_type().'_';
-    if($model->is_new())
-      $route_name.= 'new';
-    else
+    if($model->is_new()) {
+          $route_name.= 'new';
+    } else
     {
       $route_name.= 'default';
       $route_params = ['id' => $model->get_id()];
@@ -343,11 +357,13 @@ 
 
   public function route_factory($route=null, $route_params=[]) : string
   {
-    if(is_null($route) && $this->router()->submits())
-      $route = $this->form_model;
+    if(is_null($route) && $this->router()->submits()) {
+          $route = $this->form_model;
+    }
 
-    if(!is_null($route) && is_subclass_of($route, '\HexMakina\Crudites\Interfaces\ModelInterface'))
-      $route = $this->route_model($route);
+    if(!is_null($route) && is_subclass_of($route, '\HexMakina\Crudites\Interfaces\ModelInterface')) {
+          $route = $this->route_model($route);
+    }
 
     return parent::route_factory($route, $route_params);
   }