crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Utils/SQL/Insert.php

   1 <?php
   2
   3 /**
   4  * Dear God Why Do I Have To Write This (Dumb SQL Builder)
   5  *
   6  * Usage:
   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();
  11  *
  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.
  15  *
  16  * Design principles:
  17  *  - Portable
  18  *    - No knowledge of the underlying SQL API (except for escaping -- CRM_Core_DAO::escapeString)
  19  *    - No knowledge of the underlying data model
  20  *    - Single file
  21  *  - SQL clauses correspond to PHP functions ($select->where("foo_id=123"))
  22  */
  23 class CRM_Utils_SQL_Insert {
  24
  25   private $verb = 'INSERT INTO';
  26
  27   /**
  28    * @var string
  29    */
  30   private $table;
  31
  32   /**
  33    * @var array
  34    */
  35   private $rows;
  36
  37   /**
  38    * Array<string> list of column names
  39    */
  40   private $columns;
  41
  42   /**
  43    * Create a new INSERT query.
  44    *
  45    * @param string $table
  46    *   Table-name and optional alias.
  47    * @return CRM_Utils_SQL_Insert
  48    */
  49   public static function into($table) {
  50     return new self($table);
  51   }
  52
  53   /**
  54    * Create a new SELECT query.
  55    *
  56    * @param string $table
  57    *   Table-name and optional alias.
  58    */
  59   public function __construct($table) {
  60     $this->table = $table;
  61     $this->rows = array();
  62   }
  63
  64   public function columns($columns) {
  65     if ($this->columns !== NULL) {
  66       throw new CRM_Core_Exception("Column order already specified.");
  67     }
  68     $this->columns = $columns;
  69     return $this;
  70   }
  71
  72   /**
  73    * @param array $rows
  74    * @return CRM_Utils_SQL_Insert
  75    */
  76   public function rows($rows) {
  77     foreach ($rows as $row) {
  78       $this->row($row);
  79     }
  80     return $this;
  81   }
  82
  83   /**
  84    * @param array $row
  85    * @return CRM_Utils_SQL_Insert
  86    * @throws CRM_Core_Exception
  87    */
  88   public function row($row) {
  89     $columns = array_keys($row);
  90
  91     if ($this->columns === NULL) {
  92       sort($columns);
  93       $this->columns = $columns;
  94     }
  95     elseif (array_diff($this->columns, $columns) !== array()) {
  96       throw new CRM_Core_Exception("Inconsistent column names");
  97     }
  98
  99     $escapedRow = array();
 100     foreach ($this->columns as $column) {
 101       $escapedRow[$column] = $this->escapeString($row[$column]);
 102     }
 103     $this->rows[] = $escapedRow;
 104
 105     return $this;
 106   }
 107
 108   /**
 109    * Use REPLACE INTO instead of INSERT INTO.
 110    *
 111    * @param bool $asReplace
 112    * @return CRM_Utils_SQL_Insert
 113    */
 114   public function usingReplace($asReplace = TRUE) {
 115     $this->verb = $asReplace ? 'REPLACE INTO' : 'INSERT INTO';
 116     return $this;
 117   }
 118
 119   /**
 120    * @param string|NULL $value
 121    * @return string
 122    *   SQL expression, e.g. "it\'s great" (with-quotes) or NULL (without-quotes)
 123    */
 124   protected function escapeString($value) {
 125     return $value === NULL ? 'NULL' : '"' . CRM_Core_DAO::escapeString($value) . '"';
 126   }
 127
 128   /**
 129    * @return string
 130    *   SQL statement
 131    */
 132   public function toSQL() {
 133     $columns = "`" . implode('`,`', $this->columns) . "`";
 134     $sql = "{$this->verb} {$this->table} ({$columns}) VALUES";
 135
 136     $nextDelim = '';
 137     foreach ($this->rows as $row) {
 138       $sql .= "{$nextDelim}\n(" . implode(',', $row) . ")";
 139       $nextDelim = ',';
 140     }
 141     $sql .= "\n";
 142
 143     return $sql;
 144   }
 145
 146 }