ArekX\PQL\Sql\Query\Update

Complexity

Total Complexity

2

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
A	to()	0	4	1
A	set()	0	4	1

<?php
/**
 * Copyright 2021 Aleksandar Panic
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace ArekX\PQL\Sql\Query;

use ArekX\PQL\Contracts\StructuredQuery;
use ArekX\PQL\Query;
use ArekX\PQL\Sql\Query\Traits\ConditionTrait;
use ArekX\PQL\Sql\Query\Traits\ConfigureTrait;
use ArekX\PQL\Sql\Query\Traits\JoinTrait;

/**
 * Represents a delete query to delete items from the
 * driver.
 */
class Update extends Query
{
    use ConditionTrait;
    use JoinTrait;
    use ConfigureTrait;

    /**
     * Set the destination to which to update data.
     *
     * **SQL Injection Warning**: Value in this function is not usually escaped in the driver
     * and should not be used to pass values from the user input to it. If you need to pass
     * and escape query use Raw query.
     *
     * If a StructuredQuery is passed, it will be additionally parsed according to that type.
     *
     * @param string|StructuredQuery $to Table or other destination to update the data.
     * @return $this
     */
    public function to(StructuredQuery|string $to): static
    {
        $this->use('to', $to);
        return $this;
    }

    /**
     * Set values to be updated.
     *
     * Data accepted is an associative array where key is the column name and value is the value to update.
     *
     * **SQL Injection Warning**: If an array is passed the keys in the array are not escaped
     * meaning they should not be for user input, values are escaped properly and user input
     * can be used for them.
     *
     * @param array|StructuredQuery $data
     * @return $this
     */
    public function set(array|StructuredQuery $data): static
    {
        $this->use('set', $data);
        return $this;
    }
}