View System 2

Author: afnx

app/controllers/p404Controller.php

@@ -10,7 +10,6 @@
 namespace AFN\App\Controllers;
 
 use AFN\App\Core\Controller;
-use AFN\App\Models\Localization;
 
 /**
  * 404 Not Found Page
@@ -19,8 +18,6 @@
  */
 class p404Controller extends Controller {
     public function show_404() {
-        $layout = $this->get_layout('404.php');
-        $loc = new Localization();
-        echo $loc->translate($layout);
+
     }
 }

app/core/Model.php

@@ -1,6 +1,6 @@
 <?php
 
-/*
+/**
  * This file was created by AFN.
  * If you think that there is a notifiable issue
  * affecting the file, please contact AFN.
@@ -18,31 +18,87 @@
  */
 class Model {
 
-    private $db;
+    /**
+     * Stores database id from config file
+     * @var integer
+     */
+    private $dbno;
+
+    /**
+     * Stores database connection
+     * @var object
+     */
     private $conn;
+
+    /**
+     * Stores number of records after an operation
+     * @var integer
+     */
     public $recordcount;
+
+    /**
+     * Stores the name of table that will be called
+     * @var string
+     */
     public $table;
 
+    /**
+     * Makes a database connection by using the credential in the config file
+     * The credential is chosen according to database id
+     * @param integer $dbno database id
+     */
     public function __construct($dbno = 1) {
         try {
+            // Check if ROOT_DIR is defined then use it or add it manually for the config file path
             if(!defined(ROOT_DIR)) {
                 $db_dir = realpath(__DIR__ . '/../..') . '/config/database.php';
             } else {
                 $db_dir = ROOT_DIR . '/config/database.php';
             }
 
+            // Include the database config file
             $database = require_once $db_dir;
 
+            // Run database connection with PDO and pass it to the variable
             $this->conn = new PDO($database[$dbno]["DSN"], $database[$dbno]["USERNAME"], $database[$dbno]["PASSWORD"], [
                 PDO::ATTR_EMULATE_PREPARES => false,
                 PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
                 PDO::MYSQL_ATTR_INIT_COMMAND => 'SET sql_mode="NO_BACKSLASH_ESCAPES"'
             ]);
         } catch(PDOException $e) {
+            // If the process fails, throw an error
             echo $e->getMessage();
         }
     }
 
+    /**
+     * Passes the given value to the given property
+     * @param string $property
+     * @param mixed $value
+     */
+    public function __set($property, $value) {
+        $this->$property = $value;
+    }
+
+    /**
+     * Returns value of the property if it is defined
+     * @param string $property
+     * @return mixed
+     */
+    public function __get($property) {
+        if(isset($this->$property)) {
+            return $this->$property;
+        }
+    }
+
+    /**
+     * Executes the given query with its parameters as an array
+     * Besides, it calculates record count of the query and pass it to a public variable
+     * @param string $query The query that will be executed
+     * @param array $params The Parameters that will be inserted to the query
+     * @param boolean $count The parameter that will decide as to whether or not to calculate record count
+     * @return boolean
+     */
     public function execute_on_query($query, array $params = [], $count = FALSE) {
         $stmt = $this->conn->prepare($query);
         try {
@@ -59,10 +115,19 @@ public function execute_on_query($query, array $params = [], $count = FALSE) {
         }
     }
 
+    /**
+     * @param object $stmt
+     * @return array
+     */
     public function get_num_rows($stmt) {
         return (is_resource($stmt) ? $stmt->fetchColumn() : 0);
     }
 
+    /**
+     * Fetches all column names of the given table as an array
+     * @param string $tableName
+     * @return boolean or array
+     */
     public function get_columns_name(string $tableName = "") {
         if(!empty($this->table) || !empty($tableName)) {
             $tname = isset($tableName) ? $tableName : $this->table;
@@ -77,6 +142,11 @@ public function get_columns_name(string $tableName = "") {
         }
     }
 
+    /**
+     * Prepares data according to JSON format
+     * @param array $array
+     * @return string
+     */
     public function json_turkish(array $array) {
         foreach($array as $record) {
             foreach($record as $key => $og) {
@@ -90,6 +160,11 @@ public function json_turkish(array $array) {
         return $result;
     }
 
+    /**
+     * Fetches data with given id from the database and passes it to properties
+     * @param integer $ID The row id of the expected content in the database
+     * @return string The Error
+     */
     public function refresh($ID) {
         if(is_numeric($ID)) {
             $query = "SELECT * FROM " . $this->table . " WHERE " . key($this) . " = :id";
@@ -101,7 +176,7 @@ public function refresh($ID) {
                 return 'ERROR: ' . $error[2];
             } else {
                 $result = $stmt->fetch(PDO::FETCH_BOTH);
-                if($result) {
+                if(isset($result)) {
                     foreach($result as $name => $value) {
                         $this->$name = $value;
                     }
@@ -110,6 +185,12 @@ public function refresh($ID) {
         }
     }
 
+    /**
+     * Executes given query to fetch data and then passes data to properties
+     * @param string $query The query that will be executed
+     * @param array $params The Parameters that will be inserted to the query
+     * @return string The error or nothing
+     */
     public function refresh_procedure($query, array $params = []) {
         if($query != "") {
             $stmt = $this->conn->prepare($query);
@@ -127,8 +208,11 @@ public function refresh_procedure($query, array $params = []) {
         }
     }
 
+    /**
+     * Returns property names and property values of child classes as JSON format
+     * @return string The property names and property values as JSON format
+     */
     public function to_json() {
-
         $classItems = get_object_vars($this);
         $json = "{";
         foreach($classItems as $key => $val) {
@@ -141,19 +225,33 @@ public function to_json() {
         return $json;
     }
 
+    /**
+     * The save function
+     * The function deals two different situation. If the row id not exists,the function insert
+     * the given data by adding new row to the table. However, if it exists, the function updates the row
+     * by using new data.
+     * @return int
+     */
     public function save() {
+        // Get class properties and pass them
         $classitems = get_object_vars($this);
+
+        // Get column names
         $columns = $this->get_columns_name();
 
+        // Create needed arrays
         $data_fields = [];
         $data_names = [];
         $params = [];
 
+        // Push names and values of properties to arrays if property names does not match column names
         foreach($classitems as $claskey => $clasval) {
             foreach($columns as $colkey => $colval) {
                 if($claskey == $colval) {
                     $data_fields[] = $colval;
                     $data_names[] = ":" . $colval;
+
+                    // Determine the form of NULL according to numericalness of $classval
                     if(is_numeric($clasval)) {
                         $params[":" . $colval] = str_replace("'on'", "True", str_replace("'NULL'", "NULL", is_null($clasval) ? "NULL" : $clasval));
                     } else {
@@ -163,8 +261,10 @@ public function save() {
             }
         }
 
+        // Begin the transaction
         $this->conn->beginTransaction();
 
+        // If the id exists, the process is updating. However, if not, the process is inserting.
         if(!is_numeric($this->ID) || $this->ID == 0) {
             $sql = "INSERT INTO " . $this->table . " (" . implode(",", $data_fields) . ") VALUES " . implode(',', $data_names);
         } else {
@@ -179,36 +279,45 @@ public function save() {
             $sql .= " WHERE ID=:ID";
         }
 
+        // Prepare a statement for above execution
         $stmt = $this->conn->prepare($sql);
 
         try {
 
             $stmt->execute($params);
 
+            // Get last inserted id after inserting process or get the id of updated row
             if(substr($sql, 0, 6) == "INSERT") {
                 $operation = 1;
-                $last_insert = $this->conn->lastInsertId();
+                $last_insert_id = $this->conn->lastInsertId();
             } else {
                 $operation = 2;
-                $last_insert = $this->ID;
+                $last_insert_id = $this->ID;
             }
 
-            // history operation
+            // History operation will be here soon
             // $this->new_history($lastInsert, $operation);
 
-            return $last_insert;
+            return $last_insert_id;
         } catch(PDOException $e) {
+            // If the execution fails, throw an error
             echo $e->getMessage();
             return 0;
         }
+
+        // Send all to database
         $this->conn->commit();
     }
 
+    /**
+     * Generate a globally unique identifier
+     * @return string
+     */
     public function custom_create_guid() {
         if(function_exists('com_create_guid')) {
             return com_create_guid();
         } else {
-            mt_srand((double) microtime() * 10000); // optional for php 4.2.0 and up.
+            mt_srand((double) microtime() * 10000); // Optional for php 4.2.0 and up.
             $charid = strtoupper(md5(uniqid(rand(), true)));
             $hyphen = chr(45); // "-"
             $uuid = ""// "{"
@@ -222,27 +331,43 @@ public function custom_create_guid() {
         }
     }
 
+    /**
+     * Deletes a record in the database according to the given id
+     * @param type $force 0 permanent deleting, 1 recoverable deleting
+     * @return boolean The result of operation
+     */
     public function delete($force = 0) {
+        // Check requested operation and run it
         if($force == 1) {
+            // Permanent deleting
             $sql = "DELETE FROM " . $this->table . " WHERE " . key($this) . "=:ID";
         } else {
+            // Recoverable deleting
             $sql = "UPDATE " . $this->table . " SET isDeleted=1 WHERE " . key($this) . "=:ID";
         }
 
+        // Prepare a statement for execution
         $stmt = $this->conn->prepare($sql);
+
+        // Send id of record that will be deleted
         $stmt->bindParam(':ID', $this->ID, PDO::PARAM_INT);
 
         try {
             $stmt->execute();
-            // history operation
+            // History operation will be here soon
             // $this->new_history($this->ID, 3);
             return TRUE;
         } catch(PDOException $e) {
+            // If the execution fails, throw an error
             echo $e->getMessage();
             return FALSE;
         }
     }
 
+    /**
+     * Deletes all records in the given table
+     * @return boolean
+     */
     public function delete_all() {
         $sql = "DELETE FROM " . $this->table;
         $stmt = $this->conn->prepare($sql);
@@ -252,28 +377,16 @@ public function delete_all() {
             // $this->new_history($this->ID, 3);
             return TRUE;
         } catch(PDOException $e) {
+            // If the execution fails, throw an error
             echo $e->getMessage();
             return FALSE;
         }
     }
 
-    public function new_history($ID, $operation, $userID = 0) {
-        //operation 1-New 2-Update 3-Delete
-        $sql = "INSER INTO History (tableName,tableID,userID,operation,updated) VALUES (':table',:ID,:userID,:operation,NOW())";
-        $stmt = $this->conn->prepare($sql);
-        $stmt->bindParam(':table', $this->table, PDO::PARAM_STR);
-        $stmt->bindParam(':ID', $ID, PDO::PARAM_INT);
-        $stmt->bindParam(':userID', $userID, PDO::PARAM_INT);
-        $stmt->bindParam(':operation', $operation, PDO::PARAM_INT);
-        try {
-            $stmt->execute();
-            return TRUE;
-        } catch(PDOException $e) {
-            echo $e->getMessage();
-            return FALSE;
-        }
-    }
-
+    /**
+     * Returns the count of records in the given table
+     * @return integer The count of records
+     */
     public function table_record_count() {
         $query = "SELECT COUNT(*) FROM " . $this->table;
         $result = $this->conn->query($query)->fetchColumn();
@@ -338,4 +451,28 @@ public function fetch_column($query, array $params = [], $count = FALSE) {
         }
     }
 
+    /*
+     * History operation will be in use soon
+     * @param type $ID
+     * @param type $operation
+     * @param type $userID
+     * @return boolean
+
+      public function new_history($ID, $operation, $userID = 0) {
+      //operation 1-New 2-Update 3-Delete
+      $sql = "INSER INTO History (tableName,tableID,userID,operation,updated) VALUES (':table',:ID,:userID,:operation,NOW())";
+      $stmt = $this->conn->prepare($sql);
+      $stmt->bindParam(':table', $this->table, PDO::PARAM_STR);
+      $stmt->bindParam(':ID', $ID, PDO::PARAM_INT);
+      $stmt->bindParam(':userID', $userID, PDO::PARAM_INT);
+      $stmt->bindParam(':operation', $operation, PDO::PARAM_INT);
+      try {
+      $stmt->execute();
+      return TRUE;
+      } catch(PDOException $e) {
+      echo $e->getMessage();
+      return FALSE;
+      }
+      }
+     */
 }