Completed src files

Completed src files and added example.

Author: likel

src/autoload.php

@@ -2,7 +2,7 @@
 /**
  * Load the models
  *
- * Sadly we can't use an autoloader here incase the end-user
+ * Sadly we can't use an autoloader here in the case that the end-user
  * is using one. Multiple autoloaders can cause conflicts
  *
  * Likel/Session/Handler can be called like this:
@@ -18,5 +18,5 @@
  */
 
 // Require the models
-require_once(__DIR__ . '/models/Handler.php');
 require_once(__DIR__ . '/models/DB.php');
+require_once(__DIR__ . '/models/Session/Handler.php');

src/example.php

@@ -10,13 +10,41 @@
  * @version     1.0.0
  */
 
-ini_set('display_errors', 1);
-ini_set('display_startup_errors', 1);
-error_reporting(E_ALL);
+header('Content-Type: text/plain');
 
+// Load the scripts, alternatively use a custom PSR-4 autoloader
 include('autoload.php');
 
+// This looks nicer and makes the session Handler easier to call
 use Likel\Session\Handler as LikelSession;
 
+// Create a new session. Example parameters include:
+//      $session = new LikelSession(array(
+//          'session_name' => "YourCustomSessionName",
+//          'credentials_location' => "/path/to/new/credentials.ini",
+//          'secure' => true
+//      ));
 $session = new LikelSession();
-$session->getSession();
+
+// Set some session variables
+if(!isset($session["user_id"])) {
+    $session["user_id"] = 1;
+    $session["name"] = "Liam";
+    $session["preferences"] = array(
+        'language' => 'en-AU'
+    );
+    $_SESSION["test"] = "works";
+}
+
+// Unset our name
+unset($session["name"]);
+
+// Dump some variables and the session
+echo "The session_id is: " . session_id() . PHP_EOL . PHP_EOL;
+echo "The name is (should be blank): " . $session["name"] . PHP_EOL . PHP_EOL;
+echo "The user_id is: " . $session["user_id"] . PHP_EOL . PHP_EOL;
+echo "The preferences are: " . print_r($session["preferences"], true) . PHP_EOL;
+echo "The \$_SESSION variable still: " . $_SESSION["test"] . PHP_EOL . PHP_EOL;
+var_dump($session);
+
+// You should no check the database table to see if a row has been added

src/ini/credentials.ini

@@ -6,7 +6,9 @@
 ;
 ; You can set the .ini path when creating a new LikelSession object like so:
 ;
-;       $session = new LikelSession("/path/to/new/ini/credentials.ini");
+;       $session = new LikelSession(array(
+;           "credentials_location" => "/path/to/new/credentials.ini"
+;       ));
 ;
 ; @package     php-simple-sessions
 ; @author      Liam Kelly <https://github.com/likel>
@@ -21,3 +23,6 @@ username = "root"
 password = "root"
 db_name = "likel_sessions"
 table_prefix = "likel_"
+
+[likel_session]
+secret_hash = "BnFEC}}[CvP_djqM~[sbcXZp`/N:Y3Vu28m9zX~@:[gM,BNTYA]nFwd}>(nJ*hse"

src/models/DB.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * The database object which helps abstract database functions
+ * The database object which helps to abstract database functions
  *
  * Uses and requires PDO, generally available after PHP 5.1
  *
@@ -11,32 +11,41 @@
  * @link        https://github.com/likel/php-simple-sessions
  * @version     1.0.0
  */
