<html>
<head>
<title>Coverage for Doctrine_Expression_Pgsql</title>
<style type="text/css">
.covered{ background: green;}
.normal{ background: white;}
.red{ background: red;}
.orange{ background: #f90;}
</style>
</head>
<body><h1>Coverage for Doctrine_Expression_Pgsql</h1><p><a href="index.php">Back to coverage report</a></p><table>
<tr><td>1</td>
<td class="normal"><?php
</td></tr>
<tr><td>2</td>
<td class="normal">/*
</td></tr>
<tr><td>3</td>
<td class="normal"> * $Id: Pgsql.php 2963 2007-10-21 06:23:59Z Jonathan.Wage $
</td></tr>
<tr><td>4</td>
<td class="normal"> *
</td></tr>
<tr><td>5</td>
<td class="normal"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
</td></tr>
<tr><td>6</td>
<td class="normal"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
</td></tr>
<tr><td>7</td>
<td class="normal"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
</td></tr>
<tr><td>8</td>
<td class="normal"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
</td></tr>
<tr><td>9</td>
<td class="normal"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
</td></tr>
<tr><td>10</td>
<td class="normal"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
</td></tr>
<tr><td>11</td>
<td class="normal"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
</td></tr>
<tr><td>12</td>
<td class="normal"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
</td></tr>
<tr><td>13</td>
<td class="normal"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
</td></tr>
<tr><td>14</td>
<td class="normal"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
</td></tr>
<tr><td>15</td>
<td class="normal"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</td></tr>
<tr><td>16</td>
<td class="normal"> *
</td></tr>
<tr><td>17</td>
<td class="normal"> * This software consists of voluntary contributions made by many individuals
</td></tr>
<tr><td>18</td>
<td class="normal"> * and is licensed under the LGPL. For more information, see
</td></tr>
<tr><td>19</td>
<td class="normal"> * <http://www.phpdoctrine.com>.
</td></tr>
<tr><td>20</td>
<td class="normal"> */
</td></tr>
<tr><td>21</td>
<td class="covered">Doctrine::autoload('Doctrine_Expression_Driver');
</td></tr>
<tr><td>22</td>
<td class="normal">/**
</td></tr>
<tr><td>23</td>
<td class="normal"> * Doctrine_Expression_Pgsql
</td></tr>
<tr><td>24</td>
<td class="normal"> *
</td></tr>
<tr><td>25</td>
<td class="normal"> * @package Doctrine
</td></tr>
<tr><td>26</td>
<td class="normal"> * @subpackage Expression
</td></tr>
<tr><td>27</td>
<td class="normal"> * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
</td></tr>
<tr><td>28</td>
<td class="normal"> * @link www.phpdoctrine.com
</td></tr>
<tr><td>29</td>
<td class="normal"> * @since 1.0
</td></tr>
<tr><td>30</td>
<td class="normal"> * @version $Revision: 2963 $
</td></tr>
<tr><td>31</td>
<td class="normal"> * @author Konsta Vesterinen <kvesteri@cc.hut.fi>
</td></tr>
<tr><td>32</td>
<td class="normal"> */
</td></tr>
<tr><td>33</td>
<td class="covered">class Doctrine_Expression_Pgsql extends Doctrine_Expression_Driver
</td></tr>
<tr><td>34</td>
<td class="normal">{
</td></tr>
<tr><td>35</td>
<td class="normal"> /**
</td></tr>
<tr><td>36</td>
<td class="normal"> * Returns the md5 sum of a field.
</td></tr>
<tr><td>37</td>
<td class="normal"> *
</td></tr>
<tr><td>38</td>
<td class="normal"> * Note: Not SQL92, but common functionality
</td></tr>
<tr><td>39</td>
<td class="normal"> *
</td></tr>
<tr><td>40</td>
<td class="normal"> * md5() works with the default PostgreSQL 8 versions.
</td></tr>
<tr><td>41</td>
<td class="normal"> *
</td></tr>
<tr><td>42</td>
<td class="normal"> * If you are using PostgreSQL 7.x or older you need
</td></tr>
<tr><td>43</td>
<td class="normal"> * to make sure that the digest procedure is installed.
</td></tr>
<tr><td>44</td>
<td class="normal"> * If you use RPMS (Redhat and Mandrake) install the postgresql-contrib
</td></tr>
<tr><td>45</td>
<td class="normal"> * package. You must then install the procedure by running this shell command:
</td></tr>
<tr><td>46</td>
<td class="normal"> * <code>
</td></tr>
<tr><td>47</td>
<td class="normal"> * psql [dbname] < /usr/share/pgsql/contrib/pgcrypto.sql
</td></tr>
<tr><td>48</td>
<td class="normal"> * </code>
</td></tr>
<tr><td>49</td>
<td class="normal"> * You should make sure you run this as the postgres user.
</td></tr>
<tr><td>50</td>
<td class="normal"> *
</td></tr>
<tr><td>51</td>
<td class="normal"> * @return string
</td></tr>
<tr><td>52</td>
<td class="normal"> */
</td></tr>
<tr><td>53</td>
<td class="normal"> public function md5($column)
</td></tr>
<tr><td>54</td>
<td class="normal"> {
</td></tr>
<tr><td>55</td>
<td class="red"> $column = $this->getIdentifier($column);
</td></tr>
<tr><td>56</td>
<td class="normal">
</td></tr>
<tr><td>57</td>
<td class="red"> if ($this->version > 7) {
</td></tr>
<tr><td>58</td>
<td class="red"> return 'MD5(' . $column . ')';
</td></tr>
<tr><td>59</td>
<td class="orange"> } else {
</td></tr>
<tr><td>60</td>
<td class="red"> return 'encode(digest(' . $column .', md5), hex)';
</td></tr>
<tr><td>61</td>
<td class="normal"> }
</td></tr>
<tr><td>62</td>
<td class="orange"> }
</td></tr>
<tr><td>63</td>
<td class="normal">
</td></tr>
<tr><td>64</td>
<td class="normal"> /**
</td></tr>
<tr><td>65</td>
<td class="normal"> * Returns part of a string.
</td></tr>
<tr><td>66</td>
<td class="normal"> *
</td></tr>
<tr><td>67</td>
<td class="normal"> * Note: Not SQL92, but common functionality.
</td></tr>
<tr><td>68</td>
<td class="normal"> *
</td></tr>
<tr><td>69</td>
<td class="normal"> * @param string $value the target $value the string or the string column.
</td></tr>
<tr><td>70</td>
<td class="normal"> * @param int $from extract from this characeter.
</td></tr>
<tr><td>71</td>
<td class="normal"> * @param int $len extract this amount of characters.
</td></tr>
<tr><td>72</td>
<td class="normal"> * @return string sql that extracts part of a string.
</td></tr>
<tr><td>73</td>
<td class="normal"> */
</td></tr>
<tr><td>74</td>
<td class="normal"> public function substring($value, $from, $len = null)
</td></tr>
<tr><td>75</td>
<td class="normal"> {
</td></tr>
<tr><td>76</td>
<td class="red"> $value = $this->getIdentifier($value);
</td></tr>
<tr><td>77</td>
<td class="normal">
</td></tr>
<tr><td>78</td>
<td class="red"> if ($len === null) {
</td></tr>
<tr><td>79</td>
<td class="red"> $len = $this->getIdentifier($len);
</td></tr>
<tr><td>80</td>
<td class="red"> return 'SUBSTR(' . $value . ', ' . $from . ')';
</td></tr>
<tr><td>81</td>
<td class="orange"> } else {
</td></tr>
<tr><td>82</td>
<td class="red"> return 'SUBSTR(' . $value . ', ' . $from . ', ' . $len . ')';
</td></tr>
<tr><td>83</td>
<td class="normal"> }
</td></tr>
<tr><td>84</td>
<td class="orange"> }
</td></tr>
<tr><td>85</td>
<td class="normal">
</td></tr>
<tr><td>86</td>
<td class="normal"> /**
</td></tr>
<tr><td>87</td>
<td class="normal"> * Returns a series of strings concatinated
</td></tr>
<tr><td>88</td>
<td class="normal"> *
</td></tr>
<tr><td>89</td>
<td class="normal"> * concat() accepts an arbitrary number of parameters. Each parameter
</td></tr>
<tr><td>90</td>
<td class="normal"> * must contain an expression or an array with expressions.
</td></tr>
<tr><td>91</td>
<td class="normal"> *
</td></tr>
<tr><td>92</td>
<td class="normal"> * @param string|array(string) strings that will be concatinated.
</td></tr>
<tr><td>93</td>
<td class="normal"> * @return string
</td></tr>
<tr><td>94</td>
<td class="normal"> */
</td></tr>
<tr><td>95</td>
<td class="normal">
</td></tr>
<tr><td>96</td>
<td class="normal">
</td></tr>
<tr><td>97</td>
<td class="normal"> /**
</td></tr>
<tr><td>98</td>
<td class="normal"> * PostgreSQLs AGE(<timestamp1> [, <timestamp2>]) function.
</td></tr>
<tr><td>99</td>
<td class="normal"> *
</td></tr>
<tr><td>100</td>
<td class="normal"> * @param string $timestamp1 timestamp to subtract from NOW()
</td></tr>
<tr><td>101</td>
<td class="normal"> * @param string $timestamp2 optional; if given: subtract arguments
</td></tr>
<tr><td>102</td>
<td class="normal"> * @return string
</td></tr>
<tr><td>103</td>
<td class="normal"> */
</td></tr>
<tr><td>104</td>
<td class="normal"> public function age($timestamp1, $timestamp2 = null) {
</td></tr>
<tr><td>105</td>
<td class="red"> if ( $timestamp2 == null ) {
</td></tr>
<tr><td>106</td>
<td class="red"> return 'AGE(' . $timestamp1 . ')';
</td></tr>
<tr><td>107</td>
<td class="orange"> }
</td></tr>
<tr><td>108</td>
<td class="red"> return 'AGE(' . $timestamp1 . ', ' . $timestamp2 . ')';
</td></tr>
<tr><td>109</td>
<td class="orange"> }
</td></tr>
<tr><td>110</td>
<td class="normal">
</td></tr>
<tr><td>111</td>
<td class="normal"> /**
</td></tr>
<tr><td>112</td>
<td class="normal"> * PostgreSQLs DATE_PART( <text>, <time> ) function.
</td></tr>
<tr><td>113</td>
<td class="normal"> *
</td></tr>
<tr><td>114</td>
<td class="normal"> * @param string $text what to extract
</td></tr>
<tr><td>115</td>
<td class="normal"> * @param string $time timestamp or interval to extract from
</td></tr>
<tr><td>116</td>
<td class="normal"> * @return string
</td></tr>
<tr><td>117</td>
<td class="normal"> */
</td></tr>
<tr><td>118</td>
<td class="normal"> public function date_part($text, $time) {
</td></tr>
<tr><td>119</td>
<td class="red"> return 'DATE_PART(' . $text . ', ' . $time . ')';
</td></tr>
<tr><td>120</td>
<td class="orange"> }
</td></tr>
<tr><td>121</td>
<td class="normal">
</td></tr>
<tr><td>122</td>
<td class="normal">
</td></tr>
<tr><td>123</td>
<td class="normal"> /**
</td></tr>
<tr><td>124</td>
<td class="normal"> * PostgreSQLs TO_CHAR( <time>, <text> ) function.
</td></tr>
<tr><td>125</td>
<td class="normal"> *
</td></tr>
<tr><td>126</td>
<td class="normal"> * @param string $time timestamp or interval
</td></tr>
<tr><td>127</td>
<td class="normal"> * @param string $text how to the format the output
</td></tr>
<tr><td>128</td>
<td class="normal"> * @return string
</td></tr>
<tr><td>129</td>
<td class="normal"> */
</td></tr>
<tr><td>130</td>
<td class="normal"> public function to_char($time, $text) {
</td></tr>
<tr><td>131</td>
<td class="red"> return 'TO_CHAR(' . $time . ', ' . $text . ')';
</td></tr>
<tr><td>132</td>
<td class="orange"> }
</td></tr>
<tr><td>133</td>
<td class="normal">
</td></tr>
<tr><td>134</td>
<td class="normal"> /**
</td></tr>
<tr><td>135</td>
<td class="normal"> * PostgreSQLs CONCAT() function
</td></tr>
<tr><td>136</td>
<td class="normal"> *
</td></tr>
<tr><td>137</td>
<td class="normal"> * @param an array of values
</td></tr>
<tr><td>138</td>
<td class="normal"> * @return string
</td></tr>
<tr><td>139</td>
<td class="normal"> */
</td></tr>
<tr><td>140</td>
<td class="normal"> public function concat()
</td></tr>
<tr><td>141</td>
<td class="normal"> {
</td></tr>
<tr><td>142</td>
<td class="red"> $args = func_get_args();
</td></tr>
<tr><td>143</td>
<td class="normal">
</td></tr>
<tr><td>144</td>
<td class="red"> return join(' || ' , $args);
</td></tr>
<tr><td>145</td>
<td class="orange"> }
</td></tr>
<tr><td>146</td>
<td class="normal">
</td></tr>
<tr><td>147</td>
<td class="normal"> /**
</td></tr>
<tr><td>148</td>
<td class="normal"> * Returns the SQL string to return the current system date and time.
</td></tr>
<tr><td>149</td>
<td class="normal"> *
</td></tr>
<tr><td>150</td>
<td class="normal"> * @return string
</td></tr>
<tr><td>151</td>
<td class="normal"> */
</td></tr>
<tr><td>152</td>
<td class="normal"> public function now()
</td></tr>
<tr><td>153</td>
<td class="normal"> {
</td></tr>
<tr><td>154</td>
<td class="red"> return 'LOCALTIMESTAMP(0)';
</td></tr>
<tr><td>155</td>
<td class="orange"> }
</td></tr>
<tr><td>156</td>
<td class="normal">
</td></tr>
<tr><td>157</td>
<td class="normal"> /**
</td></tr>
<tr><td>158</td>
<td class="normal"> * regexp
</td></tr>
<tr><td>159</td>
<td class="normal"> *
</td></tr>
<tr><td>160</td>
<td class="normal"> * @return string the regular expression operator
</td></tr>
<tr><td>161</td>
<td class="normal"> */
</td></tr>
<tr><td>162</td>
<td class="normal"> public function regexp()
</td></tr>
<tr><td>163</td>
<td class="normal"> {
</td></tr>
<tr><td>164</td>
<td class="red"> return 'SIMILAR TO';
</td></tr>
<tr><td>165</td>
<td class="orange"> }
</td></tr>
<tr><td>166</td>
<td class="normal">
</td></tr>
<tr><td>167</td>
<td class="normal"> /**
</td></tr>
<tr><td>168</td>
<td class="normal"> * return string to call a function to get random value inside an SQL statement
</td></tr>
<tr><td>169</td>
<td class="normal"> *
</td></tr>
<tr><td>170</td>
<td class="normal"> * @return return string to generate float between 0 and 1
</td></tr>
<tr><td>171</td>
<td class="normal"> * @access public
</td></tr>
<tr><td>172</td>
<td class="normal"> */
</td></tr>
<tr><td>173</td>
<td class="normal"> public function random()
</td></tr>
<tr><td>174</td>
<td class="normal"> {
</td></tr>
<tr><td>175</td>
<td class="red"> return 'RANDOM()';
</td></tr>
<tr><td>176</td>
<td class="orange"> }
</td></tr>
<tr><td>177</td>
<td class="normal">
</td></tr>
<tr><td>178</td>
<td class="normal"> /**
</td></tr>
<tr><td>179</td>
<td class="normal"> * build a pattern matching string
</td></tr>
<tr><td>180</td>
<td class="normal"> *
</td></tr>
<tr><td>181</td>
<td class="normal"> * EXPERIMENTAL
</td></tr>
<tr><td>182</td>
<td class="normal"> *
</td></tr>
<tr><td>183</td>
<td class="normal"> * WARNING: this function is experimental and may change signature at
</td></tr>
<tr><td>184</td>
<td class="normal"> * any time until labelled as non-experimental
</td></tr>
<tr><td>185</td>
<td class="normal"> *
</td></tr>
<tr><td>186</td>
<td class="normal"> * @access public
</td></tr>
<tr><td>187</td>
<td class="normal"> *
</td></tr>
<tr><td>188</td>
<td class="normal"> * @param array $pattern even keys are strings, odd are patterns (% and _)
</td></tr>
<tr><td>189</td>
<td class="normal"> * @param string $operator optional pattern operator (LIKE, ILIKE and maybe others in the future)
</td></tr>
<tr><td>190</td>
<td class="normal"> * @param string $field optional field name that is being matched against
</td></tr>
<tr><td>191</td>
<td class="normal"> * (might be required when emulating ILIKE)
</td></tr>
<tr><td>192</td>
<td class="normal"> *
</td></tr>
<tr><td>193</td>
<td class="normal"> * @return string SQL pattern
</td></tr>
<tr><td>194</td>
<td class="normal"> */
</td></tr>
<tr><td>195</td>
<td class="normal"> public function matchPattern($pattern, $operator = null, $field = null)
</td></tr>
<tr><td>196</td>
<td class="normal"> {
</td></tr>
<tr><td>197</td>
<td class="red"> $match = '';
</td></tr>
<tr><td>198</td>
<td class="red"> if ( ! is_null($operator)) {
</td></tr>
<tr><td>199</td>
<td class="red"> $field = is_null($field) ? '' : $field.' ';
</td></tr>
<tr><td>200</td>
<td class="red"> $operator = strtoupper($operator);
</td></tr>
<tr><td>201</td>
<td class="normal"> switch ($operator) {
</td></tr>
<tr><td>202</td>
<td class="normal"> // case insensitive
</td></tr>
<tr><td>203</td>
<td class="red"> case 'ILIKE':
</td></tr>
<tr><td>204</td>
<td class="red"> $match = $field.'ILIKE ';
</td></tr>
<tr><td>205</td>
<td class="red"> break;
</td></tr>
<tr><td>206</td>
<td class="normal"> // case sensitive
</td></tr>
<tr><td>207</td>
<td class="red"> case 'LIKE':
</td></tr>
<tr><td>208</td>
<td class="red"> $match = $field.'LIKE ';
</td></tr>
<tr><td>209</td>
<td class="red"> break;
</td></tr>
<tr><td>210</td>
<td class="red"> default:
</td></tr>
<tr><td>211</td>
<td class="red"> throw new Doctrine_Expression_Pgsql_Exception('not a supported operator type:'. $operator);
</td></tr>
<tr><td>212</td>
<td class="red"> }
</td></tr>
<tr><td>213</td>
<td class="red"> }
</td></tr>
<tr><td>214</td>
<td class="red"> $match.= "'";
</td></tr>
<tr><td>215</td>
<td class="red"> foreach ($pattern as $key => $value) {
</td></tr>
<tr><td>216</td>
<td class="red"> if ($key % 2) {
</td></tr>
<tr><td>217</td>
<td class="red"> $match.= $value;
</td></tr>
<tr><td>218</td>
<td class="red"> } else {
</td></tr>
<tr><td>219</td>
<td class="red"> $match.= $this->conn->escapePattern($this->conn->escape($value));
</td></tr>
<tr><td>220</td>
<td class="normal"> }
</td></tr>
<tr><td>221</td>
<td class="red"> }
</td></tr>
<tr><td>222</td>
<td class="red"> $match.= "'";
</td></tr>
<tr><td>223</td>
<td class="red"> $match.= $this->patternEscapeString();
</td></tr>
<tr><td>224</td>
<td class="red"> return $match;
</td></tr>
<tr><td>225</td>
<td class="orange"> }
</td></tr>
<tr><td>226</td>
<td class="covered">}</td></tr>
</table></body></html>