BfwSql\SqlActions

Complexity

Total Complexity

53

Size/Duplication

Total Lines	508
Duplicated Lines	8.66 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getSqlConnect()	0	4	1
A	setIsPreparedRequest()	0	6	1
A	getPreparedRequestArgs()	0	4	1
A	getPrepareDriversOptions()	0	4	1
A	setPrepareDriversOptions()	0	6	1
A	isAssembled()	0	8	2
	assembleRequest()	0	1	?
A	assemble()	0	8	3
B	executeQuery()	0	28	3
B	execute()	0	22	5
A	closeCursor()	0	4	1
A	obtainImpactedRows()	0	13	3
A	query()	0	4	1
A	where()	0	10	2
A	addPreparedFilters()	0	6	2
A	generateWhere()	0	20	4
A	addDatasForColumns()	0	18	4
B	addQuotedColumns()	22	22	5
B	addNotQuotedColumns()	22	22	5
B	quoteValue()	0	26	6
A	callObserver()	0	6	1

<?php

namespace BfwSql;

use \Exception;

/**
 * Abstract class used for all query writer class.
 * 
 * @package bfw-sql
 * @author Vermeulen Maxime <bulton.fr@gmail.com>
 * @version 2.0
 */
abstract class SqlActions
{
    /**
     * @const QUOTE_ALL To automatic quote all string values.
     * Used by SqlInsert and SqlUpdate.
     */
    const QUOTE_ALL = 'all';
    
    /**
     * @const QUOTE_ALL To not automatic quote string values.
     * Used by SqlInsert and SqlUpdate.
     */
    const QUOTE_NONE = 'none';
    
    /**
     * @const QUOTE_ALL To automatic quote string values only for somes columns
     * Used by SqlInsert and SqlUpdate.
     */
    const QUOTE_PARTIALLY = 'partially';
    
    /**
     * @var \BfwSql\SqlConnect $sqlConnect SqlConnect object
     */
    protected $sqlConnect;
    
    /**
     * @var string $assembledRequest The request will be executed
     */
    protected $assembledRequest = '';
    
    /**
     * @var boolean $isPreparedRequest If is a prepared request
     */
    protected $isPreparedRequest = true;
    
    /**
     * @var string $tableName The main table name for request
     */
    protected $tableName = '';
    
    /**
     * @var array $columns List of impacted columns by the request
     */
    protected $columns = array();
    
    /**
     * @var string $quoteStatus The current automic quote status.
     */
    protected $quoteStatus = self::QUOTE_ALL;
    
    /**
     * @var array $quotedColumns List of columns where value will be quoted if
     * is string.
     */
    protected $quotedColumns = [];
    
    /**
     * @var array $notQuotedColumns List of columns where value will not be
     * quoted if is string.
     */
    protected $notQuotedColumns = [];
    
    /**
     * @var string[] $where All filter use in where part of the request
     */
    protected $where = array();
    
    /**
     * @var string[] $preparedRequestArgs Arguments used by prepared request
     */
    protected $preparedRequestArgs = array();
    
    /**
     * @var array $prepareDriversOptions SGBD driver option used for
     *  prepared request
     * 
     * @link http://php.net/manual/en/pdo.prepare.php
     */
    protected $prepareDriversOptions = array();
    
    /**
     * @var boolean $noResult If request has sent no result.
     */
    protected $noResult = false;
    
    /**
     * @var \PDOStatement $lastRequestStatement The PDOStatement pour the
     *  last request executed.
     */
    protected $lastRequestStatement;
    
    /**
     * Constructor
     * 
     * @param \BfwSql\SqlConnect $sqlConnect Instance of SGBD connexion
     */
    public function __construct(\BfwSql\SqlConnect $sqlConnect)
    {
        $this->sqlConnect = $sqlConnect;
    }
    
    /**
     * Getter to access at sqlConnect property
     * 
     * @return \BfwSql\SqlConnect
     */
    public function getSqlConnect()
    {
        return $this->sqlConnect;
    }
    
    /**
     * Setter to enable or disable prepared request
     * 
     * @param boolean $preparedRequestStatus The new status for prepared request
     * 
     * @return \BfwSql\SqlActions
     */
    public function setIsPreparedRequest($preparedRequestStatus)
    {
        $this->isPreparedRequest = (bool) $preparedRequestStatus;
        
        return $this;
    }
    
