<html> <head> <title>Coverage for Doctrine_Hook</title> <style type="text/css"> .covered{ background: green;} .normal{ background: white;} .red{ background: red;} .orange{ background: #f90;} </style> </head> <body><h1>Coverage for Doctrine_Hook</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: Hook.php 3189 2007-11-18 20:37:44Z meus $ </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="normal"> </td></tr> <tr><td>22</td> <td class="normal">/** </td></tr> <tr><td>23</td> <td class="normal"> * Doctrine_Hook </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 Hook </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: 3189 $ </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="normal">class Doctrine_Hook </td></tr> <tr><td>34</td> <td class="covered">{ </td></tr> <tr><td>35</td> <td class="normal"> /** </td></tr> <tr><td>36</td> <td class="normal"> * @var Doctrine_Query $query the base query </td></tr> <tr><td>37</td> <td class="normal"> */ </td></tr> <tr><td>38</td> <td class="normal"> protected $query; </td></tr> <tr><td>39</td> <td class="normal"> </td></tr> <tr><td>40</td> <td class="normal"> /** </td></tr> <tr><td>41</td> <td class="normal"> * @var array $joins the optional joins of the base query </td></tr> <tr><td>42</td> <td class="normal"> */ </td></tr> <tr><td>43</td> <td class="normal"> protected $joins; </td></tr> <tr><td>44</td> <td class="normal"> </td></tr> <tr><td>45</td> <td class="normal"> /** </td></tr> <tr><td>46</td> <td class="normal"> * @var array $hooks hooks array </td></tr> <tr><td>47</td> <td class="normal"> */ </td></tr> <tr><td>48</td> <td class="normal"> protected $hooks = array( </td></tr> <tr><td>49</td> <td class="normal"> 'where', </td></tr> <tr><td>50</td> <td class="normal"> 'orderby', </td></tr> <tr><td>51</td> <td class="normal"> 'limit', </td></tr> <tr><td>52</td> <td class="normal"> 'offset' </td></tr> <tr><td>53</td> <td class="normal"> ); </td></tr> <tr><td>54</td> <td class="normal"> </td></tr> <tr><td>55</td> <td class="normal"> /** </td></tr> <tr><td>56</td> <td class="normal"> * @var array $fieldParsers custom field parsers array </td></tr> <tr><td>57</td> <td class="normal"> * keys as field names in the format componentAlias.FieldName </td></tr> <tr><td>58</td> <td class="normal"> * values as parser names / objects </td></tr> <tr><td>59</td> <td class="normal"> */ </td></tr> <tr><td>60</td> <td class="normal"> protected $fieldParsers = array(); </td></tr> <tr><td>61</td> <td class="normal"> </td></tr> <tr><td>62</td> <td class="normal"> /** </td></tr> <tr><td>63</td> <td class="normal"> * @var array $typeParsers type parsers array </td></tr> <tr><td>64</td> <td class="normal"> * keys as type names and values as parser names / objects </td></tr> <tr><td>65</td> <td class="normal"> */ </td></tr> <tr><td>66</td> <td class="normal"> protected $typeParsers = array( </td></tr> <tr><td>67</td> <td class="normal"> 'char' => 'Doctrine_Hook_WordLike', </td></tr> <tr><td>68</td> <td class="normal"> 'string' => 'Doctrine_Hook_WordLike', </td></tr> <tr><td>69</td> <td class="normal"> 'varchar' => 'Doctrine_Hook_WordLike', </td></tr> <tr><td>70</td> <td class="normal"> 'integer' => 'Doctrine_Hook_Integer', </td></tr> <tr><td>71</td> <td class="normal"> 'enum' => 'Doctrine_Hook_Integer', </td></tr> <tr><td>72</td> <td class="normal"> 'time' => 'Doctrine_Hook_Time', </td></tr> <tr><td>73</td> <td class="normal"> 'date' => 'Doctrine_Hook_Date', </td></tr> <tr><td>74</td> <td class="normal"> ); </td></tr> <tr><td>75</td> <td class="normal"> </td></tr> <tr><td>76</td> <td class="normal"> /** </td></tr> <tr><td>77</td> <td class="normal"> * @param Doctrine_Query $query the base query </td></tr> <tr><td>78</td> <td class="normal"> */ </td></tr> <tr><td>79</td> <td class="normal"> public function __construct($query) </td></tr> <tr><td>80</td> <td class="normal"> { </td></tr> <tr><td>81</td> <td class="covered"> if (is_string($query)) { </td></tr> <tr><td>82</td> <td class="covered"> $this->query = new Doctrine_Query(); </td></tr> <tr><td>83</td> <td class="covered"> $this->query->parseQuery($query); </td></tr> <tr><td>84</td> <td class="covered"> } elseif ($query instanceof Doctrine_Query) { </td></tr> <tr><td>85</td> <td class="red"> $this->query = $query; </td></tr> <tr><td>86</td> <td class="red"> } else { </td></tr> <tr><td>87</td> <td class="red"> throw new Doctrine_Exception('Constructor argument should be either Doctrine_Query object or valid DQL query'); </td></tr> <tr><td>88</td> <td class="normal"> } </td></tr> <tr><td>89</td> <td class="normal"> </td></tr> <tr><td>90</td> <td class="covered"> $this->query->getQuery(); </td></tr> <tr><td>91</td> <td class="covered"> } </td></tr> <tr><td>92</td> <td class="normal"> </td></tr> <tr><td>93</td> <td class="normal"> /** </td></tr> <tr><td>94</td> <td class="normal"> * getQuery </td></tr> <tr><td>95</td> <td class="normal"> * </td></tr> <tr><td>96</td> <td class="normal"> * @return Doctrine_Query returns the query object associated with this hook </td></tr> <tr><td>97</td> <td class="normal"> */ </td></tr> <tr><td>98</td> <td class="normal"> public function getQuery() </td></tr> <tr><td>99</td> <td class="normal"> { </td></tr> <tr><td>100</td> <td class="covered"> return $this->query; </td></tr> <tr><td>101</td> <td class="orange"> } </td></tr> <tr><td>102</td> <td class="normal"> </td></tr> <tr><td>103</td> <td class="normal"> /** </td></tr> <tr><td>104</td> <td class="normal"> * setTypeParser </td></tr> <tr><td>105</td> <td class="normal"> * </td></tr> <tr><td>106</td> <td class="normal"> * @param string $type type name </td></tr> <tr><td>107</td> <td class="normal"> * @param string|object $parser parser name or custom parser object </td></tr> <tr><td>108</td> <td class="normal"> */ </td></tr> <tr><td>109</td> <td class="normal"> public function setTypeParser($type, $parser) </td></tr> <tr><td>110</td> <td class="normal"> { </td></tr> <tr><td>111</td> <td class="red"> $this->typeParsers[$type] = $parser; </td></tr> <tr><td>112</td> <td class="red"> } </td></tr> <tr><td>113</td> <td class="normal"> </td></tr> <tr><td>114</td> <td class="normal"> /** </td></tr> <tr><td>115</td> <td class="normal"> * setFieldParser </td></tr> <tr><td>116</td> <td class="normal"> * </td></tr> <tr><td>117</td> <td class="normal"> * @param string $field field name </td></tr> <tr><td>118</td> <td class="normal"> * @param string|object $parser parser name or custom parser object </td></tr> <tr><td>119</td> <td class="normal"> */ </td></tr> <tr><td>120</td> <td class="normal"> public function setFieldParser($field, $parser) </td></tr> <tr><td>121</td> <td class="normal"> { </td></tr> <tr><td>122</td> <td class="red"> $this->fieldParsers[$field] = $parser; </td></tr> <tr><td>123</td> <td class="red"> } </td></tr> <tr><td>124</td> <td class="normal"> </td></tr> <tr><td>125</td> <td class="normal"> /** </td></tr> <tr><td>126</td> <td class="normal"> * hookWhere </td></tr> <tr><td>127</td> <td class="normal"> * builds DQL query where part from given parameter array </td></tr> <tr><td>128</td> <td class="normal"> * </td></tr> <tr><td>129</td> <td class="normal"> * @param array $params an associative array containing field </td></tr> <tr><td>130</td> <td class="normal"> * names and their values </td></tr> <tr><td>131</td> <td class="normal"> * @return boolean whether or not the hooking was </td></tr> <tr><td>132</td> <td class="normal"> */ </td></tr> <tr><td>133</td> <td class="normal"> public function hookWhere($params) </td></tr> <tr><td>134</td> <td class="normal"> { </td></tr> <tr><td>135</td> <td class="covered"> if ( ! is_array($params)) { </td></tr> <tr><td>136</td> <td class="red"> return false; </td></tr> <tr><td>137</td> <td class="orange"> } </td></tr> <tr><td>138</td> <td class="covered"> foreach ($params as $name => $value) { </td></tr> <tr><td>139</td> <td class="covered"> if ($value === '' || $value === '-') { </td></tr> <tr><td>140</td> <td class="red"> continue; </td></tr> <tr><td>141</td> <td class="orange"> } </td></tr> <tr><td>142</td> <td class="covered"> $e = explode('.', $name); </td></tr> <tr><td>143</td> <td class="normal"> </td></tr> <tr><td>144</td> <td class="covered"> if (count($e) == 2) { </td></tr> <tr><td>145</td> <td class="covered"> list($alias, $column) = $e; </td></tr> <tr><td>146</td> <td class="normal"> </td></tr> <tr><td>147</td> <td class="covered"> $map = $this->query->getAliasDeclaration($alias); </td></tr> <tr><td>148</td> <td class="covered"> $table = $map['table']; </td></tr> <tr><td>149</td> <td class="normal"> </td></tr> <tr><td>150</td> <td class="covered"> if ( ! $table) { </td></tr> <tr><td>151</td> <td class="red"> throw new Doctrine_Exception('Unknown alias ' . $alias); </td></tr> <tr><td>152</td> <td class="orange"> } </td></tr> <tr><td>153</td> <td class="normal"> </td></tr> <tr><td>154</td> <td class="covered"> if ($def = $table->getDefinitionOf($column)) { </td></tr> <tr><td>155</td> <td class="normal"> </td></tr> <tr><td>156</td> <td class="covered"> $def[0] = gettype($value); </td></tr> <tr><td>157</td> <td class="covered"> if (isset($this->typeParsers[$def[0]])) { </td></tr> <tr><td>158</td> <td class="covered"> $name = $this->typeParsers[$def[0]]; </td></tr> <tr><td>159</td> <td class="covered"> $parser = new $name; </td></tr> <tr><td>160</td> <td class="covered"> } </td></tr> <tr><td>161</td> <td class="normal"> </td></tr> <tr><td>162</td> <td class="covered"> $parser->parse($alias, $column, $value); </td></tr> <tr><td>163</td> <td class="normal"> </td></tr> <tr><td>164</td> <td class="covered"> $this->query->addWhere($parser->getCondition(), $parser->getParams()); </td></tr> <tr><td>165</td> <td class="covered"> } </td></tr> <tr><td>166</td> <td class="covered"> } </td></tr> <tr><td>167</td> <td class="covered"> } </td></tr> <tr><td>168</td> <td class="normal"> </td></tr> <tr><td>169</td> <td class="covered"> return true; </td></tr> <tr><td>170</td> <td class="orange"> } </td></tr> <tr><td>171</td> <td class="normal"> </td></tr> <tr><td>172</td> <td class="normal"> /** </td></tr> <tr><td>173</td> <td class="normal"> * hookOrderBy </td></tr> <tr><td>174</td> <td class="normal"> * builds DQL query orderby part from given parameter array </td></tr> <tr><td>175</td> <td class="normal"> * </td></tr> <tr><td>176</td> <td class="normal"> * @param array $params an array containing all fields which the built query </td></tr> <tr><td>177</td> <td class="normal"> * should be ordered by </td></tr> <tr><td>178</td> <td class="normal"> * @return boolean whether or not the hooking was successful </td></tr> <tr><td>179</td> <td class="normal"> */ </td></tr> <tr><td>180</td> <td class="normal"> public function hookOrderby($params) </td></tr> <tr><td>181</td> <td class="normal"> { </td></tr> <tr><td>182</td> <td class="covered"> if ( ! is_array($params)) { </td></tr> <tr><td>183</td> <td class="red"> return false; </td></tr> <tr><td>184</td> <td class="orange"> } </td></tr> <tr><td>185</td> <td class="covered"> foreach ($params as $name) { </td></tr> <tr><td>186</td> <td class="covered"> $e = explode(' ', $name); </td></tr> <tr><td>187</td> <td class="normal"> </td></tr> <tr><td>188</td> <td class="covered"> $order = 'ASC'; </td></tr> <tr><td>189</td> <td class="normal"> </td></tr> <tr><td>190</td> <td class="covered"> if (count($e) > 1) { </td></tr> <tr><td>191</td> <td class="covered"> $order = ($e[1] == 'DESC') ? 'DESC' : 'ASC'; </td></tr> <tr><td>192</td> <td class="covered"> } </td></tr> <tr><td>193</td> <td class="normal"> </td></tr> <tr><td>194</td> <td class="covered"> $e = explode('.', $e[0]); </td></tr> <tr><td>195</td> <td class="normal"> </td></tr> <tr><td>196</td> <td class="covered"> if (count($e) == 2) { </td></tr> <tr><td>197</td> <td class="covered"> list($alias, $column) = $e; </td></tr> <tr><td>198</td> <td class="normal"> </td></tr> <tr><td>199</td> <td class="covered"> $map = $this->query->getAliasDeclaration($alias); </td></tr> <tr><td>200</td> <td class="covered"> $table = $map['table']; </td></tr> <tr><td>201</td> <td class="normal"> </td></tr> <tr><td>202</td> <td class="covered"> if ($def = $table->getDefinitionOf($column)) { </td></tr> <tr><td>203</td> <td class="covered"> $this->query->addOrderBy($alias . '.' . $column . ' ' . $order); </td></tr> <tr><td>204</td> <td class="covered"> } </td></tr> <tr><td>205</td> <td class="covered"> } </td></tr> <tr><td>206</td> <td class="covered"> } </td></tr> <tr><td>207</td> <td class="covered"> return true; </td></tr> <tr><td>208</td> <td class="orange"> } </td></tr> <tr><td>209</td> <td class="normal"> </td></tr> <tr><td>210</td> <td class="normal"> /** </td></tr> <tr><td>211</td> <td class="normal"> * set the hook limit </td></tr> <tr><td>212</td> <td class="normal"> * </td></tr> <tr><td>213</td> <td class="normal"> * @param integer $limit </td></tr> <tr><td>214</td> <td class="normal"> * @return void </td></tr> <tr><td>215</td> <td class="normal"> */ </td></tr> <tr><td>216</td> <td class="normal"> public function hookLimit($limit) </td></tr> <tr><td>217</td> <td class="normal"> { </td></tr> <tr><td>218</td> <td class="red"> $this->query->limit((int) $limit); </td></tr> <tr><td>219</td> <td class="red"> } </td></tr> <tr><td>220</td> <td class="normal"> </td></tr> <tr><td>221</td> <td class="normal"> /** </td></tr> <tr><td>222</td> <td class="normal"> * set the hook offset </td></tr> <tr><td>223</td> <td class="normal"> * </td></tr> <tr><td>224</td> <td class="normal"> * @param integer $offset </td></tr> <tr><td>225</td> <td class="normal"> */ </td></tr> <tr><td>226</td> <td class="normal"> public function hookOffset($offset) </td></tr> <tr><td>227</td> <td class="normal"> { </td></tr> <tr><td>228</td> <td class="red"> $this->query->offset((int) $offset); </td></tr> <tr><td>229</td> <td class="red"> } </td></tr> <tr><td>230</td> <td class="normal">} </td></tr> </table></body></html>