<html> <head> <title>Coverage for Doctrine_Formatter</title> <style type="text/css"> .covered{ background: green;} .normal{ background: white;} .red{ background: red;} .orange{ background: #f90;} </style> </head> <body><h1>Coverage for Doctrine_Formatter</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$ </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_Connection_Module'); </td></tr> <tr><td>22</td> <td class="normal">/** </td></tr> <tr><td>23</td> <td class="normal"> * Doctrine_Formatter </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 Formatter </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$ </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_Formatter extends Doctrine_Connection_Module </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"> * Quotes pattern (% and _) characters in a string) </td></tr> <tr><td>37</td> <td class="normal"> * </td></tr> <tr><td>38</td> <td class="normal"> * EXPERIMENTAL </td></tr> <tr><td>39</td> <td class="normal"> * </td></tr> <tr><td>40</td> <td class="normal"> * WARNING: this function is experimental and may change signature at </td></tr> <tr><td>41</td> <td class="normal"> * any time until labelled as non-experimental </td></tr> <tr><td>42</td> <td class="normal"> * </td></tr> <tr><td>43</td> <td class="normal"> * @param string the input string to quote </td></tr> <tr><td>44</td> <td class="normal"> * </td></tr> <tr><td>45</td> <td class="normal"> * @return string quoted string </td></tr> <tr><td>46</td> <td class="normal"> */ </td></tr> <tr><td>47</td> <td class="normal"> public function escapePattern($text) </td></tr> <tr><td>48</td> <td class="normal"> { </td></tr> <tr><td>49</td> <td class="red"> if ($this->string_quoting['escape_pattern']) { </td></tr> <tr><td>50</td> <td class="red"> $tmp = $this->conn->string_quoting; </td></tr> <tr><td>51</td> <td class="normal"> </td></tr> <tr><td>52</td> <td class="red"> $text = str_replace($tmp['escape_pattern'], </td></tr> <tr><td>53</td> <td class="red"> $tmp['escape_pattern'] . </td></tr> <tr><td>54</td> <td class="red"> $tmp['escape_pattern'], $text); </td></tr> <tr><td>55</td> <td class="normal"> </td></tr> <tr><td>56</td> <td class="red"> foreach ($this->wildcards as $wildcard) { </td></tr> <tr><td>57</td> <td class="red"> $text = str_replace($wildcard, $tmp['escape_pattern'] . $wildcard, $text); </td></tr> <tr><td>58</td> <td class="red"> } </td></tr> <tr><td>59</td> <td class="red"> } </td></tr> <tr><td>60</td> <td class="red"> return $text; </td></tr> <tr><td>61</td> <td class="orange"> } </td></tr> <tr><td>62</td> <td class="normal"> /** </td></tr> <tr><td>63</td> <td class="normal"> * convertBooleans </td></tr> <tr><td>64</td> <td class="normal"> * some drivers need the boolean values to be converted into integers </td></tr> <tr><td>65</td> <td class="normal"> * when using DQL API </td></tr> <tr><td>66</td> <td class="normal"> * </td></tr> <tr><td>67</td> <td class="normal"> * This method takes care of that conversion </td></tr> <tr><td>68</td> <td class="normal"> * </td></tr> <tr><td>69</td> <td class="normal"> * @param array $item </td></tr> <tr><td>70</td> <td class="normal"> * @return void </td></tr> <tr><td>71</td> <td class="normal"> */ </td></tr> <tr><td>72</td> <td class="normal"> public function convertBooleans($item) </td></tr> <tr><td>73</td> <td class="normal"> { </td></tr> <tr><td>74</td> <td class="covered"> if (is_array($item)) { </td></tr> <tr><td>75</td> <td class="covered"> foreach ($item as $k => $value) { </td></tr> <tr><td>76</td> <td class="covered"> if (is_bool($value)) { </td></tr> <tr><td>77</td> <td class="covered"> $item[$k] = (int) $value; </td></tr> <tr><td>78</td> <td class="covered"> } </td></tr> <tr><td>79</td> <td class="covered"> } </td></tr> <tr><td>80</td> <td class="covered"> } else { </td></tr> <tr><td>81</td> <td class="covered"> if (is_bool($item)) { </td></tr> <tr><td>82</td> <td class="covered"> $item = (int) $item; </td></tr> <tr><td>83</td> <td class="covered"> } </td></tr> <tr><td>84</td> <td class="normal"> } </td></tr> <tr><td>85</td> <td class="covered"> return $item; </td></tr> <tr><td>86</td> <td class="orange"> } </td></tr> <tr><td>87</td> <td class="normal"> /** </td></tr> <tr><td>88</td> <td class="normal"> * Quote a string so it can be safely used as a table or column name </td></tr> <tr><td>89</td> <td class="normal"> * </td></tr> <tr><td>90</td> <td class="normal"> * Delimiting style depends on which database driver is being used. </td></tr> <tr><td>91</td> <td class="normal"> * </td></tr> <tr><td>92</td> <td class="normal"> * NOTE: just because you CAN use delimited identifiers doesn't mean </td></tr> <tr><td>93</td> <td class="normal"> * you SHOULD use them. In general, they end up causing way more </td></tr> <tr><td>94</td> <td class="normal"> * problems than they solve. </td></tr> <tr><td>95</td> <td class="normal"> * </td></tr> <tr><td>96</td> <td class="normal"> * Portability is broken by using the following characters inside </td></tr> <tr><td>97</td> <td class="normal"> * delimited identifiers: </td></tr> <tr><td>98</td> <td class="normal"> * + backtick (<kbd>`</kbd>) -- due to MySQL </td></tr> <tr><td>99</td> <td class="normal"> * + double quote (<kbd>"</kbd>) -- due to Oracle </td></tr> <tr><td>100</td> <td class="normal"> * + brackets (<kbd>[</kbd> or <kbd>]</kbd>) -- due to Access </td></tr> <tr><td>101</td> <td class="normal"> * </td></tr> <tr><td>102</td> <td class="normal"> * Delimited identifiers are known to generally work correctly under </td></tr> <tr><td>103</td> <td class="normal"> * the following drivers: </td></tr> <tr><td>104</td> <td class="normal"> * + mssql </td></tr> <tr><td>105</td> <td class="normal"> * + mysql </td></tr> <tr><td>106</td> <td class="normal"> * + mysqli </td></tr> <tr><td>107</td> <td class="normal"> * + oci8 </td></tr> <tr><td>108</td> <td class="normal"> * + pgsql </td></tr> <tr><td>109</td> <td class="normal"> * + sqlite </td></tr> <tr><td>110</td> <td class="normal"> * </td></tr> <tr><td>111</td> <td class="normal"> * InterBase doesn't seem to be able to use delimited identifiers </td></tr> <tr><td>112</td> <td class="normal"> * via PHP 4. They work fine under PHP 5. </td></tr> <tr><td>113</td> <td class="normal"> * </td></tr> <tr><td>114</td> <td class="normal"> * @param string $str identifier name to be quoted </td></tr> <tr><td>115</td> <td class="normal"> * @param bool $checkOption check the 'quote_identifier' option </td></tr> <tr><td>116</td> <td class="normal"> * </td></tr> <tr><td>117</td> <td class="normal"> * @return string quoted identifier string </td></tr> <tr><td>118</td> <td class="normal"> */ </td></tr> <tr><td>119</td> <td class="normal"> public function quoteIdentifier($str, $checkOption = true) </td></tr> <tr><td>120</td> <td class="normal"> { </td></tr> <tr><td>121</td> <td class="covered"> if ($checkOption && ! $this->conn->getAttribute(Doctrine::ATTR_QUOTE_IDENTIFIER)) { </td></tr> <tr><td>122</td> <td class="covered"> return $str; </td></tr> <tr><td>123</td> <td class="orange"> } </td></tr> <tr><td>124</td> <td class="covered"> $tmp = $this->conn->identifier_quoting; </td></tr> <tr><td>125</td> <td class="covered"> $str = str_replace($tmp['end'], </td></tr> <tr><td>126</td> <td class="covered"> $tmp['escape'] . </td></tr> <tr><td>127</td> <td class="covered"> $tmp['end'], $str); </td></tr> <tr><td>128</td> <td class="normal"> </td></tr> <tr><td>129</td> <td class="covered"> return $tmp['start'] . $str . $tmp['end']; </td></tr> <tr><td>130</td> <td class="orange"> } </td></tr> <tr><td>131</td> <td class="normal"> /** </td></tr> <tr><td>132</td> <td class="normal"> * quote </td></tr> <tr><td>133</td> <td class="normal"> * quotes given input parameter </td></tr> <tr><td>134</td> <td class="normal"> * </td></tr> <tr><td>135</td> <td class="normal"> * @param mixed $input parameter to be quoted </td></tr> <tr><td>136</td> <td class="normal"> * @param string $type </td></tr> <tr><td>137</td> <td class="normal"> * @return mixed </td></tr> <tr><td>138</td> <td class="normal"> */ </td></tr> <tr><td>139</td> <td class="normal"> public function quote($input, $type = null) </td></tr> <tr><td>140</td> <td class="normal"> { </td></tr> <tr><td>141</td> <td class="covered"> if ($type == null) { </td></tr> <tr><td>142</td> <td class="covered"> $type = gettype($input); </td></tr> <tr><td>143</td> <td class="covered"> } </td></tr> <tr><td>144</td> <td class="normal"> switch ($type) { </td></tr> <tr><td>145</td> <td class="covered"> case 'integer': </td></tr> <tr><td>146</td> <td class="covered"> case 'enum': </td></tr> <tr><td>147</td> <td class="covered"> case 'boolean': </td></tr> <tr><td>148</td> <td class="covered"> case 'double': </td></tr> <tr><td>149</td> <td class="covered"> case 'float': </td></tr> <tr><td>150</td> <td class="covered"> case 'bool': </td></tr> <tr><td>151</td> <td class="covered"> case 'decimal': </td></tr> <tr><td>152</td> <td class="covered"> case 'int': </td></tr> <tr><td>153</td> <td class="covered"> return $input; </td></tr> <tr><td>154</td> <td class="covered"> case 'array': </td></tr> <tr><td>155</td> <td class="covered"> case 'object': </td></tr> <tr><td>156</td> <td class="covered"> $input = serialize($input); </td></tr> <tr><td>157</td> <td class="covered"> case 'string': </td></tr> <tr><td>158</td> <td class="covered"> case 'char': </td></tr> <tr><td>159</td> <td class="covered"> case 'varchar': </td></tr> <tr><td>160</td> <td class="covered"> case 'text': </td></tr> <tr><td>161</td> <td class="covered"> case 'gzip': </td></tr> <tr><td>162</td> <td class="covered"> case 'blob': </td></tr> <tr><td>163</td> <td class="covered"> case 'clob': </td></tr> <tr><td>164</td> <td class="covered"> $this->conn->connect(); </td></tr> <tr><td>165</td> <td class="normal"> </td></tr> <tr><td>166</td> <td class="covered"> return $this->conn->getDbh()->quote($input); </td></tr> <tr><td>167</td> <td class="orange"> } </td></tr> <tr><td>168</td> <td class="red"> } </td></tr> <tr><td>169</td> <td class="normal"> /** </td></tr> <tr><td>170</td> <td class="normal"> * Removes any formatting in an sequence name using the 'seqname_format' option </td></tr> <tr><td>171</td> <td class="normal"> * </td></tr> <tr><td>172</td> <td class="normal"> * @param string $sqn string that containts name of a potential sequence </td></tr> <tr><td>173</td> <td class="normal"> * @return string name of the sequence with possible formatting removed </td></tr> <tr><td>174</td> <td class="normal"> */ </td></tr> <tr><td>175</td> <td class="normal"> public function fixSequenceName($sqn) </td></tr> <tr><td>176</td> <td class="normal"> { </td></tr> <tr><td>177</td> <td class="red"> $seqPattern = '/^'.preg_replace('/%s/', '([a-z0-9_]+)', $this->conn->getAttribute(Doctrine::ATTR_SEQNAME_FORMAT)).'$/i'; </td></tr> <tr><td>178</td> <td class="red"> $seqName = preg_replace($seqPattern, '\\1', $sqn); </td></tr> <tr><td>179</td> <td class="normal"> </td></tr> <tr><td>180</td> <td class="red"> if ($seqName && ! strcasecmp($sqn, $this->getSequenceName($seqName))) { </td></tr> <tr><td>181</td> <td class="red"> return $seqName; </td></tr> <tr><td>182</td> <td class="orange"> } </td></tr> <tr><td>183</td> <td class="red"> return $sqn; </td></tr> <tr><td>184</td> <td class="orange"> } </td></tr> <tr><td>185</td> <td class="normal"> /** </td></tr> <tr><td>186</td> <td class="normal"> * Removes any formatting in an index name using the 'idxname_format' option </td></tr> <tr><td>187</td> <td class="normal"> * </td></tr> <tr><td>188</td> <td class="normal"> * @param string $idx string that containts name of anl index </td></tr> <tr><td>189</td> <td class="normal"> * @return string name of the index with possible formatting removed </td></tr> <tr><td>190</td> <td class="normal"> */ </td></tr> <tr><td>191</td> <td class="normal"> public function fixIndexName($idx) </td></tr> <tr><td>192</td> <td class="normal"> { </td></tr> <tr><td>193</td> <td class="red"> $indexPattern = '/^'.preg_replace('/%s/', '([a-z0-9_]+)', $this->conn->getAttribute(Doctrine::ATTR_IDXNAME_FORMAT)).'$/i'; </td></tr> <tr><td>194</td> <td class="red"> $indexName = preg_replace($indexPattern, '\\1', $idx); </td></tr> <tr><td>195</td> <td class="red"> if ($indexName && ! strcasecmp($idx, $this->getIndexName($indexName))) { </td></tr> <tr><td>196</td> <td class="red"> return $indexName; </td></tr> <tr><td>197</td> <td class="orange"> } </td></tr> <tr><td>198</td> <td class="red"> return $idx; </td></tr> <tr><td>199</td> <td class="orange"> } </td></tr> <tr><td>200</td> <td class="normal"> /** </td></tr> <tr><td>201</td> <td class="normal"> * adds sequence name formatting to a sequence name </td></tr> <tr><td>202</td> <td class="normal"> * </td></tr> <tr><td>203</td> <td class="normal"> * @param string name of the sequence </td></tr> <tr><td>204</td> <td class="normal"> * @return string formatted sequence name </td></tr> <tr><td>205</td> <td class="normal"> */ </td></tr> <tr><td>206</td> <td class="normal"> public function getSequenceName($sqn) </td></tr> <tr><td>207</td> <td class="normal"> { </td></tr> <tr><td>208</td> <td class="covered"> return sprintf($this->conn->getAttribute(Doctrine::ATTR_SEQNAME_FORMAT), </td></tr> <tr><td>209</td> <td class="covered"> preg_replace('/[^a-z0-9_\$.]/i', '_', $sqn)); </td></tr> <tr><td>210</td> <td class="orange"> } </td></tr> <tr><td>211</td> <td class="normal"> /** </td></tr> <tr><td>212</td> <td class="normal"> * adds index name formatting to a index name </td></tr> <tr><td>213</td> <td class="normal"> * </td></tr> <tr><td>214</td> <td class="normal"> * @param string name of the index </td></tr> <tr><td>215</td> <td class="normal"> * @return string formatted index name </td></tr> <tr><td>216</td> <td class="normal"> */ </td></tr> <tr><td>217</td> <td class="normal"> public function getIndexName($idx) </td></tr> <tr><td>218</td> <td class="normal"> { </td></tr> <tr><td>219</td> <td class="covered"> return sprintf($this->conn->getAttribute(Doctrine::ATTR_IDXNAME_FORMAT), </td></tr> <tr><td>220</td> <td class="covered"> preg_replace('/[^a-z0-9_\$]/i', '_', $idx)); </td></tr> <tr><td>221</td> <td class="orange"> } </td></tr> <tr><td>222</td> <td class="covered">}</td></tr> </table></body></html>