Add the class PreparedQueryStatement

Class used for prepared queries

Author: na2axl

src/JSONDB/PreparedQueryStatement.php

@@ -0,0 +1,144 @@
+<?php
+
+    /**
+     * JSONDB - JSON Database Manager
+     *
+     * Manage local databases with JSON files and JSON Query Language (JQL)
+     *
+     * This content is released under the MIT License (MIT)
+     *
+     * Copyright (c) 2016, Centers Technologies
+     *
+     * Permission is hereby granted, free of charge, to any person obtaining a copy
+     * of this software and associated documentation files (the "Software"), to deal
+     * in the Software without restriction, including without limitation the rights
+     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+     * copies of the Software, and to permit persons to whom the Software is
+     * furnished to do so, subject to the following conditions:
+     *
+     * The above copyright notice and this permission notice shall be included in
+     * all copies or substantial portions of the Software.
+     *
+     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+     * THE SOFTWARE.
+     *
+     * @package    JSONDB
+     * @author     Nana Axel
+     * @copyright  Copyright (c) 2016, Centers Technologies
+     * @license    http://opensource.org/licenses/MIT MIT License
+     * @filesource
+     */
+
+    namespace JSONDB;
+
+    /**
+     * Class PreparedQueryStatement
+     *
+     * @package     JSONDB
+     * @subpackage  Utilities
+     * @category    Query
+     * @author      Nana Axel
+     */
+    class PreparedQueryStatement
+    {
+        /**
+         * The JSONDB instance
+         * @var JSONDB
+         */
+        private $database;
+
+        /**
+         * The query string.
+         * @var string
+         */
+        private $queryString;
+
+        /**
+         * An array of keys inserted in the
+         * query.
+         * @var array
+         */
+        private $preparedQueryKeys = array();
+
+        /**
+         * PreparedQueryStatement __constructor.
+         * @param string $query
+         * @param JSONDB $database
+         */
+        public function __construct($query, &$database)
+        {
+            $this->queryString = $query;
+            $this->database = &$database;
+
+            $this->_prepareQuery();
+        }
+
+        /**
+         * Binds a value in a prepared query.
+         * @param string $key The parameter's key
+         * @param string|int|bool $value The parameter's value
+         * @param int $parse_method The parse method to use
+         * @throws Exception
+         */
+        public function bindValue($key, $value, $parse_method = JSONDB::PARAM_STRING)
+        {
+            if ($this->database->queryIsPrepared()) {
+                if (in_array($key, $this->preparedQueryKeys, TRUE)) {
+                    switch ($parse_method) {
+                        default:
+                        case JSONDB::PARAM_STRING:
+                            $value = JSONDB::quote((string)$value);
+                            break;
+
+                        case JSONDB::PARAM_INT:
+                            $value = (int)$value;
+                            break;
+
+                        case JSONDB::PARAM_BOOL:
+                            $value = ((string)((int)$value)) . ':JSONDB::TO_BOOL:';
+                            break;
+
+                        case JSONDB::PARAM_NULL:
+                            $value = (string)$value . ':JSONDB::TO_NULL:';
+                            break;
+                    }
+                    $this->queryString = str_replace($key, $value, $this->queryString);
+                } else {
+                    throw new Exception("JSONDB Error: Can't bind the value \"{$value}\" for the key \"{$key}\". The key isn't in the query.");
+                }
+            } else {
+                throw new Exception("JSONDB Error: Can't use JSONDB::bindValue() with non prepared queries. Send your query with JSONDB::prepare() first.");
+            }
+        }
+
+        /**
+         * Execute the prepared query
+         * @throws Exception
+         * @return mixed
+         */
+        public function execute()
+        {
+            if ($this->database->queryIsPrepared()) {
+                return $this->database->query($this->queryString);
+            } else {
+                throw new Exception("JSONDB Error: Can't execute the prepared query. There is no prepared query to execute or the prepared query is already executed.");
+            }
+        }
+
+        /**
+         * Prepare a query
+         * @return PreparedQueryStatement
+         */
+        private function _prepareQuery()
+        {
+            $query = $this->queryString;
+            preg_match_all('#(:[\w]+)#', $query, $keys);
+            $this->preparedQueryKeys = $keys[0];
+        }
+
+    }