4 * Dear God Why Do I Have To Write This (Dumb SQL Builder)
7 * $insert = CRM_Utils_SQL_Insert::into('mytable')
8 * ->row(array('col1' => '1', 'col2' => '2' ))
9 * ->row(array('col1' => '2b', 'col2' => '1b'));
10 * echo $insert->toSQL();
12 * Note: In MySQL, numeric values may be escaped. Except for NULL values,
13 * it's reasonable for us to simply escape all values by default -- without
14 * any knowledge of the underlying schema.
18 * - No knowledge of the underlying SQL API (except for escaping -- CRM_Core_DAO::escapeString)
19 * - No knowledge of the underlying data model
21 * - SQL clauses correspond to PHP functions ($select->where("foo_id=123"))
23 class CRM_Utils_SQL_Insert
{
25 private $verb = 'INSERT INTO';
38 * array<string> list of column names
43 * Create a new INSERT query
45 * @param string $table table-name and optional alias
46 * @return CRM_Utils_SQL_Insert
48 public static function into($table) {
49 return new self($table);
53 * Create a new SELECT query
55 * @param string $from table-name and optional alias
57 public function __construct($table) {
58 $this->table
= $table;
59 $this->rows
= array();
64 * @return CRM_Utils_SQL_Insert
66 public function rows($rows) {
67 foreach ($rows as $row) {
75 * @return CRM_Utils_SQL_Insert
76 * @throws CRM_Core_Exception
78 public function row($row) {
79 $columns = array_keys($row);
82 if ($this->columns
=== NULL) {
83 $this->columns
= $columns;
85 elseif ($this->columns
!= $columns) {
86 throw new CRM_Core_Exception("Inconsistent column names");
89 $escapedRow = array();
90 foreach ($columns as $column) {
91 $escapedRow[$column] = $this->escapeString($row[$column]);
93 $this->rows
[] = $escapedRow;
99 * Use REPLACE INTO instead of INSERT INTO
101 * @param bool $asReplace
102 * @return CRM_Utils_SQL_Insert
104 public function usingReplace($asReplace = TRUE) {
105 $this->verb
= $asReplace ?
'REPLACE INTO' : 'INSERT INTO';
110 * @param string|NULL $value
111 * @return string SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes)
113 protected function escapeString($value) {
114 return $value === NULL ?
'NULL' : '"' . CRM_Core_DAO
::escapeString($value) . '"';
118 * @return string SQL statement
120 public function toSQL() {
121 $columns = "`" . implode('`,`', $this->columns
) . "`";
122 $sql = "{$this->verb} {$this->table} ({$columns}) VALUES";
125 foreach ($this->rows
as $row) {
126 $sql .= "{$nextDelim}\n(" . implode(',', $row) . ")";