    /**
     * Getter to access at preparedRequestArgs property
     * 
     * @return array
     */
    public function getPreparedRequestArgs()
    {
        return $this->preparedRequestArgs;
    }
    
    /**
     * Getter to access at prepareDriversOptions property
     * 
     * @return array
     */
    public function getPrepareDriversOptions()
    {
        return $this->prepareDriversOptions;
    }
    
    /**
     * Define driver options to prepared request
     * 
     * @link http://php.net/manual/fr/pdo.prepare.php
     * 
     * @param array $driverOptions Drivers options
     * 
     * @return \BfwSql\SqlActions
     */
    public function setPrepareDriversOptions($driverOptions)
    {
        $this->prepareDriversOptions = $driverOptions;
        
        return $this;
    }
    
    /**
     * Check if a request is assemble or not.
     * If not, run the method assembleRequest.
     * 
     * @return boolean
     */
    public function isAssembled()
    {
        if ($this->assembledRequest === '') {
            return false;
        }
        
        return true;
    }
    
    /**
     * Write the query
     * 
     * @return void
     */
    protected abstract function assembleRequest();
    
    /**
     * Return the assembled request
     * 
     * @param boolean $force : Force to re-assemble request
     * 
     * @return string
     */
    public function assemble($force = false)
    {
        if ($this->isAssembled() === false || $force === true) {
            $this->assembleRequest();
        }
        
        return $this->assembledRequest;
    }
    
    /**
     * Execute the assembled request
     * 
     * @return array The pdo errorInfo array
     */
    protected function executeQuery()
    {
        $pdo = $this->sqlConnect->getPDO();
        $this->sqlConnect->upNbQuery();
        $this->assemble();
        
        if ($this->isPreparedRequest) {
            $req = $pdo->prepare(
                $this->assembledRequest,
                $this->prepareDriversOptions
            );
            
            $req->execute($this->preparedRequestArgs);
            $error = $req->errorInfo();
        } else {
            $pdoMethodToCall = 'exec';
            if ($this instanceof \BfwSql\SqlSelect) {
                $pdoMethodToCall = 'query';
            }
            
            $req   = $pdo->{$pdoMethodToCall}($this->assembledRequest);
            $error = $pdo->errorInfo();
        }
        
        $this->lastRequestStatement = $req;
        
        return $error;
    }
    
    /**
     * Execute the assembled request and check if there are errors
     * Update property noResult
     * 
     * @throws \Exception If the request fail
     * 
     * @return \PDOStatement|integer
     */
    public function execute()
    {
        $error = $this->executeQuery();
        
        //Throw an exception if they are an error with the request
        if ($error[0] !== null && $error[0] !== '00000') {
            throw new Exception($error[2]);
        }
        
        if ($this->lastRequestStatement === false) {
            throw new Exception(
                'An error occurred during the execution of the request'
            );
        }
        
        $this->noResult = false;
        if ($this->obtainImpactedRows() === 0) {
            $this->noResult = true;
        }

        return $this->lastRequestStatement;
    }
    
    /**
     * Closes the cursor, enabling the statement to be executed again.
     * 
     * @link http://php.net/manual/fr/pdostatement.closecursor.php
     * 
     * @return void
     */
    public function closeCursor()
    {
        return $this->lastRequestStatement->closeCursor();
    }
    
    /**
     * Return the number of impacted rows by the last request
     * 
     * @return int|bool
     */
    public function obtainImpactedRows()
    {
        if (is_object($this->lastRequestStatement)) {
            //If pdo::query or pdo::prepare
            return $this->lastRequestStatement->rowCount();
        } elseif (is_integer($this->lastRequestStatement)) {
            //If pdo::exec
            return $this->lastRequestStatement;
        }
        
        //Security if call without executed a request
        return false;
    }
    
    /**
     * To call this own request without use query writer
     * 
     * @param string $request The user request
     * 
     * @return void
     */
    public function query($request)
    {
        $this->assembledRequest = $request;
    }
    
    /**
     * Add a filter to where part of the request
     * 
     * @param string     $filter          The filter to add
     * @param array|null $preparedFilters (default: null) Filters to add
     *  in prepared request
     * 
     * @throws \Exception If key on prepared request is already used
     * 
     * @return \BfwSql\SqlActions
     */
    public function where($filter, $preparedFilters = null)
    {
        $this->where[] = $filter;
        
        if (is_array($preparedFilters)) {
            $this->addPreparedFilters($preparedFilters);
        }
        
        return $this;
    }
    
