<html> <head> <title>Coverage for Doctrine_Import_Schema</title> <style type="text/css"> .covered{ background: green;} .normal{ background: white;} .red{ background: red;} .orange{ background: #f90;} </style> </head> <body><h1>Coverage for Doctrine_Import_Schema</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: Schema.php 1838 2007-06-26 00:58:21Z nicobn $ </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"> * class Doctrine_Import_Schema </td></tr> <tr><td>24</td> <td class="normal"> * </td></tr> <tr><td>25</td> <td class="normal"> * Different methods to import a XML schema. The logic behind using two different </td></tr> <tr><td>26</td> <td class="normal"> * methods is simple. Some people will like the idea of producing Doctrine_Record </td></tr> <tr><td>27</td> <td class="normal"> * objects directly, which is totally fine. But in fast and growing application, </td></tr> <tr><td>28</td> <td class="normal"> * table definitions tend to be a little bit more volatile. importArr() can be used </td></tr> <tr><td>29</td> <td class="normal"> * to output a table definition in a PHP file. This file can then be stored </td></tr> <tr><td>30</td> <td class="normal"> * independantly from the object itself. </td></tr> <tr><td>31</td> <td class="normal"> * </td></tr> <tr><td>32</td> <td class="normal"> * @package Doctrine </td></tr> <tr><td>33</td> <td class="normal"> * @subpackage Import </td></tr> <tr><td>34</td> <td class="normal"> * @link www.phpdoctrine.com </td></tr> <tr><td>35</td> <td class="normal"> * @license http://www.opensource.org/licenses/lgpl-license.php LGPL </td></tr> <tr><td>36</td> <td class="normal"> * @version $Revision: 1838 $ </td></tr> <tr><td>37</td> <td class="normal"> * @author Nicolas BĂ©rard-Nault <nicobn@gmail.com> </td></tr> <tr><td>38</td> <td class="normal"> * @author Jonathan H. Wage <jonwage@gmail.com> </td></tr> <tr><td>39</td> <td class="normal"> */ </td></tr> <tr><td>40</td> <td class="normal">class Doctrine_Import_Schema </td></tr> <tr><td>41</td> <td class="covered">{ </td></tr> <tr><td>42</td> <td class="normal"> public $relations = array(); </td></tr> <tr><td>43</td> <td class="normal"> public $generateBaseClasses = false; </td></tr> <tr><td>44</td> <td class="normal"> </td></tr> <tr><td>45</td> <td class="normal"> public function generateBaseClasses($bool = null) </td></tr> <tr><td>46</td> <td class="normal"> { </td></tr> <tr><td>47</td> <td class="covered"> if ($bool !== null) { </td></tr> <tr><td>48</td> <td class="red"> $this->generateBaseClasses = $bool; </td></tr> <tr><td>49</td> <td class="red"> } </td></tr> <tr><td>50</td> <td class="normal"> </td></tr> <tr><td>51</td> <td class="covered"> return $this->generateBaseClasses; </td></tr> <tr><td>52</td> <td class="orange"> } </td></tr> <tr><td>53</td> <td class="normal"> public function buildSchema($schema, $format) </td></tr> <tr><td>54</td> <td class="normal"> { </td></tr> <tr><td>55</td> <td class="covered"> $array = array(); </td></tr> <tr><td>56</td> <td class="covered"> foreach ((array) $schema AS $s) { </td></tr> <tr><td>57</td> <td class="covered"> $array = array_merge($array, $this->parseSchema($s, $format)); </td></tr> <tr><td>58</td> <td class="covered"> } </td></tr> <tr><td>59</td> <td class="normal"> </td></tr> <tr><td>60</td> <td class="covered"> $this->buildRelationships($array); </td></tr> <tr><td>61</td> <td class="normal"> </td></tr> <tr><td>62</td> <td class="covered"> return array('schema' => $array, 'relations' => $this->relations); </td></tr> <tr><td>63</td> <td class="orange"> } </td></tr> <tr><td>64</td> <td class="normal"> /** </td></tr> <tr><td>65</td> <td class="normal"> * importSchema </td></tr> <tr><td>66</td> <td class="normal"> * </td></tr> <tr><td>67</td> <td class="normal"> * A method to import a Schema and translate it into a Doctrine_Record object </td></tr> <tr><td>68</td> <td class="normal"> * </td></tr> <tr><td>69</td> <td class="normal"> * @param string $schema The file containing the XML schema </td></tr> <tr><td>70</td> <td class="normal"> * @param string $directory The directory where the Doctrine_Record class will be written </td></tr> <tr><td>71</td> <td class="normal"> * @param array $models Optional array of models to import </td></tr> <tr><td>72</td> <td class="normal"> * </td></tr> <tr><td>73</td> <td class="normal"> * @access public </td></tr> <tr><td>74</td> <td class="normal"> */ </td></tr> <tr><td>75</td> <td class="normal"> public function importSchema($schema, $format = 'yml', $directory = null, $models = array()) </td></tr> <tr><td>76</td> <td class="normal"> { </td></tr> <tr><td>77</td> <td class="covered"> $builder = new Doctrine_Import_Builder(); </td></tr> <tr><td>78</td> <td class="covered"> $builder->setTargetPath($directory); </td></tr> <tr><td>79</td> <td class="covered"> $builder->generateBaseClasses($this->generateBaseClasses()); </td></tr> <tr><td>80</td> <td class="normal"> </td></tr> <tr><td>81</td> <td class="covered"> $schema = $this->buildSchema($schema, $format); </td></tr> <tr><td>82</td> <td class="normal"> </td></tr> <tr><td>83</td> <td class="covered"> $array = $schema['schema']; </td></tr> <tr><td>84</td> <td class="normal"> </td></tr> <tr><td>85</td> <td class="covered"> foreach ($array as $name => $properties) { </td></tr> <tr><td>86</td> <td class="covered"> if (!empty($models) && !in_array($properties['className'], $models)) { </td></tr> <tr><td>87</td> <td class="red"> continue; </td></tr> <tr><td>88</td> <td class="orange"> } </td></tr> <tr><td>89</td> <td class="normal"> </td></tr> <tr><td>90</td> <td class="covered"> $options = $this->getOptions($properties, $directory); </td></tr> <tr><td>91</td> <td class="covered"> $columns = $this->getColumns($properties); </td></tr> <tr><td>92</td> <td class="covered"> $relations = $this->getRelations($properties); </td></tr> <tr><td>93</td> <td class="normal"> </td></tr> <tr><td>94</td> <td class="covered"> $builder->buildRecord($options, $columns, $relations); </td></tr> <tr><td>95</td> <td class="covered"> } </td></tr> <tr><td>96</td> <td class="covered"> } </td></tr> <tr><td>97</td> <td class="normal"> </td></tr> <tr><td>98</td> <td class="normal"> public function getOptions($properties, $directory) </td></tr> <tr><td>99</td> <td class="normal"> { </td></tr> <tr><td>100</td> <td class="covered"> $options = array(); </td></tr> <tr><td>101</td> <td class="covered"> $options['className'] = $properties['className']; </td></tr> <tr><td>102</td> <td class="covered"> $options['fileName'] = $directory.DIRECTORY_SEPARATOR.$properties['className'].'.class.php'; </td></tr> <tr><td>103</td> <td class="covered"> $options['tableName'] = isset($properties['tableName']) ? $properties['tableName']:null; </td></tr> <tr><td>104</td> <td class="normal"> </td></tr> <tr><td>105</td> <td class="covered"> if (isset($properties['inheritance'])) { </td></tr> <tr><td>106</td> <td class="red"> $options['inheritance'] = $properties['inheritance']; </td></tr> <tr><td>107</td> <td class="red"> } </td></tr> <tr><td>108</td> <td class="normal"> </td></tr> <tr><td>109</td> <td class="covered"> return $options; </td></tr> <tr><td>110</td> <td class="orange"> } </td></tr> <tr><td>111</td> <td class="normal"> </td></tr> <tr><td>112</td> <td class="normal"> public function getColumns($properties) </td></tr> <tr><td>113</td> <td class="normal"> { </td></tr> <tr><td>114</td> <td class="covered"> return isset($properties['columns']) ? $properties['columns']:array(); </td></tr> <tr><td>115</td> <td class="orange"> } </td></tr> <tr><td>116</td> <td class="normal"> </td></tr> <tr><td>117</td> <td class="normal"> public function getRelations($properties) </td></tr> <tr><td>118</td> <td class="normal"> { </td></tr> <tr><td>119</td> <td class="covered"> return isset($this->relations[$properties['className']]) ? $this->relations[$properties['className']]:array(); </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"> * parseSchema </td></tr> <tr><td>124</td> <td class="normal"> * </td></tr> <tr><td>125</td> <td class="normal"> * A method to parse a Yml Schema and translate it into a property array. </td></tr> <tr><td>126</td> <td class="normal"> * The function returns that property array. </td></tr> <tr><td>127</td> <td class="normal"> * </td></tr> <tr><td>128</td> <td class="normal"> * @param string $schema Path to the file containing the XML schema </td></tr> <tr><td>129</td> <td class="normal"> * @return array </td></tr> <tr><td>130</td> <td class="normal"> */ </td></tr> <tr><td>131</td> <td class="normal"> public function parseSchema($schema, $type) </td></tr> <tr><td>132</td> <td class="normal"> { </td></tr> <tr><td>133</td> <td class="covered"> $array = Doctrine_Parser::load($schema, $type); </td></tr> <tr><td>134</td> <td class="normal"> </td></tr> <tr><td>135</td> <td class="covered"> $build = array(); </td></tr> <tr><td>136</td> <td class="normal"> </td></tr> <tr><td>137</td> <td class="covered"> foreach ($array as $className => $table) { </td></tr> <tr><td>138</td> <td class="covered"> $columns = array(); </td></tr> <tr><td>139</td> <td class="normal"> </td></tr> <tr><td>140</td> <td class="covered"> $className = isset($table['className']) ? (string) $table['className']:(string) $className; </td></tr> <tr><td>141</td> <td class="covered"> $tableName = isset($table['tableName']) ? (string) $table['tableName']:(string) Doctrine::tableize($className); </td></tr> <tr><td>142</td> <td class="normal"> </td></tr> <tr><td>143</td> <td class="covered"> $build[$className]['className'] = $className; </td></tr> <tr><td>144</td> <td class="normal"> </td></tr> <tr><td>145</td> <td class="covered"> if (isset($table['columns'])) { </td></tr> <tr><td>146</td> <td class="covered"> foreach ($table['columns'] as $columnName => $field) { </td></tr> <tr><td>147</td> <td class="covered"> $colDesc = array(); </td></tr> <tr><td>148</td> <td class="covered"> $colDesc['name'] = isset($field['name']) ? (string) $field['name']:$columnName; </td></tr> <tr><td>149</td> <td class="covered"> $colDesc['type'] = isset($field['type']) ? (string) $field['type']:null; </td></tr> <tr><td>150</td> <td class="covered"> $colDesc['ptype'] = isset($field['ptype']) ? (string) $field['ptype']:(string) $colDesc['type']; </td></tr> <tr><td>151</td> <td class="covered"> $colDesc['length'] = isset($field['length']) ? (int) $field['length']:null; </td></tr> <tr><td>152</td> <td class="covered"> $colDesc['fixed'] = isset($field['fixed']) ? (int) $field['fixed']:null; </td></tr> <tr><td>153</td> <td class="covered"> $colDesc['unsigned'] = isset($field['unsigned']) ? (bool) $field['unsigned']:null; </td></tr> <tr><td>154</td> <td class="covered"> $colDesc['primary'] = isset($field['primary']) ? (bool) (isset($field['primary']) && $field['primary']):null; </td></tr> <tr><td>155</td> <td class="covered"> $colDesc['default'] = isset($field['default']) ? (string) $field['default']:null; </td></tr> <tr><td>156</td> <td class="covered"> $colDesc['notnull'] = isset($field['notnull']) ? (bool) (isset($field['notnull']) && $field['notnull']):null; </td></tr> <tr><td>157</td> <td class="covered"> $colDesc['autoincrement'] = isset($field['autoincrement']) ? (bool) (isset($field['autoincrement']) && $field['autoincrement']):null; </td></tr> <tr><td>158</td> <td class="covered"> $colDesc['unique'] = isset($field['unique']) ? (bool) (isset($field['unique']) && $field['unique']):null; </td></tr> <tr><td>159</td> <td class="covered"> $colDesc['values'] = isset($field['values']) ? (array) $field['values']: null; </td></tr> <tr><td>160</td> <td class="normal"> </td></tr> <tr><td>161</td> <td class="covered"> $columns[(string) $colDesc['name']] = $colDesc; </td></tr> <tr><td>162</td> <td class="covered"> } </td></tr> <tr><td>163</td> <td class="normal"> </td></tr> <tr><td>164</td> <td class="covered"> $build[$className]['tableName'] = $tableName; </td></tr> <tr><td>165</td> <td class="covered"> $build[$className]['columns'] = $columns; </td></tr> <tr><td>166</td> <td class="covered"> $build[$className]['relations'] = isset($table['relations']) ? $table['relations']:array(); </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"> if (isset($table['inheritance'])) { </td></tr> <tr><td>170</td> <td class="red"> $build[$className]['inheritance'] = $table['inheritance']; </td></tr> <tr><td>171</td> <td class="red"> } </td></tr> <tr><td>172</td> <td class="covered"> } </td></tr> <tr><td>173</td> <td class="normal"> </td></tr> <tr><td>174</td> <td class="covered"> return $build; </td></tr> <tr><td>175</td> <td class="orange"> } </td></tr> <tr><td>176</td> <td class="normal"> </td></tr> <tr><td>177</td> <td class="normal"> public function buildRelationships(&$array) </td></tr> <tr><td>178</td> <td class="normal"> { </td></tr> <tr><td>179</td> <td class="covered"> foreach ($array as $name => $properties) { </td></tr> <tr><td>180</td> <td class="covered"> if (!isset($properties['relations'])) { </td></tr> <tr><td>181</td> <td class="red"> continue; </td></tr> <tr><td>182</td> <td class="orange"> } </td></tr> <tr><td>183</td> <td class="normal"> </td></tr> <tr><td>184</td> <td class="covered"> $className = $properties['className']; </td></tr> <tr><td>185</td> <td class="covered"> $relations = $properties['relations']; </td></tr> <tr><td>186</td> <td class="normal"> </td></tr> <tr><td>187</td> <td class="covered"> foreach ($relations as $alias => $relation) { </td></tr> <tr><td>188</td> <td class="normal"> </td></tr> <tr><td>189</td> <td class="red"> $class = isset($relation['class']) ? $relation['class']:$alias; </td></tr> <tr><td>190</td> <td class="normal"> </td></tr> <tr><td>191</td> <td class="red"> $relation['foreign'] = isset($relation['foreign'])?$relation['foreign']:'id'; </td></tr> <tr><td>192</td> <td class="red"> $relation['alias'] = isset($relation['alias']) ? $relation['alias'] : $alias; </td></tr> <tr><td>193</td> <td class="red"> $relation['class'] = $class; </td></tr> <tr><td>194</td> <td class="normal"> </td></tr> <tr><td>195</td> <td class="red"> if (isset($relation['type']) && $relation['type']) { </td></tr> <tr><td>196</td> <td class="red"> $relation['type'] = $relation['type'] === 'one' ? Doctrine_Relation::ONE:Doctrine_Relation::MANY; </td></tr> <tr><td>197</td> <td class="red"> } else { </td></tr> <tr><td>198</td> <td class="red"> $relation['type'] = Doctrine_Relation::ONE; </td></tr> <tr><td>199</td> <td class="normal"> } </td></tr> <tr><td>200</td> <td class="normal"> </td></tr> <tr><td>201</td> <td class="red"> if (isset($relation['foreignType']) && $relation['foreignType']) { </td></tr> <tr><td>202</td> <td class="red"> $relation['foreignType'] = $relation['foreignType'] === 'one' ? Doctrine_Relation::ONE:Doctrine_Relation::MANY; </td></tr> <tr><td>203</td> <td class="red"> } </td></tr> <tr><td>204</td> <td class="normal"> </td></tr> <tr><td>205</td> <td class="red"> if(isset($relation['refClass']) && !empty($relation['refClass']) && (!isset($array[$relation['refClass']]['relations']) || empty($array[$relation['refClass']]['relations']))) { </td></tr> <tr><td>206</td> <td class="red"> $array[$relation['refClass']]['relations'][$className] = array('local'=>$relation['local'],'foreign'=>$relation['foreign'],'ignore'=>true); </td></tr> <tr><td>207</td> <td class="red"> $array[$relation['refClass']]['relations'][$relation['class']] = array('local'=>$relation['local'],'foreign'=>$relation['foreign'],'ignore'=>true); </td></tr> <tr><td>208</td> <td class="normal"> </td></tr> <tr><td>209</td> <td class="red"> if(isset($relation['foreignAlias'])) { </td></tr> <tr><td>210</td> <td class="red"> $array[$relation['class']]['relations'][$relation['foreignAlias']] = array('type'=>$relation['type'],'local'=>$relation['foreign'],'foreign'=>$relation['local'],'refClass'=>$relation['refClass'],'class'=>$className); </td></tr> <tr><td>211</td> <td class="red"> } </td></tr> <tr><td>212</td> <td class="red"> } </td></tr> <tr><td>213</td> <td class="normal"> </td></tr> <tr><td>214</td> <td class="red"> $this->relations[$className][$alias] = $relation; </td></tr> <tr><td>215</td> <td class="red"> } </td></tr> <tr><td>216</td> <td class="covered"> } </td></tr> <tr><td>217</td> <td class="normal"> </td></tr> <tr><td>218</td> <td class="covered"> $this->fixRelationships(); </td></tr> <tr><td>219</td> <td class="covered"> } </td></tr> <tr><td>220</td> <td class="normal"> </td></tr> <tr><td>221</td> <td class="normal"> public function fixRelationships() </td></tr> <tr><td>222</td> <td class="normal"> { </td></tr> <tr><td>223</td> <td class="normal"> // define both sides of the relationship </td></tr> <tr><td>224</td> <td class="covered"> foreach($this->relations as $className => $relations) { </td></tr> <tr><td>225</td> <td class="red"> foreach ($relations AS $alias => $relation) { </td></tr> <tr><td>226</td> <td class="red"> if(isset($relation['ignore']) && $relation['ignore'] || isset($relation['refClass']) || isset($this->relations[$relation['class']]['relations'][$className])) { </td></tr> <tr><td>227</td> <td class="red"> continue; </td></tr> <tr><td>228</td> <td class="orange"> } </td></tr> <tr><td>229</td> <td class="normal"> </td></tr> <tr><td>230</td> <td class="red"> $newRelation = array(); </td></tr> <tr><td>231</td> <td class="red"> $newRelation['foreign'] = $relation['local']; </td></tr> <tr><td>232</td> <td class="red"> $newRelation['local'] = $relation['foreign']; </td></tr> <tr><td>233</td> <td class="red"> $newRelation['class'] = $className; </td></tr> <tr><td>234</td> <td class="red"> $newRelation['alias'] = isset($relation['foreignAlias'])?$relation['foreignAlias']:$className; </td></tr> <tr><td>235</td> <td class="normal"> </td></tr> <tr><td>236</td> <td class="red"> if(isset($relation['foreignType'])) { </td></tr> <tr><td>237</td> <td class="red"> $newRelation['type'] = $relation['foreignType']; </td></tr> <tr><td>238</td> <td class="red"> } else { </td></tr> <tr><td>239</td> <td class="red"> $newRelation['type'] = $relation['type'] === Doctrine_Relation::ONE ? Doctrine_Relation::MANY:Doctrine_Relation::ONE; </td></tr> <tr><td>240</td> <td class="normal"> } </td></tr> <tr><td>241</td> <td class="normal"> </td></tr> <tr><td>242</td> <td class="red"> if( isset($this->relations[$relation['class']]) && is_array($this->relations[$relation['class']]) ) { </td></tr> <tr><td>243</td> <td class="red"> foreach($this->relations[$relation['class']] as $otherRelation) { </td></tr> <tr><td>244</td> <td class="normal"> // skip fully defined m2m relationships </td></tr> <tr><td>245</td> <td class="red"> if(isset($otherRelation['refClass']) && $otherRelation['refClass'] == $className) { </td></tr> <tr><td>246</td> <td class="red"> continue(2); </td></tr> <tr><td>247</td> <td class="orange"> } </td></tr> <tr><td>248</td> <td class="red"> } </td></tr> <tr><td>249</td> <td class="red"> } </td></tr> <tr><td>250</td> <td class="normal"> </td></tr> <tr><td>251</td> <td class="red"> $this->relations[$relation['class']][$className] = $newRelation; </td></tr> <tr><td>252</td> <td class="red"> } </td></tr> <tr><td>253</td> <td class="red"> } </td></tr> <tr><td>254</td> <td class="covered"> } </td></tr> <tr><td>255</td> <td class="covered">}</td></tr> </table></body></html>