<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"> protected $_relations = array(); </td></tr> <tr><td>43</td> <td class="normal"> protected $_options = array('packagesPrefix' => 'Package', </td></tr> <tr><td>44</td> <td class="normal"> 'packagesPath' => '', </td></tr> <tr><td>45</td> <td class="normal"> 'generateBaseClasses' => true, </td></tr> <tr><td>46</td> <td class="normal"> 'generateTableClasses' => true, </td></tr> <tr><td>47</td> <td class="normal"> 'baseClassesDirectory' => 'generated', </td></tr> <tr><td>48</td> <td class="normal"> 'baseClassName' => 'Doctrine_Record', </td></tr> <tr><td>49</td> <td class="normal"> 'suffix' => '.php'); </td></tr> <tr><td>50</td> <td class="normal"> </td></tr> <tr><td>51</td> <td class="normal"> /** </td></tr> <tr><td>52</td> <td class="normal"> * getOption </td></tr> <tr><td>53</td> <td class="normal"> * </td></tr> <tr><td>54</td> <td class="normal"> * @param string $name </td></tr> <tr><td>55</td> <td class="normal"> * @return void </td></tr> <tr><td>56</td> <td class="normal"> */ </td></tr> <tr><td>57</td> <td class="normal"> public function getOption($name) </td></tr> <tr><td>58</td> <td class="normal"> { </td></tr> <tr><td>59</td> <td class="covered"> if (isset($this->_options[$name])) { </td></tr> <tr><td>60</td> <td class="covered"> return $this->_options[$name]; </td></tr> <tr><td>61</td> <td class="orange"> } </td></tr> <tr><td>62</td> <td class="red"> } </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"> * setOption </td></tr> <tr><td>66</td> <td class="normal"> * </td></tr> <tr><td>67</td> <td class="normal"> * @param string $name </td></tr> <tr><td>68</td> <td class="normal"> * @param string $value </td></tr> <tr><td>69</td> <td class="normal"> * @return void </td></tr> <tr><td>70</td> <td class="normal"> */ </td></tr> <tr><td>71</td> <td class="normal"> public function setOption($name, $value) </td></tr> <tr><td>72</td> <td class="normal"> { </td></tr> <tr><td>73</td> <td class="red"> if (isset($this->_options[$name])) { </td></tr> <tr><td>74</td> <td class="red"> $this->_options[$name] = $value; </td></tr> <tr><td>75</td> <td class="red"> } </td></tr> <tr><td>76</td> <td class="red"> } </td></tr> <tr><td>77</td> <td class="normal"> </td></tr> <tr><td>78</td> <td class="normal"> /** </td></tr> <tr><td>79</td> <td class="normal"> * setOptions </td></tr> <tr><td>80</td> <td class="normal"> * </td></tr> <tr><td>81</td> <td class="normal"> * @param string $options </td></tr> <tr><td>82</td> <td class="normal"> * @return void </td></tr> <tr><td>83</td> <td class="normal"> */ </td></tr> <tr><td>84</td> <td class="normal"> public function setOptions($options) </td></tr> <tr><td>85</td> <td class="normal"> { </td></tr> <tr><td>86</td> <td class="red"> if (!empty($options)) { </td></tr> <tr><td>87</td> <td class="red"> $this->_options = $options; </td></tr> <tr><td>88</td> <td class="red"> } </td></tr> <tr><td>89</td> <td class="red"> } </td></tr> <tr><td>90</td> <td class="normal"> </td></tr> <tr><td>91</td> <td class="normal"> /** </td></tr> <tr><td>92</td> <td class="normal"> * buildSchema </td></tr> <tr><td>93</td> <td class="normal"> * </td></tr> <tr><td>94</td> <td class="normal"> * Loop throug directories of schema files and part them all in to one complete array of schema information </td></tr> <tr><td>95</td> <td class="normal"> * </td></tr> <tr><td>96</td> <td class="normal"> * @param string $schema Array of schema files or single schema file. Array of directories with schema files or single directory </td></tr> <tr><td>97</td> <td class="normal"> * @param string $format Format of the files we are parsing and building from </td></tr> <tr><td>98</td> <td class="normal"> * @return array $array </td></tr> <tr><td>99</td> <td class="normal"> */ </td></tr> <tr><td>100</td> <td class="normal"> public function buildSchema($schema, $format) </td></tr> <tr><td>101</td> <td class="normal"> { </td></tr> <tr><td>102</td> <td class="covered"> $array = array(); </td></tr> <tr><td>103</td> <td class="normal"> </td></tr> <tr><td>104</td> <td class="covered"> foreach ((array) $schema AS $s) { </td></tr> <tr><td>105</td> <td class="covered"> if (is_file($s)) { </td></tr> <tr><td>106</td> <td class="covered"> $array = array_merge($this->parseSchema($s, $format), $array); </td></tr> <tr><td>107</td> <td class="covered"> } else if (is_dir($s)) { </td></tr> <tr><td>108</td> <td class="red"> $it = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($s), </td></tr> <tr><td>109</td> <td class="red"> RecursiveIteratorIterator::LEAVES_ONLY); </td></tr> <tr><td>110</td> <td class="normal"> </td></tr> <tr><td>111</td> <td class="red"> foreach ($it as $file) { </td></tr> <tr><td>112</td> <td class="red"> $e = explode('.', $file->getFileName()); </td></tr> <tr><td>113</td> <td class="red"> if (end($e) === $format) { </td></tr> <tr><td>114</td> <td class="red"> $array = array_merge($this->parseSchema($file->getPathName(), $format), $array); </td></tr> <tr><td>115</td> <td class="red"> } </td></tr> <tr><td>116</td> <td class="red"> } </td></tr> <tr><td>117</td> <td class="red"> } </td></tr> <tr><td>118</td> <td class="covered"> } </td></tr> <tr><td>119</td> <td class="normal"> </td></tr> <tr><td>120</td> <td class="covered"> $this->buildRelationships($array); </td></tr> <tr><td>121</td> <td class="normal"> </td></tr> <tr><td>122</td> <td class="covered"> return array('schema' => $array, 'relations' => $this->_relations); </td></tr> <tr><td>123</td> <td class="orange"> } </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"> * importSchema </td></tr> <tr><td>127</td> <td class="normal"> * </td></tr> <tr><td>128</td> <td class="normal"> * A method to import a Schema and translate it into a Doctrine_Record object </td></tr> <tr><td>129</td> <td class="normal"> * </td></tr> <tr><td>130</td> <td class="normal"> * @param string $schema The file containing the XML schema </td></tr> <tr><td>131</td> <td class="normal"> * @param string $directory The directory where the Doctrine_Record class will be written </td></tr> <tr><td>132</td> <td class="normal"> * @param array $models Optional array of models to import </td></tr> <tr><td>133</td> <td class="normal"> * </td></tr> <tr><td>134</td> <td class="normal"> * @return void </td></tr> <tr><td>135</td> <td class="normal"> */ </td></tr> <tr><td>136</td> <td class="normal"> public function importSchema($schema, $format = 'yml', $directory = null, $models = array()) </td></tr> <tr><td>137</td> <td class="normal"> { </td></tr> <tr><td>138</td> <td class="covered"> $builder = new Doctrine_Import_Builder(); </td></tr> <tr><td>139</td> <td class="covered"> $builder->setTargetPath($directory); </td></tr> <tr><td>140</td> <td class="covered"> $builder->generateBaseClasses($this->getOption('generateBaseClasses')); </td></tr> <tr><td>141</td> <td class="covered"> $builder->generateTableClasses($this->getOption('generateTableClasses')); </td></tr> <tr><td>142</td> <td class="covered"> $builder->setBaseClassesDirectory($this->getOption('baseClassesDirectory')); </td></tr> <tr><td>143</td> <td class="covered"> $builder->setBaseClassName($this->getOption('baseClassName')); </td></tr> <tr><td>144</td> <td class="covered"> $builder->setPackagesPath($this->getOption('packagesPath')); </td></tr> <tr><td>145</td> <td class="covered"> $builder->setPackagesPrefix($this->getOption('packagesPrefix')); </td></tr> <tr><td>146</td> <td class="covered"> $builder->setSuffix($this->getOption('suffix')); </td></tr> <tr><td>147</td> <td class="normal"> </td></tr> <tr><td>148</td> <td class="covered"> $schema = $this->buildSchema($schema, $format); </td></tr> <tr><td>149</td> <td class="normal"> </td></tr> <tr><td>150</td> <td class="covered"> $array = $schema['schema']; </td></tr> <tr><td>151</td> <td class="normal"> </td></tr> <tr><td>152</td> <td class="covered"> foreach ($array as $name => $properties) { </td></tr> <tr><td>153</td> <td class="covered"> if ( ! empty($models) && !in_array($properties['className'], $models)) { </td></tr> <tr><td>154</td> <td class="red"> continue; </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="covered"> $options = $this->getOptions($properties); </td></tr> <tr><td>158</td> <td class="covered"> $columns = $this->getColumns($properties); </td></tr> <tr><td>159</td> <td class="covered"> $relations = $this->getRelations($properties); </td></tr> <tr><td>160</td> <td class="covered"> $indexes = $this->getIndexes($properties); </td></tr> <tr><td>161</td> <td class="covered"> $attributes = $this->getAttributes($properties); </td></tr> <tr><td>162</td> <td class="covered"> $templates = $this->getTemplates($properties); </td></tr> <tr><td>163</td> <td class="covered"> $actAs = $this->getActAs($properties); </td></tr> <tr><td>164</td> <td class="normal"> </td></tr> <tr><td>165</td> <td class="covered"> $builder->buildRecord($options, $columns, $relations, $indexes, $attributes, $templates, $actAs); </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="normal"> /** </td></tr> <tr><td>170</td> <td class="normal"> * getOptions </td></tr> <tr><td>171</td> <td class="normal"> * </td></tr> <tr><td>172</td> <td class="normal"> * @param string $properties Array of table properties </td></tr> <tr><td>173</td> <td class="normal"> * @param string $directory Directory we are writing the class to </td></tr> <tr><td>174</td> <td class="normal"> * @return array $options Array of options from a parse schemas properties </td></tr> <tr><td>175</td> <td class="normal"> */ </td></tr> <tr><td>176</td> <td class="normal"> public function getOptions($properties) </td></tr> <tr><td>177</td> <td class="normal"> { </td></tr> <tr><td>178</td> <td class="covered"> $options = array(); </td></tr> <tr><td>179</td> <td class="covered"> $options['className'] = $properties['className']; </td></tr> <tr><td>180</td> <td class="covered"> $options['tableName'] = isset($properties['tableName']) ? $properties['tableName']:null; </td></tr> <tr><td>181</td> <td class="covered"> $options['connection'] = isset($properties['connection']) ? $properties['connection']:null; </td></tr> <tr><td>182</td> <td class="covered"> $options['connectionClassName'] = isset($properties['connection']) ? $properties['className']:null; </td></tr> <tr><td>183</td> <td class="covered"> $options['package'] = $properties['package']; </td></tr> <tr><td>184</td> <td class="normal"> </td></tr> <tr><td>185</td> <td class="covered"> if (isset($properties['inheritance'])) { </td></tr> <tr><td>186</td> <td class="red"> $options['inheritance'] = $properties['inheritance']; </td></tr> <tr><td>187</td> <td class="red"> } </td></tr> <tr><td>188</td> <td class="normal"> </td></tr> <tr><td>189</td> <td class="covered"> return $options; </td></tr> <tr><td>190</td> <td class="orange"> } </td></tr> <tr><td>191</td> <td class="normal"> </td></tr> <tr><td>192</td> <td class="normal"> /** </td></tr> <tr><td>193</td> <td class="normal"> * getColumns </td></tr> <tr><td>194</td> <td class="normal"> * </td></tr> <tr><td>195</td> <td class="normal"> * Get array of columns from table properties </td></tr> <tr><td>196</td> <td class="normal"> * </td></tr> <tr><td>197</td> <td class="normal"> * @param string $properties Array of table properties </td></tr> <tr><td>198</td> <td class="normal"> * @return array $columns Array of columns </td></tr> <tr><td>199</td> <td class="normal"> */ </td></tr> <tr><td>200</td> <td class="normal"> public function getColumns($properties) </td></tr> <tr><td>201</td> <td class="normal"> { </td></tr> <tr><td>202</td> <td class="covered"> return isset($properties['columns']) ? $properties['columns']:array(); </td></tr> <tr><td>203</td> <td class="orange"> } </td></tr> <tr><td>204</td> <td class="normal"> </td></tr> <tr><td>205</td> <td class="normal"> /** </td></tr> <tr><td>206</td> <td class="normal"> * getRelations </td></tr> <tr><td>207</td> <td class="normal"> * </td></tr> <tr><td>208</td> <td class="normal"> * Get array of relations from table properties </td></tr> <tr><td>209</td> <td class="normal"> * </td></tr> <tr><td>210</td> <td class="normal"> * @param string $properties Array of tables properties </td></tr> <tr><td>211</td> <td class="normal"> * @return array $relations Array of relations </td></tr> <tr><td>212</td> <td class="normal"> */ </td></tr> <tr><td>213</td> <td class="normal"> public function getRelations($properties) </td></tr> <tr><td>214</td> <td class="normal"> { </td></tr> <tr><td>215</td> <td class="covered"> $all_relations = isset($this->_relations[$properties['className']]) ? $this->_relations[$properties['className']]:array(); </td></tr> <tr><td>216</td> <td class="normal"> </td></tr> <tr><td>217</td> <td class="normal"> // This is for checking for duplicates between alias-relations and a auto-generated relations to ensure the result set of unique relations </td></tr> <tr><td>218</td> <td class="covered"> $exist_relations = array(); </td></tr> <tr><td>219</td> <td class="covered"> $unique_relations = array(); </td></tr> <tr><td>220</td> <td class="covered"> foreach ($all_relations as $relation) { </td></tr> <tr><td>221</td> <td class="red"> if (!in_array($relation['class'], $exist_relations)) { </td></tr> <tr><td>222</td> <td class="red"> $exist_relations[] = $relation['class']; </td></tr> <tr><td>223</td> <td class="red"> $unique_relations = array_merge($unique_relations, array($relation['alias'] => $relation)); </td></tr> <tr><td>224</td> <td class="red"> } else { </td></tr> <tr><td>225</td> <td class="normal"> // check to see if this relationship is not autogenerated, if it's not, then the user must have explicitly declared it </td></tr> <tr><td>226</td> <td class="red"> if (!isset($relation['autogenerated']) || $relation['autogenerated'] != true) { </td></tr> <tr><td>227</td> <td class="red"> $unique_relations = array_merge($unique_relations, array($relation['alias'] => $relation)); </td></tr> <tr><td>228</td> <td class="red"> } </td></tr> <tr><td>229</td> <td class="normal"> } </td></tr> <tr><td>230</td> <td class="red"> } </td></tr> <tr><td>231</td> <td class="normal"> </td></tr> <tr><td>232</td> <td class="covered"> return $unique_relations; </td></tr> <tr><td>233</td> <td class="orange"> } </td></tr> <tr><td>234</td> <td class="normal"> </td></tr> <tr><td>235</td> <td class="normal"> /** </td></tr> <tr><td>236</td> <td class="normal"> * getIndexes </td></tr> <tr><td>237</td> <td class="normal"> * </td></tr> <tr><td>238</td> <td class="normal"> * Get array of indexes from table properties </td></tr> <tr><td>239</td> <td class="normal"> * </td></tr> <tr><td>240</td> <td class="normal"> * @param string $properties Array of table properties </td></tr> <tr><td>241</td> <td class="normal"> * @return array $index </td></tr> <tr><td>242</td> <td class="normal"> */ </td></tr> <tr><td>243</td> <td class="normal"> public function getIndexes($properties) </td></tr> <tr><td>244</td> <td class="normal"> { </td></tr> <tr><td>245</td> <td class="covered"> return isset($properties['indexes']) ? $properties['indexes']:array();; </td></tr> <tr><td>246</td> <td class="orange"> } </td></tr> <tr><td>247</td> <td class="normal"> </td></tr> <tr><td>248</td> <td class="normal"> /** </td></tr> <tr><td>249</td> <td class="normal"> * getAttributes </td></tr> <tr><td>250</td> <td class="normal"> * </td></tr> <tr><td>251</td> <td class="normal"> * Get array of attributes from table properties </td></tr> <tr><td>252</td> <td class="normal"> * </td></tr> <tr><td>253</td> <td class="normal"> * @param string $properties Array of tables properties </td></tr> <tr><td>254</td> <td class="normal"> * @return array $attributes </td></tr> <tr><td>255</td> <td class="normal"> */ </td></tr> <tr><td>256</td> <td class="normal"> public function getAttributes($properties) </td></tr> <tr><td>257</td> <td class="normal"> { </td></tr> <tr><td>258</td> <td class="covered"> return isset($properties['attributes']) ? $properties['attributes']:array(); </td></tr> <tr><td>259</td> <td class="orange"> } </td></tr> <tr><td>260</td> <td class="normal"> </td></tr> <tr><td>261</td> <td class="normal"> /** </td></tr> <tr><td>262</td> <td class="normal"> * getTemplates </td></tr> <tr><td>263</td> <td class="normal"> * </td></tr> <tr><td>264</td> <td class="normal"> * Get array of templates from table properties </td></tr> <tr><td>265</td> <td class="normal"> * </td></tr> <tr><td>266</td> <td class="normal"> * @param string $properties Array of table properties </td></tr> <tr><td>267</td> <td class="normal"> * @return array $templates Array of table templates </td></tr> <tr><td>268</td> <td class="normal"> */ </td></tr> <tr><td>269</td> <td class="normal"> public function getTemplates($properties) </td></tr> <tr><td>270</td> <td class="normal"> { </td></tr> <tr><td>271</td> <td class="covered"> return isset($properties['templates']) ? $properties['templates']:array(); </td></tr> <tr><td>272</td> <td class="orange"> } </td></tr> <tr><td>273</td> <td class="normal"> </td></tr> <tr><td>274</td> <td class="normal"> /** </td></tr> <tr><td>275</td> <td class="normal"> * getActAs </td></tr> <tr><td>276</td> <td class="normal"> * </td></tr> <tr><td>277</td> <td class="normal"> * Get array of actAs definitions from table properties </td></tr> <tr><td>278</td> <td class="normal"> * </td></tr> <tr><td>279</td> <td class="normal"> * @param string $properties Array of table properties </td></tr> <tr><td>280</td> <td class="normal"> * @return array $actAs Array of actAs definitions from table properties </td></tr> <tr><td>281</td> <td class="normal"> */ </td></tr> <tr><td>282</td> <td class="normal"> public function getActAs($properties) </td></tr> <tr><td>283</td> <td class="normal"> { </td></tr> <tr><td>284</td> <td class="covered"> return isset($properties['actAs']) ? $properties['actAs']:array(); </td></tr> <tr><td>285</td> <td class="orange"> } </td></tr> <tr><td>286</td> <td class="normal"> </td></tr> <tr><td>287</td> <td class="normal"> /** </td></tr> <tr><td>288</td> <td class="normal"> * parseSchema </td></tr> <tr><td>289</td> <td class="normal"> * </td></tr> <tr><td>290</td> <td class="normal"> * A method to parse a Schema and translate it into a property array. </td></tr> <tr><td>291</td> <td class="normal"> * The function returns that property array. </td></tr> <tr><td>292</td> <td class="normal"> * </td></tr> <tr><td>293</td> <td class="normal"> * @param string $schema Path to the file containing the schema </td></tr> <tr><td>294</td> <td class="normal"> * @return array $build Built array of schema information </td></tr> <tr><td>295</td> <td class="normal"> */ </td></tr> <tr><td>296</td> <td class="normal"> public function parseSchema($schema, $type) </td></tr> <tr><td>297</td> <td class="normal"> { </td></tr> <tr><td>298</td> <td class="covered"> $array = Doctrine_Parser::load($schema, $type); </td></tr> <tr><td>299</td> <td class="normal"> </td></tr> <tr><td>300</td> <td class="covered"> $build = array(); </td></tr> <tr><td>301</td> <td class="normal"> </td></tr> <tr><td>302</td> <td class="covered"> foreach ($array as $className => $table) { </td></tr> <tr><td>303</td> <td class="covered"> $columns = array(); </td></tr> <tr><td>304</td> <td class="normal"> </td></tr> <tr><td>305</td> <td class="covered"> $className = isset($table['className']) ? (string) $table['className']:(string) $className; </td></tr> <tr><td>306</td> <td class="normal"> </td></tr> <tr><td>307</td> <td class="covered"> if (isset($table['tableName']) && $table['tableName']) { </td></tr> <tr><td>308</td> <td class="covered"> $tableName = $table['tableName']; </td></tr> <tr><td>309</td> <td class="covered"> } else { </td></tr> <tr><td>310</td> <td class="red"> if (isset($table['inheritance']['extends']) && isset($table['inheritance']['extends']['keyType']) && isset($table['inheritance']['extends']['keyValue'])) { </td></tr> <tr><td>311</td> <td class="red"> $tableName = null; </td></tr> <tr><td>312</td> <td class="red"> } else { </td></tr> <tr><td>313</td> <td class="red"> $tableName = Doctrine::tableize($className); </td></tr> <tr><td>314</td> <td class="normal"> } </td></tr> <tr><td>315</td> <td class="normal"> } </td></tr> <tr><td>316</td> <td class="normal"> </td></tr> <tr><td>317</td> <td class="covered"> $columns = isset($table['columns']) ? $table['columns']:array(); </td></tr> <tr><td>318</td> <td class="covered"> $columns = isset($table['fields']) ? $table['fields']:$columns; </td></tr> <tr><td>319</td> <td class="normal"> </td></tr> <tr><td>320</td> <td class="covered"> if ( ! empty($columns)) { </td></tr> <tr><td>321</td> <td class="covered"> foreach ($columns as $columnName => $field) { </td></tr> <tr><td>322</td> <td class="covered"> $colDesc = array(); </td></tr> <tr><td>323</td> <td class="covered"> $colDesc['name'] = $columnName; </td></tr> <tr><td>324</td> <td class="normal"> </td></tr> <tr><td>325</td> <td class="covered"> $e = explode('(', $field['type']); </td></tr> <tr><td>326</td> <td class="covered"> if (isset($e[0]) && isset($e[1])) { </td></tr> <tr><td>327</td> <td class="red"> $colDesc['type'] = $e[0]; </td></tr> <tr><td>328</td> <td class="red"> $colDesc['length'] = substr($e[1], 0, strlen($e[1]) - 1); </td></tr> <tr><td>329</td> <td class="red"> } else { </td></tr> <tr><td>330</td> <td class="covered"> $colDesc['type'] = isset($field['type']) ? (string) $field['type']:null; </td></tr> <tr><td>331</td> <td class="covered"> $colDesc['length'] = isset($field['length']) ? (int) $field['length']:null; </td></tr> <tr><td>332</td> <td class="covered"> $colDesc['length'] = isset($field['size']) ? (int) $field['size']:$colDesc['length']; </td></tr> <tr><td>333</td> <td class="normal"> } </td></tr> <tr><td>334</td> <td class="normal"> </td></tr> <tr><td>335</td> <td class="covered"> $colDesc['ptype'] = isset($field['ptype']) ? (string) $field['ptype']:(string) $colDesc['type']; </td></tr> <tr><td>336</td> <td class="normal"> </td></tr> <tr><td>337</td> <td class="covered"> $colDesc['fixed'] = isset($field['fixed']) ? (int) $field['fixed']:null; </td></tr> <tr><td>338</td> <td class="covered"> $colDesc['unsigned'] = isset($field['unsigned']) ? (bool) $field['unsigned']:null; </td></tr> <tr><td>339</td> <td class="covered"> $colDesc['primary'] = isset($field['primary']) ? (bool) (isset($field['primary']) && $field['primary']):null; </td></tr> <tr><td>340</td> <td class="covered"> $colDesc['default'] = isset($field['default']) ? $field['default']:null; </td></tr> <tr><td>341</td> <td class="covered"> $colDesc['notnull'] = isset($field['notnull']) ? (bool) (isset($field['notnull']) && $field['notnull']):null; </td></tr> <tr><td>342</td> <td class="covered"> $colDesc['autoincrement'] = isset($field['autoincrement']) ? (bool) (isset($field['autoincrement']) && $field['autoincrement']):null; </td></tr> <tr><td>343</td> <td class="covered"> $colDesc['autoincrement'] = isset($field['autoinc']) ? (bool) (isset($field['autoinc']) && $field['autoinc']):$colDesc['autoincrement']; </td></tr> <tr><td>344</td> <td class="covered"> $colDesc['unique'] = isset($field['unique']) ? (bool) (isset($field['unique']) && $field['unique']):null; </td></tr> <tr><td>345</td> <td class="covered"> $colDesc['values'] = isset($field['values']) ? (array) $field['values']: null; </td></tr> <tr><td>346</td> <td class="normal"> </td></tr> <tr><td>347</td> <td class="covered"> $columns[(string) $colDesc['name']] = $colDesc; </td></tr> <tr><td>348</td> <td class="covered"> } </td></tr> <tr><td>349</td> <td class="covered"> } </td></tr> <tr><td>350</td> <td class="normal"> </td></tr> <tr><td>351</td> <td class="covered"> $build[$className]['connection'] = isset($table['connection']) ? $table['connection']:null; </td></tr> <tr><td>352</td> <td class="covered"> $build[$className]['className'] = $className; </td></tr> <tr><td>353</td> <td class="covered"> $build[$className]['tableName'] = $tableName; </td></tr> <tr><td>354</td> <td class="covered"> $build[$className]['columns'] = $columns; </td></tr> <tr><td>355</td> <td class="covered"> $build[$className]['relations'] = isset($table['relations']) ? $table['relations']:array(); </td></tr> <tr><td>356</td> <td class="covered"> $build[$className]['indexes'] = isset($table['indexes']) ? $table['indexes']:array(); </td></tr> <tr><td>357</td> <td class="covered"> $build[$className]['attributes'] = isset($table['attributes']) ? $table['attributes']:array(); </td></tr> <tr><td>358</td> <td class="covered"> $build[$className]['templates'] = isset($table['templates']) ? $table['templates']:array(); </td></tr> <tr><td>359</td> <td class="covered"> $build[$className]['actAs'] = isset($table['actAs']) ? $table['actAs']:array(); </td></tr> <tr><td>360</td> <td class="covered"> $build[$className]['package'] = isset($table['package']) ? $table['package']:null; </td></tr> <tr><td>361</td> <td class="normal"> </td></tr> <tr><td>362</td> <td class="covered"> if (isset($table['inheritance'])) { </td></tr> <tr><td>363</td> <td class="red"> $build[$className]['inheritance'] = $table['inheritance']; </td></tr> <tr><td>364</td> <td class="red"> } </td></tr> <tr><td>365</td> <td class="covered"> } </td></tr> <tr><td>366</td> <td class="normal"> </td></tr> <tr><td>367</td> <td class="covered"> return $build; </td></tr> <tr><td>368</td> <td class="orange"> } </td></tr> <tr><td>369</td> <td class="normal"> </td></tr> <tr><td>370</td> <td class="normal"> /** </td></tr> <tr><td>371</td> <td class="normal"> * buildRelationships </td></tr> <tr><td>372</td> <td class="normal"> * </td></tr> <tr><td>373</td> <td class="normal"> * Loop through an array of schema information and build all the necessary relationship information </td></tr> <tr><td>374</td> <td class="normal"> * Will attempt to auto complete relationships and simplify the amount of information required for defining a relationship </td></tr> <tr><td>375</td> <td class="normal"> * </td></tr> <tr><td>376</td> <td class="normal"> * @param string $array </td></tr> <tr><td>377</td> <td class="normal"> * @return void </td></tr> <tr><td>378</td> <td class="normal"> */ </td></tr> <tr><td>379</td> <td class="normal"> protected function buildRelationships(&$array) </td></tr> <tr><td>380</td> <td class="normal"> { </td></tr> <tr><td>381</td> <td class="covered"> foreach ($array as $name => $properties) { </td></tr> <tr><td>382</td> <td class="covered"> if ( ! isset($properties['relations'])) { </td></tr> <tr><td>383</td> <td class="red"> continue; </td></tr> <tr><td>384</td> <td class="orange"> } </td></tr> <tr><td>385</td> <td class="normal"> </td></tr> <tr><td>386</td> <td class="covered"> $className = $properties['className']; </td></tr> <tr><td>387</td> <td class="covered"> $relations = $properties['relations']; </td></tr> <tr><td>388</td> <td class="normal"> </td></tr> <tr><td>389</td> <td class="covered"> foreach ($relations as $alias => $relation) { </td></tr> <tr><td>390</td> <td class="red"> $class = isset($relation['class']) ? $relation['class']:$alias; </td></tr> <tr><td>391</td> <td class="normal"> </td></tr> <tr><td>392</td> <td class="normal"> // Attempt to guess the local and foreign </td></tr> <tr><td>393</td> <td class="red"> if (isset($relation['refClass'])) { </td></tr> <tr><td>394</td> <td class="red"> $relation['local'] = isset($relation['local']) ? $relation['local']:Doctrine::tableize($name) . '_id'; </td></tr> <tr><td>395</td> <td class="red"> $relation['foreign'] = isset($relation['foreign']) ? $relation['foreign']:Doctrine::tableize($class) . '_id'; </td></tr> <tr><td>396</td> <td class="red"> } else { </td></tr> <tr><td>397</td> <td class="red"> $relation['local'] = isset($relation['local']) ? $relation['local']:Doctrine::tableize($class) . '_id'; </td></tr> <tr><td>398</td> <td class="red"> $relation['foreign'] = isset($relation['foreign']) ? $relation['foreign']:'id'; </td></tr> <tr><td>399</td> <td class="normal"> } </td></tr> <tr><td>400</td> <td class="normal"> </td></tr> <tr><td>401</td> <td class="red"> $relation['alias'] = isset($relation['alias']) ? $relation['alias'] : $alias; </td></tr> <tr><td>402</td> <td class="red"> $relation['class'] = $class; </td></tr> <tr><td>403</td> <td class="normal"> </td></tr> <tr><td>404</td> <td class="red"> if (isset($relation['refClass'])) { </td></tr> <tr><td>405</td> <td class="red"> $relation['type'] = 'many'; </td></tr> <tr><td>406</td> <td class="red"> } </td></tr> <tr><td>407</td> <td class="normal"> </td></tr> <tr><td>408</td> <td class="red"> if (isset($relation['type']) && $relation['type']) { </td></tr> <tr><td>409</td> <td class="red"> $relation['type'] = $relation['type'] === 'one' ? Doctrine_Relation::ONE:Doctrine_Relation::MANY; </td></tr> <tr><td>410</td> <td class="red"> } else { </td></tr> <tr><td>411</td> <td class="red"> $relation['type'] = Doctrine_Relation::ONE; </td></tr> <tr><td>412</td> <td class="normal"> } </td></tr> <tr><td>413</td> <td class="normal"> </td></tr> <tr><td>414</td> <td class="red"> if (isset($relation['foreignType']) && $relation['foreignType']) { </td></tr> <tr><td>415</td> <td class="red"> $relation['foreignType'] = $relation['foreignType'] === 'one' ? Doctrine_Relation::ONE:Doctrine_Relation::MANY; </td></tr> <tr><td>416</td> <td class="red"> } </td></tr> <tr><td>417</td> <td class="normal"> </td></tr> <tr><td>418</td> <td class="red"> $this->_relations[$className][$alias] = $relation; </td></tr> <tr><td>419</td> <td class="red"> } </td></tr> <tr><td>420</td> <td class="covered"> } </td></tr> <tr><td>421</td> <td class="normal"> </td></tr> <tr><td>422</td> <td class="normal"> // Now we fix all the relationships and auto-complete opposite ends of relationships </td></tr> <tr><td>423</td> <td class="covered"> $this->fixRelationships(); </td></tr> <tr><td>424</td> <td class="covered"> } </td></tr> <tr><td>425</td> <td class="normal"> </td></tr> <tr><td>426</td> <td class="normal"> /** </td></tr> <tr><td>427</td> <td class="normal"> * fixRelationships </td></tr> <tr><td>428</td> <td class="normal"> * </td></tr> <tr><td>429</td> <td class="normal"> * Loop through all relationships building the opposite ends of each relationship </td></tr> <tr><td>430</td> <td class="normal"> * </td></tr> <tr><td>431</td> <td class="normal"> * @return void </td></tr> <tr><td>432</td> <td class="normal"> */ </td></tr> <tr><td>433</td> <td class="normal"> protected function fixRelationships() </td></tr> <tr><td>434</td> <td class="normal"> { </td></tr> <tr><td>435</td> <td class="covered"> foreach($this->_relations as $className => $relations) { </td></tr> <tr><td>436</td> <td class="red"> foreach ($relations AS $alias => $relation) { </td></tr> <tr><td>437</td> <td class="red"> $newRelation = array(); </td></tr> <tr><td>438</td> <td class="red"> $newRelation['foreign'] = $relation['local']; </td></tr> <tr><td>439</td> <td class="red"> $newRelation['local'] = $relation['foreign']; </td></tr> <tr><td>440</td> <td class="red"> $newRelation['class'] = isset($relation['foreignClass']) ? $relation['foreignClass']:$className; </td></tr> <tr><td>441</td> <td class="red"> $newRelation['alias'] = isset($relation['foreignAlias']) ? $relation['foreignAlias']:$className; </td></tr> <tr><td>442</td> <td class="normal"> </td></tr> <tr><td>443</td> <td class="normal"> // this is so that we know that this relation was autogenerated and </td></tr> <tr><td>444</td> <td class="normal"> // that we do not need to include it if it is explicitly declared in the schema by the users. </td></tr> <tr><td>445</td> <td class="red"> $newRelation['autogenerated'] = true; </td></tr> <tr><td>446</td> <td class="normal"> </td></tr> <tr><td>447</td> <td class="red"> if (isset($relation['refClass'])) { </td></tr> <tr><td>448</td> <td class="red"> $newRelation['refClass'] = $relation['refClass']; </td></tr> <tr><td>449</td> <td class="red"> $newRelation['type'] = isset($relation['foreignType']) ? $relation['foreignType']:$relation['type']; </td></tr> <tr><td>450</td> <td class="red"> } else { </td></tr> <tr><td>451</td> <td class="red"> if(isset($relation['foreignType'])) { </td></tr> <tr><td>452</td> <td class="red"> $newRelation['type'] = $relation['foreignType']; </td></tr> <tr><td>453</td> <td class="red"> } else { </td></tr> <tr><td>454</td> <td class="red"> $newRelation['type'] = $relation['type'] === Doctrine_Relation::ONE ? Doctrine_Relation::MANY:Doctrine_Relation::ONE; </td></tr> <tr><td>455</td> <td class="normal"> } </td></tr> <tr><td>456</td> <td class="normal"> } </td></tr> <tr><td>457</td> <td class="normal"> </td></tr> <tr><td>458</td> <td class="red"> if (!isset($this->_relations[$relation['class']][$newRelation['alias']])) { </td></tr> <tr><td>459</td> <td class="red"> $this->_relations[$relation['class']][$newRelation['alias']] = $newRelation; </td></tr> <tr><td>460</td> <td class="red"> } </td></tr> <tr><td>461</td> <td class="red"> } </td></tr> <tr><td>462</td> <td class="red"> } </td></tr> <tr><td>463</td> <td class="covered"> } </td></tr> <tr><td>464</td> <td class="covered">}</td></tr> </table></body></html>