Initial commit of major files

Author: likel

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

src/autoload.php

@@ -0,0 +1,26 @@
+<?php
+/**
+ * Load the models
+ *
+ * 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:
+ *
+ *      $session = new LikelSession();
+ *
+ * @package     php-simple-sessions
+ * @author      Liam Kelly <https://github.com/likel>
+ * @copyright   2017 Liam Kelly
+ * @license     MIT License <https://github.com/likel/fizz-buzz/blob/master/LICENSE>
+ * @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

@@ -0,0 +1,20 @@
+<?php
+/**
+ * The index file, we can run our code from here
+ *
+ * A program which prints numbers from 1 to 100 with the following conditions:
+ *    multiples of 3 print "Fizz" instead of the number
+ *    multiples of 5 print "Buzz" instead of the number
+ *    multiples of 3 & 5 print "FizzBuzz"
+ *
+ * @package     fizz-buzz
+ * @author      Liam Kelly <https://github.com/likel>
+ * @copyright   2017 Liam Kelly
+ * @license     https://github.com/likel/fizz-buzz/blob/master/LICENSE GPL-3.0 License
+ * @link        https://github.com/likel/fizz-buzz
+ * @version     1.0.0
+ */
+
+require_once('autoload.php');
+
+$db = new LikelSession();

src/ini/credentials.ini

@@ -0,0 +1,23 @@
+; This .ini file stores the database credentials
+;
+; Make sure that you set these variables when you install the package on your
+; environment. It is highly suggested that you move this .ini file to a location
+; not accessible to the public
+;
+; You can set the .ini path when creating a new LikelSession object like so:
+;
+;       $session = new LikelSession("/path/to/new/ini/credentials.ini");
+;
+; @package     php-simple-sessions
+; @author      Liam Kelly <https://github.com/likel>
+; @copyright   2017 Liam Kelly
+; @license     MIT License <https://github.com/likel/fizz-buzz/blob/master/LICENSE>
+; @link        https://github.com/likel/php-simple-sessions
+; @version     1.0.0
+
+[likel_db]
+host = "localhost"
+username = "root"
+password = "root"
+db_name = "likel_session"
+table_prefix = "likel"

src/models/DB.php

@@ -0,0 +1,175 @@
+<?php
+/**
+ * This is the DB object
+ *
+ * @package     php-simple-sessions
+ * @author      Liam Kelly <https://github.com/likel>
+ * @copyright   2017 Liam Kelly
+ * @license     MIT License <https://github.com/likel/fizz-buzz/blob/master/LICENSE>
+ * @link        https://github.com/likel/php-simple-sessions
+ * @version     1.0.0
+ */
+namespace Likel\Session;
+
+class DB
+{
+    private $dbh;
+    private $stmt;
+
+    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) {
+            throw $ex;
+        }
+    }
+
+    private function loadDatabase($credentials) {
+        if(!empty($credentials["likel_db"])){
+            try {
+                $dsn = 'mysql:host=' . $credentials["likel_db"]['host'] . ';dbname=' . $credentials["likel_db"]['db_name'];
+
+                $options = array(
+                    PDO::ATTR_PERSISTENT    => true,
+                    PDO::ATTR_ERRMODE       => PDO::ERRMODE_EXCEPTION
+                );
+
+                $pdo_object = new PDO($dsn, $credentials["likel_db"]['username'], $credentials["likel_db"]['password'], $options);
+
+                return $pdo_object;
+
+            } catch(PDOException $e) {
+                throw new Exception('An error occured when attempting to connect to the database.');
+            }
+
+        } else {
+            throw new Exception('The credential file could not be located or is empty.');
+        }
+    }
+
+    /**
+     * Prepare the query from a supplied query string.
+     */
+    public function query($query)
+    {
+        $this->stmt = $this->dbh->prepare($query);
+    }
+
+    /**
+     * 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;
+                    break;
+                case is_bool($value):
+                    $type = PDO::PARAM_BOOL;
+                    break;
+                case is_null($value):
+                    $type = PDO::PARAM_NULL;
+                    break;
+                default:
+                    $type = PDO::PARAM_STR;
+            }
+        }
+
+        $this->stmt->bindValue($param, $value, $type);
+    }
+
+    /**
+     * Execute the statement.
+     * Use result()/results() for insert queries.
+     */
+    public function execute()
+    {
+        return $this->stmt->execute();
+    }
+
+    /**
+     * Return multiple rows.
+     */
+    public function results()
+    {
+        $this->execute();
+        return $this->stmt->fetchAll(PDO::FETCH_ASSOC);
+    }
+
+    /**
+     * Return a single row.
+     */
+    public function result()
+    {
+        $this->execute();
+        return $this->stmt->fetch(PDO::FETCH_ASSOC);
+    }
+
+    /**
+     * Return the row count.
+     */
+    public function rowCount()
+    {
+        return $this->stmt->rowCount();
+    }
+
+    /**
+     * Return if rows exists.
+     */
+    public function rowsExist()
+    {
+        return $this->rowCount() != 0;
+    }
+
+    /**
+     * Return the id of the last inserted row.
+     */
+    public function lastInsertId()
+    {
+        return $this->dbh->lastInsertId();
+    }
+
+    /**
+     * Begin a transaction for multiple statements.
+     */
+    public function beginTransaction()
+    {
+        return $this->dbh->beginTransaction();
+    }
+
+    /**
+     * Commit the transaction for multiple statements.
+     */
+    public function endTransaction()
+    {
+        return $this->dbh->commit();
+    }
+
+    /**
+     * Roll back the transaction.
+     */
+    public function cancelTransaction()
+    {
+        return $this->dbh->rollBack();
+    }
+
+    /**
+     * Return the table name with prefix
+     */
+    public function tb($tablename)
+    {
+        return $this->tableprefix.$tablename;
+    }
+
+    /**
+     * Dump the statement's current parameters.
+     */
+    public function dumpStatement()
+    {
+        return $this->stmt->debugDumpParams();
+    }
+}

src/models/Handler.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * This is the session handler
+ *
+ * @package     php-simple-sessions
+ * @author      Liam Kelly <https://github.com/likel>
+ * @copyright   2017 Liam Kelly
+ * @license     MIT License <https://github.com/likel/fizz-buzz/blob/master/LICENSE>
+ * @link        https://github.com/likel/php-simple-sessions
+ * @version     1.0.0
+ */
+namespace Likel\Session;
+
+class Handler
+{
+    // Helper variables used in the object
+    private $DB;
+
+    /**
+     * Construct the FizzBuzz object
+     * Sets up the range, defaults to 1-100 if no range set
+     *
+     * @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();
+    }
+
+    /**
+     * 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
+     */
+    public function setRange($range_min, $range_max)
+    {
+
+    }
+}