    /**
     * Add filters to prepared requests
     * 
     * @param array $preparedFilters Filters to add in prepared request
     * 
     * @return void
     */
    protected function addPreparedFilters($preparedFilters)
    {
        foreach ($preparedFilters as $prepareKey => $prepareValue) {
            $this->preparedRequestArgs[$prepareKey] = $prepareValue;
        }
    }
    
    /**
     * Write the where part of a sql query and return it
     * 
     * @return string
     */
    protected function generateWhere()
    {
        $where = '';
        
        //check if there are filters to write
        if (count($this->where) > 0) {
            $where = ' WHERE ';
            
            foreach ($this->where as $filter) {
                
                if ($where != ' WHERE ') {
                    $where .= ' AND ';
                }
                
                $where .= $filter;
            } 
        }
        
        return $where;
    }
    
    /**
     * Add datas to insert or update for a column.
     * Used by UPDATE and INSERT requests
     * 
     * @param array $columns Datas to add or update
     *  Format : array('sqlColumnName' => 'valueForThisColumn', ...);
     * 
     * @return \BfwSql\SqlActions
     */
    public function addDatasForColumns(array $columns)
    {
        foreach ($columns as $columnName => $data) {
            if (
                isset($this->columns[$columnName])
                && $this->columns[$columnName] != $data
            ) {
                throw new \Exception(
                    'A different data is already declared for the column '
                    .$columnName
                );
            }
            
            $this->columns[$columnName] = $data;
        }
        
        return $this;
    }
    
    /**
     * Declare columns should be automatic quoted if value is string.
     * 
     * @param string ...$columns Columns name
     * 
     * @throws Exception If the column is already declared to be not quoted
     * 
     * @return \BfwSql\SqlActions
     */
    public function addQuotedColumns(...$columns)

This method seems to be duplicated in your project.

    {
        if ($this instanceof SqlSelect || $this instanceof SqlDelete) {
            throw new Exception(
                'Sorry, automatic quoted value is not supported into '
                .get_called_class().' class'
            );
        }
        
        foreach ($columns as $columnName) {
            if (isset($this->notQuotedColumns[$columnName])) {
                throw new Exception(
                    'The column '.$columnName.' is already declared to be a'
                    .' not quoted value.'
                );
            }
            
            $this->quotedColumns[$columnName] = true;
        }
        
        return $this;
    }
    
    /**
     * Declare columns should not be automatic quoted if value is string.
     * 
     * @param string ...$columns Columns name
     * 
     * @throws Exception If the column is already declared to be quoted
     * 
     * @return \BfwSql\SqlActions
     */
    public function addNotQuotedColumns(...$columns)

This method seems to be duplicated in your project.

    {
        if ($this instanceof SqlSelect || $this instanceof SqlDelete) {
            throw new Exception(
                'Sorry, automatic quoted value is not supported into '
                .get_called_class().' class'
            );
        }
        
        foreach ($columns as $columnName) {
            if (isset($this->quotedColumns[$columnName])) {
                throw new Exception(
                    'The column '.$columnName.' is already declared to be a'
                    .' quoted value.'
                );
            }
            
            $this->notQuotedColumns[$columnName] = true;
        }
        
        return $this;
    }
    
    /**
     * Quote a value if need, else return the value passed in parameter
     * 
     * @param string $columnName The column corresponding to the value
     * @param string $value      The value to quote
     * 
     * @return string
     */
    protected function quoteValue($columnName, $value)
    {
        if ($this->quoteStatus === self::QUOTE_NONE) {
            return $value;
        }
        
        /**
         * If the status allow to quote partially, check if the column is
         * not declared to be quoted or is declared to be not quote.
         */
        if (
            (
                !isset($this->quotedColumns[$columnName])
                || isset($this->notQuotedColumns[$columnName])
            )
            && $this->quoteStatus === self::QUOTE_PARTIALLY
        ) {
            return $value;
        }
        
        if (!is_string($value)) {
            return $value;
        }
        
        return '"'.$value.'"';
    }
    
    /**
     * Send a notify to application observers
     * 
     * @return void
     */
    protected function callObserver()
    {
        $app = \BFW\Application::getInstance();
        $app->setContext($this);
        $app->notifyAction('BfwSqlRequest');
    }
}