<html>
<head>
<title>Coverage for Doctrine_Plugin</title>
<style type="text/css">
.covered{ background: green;}
.normal{ background: white;}
.red{ background: red;}
.orange{ background: #f90;}
</style>
</head>
<body><h1>Coverage for Doctrine_Plugin</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.org>.
</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_Plugin
</td></tr>
<tr><td>24</td>
<td class="normal"> *
</td></tr>
<tr><td>25</td>
<td class="normal"> * @author Konsta Vesterinen <kvesteri@cc.hut.fi>
</td></tr>
<tr><td>26</td>
<td class="normal"> * @package Doctrine
</td></tr>
<tr><td>27</td>
<td class="normal"> * @subpackage Plugin
</td></tr>
<tr><td>28</td>
<td class="normal"> * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
</td></tr>
<tr><td>29</td>
<td class="normal"> * @version $Revision$
</td></tr>
<tr><td>30</td>
<td class="normal"> * @link www.phpdoctrine.org
</td></tr>
<tr><td>31</td>
<td class="normal"> * @since 1.0
</td></tr>
<tr><td>32</td>
<td class="normal"> */
</td></tr>
<tr><td>33</td>
<td class="normal">abstract class Doctrine_Plugin
</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 array $_options an array of plugin specific options
</td></tr>
<tr><td>37</td>
<td class="normal"> */
</td></tr>
<tr><td>38</td>
<td class="normal"> protected $_options = array('generateFiles' => false,
</td></tr>
<tr><td>39</td>
<td class="normal"> 'identifier' => false,
</td></tr>
<tr><td>40</td>
<td class="normal"> 'generateFiles' => false,
</td></tr>
<tr><td>41</td>
<td class="normal"> 'table' => false,
</td></tr>
<tr><td>42</td>
<td class="normal"> 'pluginTable' => false,
</td></tr>
<tr><td>43</td>
<td class="normal"> 'children' => array(),);
</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"> * __get
</td></tr>
<tr><td>47</td>
<td class="normal"> * an alias for getOption
</td></tr>
<tr><td>48</td>
<td class="normal"> *
</td></tr>
<tr><td>49</td>
<td class="normal"> * @param string $option
</td></tr>
<tr><td>50</td>
<td class="normal"> */
</td></tr>
<tr><td>51</td>
<td class="normal"> public function __get($option)
</td></tr>
<tr><td>52</td>
<td class="normal"> {
</td></tr>
<tr><td>53</td>
<td class="red"> if (isset($this->_options[$option])) {
</td></tr>
<tr><td>54</td>
<td class="red"> return $this->_options[$option];
</td></tr>
<tr><td>55</td>
<td class="orange"> }
</td></tr>
<tr><td>56</td>
<td class="red"> return null;
</td></tr>
<tr><td>57</td>
<td class="orange"> }
</td></tr>
<tr><td>58</td>
<td class="normal">
</td></tr>
<tr><td>59</td>
<td class="normal"> /**
</td></tr>
<tr><td>60</td>
<td class="normal"> * __isset
</td></tr>
<tr><td>61</td>
<td class="normal"> *
</td></tr>
<tr><td>62</td>
<td class="normal"> * @param string $option
</td></tr>
<tr><td>63</td>
<td class="normal"> */
</td></tr>
<tr><td>64</td>
<td class="normal"> public function __isset($option)
</td></tr>
<tr><td>65</td>
<td class="normal"> {
</td></tr>
<tr><td>66</td>
<td class="red"> return isset($this->_options[$option]);
</td></tr>
<tr><td>67</td>
<td class="orange"> }
</td></tr>
<tr><td>68</td>
<td class="normal">
</td></tr>
<tr><td>69</td>
<td class="normal"> /**
</td></tr>
<tr><td>70</td>
<td class="normal"> * returns the value of an option
</td></tr>
<tr><td>71</td>
<td class="normal"> *
</td></tr>
<tr><td>72</td>
<td class="normal"> * @param $option the name of the option to retrieve
</td></tr>
<tr><td>73</td>
<td class="normal"> * @return mixed the value of the option
</td></tr>
<tr><td>74</td>
<td class="normal"> */
</td></tr>
<tr><td>75</td>
<td class="normal"> public function getOption($name)
</td></tr>
<tr><td>76</td>
<td class="normal"> {
</td></tr>
<tr><td>77</td>
<td class="covered"> if ( ! isset($this->_options[$name])) {
</td></tr>
<tr><td>78</td>
<td class="red"> throw new Doctrine_Plugin_Exception('Unknown option ' . $name);
</td></tr>
<tr><td>79</td>
<td class="orange"> }
</td></tr>
<tr><td>80</td>
<td class="normal">
</td></tr>
<tr><td>81</td>
<td class="covered"> return $this->_options[$name];
</td></tr>
<tr><td>82</td>
<td class="orange"> }
</td></tr>
<tr><td>83</td>
<td class="normal">
</td></tr>
<tr><td>84</td>
<td class="normal"> /**
</td></tr>
<tr><td>85</td>
<td class="normal"> * sets given value to an option
</td></tr>
<tr><td>86</td>
<td class="normal"> *
</td></tr>
<tr><td>87</td>
<td class="normal"> * @param $option the name of the option to be changed
</td></tr>
<tr><td>88</td>
<td class="normal"> * @param $value the value of the option
</td></tr>
<tr><td>89</td>
<td class="normal"> * @return Doctrine_Plugin this object
</td></tr>
<tr><td>90</td>
<td class="normal"> */
</td></tr>
<tr><td>91</td>
<td class="normal"> public function setOption($name, $value)
</td></tr>
<tr><td>92</td>
<td class="normal"> {
</td></tr>
<tr><td>93</td>
<td class="covered"> $this->_options[$name] = $value;
</td></tr>
<tr><td>94</td>
<td class="normal">
</td></tr>
<tr><td>95</td>
<td class="covered"> return $this;
</td></tr>
<tr><td>96</td>
<td class="orange"> }
</td></tr>
<tr><td>97</td>
<td class="normal">
</td></tr>
<tr><td>98</td>
<td class="normal"> public function addChild(Doctrine_Template $template)
</td></tr>
<tr><td>99</td>
<td class="normal"> {
</td></tr>
<tr><td>100</td>
<td class="covered"> $this->_options['children'][] = $template;
</td></tr>
<tr><td>101</td>
<td class="covered"> }
</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"> * returns all options and their associated values
</td></tr>
<tr><td>105</td>
<td class="normal"> *
</td></tr>
<tr><td>106</td>
<td class="normal"> * @return array all options as an associative array
</td></tr>
<tr><td>107</td>
<td class="normal"> */
</td></tr>
<tr><td>108</td>
<td class="normal"> public function getOptions()
</td></tr>
<tr><td>109</td>
<td class="normal"> {
</td></tr>
<tr><td>110</td>
<td class="red"> return $this->_options;
</td></tr>
<tr><td>111</td>
<td class="orange"> }
</td></tr>
<tr><td>112</td>
<td class="normal">
</td></tr>
<tr><td>113</td>
<td class="normal"> public function buildPluginDefinition(Doctrine_Table $table)
</td></tr>
<tr><td>114</td>
<td class="normal"> {
</td></tr>
<tr><td>115</td>
<td class="covered"> $this->_options['table'] = $table;
</td></tr>
<tr><td>116</td>
<td class="normal">
</td></tr>
<tr><td>117</td>
<td class="covered"> $this->_options['className'] = str_replace('%CLASS%',
</td></tr>
<tr><td>118</td>
<td class="covered"> $this->_options['table']->getComponentName(),
</td></tr>
<tr><td>119</td>
<td class="covered"> $this->_options['className']);
</td></tr>
<tr><td>120</td>
<td class="normal">
</td></tr>
<tr><td>121</td>
<td class="normal"> // check that class doesn't exist (otherwise we cannot create it)
</td></tr>
<tr><td>122</td>
<td class="covered"> if (class_exists($this->_options['className'])) {
</td></tr>
<tr><td>123</td>
<td class="red"> return false;
</td></tr>
<tr><td>124</td>
<td class="orange"> }
</td></tr>
<tr><td>125</td>
<td class="normal">
</td></tr>
<tr><td>126</td>
<td class="covered"> $this->buildDefinition();
</td></tr>
<tr><td>127</td>
<td class="covered"> }
</td></tr>
<tr><td>128</td>
<td class="normal">
</td></tr>
<tr><td>129</td>
<td class="normal"> abstract public function buildDefinition();
</td></tr>
<tr><td>130</td>
<td class="normal">
</td></tr>
<tr><td>131</td>
<td class="normal"> public function buildForeignKeys(Doctrine_Table $table)
</td></tr>
<tr><td>132</td>
<td class="normal"> {
</td></tr>
<tr><td>133</td>
<td class="covered"> $id = $table->getIdentifier();
</td></tr>
<tr><td>134</td>
<td class="normal">
</td></tr>
<tr><td>135</td>
<td class="covered"> $fk = array();
</td></tr>
<tr><td>136</td>
<td class="covered"> foreach ((array) $id as $column) {
</td></tr>
<tr><td>137</td>
<td class="covered"> $def = $table->getDefinitionOf($column);
</td></tr>
<tr><td>138</td>
<td class="normal">
</td></tr>
<tr><td>139</td>
<td class="covered"> unset($def['autoincrement']);
</td></tr>
<tr><td>140</td>
<td class="covered"> unset($def['sequence']);
</td></tr>
<tr><td>141</td>
<td class="covered"> unset($def['unique']);
</td></tr>
<tr><td>142</td>
<td class="normal">
</td></tr>
<tr><td>143</td>
<td class="covered"> $fk[$column] = $def;
</td></tr>
<tr><td>144</td>
<td class="covered"> }
</td></tr>
<tr><td>145</td>
<td class="normal">
</td></tr>
<tr><td>146</td>
<td class="covered"> return $fk;
</td></tr>
<tr><td>147</td>
<td class="orange"> }
</td></tr>
<tr><td>148</td>
<td class="normal">
</td></tr>
<tr><td>149</td>
<td class="normal"> public function generateChildDefinitions()
</td></tr>
<tr><td>150</td>
<td class="normal"> {
</td></tr>
<tr><td>151</td>
<td class="covered"> foreach ($this->_options['children'] as $child) {
</td></tr>
<tr><td>152</td>
<td class="covered"> $this->_options['pluginTable']->addTemplate(get_class($child), $child);
</td></tr>
<tr><td>153</td>
<td class="normal">
</td></tr>
<tr><td>154</td>
<td class="covered"> $child->setTable($this->_options['pluginTable']);
</td></tr>
<tr><td>155</td>
<td class="normal">
</td></tr>
<tr><td>156</td>
<td class="covered"> $child->setUp();
</td></tr>
<tr><td>157</td>
<td class="covered"> }
</td></tr>
<tr><td>158</td>
<td class="covered"> }
</td></tr>
<tr><td>159</td>
<td class="normal">
</td></tr>
<tr><td>160</td>
<td class="normal"> /**
</td></tr>
<tr><td>161</td>
<td class="normal"> * generates foreign keys for the plugin table based on the owner table
</td></tr>
<tr><td>162</td>
<td class="normal"> *
</td></tr>
<tr><td>163</td>
<td class="normal"> * the foreign keys generated by this method can be used for
</td></tr>
<tr><td>164</td>
<td class="normal"> * setting the relations between the owner and the plugin classes
</td></tr>
<tr><td>165</td>
<td class="normal"> *
</td></tr>
<tr><td>166</td>
<td class="normal"> * @param Doctrine_Table $table the table object that owns the plugin
</td></tr>
<tr><td>167</td>
<td class="normal"> * @return array an array of foreign key definitions
</td></tr>
<tr><td>168</td>
<td class="normal"> */
</td></tr>
<tr><td>169</td>
<td class="normal"> public function generateForeignKeys(Doctrine_Table $table)
</td></tr>
<tr><td>170</td>
<td class="normal"> {
</td></tr>
<tr><td>171</td>
<td class="covered"> $fk = array();
</td></tr>
<tr><td>172</td>
<td class="normal">
</td></tr>
<tr><td>173</td>
<td class="covered"> foreach ((array) $table->getIdentifier() as $column) {
</td></tr>
<tr><td>174</td>
<td class="covered"> $def = $table->getDefinitionOf($column);
</td></tr>
<tr><td>175</td>
<td class="normal">
</td></tr>
<tr><td>176</td>
<td class="covered"> unset($def['autoincrement']);
</td></tr>
<tr><td>177</td>
<td class="covered"> unset($def['sequence']);
</td></tr>
<tr><td>178</td>
<td class="covered"> unset($def['primary']);
</td></tr>
<tr><td>179</td>
<td class="normal">
</td></tr>
<tr><td>180</td>
<td class="covered"> $col = $column;
</td></tr>
<tr><td>181</td>
<td class="normal">
</td></tr>
<tr><td>182</td>
<td class="covered"> $def['primary'] = true;
</td></tr>
<tr><td>183</td>
<td class="covered"> $fk[$col] = $def;
</td></tr>
<tr><td>184</td>
<td class="covered"> }
</td></tr>
<tr><td>185</td>
<td class="covered"> return $fk;
</td></tr>
<tr><td>186</td>
<td class="orange"> }
</td></tr>
<tr><td>187</td>
<td class="normal">
</td></tr>
<tr><td>188</td>
<td class="normal"> /**
</td></tr>
<tr><td>189</td>
<td class="normal"> * generates a relation array to given table
</td></tr>
<tr><td>190</td>
<td class="normal"> *
</td></tr>
<tr><td>191</td>
<td class="normal"> * this method can be used for generating the relation from the plugin
</td></tr>
<tr><td>192</td>
<td class="normal"> * table to the owner table
</td></tr>
<tr><td>193</td>
<td class="normal"> *
</td></tr>
<tr><td>194</td>
<td class="normal"> * @param Doctrine_Table $table the table object to construct the relation to
</td></tr>
<tr><td>195</td>
<td class="normal"> * @param array $foreignKeys an array of foreign keys
</td></tr>
<tr><td>196</td>
<td class="normal"> * @return array the generated relation array
</td></tr>
<tr><td>197</td>
<td class="normal"> */
</td></tr>
<tr><td>198</td>
<td class="normal"> public function generateRelation(Doctrine_Table $table, array $foreignKeys)
</td></tr>
<tr><td>199</td>
<td class="normal"> {
</td></tr>
<tr><td>200</td>
<td class="covered"> $local = (count($foreignKeys) > 1) ? array_keys($foreignKeys) : key($foreignKeys);
</td></tr>
<tr><td>201</td>
<td class="normal">
</td></tr>
<tr><td>202</td>
<td class="covered"> $relation = array($table->getComponentName() =>
</td></tr>
<tr><td>203</td>
<td class="covered"> array('local' => $local,
</td></tr>
<tr><td>204</td>
<td class="covered"> 'foreign' => $table->getIdentifier(),
</td></tr>
<tr><td>205</td>
<td class="covered"> 'onDelete' => 'CASCADE',
</td></tr>
<tr><td>206</td>
<td class="covered"> 'onUpdate' => 'CASCADE'));
</td></tr>
<tr><td>207</td>
<td class="normal">
</td></tr>
<tr><td>208</td>
<td class="covered"> return $relation;
</td></tr>
<tr><td>209</td>
<td class="orange"> }
</td></tr>
<tr><td>210</td>
<td class="normal">
</td></tr>
<tr><td>211</td>
<td class="normal"> /**
</td></tr>
<tr><td>212</td>
<td class="normal"> * generates the class definition for plugin class
</td></tr>
<tr><td>213</td>
<td class="normal"> *
</td></tr>
<tr><td>214</td>
<td class="normal"> * @param array $options plugin class options, keys representing the option names
</td></tr>
<tr><td>215</td>
<td class="normal"> * and values as option values
</td></tr>
<tr><td>216</td>
<td class="normal"> * @param array $columns the plugin class columns, keys representing the column names
</td></tr>
<tr><td>217</td>
<td class="normal"> * and values as column definitions
</td></tr>
<tr><td>218</td>
<td class="normal"> * @param array $relations the bound relations of the plugin class
</td></tr>
<tr><td>219</td>
<td class="normal"> * @return void
</td></tr>
<tr><td>220</td>
<td class="normal"> */
</td></tr>
<tr><td>221</td>
<td class="normal"> public function generateClass($options, $columns, $relations)
</td></tr>
<tr><td>222</td>
<td class="normal"> {
</td></tr>
<tr><td>223</td>
<td class="covered"> $builder = new Doctrine_Import_Builder();
</td></tr>
<tr><td>224</td>
<td class="normal">
</td></tr>
<tr><td>225</td>
<td class="covered"> if ($this->_options['generateFiles']) {
</td></tr>
<tr><td>226</td>
<td class="red"> if (isset($this->_options['generatePath']) && $this->_options['generatePath']) {
</td></tr>
<tr><td>227</td>
<td class="red"> $builder->setTargetPath($this->_options['generatePath']);
</td></tr>
<tr><td>228</td>
<td class="normal">
</td></tr>
<tr><td>229</td>
<td class="red"> $builder->buildRecord($options, $columns, $relations);
</td></tr>
<tr><td>230</td>
<td class="red"> } else {
</td></tr>
<tr><td>231</td>
<td class="red"> throw new Doctrine_Plugin_Exception('If you wish to generate files then you must specify the path to generate the files in.');
</td></tr>
<tr><td>232</td>
<td class="normal"> }
</td></tr>
<tr><td>233</td>
<td class="red"> } else {
</td></tr>
<tr><td>234</td>
<td class="covered"> $def = $builder->buildDefinition($options, $columns, $relations);
</td></tr>
<tr><td>235</td>
<td class="normal">
</td></tr>
<tr><td>236</td>
<td class="covered"> eval($def);
</td></tr>
<tr><td>237</td>
<td class="normal"> }
</td></tr>
<tr><td>238</td>
<td class="covered"> }
</td></tr>
<tr><td>239</td>
<td class="normal">}
</td></tr>
</table></body></html>