WIP models and example

Author: likel

src/autoload.php

@@ -5,10 +5,9 @@
  * Sadly we can't use an autoloader here incase the end-user
  * is using one. Multiple autoloaders can cause conflicts
  *
- * Likel/Session/Handler can be called with the friendly name
- * LikelSession, for example:
+ * Likel/Session/Handler can be called like this:
  *
- *      $session = new LikelSession();
+ *      $session = new Likel\Session\Handler();
  *
  * @package     php-simple-sessions
  * @author      Liam Kelly <https://github.com/likel>
@@ -17,10 +16,7 @@
  * @link        https://github.com/likel/php-simple-sessions
  * @version     1.0.0
  */
-namespace Likel\Session;
 
 // Require the models
 require_once(__DIR__ . '/models/Handler.php');
 require_once(__DIR__ . '/models/DB.php');
-
-use Likel\Session\Handler as LikelSession;

src/example.php

@@ -10,6 +10,13 @@
  * @version     1.0.0
  */
 
-require_once('autoload.php');
+ini_set('display_errors', 1);
+ini_set('display_startup_errors', 1);
+error_reporting(E_ALL);
 
-$db = new LikelSession();
+include('autoload.php');
+
+use Likel\Session\Handler as LikelSession;
+
+$session = new LikelSession();
+$session->getSession();

src/ini/credentials.ini

@@ -19,5 +19,5 @@
 host = "localhost"
 username = "root"
 password = "root"
-db_name = "likel_session"
-table_prefix = "likel"
+db_name = "likel_sessions"
+table_prefix = "likel_"

src/models/DB.php

