Bluz\Db\Query\Traits\Set

Complexity

Total Complexity

4

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	set()	0	5	1
A	setArray()	0	6	2
A	prepareSet()	0	3	1

<?php

/**
 * Bluz Framework Component
 *
 * @copyright Bluz PHP Team
 * @link      https://github.com/bluzphp/framework
 */

declare(strict_types=1);

namespace Bluz\Db\Query\Traits;

use Bluz\Proxy\Db;
use PDO;

/**
 * Set Trait
 *
 * Required for:
 *  - Insert Builder
 *  - Update Builder
 *
 * @package  Bluz\Db\Query\Traits
 * @author   Anton Shevchuk
 */
trait Set
{
    /**
     * <code>
     * [
     *     '`firstName` = ?',
     *     '`lastName` = ?'
     * ]
     * </code>
     *
     * @var array
     */
    protected $set = [];

    /**
     * Set key-value pair
     *
     * Sets a new value for a column in a insert/update query
     * <code>
     *     $ub = new UpdateBuilder();
     *     $ub
     *         ->update('users')
     *         ->set('password', md5('password'))
     *         ->where('id = ?');
     * </code>
     *
     * @param  string         $key   The column to set
     * @param  string|integer $value The value, expression, placeholder, etc
     * @param  int            $type  The type of value on of PDO::PARAM_* params
     *
     * @return $this
     */
    public function set(string $key, $value, $type = PDO::PARAM_STR): self
    {
        $this->setParam(null, $value, $type);

It seems like setParam() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->set[] = Db::quoteIdentifier($key) . ' = ?';
        return $this;
    }

    /**
     * Set data from array
     *
     * <code>
     *     $ub = new UpdateBuilder();
     *     $ub
     *         ->update('users')
     *         ->setArray([
     *              'password' => md5('password')
     *              'updated' => date('Y-m-d H:i:s')
     *          ])
     *         ->where('u.id = ?');
     * </code>
     *
     * @param  array $data
     *
     * @return $this
     */
    public function setArray(array $data): self
    {
        foreach ($data as $key => $value) {
            $this->set($key, $value);
        }
        return $this;
    }

    /**
     * Prepare string to apply it inside SQL query
     *
     * @return string
     */
    protected function prepareSet(): string
    {
        return ' SET ' . implode(', ', $this->set);
    }
}