-namespace Likel\Session;
+namespace Likel;
 
 class DB
 {
-    private $dbh;
-    private $stmt;
-    private $table_prefix;
+    private $database_handler; // Stores the database connection
+    private $statement; // The MySQL query with prepared values
+    private $table_prefix; // The table prefix from the credentials.ini file
 
     /**
      * 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')
+    public function __construct($credentials_location)
     {
         try {
             $db_credentials = parse_ini_file($credentials_location, true);
-            $this->dbh = $this->loadDatabase($db_credentials["likel_db"]);
+            $this->database_handler = $this->loadDatabase($db_credentials["likel_db"]);
             $this->table_prefix = $db_credentials["likel_db"]["table_prefix"];
         } catch (\Exception $ex) {
             throw $ex;
         }
     }
 
-    private function loadDatabase($credentials) {
+    /**
+     * Attempt to retrieve the likel_db ini array and connect to the database
+     *
+     * @param array $credentials likel_db from the credentials.ini file
+     * @return mixed
+     * @throws \Exception If credentials empty or not found
+     * @throws \PDOException If PDO connection is unsuccessful
+     */
+    private function loadDatabase($credentials)
+    {
         if(!empty($credentials)){
             try {
                 $dsn = 'mysql:host=' . $credentials['host'] . ';dbname=' . $credentials['db_name'];
@@ -51,7 +60,7 @@ private function loadDatabase($credentials) {
                 return $pdo_object;
 
             } catch(\PDOException $e) {
-                throw new \Exception($e);
+                throw new \Exception($e->getMessage());
             }
 
         } else {
@@ -61,15 +70,23 @@ private function loadDatabase($credentials) {
 
     /**
      * Prepare the query from a supplied query string
+     *
+     * @param string $query The prepared query
+     * @return void
      */
     public function query($query)
     {
-        $this->stmt = $this->dbh->prepare($query);
+        $this->statement = $this->database_handler->prepare($query);
     }
 
     /**
      * Bind properties to the statement
      * E.G. $DB->bind(':fname', 'Liam');
+     *
+     * @param string $param The parameter to replace
+     * @param mixed $value The value replacement
+     * @param mixed $type Force the PDO::PARAM type
+     * @return void
      */
     public function bind($param, $value, $type = null)
     {
@@ -89,46 +106,56 @@ public function bind($param, $value, $type = null)
             }
         }
 
-        $this->stmt->bindValue($param, $value, $type);
+        $this->statement->bindValue($param, $value, $type);
     }
 
     /**
      * Execute the statement
      * Use result()/results() for insert queries
+     *
+     * @return bool
      */
     public function execute()
     {
-        return $this->stmt->execute();
+        return $this->statement->execute();
     }
 
     /**
      * Return multiple rows
+     *
+     * @return array
      */
     public function results()
     {
         $this->execute();
-        return $this->stmt->fetchAll(\PDO::FETCH_ASSOC);
+        return $this->statement->fetchAll(\PDO::FETCH_ASSOC);
     }
 
     /**
      * Return a single row
+     *
+     * @return array
      */
     public function result()
     {
         $this->execute();
-        return $this->stmt->fetch(\PDO::FETCH_ASSOC);
+        return $this->statement->fetch(\PDO::FETCH_ASSOC);
     }
 
     /**
      * Return the row count
+     *
+     * @return int
      */
     public function rowCount()
     {
-        return $this->stmt->rowCount();
+        return $this->statement->rowCount();
     }
 
     /**
      * Return if rows exists
+     *
+     * @return bool
      */
     public function rowsExist()
     {
@@ -137,38 +164,49 @@ public function rowsExist()
 
     /**
      * Return the id of the last inserted row
+     *
+     * @return mixed
      */
     public function lastInsertId()
     {
-        return $this->dbh->lastInsertId();
+        return $this->database_handler->lastInsertId();
     }
 
     /**
      * Begin a transaction for multiple statements
+     *
+     * @return bool
      */
     public function beginTransaction()
     {
-        return $this->dbh->beginTransaction();
+        return $this->database_handler->beginTransaction();
     }
 
     /**
      * Commit the transaction for multiple statements
+     *
+     * @return bool
      */
     public function endTransaction()
     {
-        return $this->dbh->commit();
+        return $this->database_handler->commit();
     }
 
     /**
      * Roll back the transaction
+     *
+     * @return bool
      */
     public function cancelTransaction()
     {
-        return $this->dbh->rollBack();
+        return $this->database_handler->rollBack();
     }
 
     /**
      * Return the table name with prefix
+     *
+     * @param string $table_name The table name that's accessed
+     * @return string
      */
     public function getTableName($table_name)
     {
@@ -177,9 +215,11 @@ public function getTableName($table_name)
 
     /**
      * Dump the statement's current parameters
+     *
+     * @return void
      */
     public function dumpStatement()
     {
-        return $this->stmt->debugDumpParams();
+        $this->statement->debugDumpParams();
     }
 }