Initial xentral_oss_20.3.c9ffacf

vendor/aura/sqlquery/src/AbstractDmlQuery.php

@@ -0,0 +1,159 @@
+<?php
+/**
+ *
+ * This file is part of Aura for PHP.
+ *
+ * @license http://opensource.org/licenses/bsd-license.php BSD
+ *
+ */
+namespace Aura\SqlQuery;
+
+/**
+ *
+ * Abstract query object for data manipulation (Insert, Update, and Delete).
+ *
+ * @package Aura.SqlQuery
+ *
+ */
+abstract class AbstractDmlQuery extends AbstractQuery
+{
+    /**
+     *
+     * Column values for INSERT or UPDATE queries; the key is the column name and the
+     * value is the column value.
+     *
+     * @param array
+     *
+     */
+    protected $col_values;
+
+    /**
+     *
+     * The columns to be returned.
+     *
+     * @var array
+     *
+     */
+    protected $returning = array();
+
+    /**
+     *
+     * Does the query have any columns in it?
+     *
+     * @return bool
+     *
+     */
+    public function hasCols()
+    {
+        return (bool) $this->col_values;
+    }
+
+    /**
+     *
+     * Sets one column value placeholder; if an optional second parameter is
+     * passed, that value is bound to the placeholder.
+     *
+     * @param string $col The column name.
+     *
+     * @return $this
+     *
+     */
+    protected function addCol($col)
+    {
+        $key = $this->quoter->quoteName($col);
+        $this->col_values[$key] = ":$col";
+        $args = func_get_args();
+        if (count($args) > 1) {
+            $this->bindValue($col, $args[1]);
+        }
+        return $this;
+    }
+
+    /**
+     *
+     * Sets multiple column value placeholders. If an element is a key-value
+     * pair, the key is treated as the column name and the value is bound to
+     * that column.
+     *
+     * @param array $cols A list of column names, optionally as key-value
+     * pairs where the key is a column name and the value is a bind value for
+     * that column.
+     *
+     * @return $this
+     *
+     */
+    protected function addCols(array $cols)
+    {
+        foreach ($cols as $key => $val) {
+            if (is_int($key)) {
+                // integer key means the value is the column name
+                $this->addCol($val);
+            } else {
+                // the key is the column name and the value is a value to
+                // be bound to that column
+                $this->addCol($key, $val);
+            }
+        }
+        return $this;
+    }
+
+    /**
+     *
+     * Sets a column value directly; the value will not be escaped, although
+     * fully-qualified identifiers in the value will be quoted.
+     *
+     * @param string $col The column name.
+     *
+     * @param string $value The column value expression.
+     *
+     * @return $this
+     *
+     */
+    protected function setCol($col, $value)
+    {
+        if ($value === null) {
+            $value = 'NULL';
+        }
+
+        $key = $this->quoter->quoteName($col);
+        $value = $this->quoter->quoteNamesIn($value);
+        $this->col_values[$key] = $value;
+        return $this;
+    }
+
+    /**
+     *
+     * Adds returning columns to the query.
+     *
+     * Multiple calls to returning() will append to the list of columns, not
+     * overwrite the previous columns.
+     *
+     * @param array $cols The column(s) to add to the query.
+     *
+     * @return $this
+     *
+     */
+    protected function addReturning(array $cols)
+    {
+        foreach ($cols as $col) {
+            $this->returning[] = $this->quoter->quoteNamesIn($col);
+        }
+        return $this;
+    }
+
+    /**
+     *
+     * Builds the `RETURNING` clause of the statement.
+     *
+     * @return string
+     *
+     */
+    protected function buildReturning()
+    {
+        if (! $this->returning) {
+            return ''; // not applicable
+        }
+
+        return PHP_EOL . 'RETURNING' . $this->indentCsv($this->returning);
+    }
+}