InsertQueryBuilder.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\Rdbms;
 
use InvalidArgumentException;
use UnexpectedValueException;
 
class InsertQueryBuilder {
    private $table = '';
 
    private $rows = [];
 
    private $caller = __CLASS__;
 
    private $upsert = false;
 
    private $set = [];
 
    private $uniqueIndexFields = [];
 
    protected $options = [];
 
    protected $db;
 
    public function __construct( IDatabase $db ) {
        $this->db = $db;
    }
 
    public function connection( IDatabase $db ) {
        if ( $this->db->getType() !== $db->getType() ) {
            throw new InvalidArgumentException(
                __METHOD__ . ' cannot switch to a database of a different type.'
            );
        }
        $this->db = $db;
        return $this;
    }
 
    public function queryInfo( $info ) {
        if ( isset( $info['table'] ) ) {
            $this->table( $info['table'] );
        }
        if ( isset( $info['rows'] ) ) {
            $this->rows( $info['rows'] );
        }
        if ( isset( $info['options'] ) ) {
            $this->options( (array)$info['options'] );
        }
        if ( isset( $info['upsert'] ) ) {
            $this->onDuplicateKeyUpdate();
        }
        if ( isset( $info['uniqueIndexFields'] ) ) {
            $this->uniqueIndexFields( (array)$info['uniqueIndexFields'] );
        }
        if ( isset( $info['set'] ) ) {
            $this->set( (array)$info['set'] );
        }
        if ( isset( $info['caller'] ) ) {
            $this->caller( $info['caller'] );
        }
        return $this;
    }
 
    public function table( $table ) {
        $this->table = $table;
        return $this;
    }
 
    public function insertInto( string $table ) {
        return $this->table( $table );
    }
 
    public function insert( string $table ) {
        return $this->table( $table );
    }
 
    public function option( $name, $value = null ) {
        if ( $value === null ) {
            $this->options[] = $name;
        } else {
            $this->options[$name] = $value;
        }
        return $this;
    }
 
    public function options( array $options ) {
        $this->options = array_merge( $this->options, $options );
        return $this;
    }
 
    public function rows( array $rows ) {
        $this->rows = array_merge( $this->rows, $rows );
        return $this;
    }
 
    public function row( array $row ) {
        $this->rows[] = $row;
        return $this;
    }
 
    public function ignore() {
        $this->options[] = 'IGNORE';
        return $this;
    }
 
    public function onDuplicateKeyUpdate() {
        $this->upsert = true;
        return $this;
    }
 
    public function uniqueIndexFields( $uniqueIndexFields ) {
        if ( is_string( $uniqueIndexFields ) ) {
            $uniqueIndexFields = [ $uniqueIndexFields ];
        }
        $this->uniqueIndexFields = $uniqueIndexFields;
        return $this;
    }
 
    public function set( $set ) {
        if ( is_array( $set ) ) {
            foreach ( $set as $key => $value ) {
                if ( is_int( $key ) ) {
                    $this->set[] = $value;
                } else {
                    $this->set[$key] = $value;
                }
            }
        } else {
            $this->set[] = $set;
        }
        return $this;
    }
 
    public function andSet( $set ) {
        return $this->set( $set );
    }
 
    public function caller( $fname ) {
        $this->caller = $fname;
        return $this;
    }
 
    public function execute() {
        if ( !$this->rows ) {
            // (T347610) For now, allow this but deprecate it, so we can trace these and fix them rapidly.
            wfDeprecatedMsg( self::class . ' triggered with no rows set; exit early instead.' );
            // TODO: Uncomment rather than deprecate once early-exist mitigations are in place.
            // throw new UnexpectedValueException( __METHOD__ . ' can\'t have empty $rows value' );
        }
        if ( $this->table === '' ) {
            throw new UnexpectedValueException(
                __METHOD__ . ' expects table not to be empty' );
        }
        if ( $this->upsert && ( !$this->set || !$this->uniqueIndexFields ) ) {
            throw new UnexpectedValueException(
                __METHOD__ . ' called with upsert but no set value or unique key has been provided' );
        }
        if ( !$this->upsert && ( $this->set || $this->uniqueIndexFields ) ) {
            throw new UnexpectedValueException(
                __METHOD__ . ' is not called with upsert but set value or unique key has been provided' );
        }
        if ( $this->upsert ) {
            $this->db->upsert( $this->table, $this->rows, [ $this->uniqueIndexFields ], $this->set, $this->caller );
            return;
        }
        $this->db->insert( $this->table, $this->rows, $this->caller, $this->options );
    }
 
    public function getQueryInfo() {
        $info = [
            'table' => $this->table,
            'rows' => $this->rows,
            'upsert' => $this->upsert,
            'set' => $this->set,
            'uniqueIndexFields' => $this->uniqueIndexFields,
            'options' => $this->options,
        ];
        if ( $this->caller !== __CLASS__ ) {
            $info['caller'] = $this->caller;
        }
        return $info;
    }
}