@@ -1,6 +1,8 @@
 <?php
 /**
- * This is the DB object
+ * The database object which helps abstract database functions
+ *
+ * Uses and requires PDO, generally available after PHP 5.1
  *
  * @package     php-simple-sessions
  * @author      Liam Kelly <https://github.com/likel>
@@ -15,142 +17,150 @@ class DB
 {
     private $dbh;
     private $stmt;
+    private $table_prefix;
 
+    /**
+     * Construct the database object
+     *
+     * @param string $credentials_location The location of the credential file
+     * @return void
+     */
     public function __construct($credentials_location = __DIR__ . '/../ini/credentials.ini')
     {
         try {
             $db_credentials = parse_ini_file($credentials_location, true);
-            $this->dbh = loadDatabase($db_credentials["likel_db"]);
-        } catch (Exception $ex) {
+            $this->dbh = $this->loadDatabase($db_credentials["likel_db"]);
+            $this->table_prefix = $db_credentials["likel_db"]["table_prefix"];
+        } catch (\Exception $ex) {
             throw $ex;
         }
     }
 
     private function loadDatabase($credentials) {
-        if(!empty($credentials["likel_db"])){
+        if(!empty($credentials)){
             try {
-                $dsn = 'mysql:host=' . $credentials["likel_db"]['host'] . ';dbname=' . $credentials["likel_db"]['db_name'];
+                $dsn = 'mysql:host=' . $credentials['host'] . ';dbname=' . $credentials['db_name'];
 
                 $options = array(
-                    PDO::ATTR_PERSISTENT    => true,
-                    PDO::ATTR_ERRMODE       => PDO::ERRMODE_EXCEPTION
+                    \PDO::ATTR_PERSISTENT    => true,
+                    \PDO::ATTR_ERRMODE       => \PDO::ERRMODE_EXCEPTION
                 );
 
-                $pdo_object = new PDO($dsn, $credentials["likel_db"]['username'], $credentials["likel_db"]['password'], $options);
+                $pdo_object = new \PDO($dsn, $credentials['username'], $credentials['password'], $options);
 
                 return $pdo_object;
 
-            } catch(PDOException $e) {
-                throw new Exception('An error occured when attempting to connect to the database.');
+            } catch(\PDOException $e) {
+                throw new \Exception($e);
             }
 
         } else {
-            throw new Exception('The credential file could not be located or is empty.');
+            throw new \Exception('The credential file could not be located or is empty.');
         }
     }
 
     /**
-     * Prepare the query from a supplied query string.
+     * Prepare the query from a supplied query string
      */
     public function query($query)
     {
         $this->stmt = $this->dbh->prepare($query);
     }
 
     /**
-     * Bind properties to the statement.
+     * Bind properties to the statement
      * E.G. $DB->bind(':fname', 'Liam');
      */
     public function bind($param, $value, $type = null)
     {
         if (is_null($type)) {
             switch (true) {
                 case is_int($value):
-                    $type = PDO::PARAM_INT;
+                    $type = \PDO::PARAM_INT;
                     break;
                 case is_bool($value):
-                    $type = PDO::PARAM_BOOL;
+                    $type = \PDO::PARAM_BOOL;
                     break;
                 case is_null($value):
-                    $type = PDO::PARAM_NULL;
+                    $type = \PDO::PARAM_NULL;
                     break;
                 default:
-                    $type = PDO::PARAM_STR;
+                    $type = \PDO::PARAM_STR;
             }
         }
 
         $this->stmt->bindValue($param, $value, $type);
     }
 
     /**
-     * Execute the statement.
-     * Use result()/results() for insert queries.
+     * Execute the statement
+     * Use result()/results() for insert queries
      */
     public function execute()
     {
         return $this->stmt->execute();
     }
 
     /**
-     * Return multiple rows.
+     * Return multiple rows
      */
     public function results()
     {
         $this->execute();
-        return $this->stmt->fetchAll(PDO::FETCH_ASSOC);
+        return $this->stmt->fetchAll(\PDO::FETCH_ASSOC);
     }
 
     /**
-     * Return a single row.
+     * Return a single row
      */
     public function result()
     {
         $this->execute();
-        return $this->stmt->fetch(PDO::FETCH_ASSOC);
+        return $this->stmt->fetch(\PDO::FETCH_ASSOC);
     }
 
     /**
-     * Return the row count.
+     * Return the row count
      */
     public function rowCount()
     {
         return $this->stmt->rowCount();
     }
 
     /**
-     * Return if rows exists.
+     * Return if rows exists
      */
     public function rowsExist()
     {
         return $this->rowCount() != 0;
     }
 
     /**
-     * Return the id of the last inserted row.
+     * Return the id of the last inserted row
      */
     public function lastInsertId()
     {
         return $this->dbh->lastInsertId();
     }
 
     /**
-     * Begin a transaction for multiple statements.
+     * Begin a transaction for multiple statements
      */
     public function beginTransaction()
     {
         return $this->dbh->beginTransaction();
     }
 
     /**
-     * Commit the transaction for multiple statements.
+     * Commit the transaction for multiple statements
      */
     public function endTransaction()
     {
         return $this->dbh->commit();
     }
 
     /**
-     * Roll back the transaction.
+     * Roll back the transaction
      */
     public function cancelTransaction()
     {
@@ -160,13 +170,13 @@ public function cancelTransaction()
     /**
      * Return the table name with prefix
      */
-    public function tb($tablename)
+    public function getTableName($table_name)
     {
-        return $this->tableprefix.$tablename;
+        return $this->table_prefix . $table_name;
     }
 
     /**
-     * Dump the statement's current parameters.
+     * Dump the statement's current parameters
      */
     public function dumpStatement()
     {

src/models/Handler.php

@@ -13,32 +13,30 @@
 
 class Handler
 {
-    // Helper variables used in the object
-    private $DB;
+    // Store the database variable
+    private $db;
 
     /**
-     * Construct the FizzBuzz object
-     * Sets up the range, defaults to 1-100 if no range set
+     * Construct the session Handler object
      *
-     * @param int $range_min The minimum range for the sequence
-     * @param int $range_max The maximum range for the sequence
      * @return void
      */
     function __construct()
     {
-        $this->DB = new Likel\Session\DB();
+        $this->db = new DB();
     }
 
     /**
-     * Sets the range for the FizzBuzz test
-     * Expects is_numeric params
      *
-     * @param int $range_min The minimum range for the sequence
-     * @param int $range_max The maximum range for the sequence
-     * @return void
+     *
+     * @return 
      */
-    public function setRange($range_min, $range_max)
+    public function getSession()
     {
+        $this->db->query("
+            SELECT * FROM {$this->db->getTableName("sessions")}
+        ");
 
+        return $this->db->execute();
     }
 }