Drush: includes/dbtng.inc Source File

  1. 7.x doxygen/html/dbtng_8inc_source.html
  2. master doxygen/html/dbtng_8inc_source.html
Go to the documentation of this file.
1 <?php
2 
3 /**
4  * @file
5  * Wrappers to abstract database operations from Drupal version.
6  */
7 
8 /**
9  * @defgroup dbfunctions Database convenience functions.
10  * @{
11  */
12 
13 /**
14  * Replace named placeholders in a WHERE snippet.
15  *
16  * Helper function to allow the usage of Drupal 7+ WHERE snippets
17  * with named placeholders in code for Drupal 6.
18  *
19  * @param $where
20  * String with a WHERE snippet using named placeholders.
21  * @param $args
22  * Array of placeholder values.
23  * @return
24  * String. $where filled with literals from $args.
25  */
26 function _drush_replace_query_placeholders($where, $args) {
27  foreach ($args as $key => $data) {
28  if (is_array($data)) {
29  $new_keys = array();
30  // $data can't have keys that are a prefix of other keys to
31  // prevent a corrupted result in the below calls to str_replace().
32  // To avoid this we will use a zero padded indexed array of the values of $data.
33  $pad_length = strlen((string)count(array_values($data)));
34  foreach (array_values($data) as $i => $value) {
35  if (!is_numeric($value)) {
36  $value = "'".$value."'";
37  }
38  $new_keys[$key . '_' . str_pad($i, $pad_length, '0', STR_PAD_LEFT)] = $value;
39  }
40  $where = preg_replace('#' . $key . '\b#', implode(', ', array_keys($new_keys)), $where);
41  unset($args[$key]);
42  $args += $new_keys;
43  }
44  else if (!is_numeric($data)) {
45  $args[$key] = "'".$data."'";
46  }
47  }
48 
49  foreach ($args as $key => $data) {
50  $where = str_replace($key, $data, $where);
51  }
52 
53  return $where;
54 }
55 
56 /**
57  * A db_select() that works for any version of Drupal.
58  *
59  * @param $table
60  * String. The table to operate on.
61  * @param $fields
62  * Array or string. Fields affected in this operation. Valid string values are '*' or a single column name.
63  * @param $where
64  * String. WHERE snippet for the operation. It uses named placeholders. see @_drush_replace_query_placeholders()
65  * @param $args
66  * Array. Arguments for the WHERE snippet.
67  * @param $start
68  * Int. Value for OFFSET.
69  * @param $length
70  * Int. Value for LIMIT.
71  * @param $order_by_field
72  * String. Database column to order by.
73  * @param $order_by_direction
74  * ('ASC', 'DESC'). Ordering direction.
75  * @return
76  * A database resource.
77  */
78 function drush_db_select($table, $fields = '*', $where = NULL, $args = NULL, $start = NULL, $length = NULL, $order_by_field = NULL, $order_by_direction = 'ASC') {
79  if (drush_drupal_major_version() >= 7) {
80  if (!is_array($fields)) {
81  if ($fields == '*') {
82  $fields = array();
83  }
84  else {
85  $fields = array($fields);
86  }
87  }
88  $query = db_select($table, $table)
89  ->fields($table, $fields);
90  if (!empty($where)) {
91  $query = $query->where($where, $args);
92  }
93  if (isset($order_by_field)) {
94  $query = $query->orderBy($order_by_field, $order_by_direction);
95  }
96  if (isset($length)) {
97  $query = $query->range($start, $length);
98  }
99  return $query->execute();
100  }
101  else {
102  if (is_array($fields)) {
103  $fields = implode(', ', $fields);
104  }
105  $query = "SELECT $fields FROM {{$table}}";
106  if (!empty($where)) {
107  $where = _drush_replace_query_placeholders($where, $args);
108  $query .= " WHERE ".$where;
109  }
110  if (isset($order_by_field)) {
111  $query .= " ORDER BY $order_by_field $order_by_direction";
112  }
113  if (isset($length)) {
114  $db_spec = _drush_sql_get_db_spec();
115  $db_scheme = _drush_sql_get_scheme($db_spec);
116  if ($db_scheme == 'oracle')
117  return db_query_range($query, $start, $length);
118  else {
119  $limit = " LIMIT $length";
120  if (isset($start)) {
121  $limit .= " OFFSET $start";
122  }
123  $query .= $limit;
124  }
125  }
126 
127  return db_query($query, $args);
128  }
129 }
130 
131 /**
132  * A db_delete() that works for any version of Drupal.
133  *
134  * @param $table
135  * String. The table to operate on.
136  * @param $where
137  * String. WHERE snippet for the operation. It uses named placeholders. see @_drush_replace_query_placeholders()
138  * @param $args
139  * Array. Arguments for the WHERE snippet.
140  * @return
141  * Affected rows (except on D7+mysql without a WHERE clause - returns TRUE) or FALSE.
142  */
143 function drush_db_delete($table, $where = NULL, $args = NULL) {
144  if (drush_drupal_major_version() >= 7) {
145  if (!empty($where)) {
146  $query = db_delete($table)->where($where, $args);
147  return $query->execute();
148  }
149  else {
150  return db_truncate($table)->execute();
151  }
152  }
153  else {
154  $query = "DELETE FROM {{$table}}";
155  if (!empty($where)) {
156  $where = _drush_replace_query_placeholders($where, $args);
157  $query .= ' WHERE '.$where;
158  }
159  if (!db_query($query, $args)) {
160  return FALSE;
161  }
162  return db_affected_rows();
163  }
164 }
165 
166 /**
167  * A db_result() that works consistently for any version of Drupal.
168  *
169  * @param
170  * A Database result object.
171  */
172 function drush_db_result($result) {
173  switch (drush_drupal_major_version()) {
174  case 6:
175  return db_result($result);
176  case 7:
177  default:
178  return $result->fetchField();
179  }
180 }
181 
182 /**
183  * A db_fetch_object() that works for any version of Drupal.
184  *
185  * @param
186  * A Database result object.
187  */
188 function drush_db_fetch_object($result) {
189  return drush_drupal_major_version() >= 7 ? $result->fetchObject() : db_fetch_object($result);
190 }
191 
192 /**
193  * @} End of "defgroup dbfunctions".
194  */

