XoopsDatabaseManager::isConnectable() - Code Metrics - Inspection of "Merge pull request #558 from geekwright/xmfuuid" - XOOPS/XoopsCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d0941c...c232a4 )

by Richard

created 2018-01-10 22:09 UTC

XoopsDatabaseManager::isConnectable() A

↳ Parent: XoopsDatabaseManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	2
nc	2
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	0
cts	2
cp	0
crap	6

<?php
/**
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

/**
 * Database manager for XOOPS
 *
 * PHP version 5.3
 *
 * @category  Xoops\Class\Database\Manager
 * @package   Manager
 * @author    Haruki Setoyama  <[email protected]>
 * @copyright 2013 XOOPS Project (http://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @version   Release: 2.6
 * @link      http://xoops.org
 * @since     2.6.0
 */

class XoopsDatabaseManager
{
    /**
     * @var array
     */
    private $s_tables = array();

    /**
     * @var array
     */
    private $f_tables = array();

    /**
     * @var XoopsDatabase
     */
    public $db;

    /**
     * @var array
     */
    public $successStrings = array();

    /**
     * @var array
     */
    public $failureStrings = array();

    /**
     *Construct declaration
     */
    public function __construct()
    {
        $xoops = Xoops::getInstance();
        $xoops->db();
        global $xoopsDB;
function myFunction($a, $b) {
    // Do something
}
        $this->db = $xoopsDB;
        $this->db->setPrefix(\XoopsBaseConfig::get('db-prefix'));
        $this->successStrings = array(
            'create' => XoopsLocale::SF_TABLE_CREATED,
            'insert' => XoopsLocale::SF_ENTRIES_INSERTED_TO_TABLE,
            'alter'  => XoopsLocale::SF_TABLE_UPDATED,
            'drop'   => XoopsLocale::SF_TABLE_DROPPED,
        );
        $this->failureStrings = array(
            'create' => XoopsLocale::EF_TABLE_NOT_CREATED,
            'insert' => XoopsLocale::EF_ENTRIES_NOT_INSERTED_TO_TABLE,
            'alter'  => XoopsLocale::EF_TABLE_NOT_UPDATED,
            'drop'   => XoopsLocale::EF_TABLE_NOT_DROPPED,
        );
    }

    /**
     * Is the database connectable?
     *
     * @return bool is it connectable?
     */
    public function isConnectable()
    {
        return ($this->db->connect(false) != false) ? true : false;

    }

    /**
     * Checks if a database exists
     *
     * @return bool returns if exists
     */
    public function dbExists()
    {
        return ($this->db->connect() != false) ? true : false;

    }

    /**
     * creates a database table
     *
     * @return bool return if successful
     */
    public function createDB()
    {
        $this->db->connect(false);


        $result = $this->db->query("CREATE DATABASE " . \XoopsBaseConfig::get('db-name'));


        return ($result != false) ? true : false;
    }

