Model::getTablePrefix() - Code Metrics - Inspection of "Accessing and setting the site config" - Starbugstone/blogoc - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — dev (#47)

by Stone

created 2018-09-05 16:01 UTC

Model::getTablePrefix() A

↳ Parent: Model

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	1
dl	0
loc	6
rs	10
c	0
b	0
f	0

<?php

namespace Core;

use Core\Traits\StringFunctions;
use PDO;

/**
 * Class Model here we have all the generic calls to be inherited by the App\Models
 * using PDO connections
 * @package Core
 *
 * PHP version 7
 */
abstract class Model
{
    use StringFunctions;
    /**
     * @var PDO the database handeler
     */
    protected $dbh;

    /**
     * @var \PDOStatement|boolean the prepared sql statement
     */
    protected $stmt;

    /**
     * @var Container the dependancy injector
     */
    private $container;

    /**
     * Model constructor. prepares the database connection
     * @param Container $container
     */
    public function __construct(Container $container)
    {
        $this->container = $container;
        $this->dbh = $this->container->setPdo();
    }

    /*
     * generic PDO query constructor
     * ---------------------------------------------
     */

    /**
     * creating and storing the query
     * @param $sql string creating the sql query
     */
    protected function query($sql): void
    {
        $this->stmt = $this->dbh->prepare($sql);
    }

    /**
     * binding the parameters to the query. Need the stmt to be declared before via query()
     * @param $param
     * @param $value
     * @param  $type
     * @throws \Exception error if no sql query to bind to
     */
    protected function bind($param, $value, $type = null): void
    {
        if ($this->stmt == null) {
            throw new \Exception("No query to bind to");
        }
        if (is_null($type)) { //need a bind value, so just check it in code. that way we can just call bind(param,value)
            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 our constructed SQL statement
     * @return bool
     * @throws \Exception if the statement is empty
     */
    protected function execute()
    {
        if ($this->stmt == null) {
            throw new \Exception("No statement to execute");
        }
        return $this->stmt->execute();
    }

    /**
     * fetches the result from an executed query
     * @return array
     */
    protected function fetchAll(){
        return $this->stmt->fetchAll();
    }

    /**
     * returns a single line from the executed query
     * @return mixed
     */
    protected function fetch(){
        return $this->stmt->fetch();
    }

    /*
     * END generic PDO query constructor
     * ---------------------------------------------
     */

    /**
     * correlation between the model name and the table name
     * if we don't have a table name, get the table that has the same name as the model will be returned (else, we do nothing !!)
     * Also search if the table exists, if not do a check in the views (must be v_$table)
     * @param string|null $table the name of the table to get, if none the get the table of the models name
     * @return string the table name (with an s)
     * @throws \ReflectionException the model doesn't exist, should never happen
     * @throws \Exception table or view doesn't exist
     * @return string table or view name
     */
    protected function getTable(String $table = null): String
    {
        //If no table is passed, get the calling model name
        if ($table === null) {
            $reflect = new \ReflectionClass(get_class($this));
            $table = $reflect->getShortName(); //this is to only get the model name, otherwise we get the full namespace
            //since our models all end with Model, we should remove it.
            $table = $this->removeFromEnd($table, 'Model');
            $table = $table . 's'; //adding the s since the table should be plural. Might be some special case where the plural isn't just with an s
            $table = strtolower($table); //the database names are in lowercase
        }

        $table = $this->getTablePrefix($table);

        //see if table exists
        $sql = "SHOW TABLES LIKE :table";
        $stmt = $this->dbh->prepare($sql);
        $stmt->bindValue(':table', $table, PDO::PARAM_STR);
        $stmt->execute();
        $exists = $stmt->rowCount() > 0; //will return 1 if table exists or 0 if non existant

        if ($exists) {
            //the table exists
            return $table;
        }

        //if we are here, then table doesn't exist, check for view
        $view = 'v_' . $table;
        $stmt->bindValue(':table', $view, PDO::PARAM_STR);
        $stmt->execute();
        $exists = $stmt->rowCount() > 0; //will return 1 if table exists or 0 if non existant

        if ($exists) {
            //the view exists
            return $view;
        }

        //neither table or view exists
        //throw an error
        throw new \Exception("Table or view $table doesn't exist");
    }

    /**
     * This function adds the table prefix if set and returns the name
     * Use this if we are sure of the table name. Avoids the DB calls
     * @param $table string the table name
     * @return string
     */
    protected function getTablePrefix($table){
        if(Config::TABLE_PREFIX != '')
        {
            $table = Config::TABLE_PREFIX.'_'.$table;
        }
        return $table;
    }

    /**
     * checks if the result from a PDO query has any data.
     * If yes then we return the array
     * If debugging is enabled we throw an exception on no results
     * or we just return an empty array
     * @param mixed $result the PDO result of a query
     * @return array the result or empty
     * @throws \Exception if debugging is on and no result
     */
    private function returnArray($result): array
    {
        if ($result) {
            return $result;
        }
        if (Config::DEV_ENVIRONMENT) {
            throw new \Exception("No results in database");
        }
        return [];
    }

    /**
     * gets the entire table or view and returns the array
     * @param string $table the table to search in, if empty then get the table based on model name
     * @return array the results from database
     * @throws \ReflectionException
     */
    protected function getResultSet($table = null): array
    {
        $tableName = $this->getTable($table);
        $sql = "SELECT * FROM $tableName"; //can not pass table name as :parameter. since we already have tested if the table exists, this var should be safe.
        $this->query($sql);
        $this->execute();
        $result = $this->stmt->fetchAll(); //returns an array or false if no results
        return $this->returnArray($result);
    }

    /**
     * gets the entire table or view and returns the array with a limit to the number of rows
     * @param string $table the table to search in, if empty then get the table based on model name
     * @param string $limit the limit of rows to return
     * @return array the results from database
     * @throws \ReflectionException
     */
    protected function getResultSetLimited($limit, $table = null): array
    {
        $tableName = $this->getTable($table);
        $sql = "SELECT * FROM $tableName LIMIT :limit";
        $this->query($sql);
        $this->bind(':limit', $limit);
        $this->execute();
        $result = $this->stmt->fetchAll(); //returns an array or false if no results
        return $this->returnArray($result);
    }

    /**
     * get's the result of SELECT * FROM table where idtable=$id
     * @param int $rowId searched id
     * @param string $table the table to search, if blank then we get the table or view based on the model name
     * @return array result or empty array
     * @throws \ReflectionException (probably not, but will throw an exception if debugging is on and no results)
     */
    protected function getRowById($rowId, $table = null): array
    {
        $tableName = $this->getTable($table);
        $idName = 'id' . $tableName;
        $sql = "SELECT * FROM $tableName WHERE $idName = :rowId";
        $this->query($sql);
        $this->bind(':rowId', $rowId);
        $this->execute();
        $result = $this->stmt->fetch();
        return $this->returnArray($result);
    }

    /**
     * gets the row from the query SELECT * FROM table WHERE $columnName = $Value
     * @param string $columnName the column to search in. Does a regex check for security
     * @param string $value the value to search for
     * @param string $table the table to search, if blank then we get the table or view based on the model name
     * @return array the results or empty
     * @throws \ReflectionException (probably not, but will throw an exception if debugging is on and no results)
     * @throws \Exception if the column name consists of other characters than lower case, numbers and underscore for security
     */
    protected function getRowByColumn(String $columnName, $value, $table = null): array
    {
        $tableName = $this->getTable($table);
        $columnNameOk = preg_match("/^[a-z0-9_]+$/i", $columnName); //testing if column name only has lower case, numbers and underscore
        if (!$columnNameOk) {
            throw new \Exception("Syntax error : Column name \"$columnName\" is not legal");
        }
        $sql = "SELECT * FROM $tableName WHERE $columnName = :value";
        $this->query($sql);
        $this->bind(':value', $value);
        $this->execute();
        $result = $this->stmt->fetch();
        return $this->returnArray($result);
    }

    /**
     * get's the result of SELECT * FROM table where table_slug=$slug
     * @param string $slug the slug to look up
     * @param string $table the table to search, if blank then we get the table or view based on the model name
     * @return array result or empty array
     * @throws \ReflectionException (probably not, but will throw an exception if debugging is on and no results)
     */
    protected function getRowBySlug(String $slug, $table = null): array
    {
        $tableName = $this->getTable($table);
        $slugName = $tableName.'_slug';
        $sql = "SELECT * FROM $tableName WHERE $slugName = :slug";
        $this->query($sql);
        $this->bind(':slug', $slug);
        $this->execute();
        $result = $this->stmt->fetch();
        return $this->returnArray($result);
    }
}

1			<?php
2
3			namespace Core;
4
5			use Core\Traits\StringFunctions;
6			use PDO;
7
8			/**
9			* Class Model here we have all the generic calls to be inherited by the App\Models
10			* using PDO connections
11			* @package Core
12			*
13			* PHP version 7
14			*/
15			abstract class Model
16			{
17			use StringFunctions;
18			/**
19			* @var PDO the database handeler
20			*/
21			protected $dbh;
22
23			/**
24			* @var \PDOStatement\|boolean the prepared sql statement
25			*/
26			protected $stmt;
27
28			/**
29			* @var Container the dependancy injector
30			*/
31			private $container;
32
33			/**
34			* Model constructor. prepares the database connection
35			* @param Container $container
36			*/
37			public function __construct(Container $container)
38			{
39			$this->container = $container;
40			$this->dbh = $this->container->setPdo();
41			}
42
43			/*
44			* generic PDO query constructor
45			* ---------------------------------------------
46			*/
47
48			/**
49			* creating and storing the query
50			* @param $sql string creating the sql query
51			*/
52			protected function query($sql): void
53			{
54			$this->stmt = $this->dbh->prepare($sql);
55			}
56
57			/**
58			* binding the parameters to the query. Need the stmt to be declared before via query()
59			* @param $param
60			* @param $value
61			* @param $type
62			* @throws \Exception error if no sql query to bind to
63			*/
64			protected function bind($param, $value, $type = null): void
65			{
66			if ($this->stmt == null) {
67			throw new \Exception("No query to bind to");
68			}
69			if (is_null($type)) { //need a bind value, so just check it in code. that way we can just call bind(param,value)
70			switch (true) {
71			case is_int($value):
72			$type = PDO::PARAM_INT;
73			break;
74			case is_bool($value):
75			$type = PDO::PARAM_BOOL;
76			break;
77			case is_null($value):
78			$type = PDO::PARAM_NULL;
79			break;
80			default:
81			$type = PDO::PARAM_STR;
82			}
83			}
84			$this->stmt->bindValue($param, $value, $type);
85			}
86
87			/**
88			* Execute our constructed SQL statement
89			* @return bool
90			* @throws \Exception if the statement is empty
91			*/
92			protected function execute()
93			{
94			if ($this->stmt == null) {
95			throw new \Exception("No statement to execute");
96			}
97			return $this->stmt->execute();
98			}
99
100			/**
101			* fetches the result from an executed query
102			* @return array
103			*/
104			protected function fetchAll(){
105			return $this->stmt->fetchAll();
106			}
107
108			/**
109			* returns a single line from the executed query
110			* @return mixed
111			*/
112			protected function fetch(){
113			return $this->stmt->fetch();
114			}
115
116			/*
117			* END generic PDO query constructor
118			* ---------------------------------------------
119			*/
120
121			/**
122			* correlation between the model name and the table name
123			* if we don't have a table name, get the table that has the same name as the model will be returned (else, we do nothing !!)
124			* Also search if the table exists, if not do a check in the views (must be v_$table)
125			* @param string\|null $table the name of the table to get, if none the get the table of the models name
126			* @return string the table name (with an s)
127			* @throws \ReflectionException the model doesn't exist, should never happen
128			* @throws \Exception table or view doesn't exist
129			* @return string table or view name
130			*/
131			protected function getTable(String $table = null): String
132			{
133			//If no table is passed, get the calling model name
134			if ($table === null) {
135			$reflect = new \ReflectionClass(get_class($this));
136			$table = $reflect->getShortName(); //this is to only get the model name, otherwise we get the full namespace
137			//since our models all end with Model, we should remove it.
138			$table = $this->removeFromEnd($table, 'Model');
139			$table = $table . 's'; //adding the s since the table should be plural. Might be some special case where the plural isn't just with an s
140			$table = strtolower($table); //the database names are in lowercase
141			}
142
143			$table = $this->getTablePrefix($table);
144
145			//see if table exists
146			$sql = "SHOW TABLES LIKE :table";
147			$stmt = $this->dbh->prepare($sql);
148			$stmt->bindValue(':table', $table, PDO::PARAM_STR);
149			$stmt->execute();
150			$exists = $stmt->rowCount() > 0; //will return 1 if table exists or 0 if non existant
151
152			if ($exists) {
153			//the table exists
154			return $table;
155			}
156
157			//if we are here, then table doesn't exist, check for view
158			$view = 'v_' . $table;
159			$stmt->bindValue(':table', $view, PDO::PARAM_STR);
160			$stmt->execute();
161			$exists = $stmt->rowCount() > 0; //will return 1 if table exists or 0 if non existant
162
163			if ($exists) {
164			//the view exists
165			return $view;
166			}
167
168			//neither table or view exists
169			//throw an error
170			throw new \Exception("Table or view $table doesn't exist");
171			}
172
173			/**
174			* This function adds the table prefix if set and returns the name
175			* Use this if we are sure of the table name. Avoids the DB calls
176			* @param $table string the table name
177			* @return string
178			*/
179			protected function getTablePrefix($table){
180			if(Config::TABLE_PREFIX != '')
181			{
182			$table = Config::TABLE_PREFIX.'_'.$table;
183			}
184			return $table;
185			}
186
187			/**
188			* checks if the result from a PDO query has any data.
189			* If yes then we return the array
190			* If debugging is enabled we throw an exception on no results
191			* or we just return an empty array
192			* @param mixed $result the PDO result of a query
193			* @return array the result or empty
194			* @throws \Exception if debugging is on and no result
195			*/
196			private function returnArray($result): array
197			{
198			if ($result) {
199			return $result;
200			}
201			if (Config::DEV_ENVIRONMENT) {
202			throw new \Exception("No results in database");
203			}
204			return [];
205			}
206
207			/**
208			* gets the entire table or view and returns the array
209			* @param string $table the table to search in, if empty then get the table based on model name
210			* @return array the results from database
211			* @throws \ReflectionException
212			*/
213			protected function getResultSet($table = null): array
214			{
215			$tableName = $this->getTable($table);
216			$sql = "SELECT * FROM $tableName"; //can not pass table name as :parameter. since we already have tested if the table exists, this var should be safe.
217			$this->query($sql);
218			$this->execute();
219			$result = $this->stmt->fetchAll(); //returns an array or false if no results
220			return $this->returnArray($result);
221			}
222
223			/**
224			* gets the entire table or view and returns the array with a limit to the number of rows
225			* @param string $table the table to search in, if empty then get the table based on model name
226			* @param string $limit the limit of rows to return
227			* @return array the results from database
228			* @throws \ReflectionException
229			*/
230			protected function getResultSetLimited($limit, $table = null): array
231			{
232			$tableName = $this->getTable($table);
233			$sql = "SELECT * FROM $tableName LIMIT :limit";
234			$this->query($sql);
235			$this->bind(':limit', $limit);
236			$this->execute();
237			$result = $this->stmt->fetchAll(); //returns an array or false if no results
238			return $this->returnArray($result);
239			}
240
241			/**
242			* get's the result of SELECT * FROM table where idtable=$id
243			* @param int $rowId searched id
244			* @param string $table the table to search, if blank then we get the table or view based on the model name
245			* @return array result or empty array
246			* @throws \ReflectionException (probably not, but will throw an exception if debugging is on and no results)
247			*/
248			protected function getRowById($rowId, $table = null): array
249			{
250			$tableName = $this->getTable($table);
251			$idName = 'id' . $tableName;
252			$sql = "SELECT * FROM $tableName WHERE $idName = :rowId";
253			$this->query($sql);
254			$this->bind(':rowId', $rowId);
255			$this->execute();
256			$result = $this->stmt->fetch();
257			return $this->returnArray($result);
258			}
259
260			/**
261			* gets the row from the query SELECT * FROM table WHERE $columnName = $Value
262			* @param string $columnName the column to search in. Does a regex check for security
263			* @param string $value the value to search for
264			* @param string $table the table to search, if blank then we get the table or view based on the model name
265			* @return array the results or empty
266			* @throws \ReflectionException (probably not, but will throw an exception if debugging is on and no results)
267			* @throws \Exception if the column name consists of other characters than lower case, numbers and underscore for security
268			*/
269			protected function getRowByColumn(String $columnName, $value, $table = null): array
270			{
271			$tableName = $this->getTable($table);
272			$columnNameOk = preg_match("/^[a-z0-9_]+$/i", $columnName); //testing if column name only has lower case, numbers and underscore
273			if (!$columnNameOk) {
274			throw new \Exception("Syntax error : Column name \"$columnName\" is not legal");
275			}
276			$sql = "SELECT * FROM $tableName WHERE $columnName = :value";
277			$this->query($sql);
278			$this->bind(':value', $value);
279			$this->execute();
280			$result = $this->stmt->fetch();
281			return $this->returnArray($result);
282			}
283
284			/**
285			* get's the result of SELECT * FROM table where table_slug=$slug
286			* @param string $slug the slug to look up
287			* @param string $table the table to search, if blank then we get the table or view based on the model name
288			* @return array result or empty array
289			* @throws \ReflectionException (probably not, but will throw an exception if debugging is on and no results)
290			*/
291			protected function getRowBySlug(String $slug, $table = null): array
292			{
293			$tableName = $this->getTable($table);
294			$slugName = $tableName.'_slug';
295			$sql = "SELECT * FROM $tableName WHERE $slugName = :slug";
296			$this->query($sql);
297			$this->bind(':slug', $slug);
298			$this->execute();
299			$result = $this->stmt->fetch();
300			return $this->returnArray($result);
301			}
302			}

Starbugstone / blogoc

Pull Request — dev (#47)

Model::getTablePrefix() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like