danielgp\common_lib\MySQLiMultipleExecution

Complexity

Total Complexity

30

Size/Duplication

Total Lines	191
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	handleFeatures()	0	9	3
A	getMySQLgenericInformations()	0	6	2
A	handleFeaturesSingle()	0	16	4
A	establishDefaultEnumSet()	0	7	1
A	fixTableSource()	0	15	4
A	executeMultipleRepetitiveValues()	0	16	4
A	getMySqlCurrentDatabase()	0	4	1
A	glueDbTb()	0	3	1
A	setVariableTypeForMySqlStatements()	0	11	4
A	getTwoDecimalsNumber()	0	6	2
A	setVariableTypeForMySqlStatementsMany()	0	7	2
A	handleMySqlVersionConsistenly()	0	8	2

<?php

/**
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Daniel Popiniuc
 *
 * 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.
 *
 */

namespace danielgp\common_lib;

/**
 * Useful functions to get quick MySQL content
 *
 * @author Daniel Popiniuc
 */
trait MySQLiMultipleExecution
{

    protected $mySQLconnection = null;

    protected function executeMultipleRepetitiveValues($qry, $prmtrs)
    {
        $stmt = $this->mySQLconnection->stmt_init();
        if ($stmt->prepare($qry)) {
            foreach ($prmtrs as $vParams) {
                $paramType = $this->setVariableTypeForMySqlStatementsMany($vParams);
                $aParams   = [];
                $aParams[] = &$paramType;
                for ($counter = 0; $counter < $stmt->param_count; $counter++) {
                    $aParams[] = &$vParams[$counter];
                }
                call_user_func_array([$stmt, 'bind_param'], $aParams);
                $stmt->execute();
            }
            $stmt->close();
            return '';
        }
    }

    /**
     * Establishes the defaults for ENUM or SET field
     *
     * @param string $fldType
     * @return array
     */
    protected function establishDefaultEnumSet($fldType)
    {
        $dfltArray = [
            'enum' => ['additional' => ['size' => 1], 'suffix' => ''],
            'set'  => ['additional' => ['size' => 5, 'multiselect'], 'suffix' => '[]'],
        ];
        return $dfltArray[$fldType];
    }

    /**
     * Adjust table name with proper sufix and prefix
     *
     * @param string $refTbl
     * @return string
     */
    protected function fixTableSource($refTbl)
    {
        $outS = [];
        if (substr($refTbl, 0, 1) !== '`') {
            $outS[] = '`';
        }
        $psT = strpos($refTbl, '.`');
        if ($psT !== false) {
            $refTbl = substr($refTbl, $psT + 2, strlen($refTbl) - $psT);
        }
        $outS[] = $refTbl;
        if (substr($refTbl, -1) !== '`') {
            $outS[] = '`';
        }
        return implode('', $outS);
    }

    /**
     * returns the list of all MySQL generic information
     *
     * @return array
     */
    protected function getMySQLgenericInformations()
    {
        if (is_null($this->mySQLconnection)) {
            return [];
        }
        return ['Info' => $this->mySQLconnection->server_info, 'Version' => $this->handleMySqlVersionConsistenly()];
    }

    protected function getMySqlCurrentDatabase()
    {
        $result = $this->mySQLconnection->query('SELECT DATABASE();');
        return $result->fetch_row()[0];
    }

    /**
     * Glues Database and Table into 1 single string
     *
     * @param string $dbName
     * @param string $tbName
     * @return string
     */
    protected function glueDbTb($dbName, $tbName)
    {
        return '`' . $dbName . '`.`' . $tbName . '`';
    }

    /**
     * Manages features flag
     *
     * @param string $fieldName
     * @param array $features
     * @return array
     */
    protected function handleFeatures($fieldName, $features)
    {
        $rOly  = $this->handleFeaturesSingle($fieldName, $features, 'readonly');
        $rDbld = $this->handleFeaturesSingle($fieldName, $features, 'disabled');
        $rNl   = [];
        if (isset($features['include_null']) && in_array($fieldName, $features['include_null'])) {
            $rNl = ['include_null'];
        }
        return array_merge([], $rOly, $rDbld, $rNl);
    }

    /**
     * Handles the features
     *
     * @param string $fieldName
     * @param array $features
     * @param string $featureKey
     * @return array
     */
    private function handleFeaturesSingle($fieldName, $features, $featureKey)
    {
        $fMap    = [
            'readonly' => ['readonly', 'class', 'input_readonly'],
            'disabled' => ['disabled']
        ];
        $aReturn = [];
        if (array_key_exists($featureKey, $features)) {
            if (array_key_exists($fieldName, $features[$featureKey])) {
                $aReturn[$featureKey][$fMap[$featureKey][0]] = $fMap[$featureKey][0];
                if (count($fMap[$featureKey]) > 1) {
                    $aReturn[$featureKey][$fMap[$featureKey][1]] = $fMap[$featureKey][2];
                }
            }
        }
        return $aReturn;
    }

    /**
     * Ensures a consistent output of version for MySQL as well as MariaDB
     *
     * @return string
     */
    private function handleMySqlVersionConsistenly()
    {
        if (substr($this->mySQLconnection->server_info, -7) === 'MariaDB') {
            $strVersionParts = explode('.', explode('-', $this->mySQLconnection->server_info)[1]);
            return $this->getTwoDecimalsNumber($strVersionParts[0]) . $this->getTwoDecimalsNumber($strVersionParts[1])

$strVersionParts[0] of type string is incompatible with the type danielgp\common_lib\type expected by parameter $inNumber of danielgp\common_lib\MySQLiMultipleExecution::getTwoDecimalsNumber().

                . $this->getTwoDecimalsNumber($strVersionParts[2]);
        }
        return $this->mySQLconnection->server_version;
    }

    /**
     *
     * @param type $inNumber

The type danielgp\common_lib\type was not found. Maybe you did not declare it correctly or list all dependencies?

     * @return string
     */
    private function getTwoDecimalsNumber($inNumber)
    {
        if ($inNumber < 10) {
            return '0' . $inNumber;
        }
        return $inNumber;
    }

    /**
     * Detects what kind of variable has been transmitted
     * to return the identifier needed by MySQL statement preparing
     *
     * @return string
     */
    protected function setVariableTypeForMySqlStatements($variabaleValue)
    {
        $sReturn = 'b';
        if (is_int($variabaleValue)) {
            $sReturn = 'i';
        } elseif (is_double($variabaleValue)) {
            $sReturn = 'd';
        } elseif (is_string($variabaleValue)) {
            $sReturn = 's';
        }
        return $sReturn;
    }

    protected function setVariableTypeForMySqlStatementsMany($variabales)
    {
        $types = [];
        foreach ($variabales as $value2) {
            $types[] = $this->setVariableTypeForMySqlStatements($value2);
        }
        return implode('', $types);
    }
}