    /**
     * Loads a query from a file
     *
     * @param string $sql_file_path name of file to read
     * @param bool   $force         weither to force the query or not
     *
     * @return bool
     */
    public function queryFromFile($sql_file_path, $force = false)
    {
        if (!XoopsLoad::fileExists($sql_file_path)) {
            return false;
        }
        $queryFunc = (bool)$force ? "queryF" : "query";
        $sql_query = trim(fread(fopen($sql_file_path, 'r'), filesize($sql_file_path)));
        SqlUtility::splitMySqlFile($pieces, $sql_query);
        $this->db->connect();

        foreach ($pieces as $piece) {
            $piece = trim($piece);
            // [0] contains the prefixed query
            // [4] contains unprefixed table name
            $prefixed_query = SqlUtility::prefixQuery($piece, $this->db->prefix());

            if ($prefixed_query != false) {
                $table = $this->db->prefix($prefixed_query[4]);

                if ($prefixed_query[1] === 'CREATE TABLE') {
                    if ($this->db->$queryFunc($prefixed_query[0]) != false) {
                        if (!isset($this->s_tables['create'][$table])) {
                            $this->s_tables['create'][$table] = 1;
                        }
                    } else {
                        if (!isset($this->f_tables['create'][$table])) {
                            $this->f_tables['create'][$table] = 1;
                        }
                    }
                } else {
                    if ($prefixed_query[1] === 'INSERT INTO') {
                        if ($this->db->$queryFunc($prefixed_query[0]) != false) {
                            if (!isset($this->s_tables['insert'][$table])) {
                                $this->s_tables['insert'][$table] = 1;
                            } else {
                                $this->s_tables['insert'][$table]++;
                            }
                        } else {
                            if (!isset($this->f_tables['insert'][$table])) {
                                $this->f_tables['insert'][$table] = 1;
                            } else {
                                $this->f_tables['insert'][$table]++;
                            }
                        }
                    } else {
                        if ($prefixed_query[1] === 'ALTER TABLE') {
                            if ($this->db->$queryFunc($prefixed_query[0]) != false) {
                                if (!isset($this->s_tables['alter'][$table])) {
                                    $this->s_tables['alter'][$table] = 1;
                                }
                            } else {
                                if (!isset($this->s_tables['alter'][$table])) {
                                    $this->f_tables['alter'][$table] = 1;
                                }
                            }
                        } else {
                            if ($prefixed_query[1] === 'DROP TABLE') {
                                if ($this->db->$queryFunc('DROP TABLE ' . $table) != false) {
                                    if (!isset($this->s_tables['drop'][$table])) {
                                        $this->s_tables['drop'][$table] = 1;
                                    }
                                } else {
                                    if (!isset($this->s_tables['drop'][$table])) {
                                        $this->f_tables['drop'][$table] = 1;
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
        return true;
    }

    /**
     * returns a report
     *
     * @return string
     */
    public function report()
    {
        $commands = array('create', 'insert', 'alter', 'drop');
        $content = '<ul class="log">';
        foreach ($commands as $cmd) {
            if (!@empty($this->s_tables[$cmd])) {
                foreach ($this->s_tables[$cmd] as $key => $val) {
                    $content .= '<li class="success">';
                    $content .= ($cmd !== 'insert')
                        ? sprintf($this->successStrings[$cmd], $key)
                        : sprintf($this->successStrings[$cmd], $val, $key);
                    $content .= "</li>\n";
                }
            }
        }
        foreach ($commands as $cmd) {
            if (!@empty($this->f_tables[$cmd])) {
                foreach ($this->f_tables[$cmd] as $key => $val) {
                    $content .= '<li class="failure">';
                    $content .= ($cmd !== 'insert')
                        ? sprintf($this->failureStrings[$cmd], $key)
                        : sprintf($this->failureStrings[$cmd], $val, $key);
                    $content .= "</li>\n";
                }
            }
        }
        $content .= '</ul>';
        return $content;
    }

    /**
     * runs a query
     *
     * @param string $sql sql statement to perform
     *
     * @return resource
     */
    public function query($sql)
    {
        $this->db->connect();

        return $this->db->query($sql);

    }

    /**
     * Setup prefix table
     *
     * @param string $table table to prefix
     *
     * @return string prefixed table
     */
    public function prefix($table)
    {
        $this->db->connect();

        return $this->db->prefix($table);

    }

    /**
     * fetches an array
     *
     * @param string $ret resource that was returned from query
     *
     * @return array returns the array
     */
    public function fetchArray($ret)
    {
        $this->db->connect();

        return $this->db->fetchArray($ret);

    }

    /**
     * Inserts into a table
     *
     * @param string $table table to insert into
     * @param string $query query to use to insert
     *
     * @return bool|void
     */
    public function insert($table, $query)
    {
        $this->db->connect();

        $table = $this->db->prefix($table);

        $query = 'INSERT INTO ' . $table . ' ' . $query;
        if (!$this->db->queryF($query)) {

            if (!isset($this->f_tables['insert'][$table])) {
                $this->f_tables['insert'][$table] = 1;
            } else {
                $this->f_tables['insert'][$table]++;
            }
            return false;
        } else {
            if (!isset($this->s_tables['insert'][$table])) {
                $this->s_tables['insert'][$table] = 1;
            } else {
                $this->s_tables['insert'][$table]++;
            }
            return $this->db->getInsertId();

        }
    }

    /**
     * return the error
     *
     * @return bool
     */
    public function isError()
    {
        return (isset($this->f_tables)) ? true : false;
    }

    /**
     * Deletes tables
     *
     * No callers found in core. foreach loop is suspect, using key and value for
     * a list of tables? No docs or examples about what it is supposed to do.
     *
     * @param array $tables table to delete
     *
     * @return array list of dropped tables
     */
    public function deleteTables($tables)
    {
        $deleted = array();
        $this->db->connect();

        foreach ($tables as $key => $val) {
            //was: if (!$this->db->query("DROP TABLE " . $this->db->prefix($key))) {
            if (!$this->db->query("DROP TABLE " . $this->db->prefix($val))) {

                $deleted[] = $val;
            }
        }
        return $deleted;
    }

    /**
     * Checks to see if table exists
     *
     * @param string $table name of database table looking for
      *
     * @return bool true if exists or false if doesnt
     */
    public function tableExists($table)
    {
        $table = trim($table);
        $ret = false;
        if ($table != '') {
            $this->db->connect();

            $sql = 'SELECT COUNT(*) FROM ' . $this->db->prefix($table);

            $ret = (false != $this->db->query($sql)) ? true : false;

        }
        return $ret;
    }

    /**
     * This method allows to copy fields from one table to another
     *
     * @param array  $fieldsMap  Map of the fields
     *                           ex: array('oldfieldname' => 'newfieldname');
     * @param string $oTableName Old Table
     * @param string $nTableName New Table
     * @param bool   $dropTable  Drop old Table
     *
     * @return this does not return anything
     */
    public function copyFields(
        $fieldsMap,
        $oTableName,
        $nTableName,
        $dropTable = false
    ) {
        $sql = "SHOW COLUMNS FROM " . $this->db->prefix($oTableName);

        $result = $this->db->queryF($sql);

        if (($rows = $this->db->getRowsNum($result)) == count($fieldsMap)) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $sql = "SELECT * FROM " . $this->db->prefix($oTableName);

            $result = $this->db->queryF($sql);

            while ($myrow = $this->db->fetchArray($result)) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
                ksort($fieldsMap);
                ksort($myrow);
                $sql = "INSERT INTO `" . $this->db->prefix($nTableName)

                    . "` " . "(`" . implode("`,`", $fieldsMap) . "`)" .
                    " VALUES ('" . implode("','", $myrow) . "')";

                $this->db->queryF($sql);

            }
            if ($dropTable) {
                $sql = "DROP TABLE " . $this->db->prefix($oTableName);

                $this->db->queryF($sql);

            }
        }
    }
}


Push — master ( d0941c...c232a4 )

XoopsDatabaseManager::isConnectable() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
2			/**
3			* You may not change or alter any portion of this comment or credits
4			* of supporting developers from this source code or any supporting source code
5			* which is considered copyrighted (c) material of the original comment or credit authors.
6			*
7			* This program is distributed in the hope that it will be useful,
8			* but WITHOUT ANY WARRANTY; without even the implied warranty of
9			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10			*/
11
12			/**
13			* Database manager for XOOPS
14			*
15			* PHP version 5.3
16			*
17			* @category Xoops\Class\Database\Manager
18			* @package Manager
19			* @author Haruki Setoyama <[email protected]>
20			* @copyright 2013 XOOPS Project (http://xoops.org)
21			* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
22			* @version Release: 2.6
23			* @link http://xoops.org
24			* @since 2.6.0
25			*/
26
27			class XoopsDatabaseManager
28			{
29			/**
30			* @var array
31			*/
32			private $s_tables = array();
33
34			/**
35			* @var array
36			*/
37			private $f_tables = array();
38
39			/**
40			* @var XoopsDatabase

XOOPS / XoopsCore

Push — master ( d0941c...c232a4 )

XoopsDatabaseManager::isConnectable() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like