Xoops\Core\Database\QueryBuilder

Complexity

Total Complexity

9

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

46.43%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	deletePrefix()	0	5	1
A	updatePrefix()	0	5	1
A	insertPrefix()	0	5	1
A	fromPrefix()	0	5	1
A	joinPrefix()	0	5	1
A	innerJoinPrefix()	0	5	1
A	leftJoinPrefix()	0	5	1
A	rightJoinPrefix()	0	5	1

<?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.
 */

namespace Xoops\Core\Database;

use Xoops\Core\Database\Connection;

/**
 * Connection wrapper for Doctrine DBAL Connection
 *
 * PHP version 5.3
 *
 * @category  Xoops\Core\Database\QueryBuilder
 * @package   QueryBuilder
 * @author    readheadedrod <redheadedrod@hotmail.com>
 * @author    Richard Griffith <richard@geekwright.com>
 * @copyright 2013-2015 XOOPS Project (http://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @version   Release: 2.6.0
 * @link      http://xoops.org
 * @since     2.6.0
 */
class QueryBuilder extends \Doctrine\DBAL\Query\QueryBuilder
{

    /**
     * @var Connection DBAL Connection
     */
    private $connection = null;

    /**
     * __construct
     */
    public function __construct(Connection $connection)
    {
        $this->connection = $connection;
        parent::__construct($connection);
    }

    /**
     * Turns the query being built into a bulk delete query that ranges over
     * a certain table.
     *
     * <code>
     *     $qb = $conn->createQueryBuilder()
     *         ->delete('users', 'u')
     *         ->where('u.id = :user_id');
     *         ->setParameter(':user_id', 1);
     * </code>
     *
     * @param string $delete The table whose rows are subject to the deletion.
     * Adds table prefix to table.
     * @param string $alias  The table alias used in the constructed query.
     *
     * @return QueryBuilder This QueryBuilder instance.
     */
    public function deletePrefix($delete = null, $alias = null)
    {
        $delete = $this->connection->prefix($delete);
        return $this->delete($delete, $alias);
    }

    /**
     * Turns the query being built into a bulk update query that ranges over
     * a certain table
     *
     * <code>
     *     $qb = $conn->createQueryBuilder()
     *         ->update('users', 'u')
     *         ->set('u.password', md5('password'))
     *         ->where('u.id = ?');
     * </code>
     *
     * @param string $update The table whose rows are subject to the update.
     * Adds table prefix to table.
     * @param string $alias  The table alias used in the constructed query.
     *
     * @return QueryBuilder This QueryBuilder instance.
     */
    public function updatePrefix($update = null, $alias = null)
    {
        $update = $this->connection->prefix($update);
        return $this->update($update, $alias);
    }

    /**
     * Turns the query being built into an insert query that inserts into
     * a certain table
     *
     * <code>
     *     $qb = $conn->createQueryBuilder()
     *         ->insert('users')
     *         ->values(
     *             array(
     *                 'name' => '?',
     *                 'password' => '?'
     *             )
     *         );
     * </code>
     *
     * @param string $insert The table into which the rows should be inserted.
     *                       Adds table prefix to table.
     *
     * @return QueryBuilder This QueryBuilder instance.
     */
    public function insertPrefix($insert = null)
    {
        $insert = $this->connection->prefix($insert);
        return $this->insert($insert);
    }

    /**
     * Create and add a query root corresponding to the table identified by the
     * given alias, forming a cartesian product with any existing query roots.
     *
     * <code>
     *     $qb = $conn->createQueryBuilder()
     *         ->select('u.id')
     *         ->from('users', 'u')
     * </code>
     *
     * @param string      $from  The table. Adds table prefix to table.
     * @param string|null $alias The alias of the table.
     *
     * @return QueryBuilder This QueryBuilder instance.
     */
    public function fromPrefix($from, $alias = null)
    {
        $from = $this->connection->prefix($from);
        return $this->from($from, $alias);
    }

    /**
     * Creates and adds a join to the query.
     *
     * <code>
     *     $qb = $conn->createQueryBuilder()
     *         ->select('u.name')
     *         ->from('users', 'u')
     *         ->join('u', 'phonenumbers', 'p', 'p.is_primary = 1');
     * </code>
     *
     * @param string $fromAlias The alias that points to a from clause
     * @param string $join      The table name to join. Adds table prefix to table.
     * @param string $alias     The alias of the join table
     * @param string $condition The condition for the join
     *
     * @return QueryBuilder This QueryBuilder instance.
     */
    public function joinPrefix($fromAlias, $join, $alias, $condition = null)
    {
        $join = $this->connection->prefix($join);
        return $this->join($fromAlias, $join, $alias, $condition);
    }


    /**
     * Creates and adds a join to the query.
     *
     * <code>
     *     $qb = $conn->createQueryBuilder()
     *         ->select('u.name')
     *         ->from('users', 'u')
     *         ->innerJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
     * </code>
     *
     * @param string $fromAlias The alias that points to a from clause
     * @param string $join      The table name to join. Adds table prefix to table.
     * @param string $alias     The alias of the join table
     * @param string $condition The condition for the join
     *
     * @return QueryBuilder This QueryBuilder instance.
     */
    public function innerJoinPrefix($fromAlias, $join, $alias, $condition = null)
    {
        $join = $this->connection->prefix($join);
        return $this->innerJoin($fromAlias, $join, $alias, $condition);
    }

    /**
     * Creates and adds a left join to the query.
     *
     * <code>
     *     $qb = $conn->createQueryBuilder()
     *         ->select('u.name')
     *         ->from('users', 'u')
     *         ->leftJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
     * </code>
     *
     * @param string $fromAlias The alias that points to a from clause
     * @param string $join      The table name to join. Adds table prefix to table.
     * @param string $alias     The alias of the join table
     * @param string $condition The condition for the join
     *
     * @return QueryBuilder This QueryBuilder instance.
     */
    public function leftJoinPrefix($fromAlias, $join, $alias, $condition = null)
    {
        $join = $this->connection->prefix($join);
        return $this->leftJoin($fromAlias, $join, $alias, $condition);
    }

    /**
     * Creates and adds a right join to the query.
     *
     * <code>
     *     $qb = $conn->createQueryBuilder()
     *         ->select('u.name')
     *         ->from('users', 'u')
     *         ->rightJoin('u', 'phonenumbers', 'p', 'p.is_primary = 1');
     * </code>
     *
     * @param string $fromAlias The alias that points to a from clause
     * @param string $join      The table name to join. Adds table prefix to table.
     * @param string $alias     The alias of the join table
     * @param string $condition The condition for the join
     *
     * @return QueryBuilder This QueryBuilder instance.
     */
    public function rightJoinPrefix($fromAlias, $join, $alias, $condition = null)
    {
        $join = $this->connection->prefix($join);
        return $this->rightJoin($fromAlias, $join, $alias, $condition);
    }
}