File

doxygen/html/dbtng_8inc_source.html
View source
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Drush: includes/dbtng.inc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Drush
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_09e761304027c904456130627fd4dcf5.html">includes</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">dbtng.inc</div>  </div>
</div><!--header-->
<div class="contents">
<a href="dbtng_8inc.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;&lt;?php</div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * @file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Wrappers to abstract database operations from Drupal version.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * @defgroup dbfunctions Database convenience functions.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * @{</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * Replace named placeholders in a WHERE snippet.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * Helper function to allow the usage of Drupal 7+ WHERE snippets</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * with named placeholders in code for Drupal 6.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * @param $where</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *   String with a WHERE snippet using named placeholders.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * @param $args</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *   Array of placeholder values.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *   String. $where filled with literals from $args.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="code" href="group__dbfunctions.html#ga52d2d87eeff2e6dc41a85892072b6c1c">   26</a></span>&#160;<span class="keyword">function</span> <a class="code" href="group__dbfunctions.html#ga52d2d87eeff2e6dc41a85892072b6c1c">_drush_replace_query_placeholders</a>($where, $args) {</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;  <span class="keywordflow">foreach</span> ($args as $key =&gt; $data) {</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="keywordflow">if</span> (is_array($data)) {</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;      $new_keys = array();</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;      <span class="comment">// $data can&#39;t have keys that are a prefix of other keys to</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;      <span class="comment">// prevent a corrupted result in the below calls to str_replace().</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;      <span class="comment">// To avoid this we will use a zero padded indexed array of the values of $data.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;      $pad_length = strlen((<span class="keywordtype">string</span>)count(array_values($data)));</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;      <span class="keywordflow">foreach</span> (array_values($data) as $i =&gt; $value) {</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;        <span class="keywordflow">if</span> (!is_numeric($value)) {</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;          $value = <span class="stringliteral">&quot;&#39;&quot;</span>.$value.<span class="stringliteral">&quot;&#39;&quot;</span>;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;        }</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;        $new_keys[$key . <span class="charliteral">&#39;_&#39;</span> . str_pad($i, $pad_length, <span class="charliteral">&#39;0&#39;</span>, STR_PAD_LEFT)] = $value;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;      }</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;      $where = preg_replace(<span class="charliteral">&#39;#&#39;</span> . $key . <span class="stringliteral">&#39;\b#&#39;</span>, implode(<span class="stringliteral">&#39;, &#39;</span>, array_keys($new_keys)), $where);</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;      unset($args[$key]);</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;      $args += $new_keys;</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    }</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <span class="keywordflow">else</span> <span class="keywordflow">if</span> (!is_numeric($data)) {</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;      $args[$key] = <span class="stringliteral">&quot;&#39;&quot;</span>.$data.<span class="stringliteral">&quot;&#39;&quot;</span>;</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    }</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  }</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;  <span class="keywordflow">foreach</span> ($args as $key =&gt; $data) {</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    $where = str_replace($key, $data, $where);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  }</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <span class="keywordflow">return</span> $where;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;}</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"> * A db_select() that works for any version of Drupal.</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> * @param $table</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> *   String. The table to operate on.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"> * @param $fields</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"> *   Array or string. Fields affected in this operation. Valid string values are &#39;*&#39; or a single column name.</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"> * @param $where</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> *   String. WHERE snippet for the operation. It uses named placeholders. see @_drush_replace_query_placeholders()</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> * @param $args</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> *   Array. Arguments for the WHERE snippet.</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"> * @param $start</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> *   Int. Value for OFFSET.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"> * @param $length</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"> *   Int. Value for LIMIT.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"> * @param $order_by_field</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"> *   String. Database column to order by.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> * @param $order_by_direction</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> *   (&#39;ASC&#39;, &#39;DESC&#39;). Ordering direction.</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> *   A database resource.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="code" href="group__dbfunctions.html#gaaf67a267a19ac63f7eb05721b2170f89">   78</a></span>&#160;<span class="keyword">function</span> <a class="code" href="group__dbfunctions.html#gaaf67a267a19ac63f7eb05721b2170f89">drush_db_select</a>($table, $fields = <span class="charliteral">&#39;*&#39;</span>, $where = NULL, $args = NULL, $start = NULL, $length = NULL, $order_by_field = NULL, $order_by_direction = <span class="stringliteral">&#39;ASC&#39;</span>) {</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <span class="keywordflow">if</span> (<a class="code" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0">drush_drupal_major_version</a>() &gt;= 7) {</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keywordflow">if</span> (!is_array($fields)) {</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;      <span class="keywordflow">if</span> ($fields == <span class="charliteral">&#39;*&#39;</span>) {</div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;        $fields = array();</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;      }</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;      <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;        $fields = array($fields);</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;      }</div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    }</div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    $query = db_select($table, $table)</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;      -&gt;fields($table, $fields);</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    <span class="keywordflow">if</span> (!empty($where)) {</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;      $query = $query-&gt;where($where, $args);</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    }</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    <span class="keywordflow">if</span> (isset($order_by_field)) {</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;      $query = $query-&gt;orderBy($order_by_field, $order_by_direction);</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;    }</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="keywordflow">if</span> (isset($length)) {</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;      $query = $query-&gt;range($start, $length);</div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;    }</div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <span class="keywordflow">return</span> $query-&gt;execute();</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;  }</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    <span class="keywordflow">if</span> (is_array($fields)) {</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;      $fields = implode(<span class="stringliteral">&#39;, &#39;</span>, $fields);</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    }</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;    $query = <span class="stringliteral">&quot;SELECT $fields FROM {{$table}}&quot;</span>;</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    <span class="keywordflow">if</span> (!empty($where)) {</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;      $where = <a class="code" href="group__dbfunctions.html#ga52d2d87eeff2e6dc41a85892072b6c1c">_drush_replace_query_placeholders</a>($where, $args);</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;      $query .= <span class="stringliteral">&quot; WHERE &quot;</span>.$where;</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;    }</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    <span class="keywordflow">if</span> (isset($order_by_field)) {</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;      $query .= <span class="stringliteral">&quot; ORDER BY $order_by_field $order_by_direction&quot;</span>;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    }</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;    <span class="keywordflow">if</span> (isset($length)) {</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;      $db_spec = _drush_sql_get_db_spec();</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;      $db_scheme = _drush_sql_get_scheme($db_spec);</div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;      <span class="keywordflow">if</span> ($db_scheme == <span class="stringliteral">&#39;oracle&#39;</span>)</div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;        <span class="keywordflow">return</span> db_query_range($query, $start, $length);</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;      <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;              $limit = <span class="stringliteral">&quot; LIMIT $length&quot;</span>;</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;              <span class="keywordflow">if</span> (isset($start)) {</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;          $limit .= <span class="stringliteral">&quot; OFFSET $start&quot;</span>;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;              }</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;              $query .= $limit;</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;      }</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;    }</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;    <span class="keywordflow">return</span> db_query($query, $args);</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;  }</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;}</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"> * A db_delete() that works for any version of Drupal.</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> * @param $table</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> *   String. The table to operate on.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> * @param $where</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> *   String. WHERE snippet for the operation. It uses named placeholders. see @_drush_replace_query_placeholders()</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> * @param $args</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> *   Array. Arguments for the WHERE snippet.</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"> * @return</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"> *   Affected rows (except on D7+mysql without a WHERE clause - returns TRUE) or FALSE.</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00143"></a><span class="lineno"><a class="code" href="group__dbfunctions.html#ga67f2a8891d0642284b856f8d90fa768d">  143</a></span>&#160;<span class="keyword">function</span> <a class="code" href="group__dbfunctions.html#ga67f2a8891d0642284b856f8d90fa768d">drush_db_delete</a>($table, $where = NULL, $args = NULL) {</div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;  <span class="keywordflow">if</span> (<a class="code" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0">drush_drupal_major_version</a>() &gt;= 7) {</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;    <span class="keywordflow">if</span> (!empty($where)) {</div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;      $query = db_delete($table)-&gt;where($where, $args);</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;      <span class="keywordflow">return</span> $query-&gt;execute();</div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    }</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;      <span class="keywordflow">return</span> db_truncate($table)-&gt;execute();</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;    }</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;  }</div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;  <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    $query = <span class="stringliteral">&quot;DELETE FROM {{$table}}&quot;</span>;</div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;    <span class="keywordflow">if</span> (!empty($where)) {</div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;      $where = <a class="code" href="group__dbfunctions.html#ga52d2d87eeff2e6dc41a85892072b6c1c">_drush_replace_query_placeholders</a>($where, $args);</div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;      $query .= <span class="stringliteral">&#39; WHERE &#39;</span>.$where;</div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;    }</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;    <span class="keywordflow">if</span> (!db_query($query, $args)) {</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;      <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;    }</div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;    <span class="keywordflow">return</span> db_affected_rows();</div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;  }</div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;}</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"> * A db_result() that works consistently for any version of Drupal.</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment"> * @param</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="comment"> *   A Database result object.</span></div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"><a class="code" href="group__dbfunctions.html#ga5e868125411566a8b7f72cb2140bf45f">  172</a></span>&#160;<span class="keyword">function</span> <a class="code" href="group__dbfunctions.html#ga5e868125411566a8b7f72cb2140bf45f">drush_db_result</a>($result) {</div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;  <span class="keywordflow">switch</span> (<a class="code" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0">drush_drupal_major_version</a>()) {</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;    <span class="keywordflow">case</span> 6:</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;      <span class="keywordflow">return</span> db_result($result);</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    <span class="keywordflow">case</span> 7:</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;    <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;      <span class="keywordflow">return</span> $result-&gt;fetchField();</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;  }</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;}</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment"> * A db_fetch_object() that works for any version of Drupal.</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;<span class="comment"> * @param</span></div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;<span class="comment"> *   A Database result object.</span></div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"><a class="code" href="group__dbfunctions.html#ga4cd1e1df83196d9a69084246703c9057">  188</a></span>&#160;<span class="keyword">function</span> <a class="code" href="group__dbfunctions.html#ga4cd1e1df83196d9a69084246703c9057">drush_db_fetch_object</a>($result) {</div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;  <span class="keywordflow">return</span> <a class="code" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0">drush_drupal_major_version</a>() &gt;= 7 ? $result-&gt;fetchObject() : db_fetch_object($result);</div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;}</div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment"> * @} End of &quot;defgroup dbfunctions&quot;.</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment"> */</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 8 2014 09:04:54 for Drush by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>