@@ -30,78 +30,78 @@ |
||
30 | 30 | */ |
31 | 31 | class StandardObjectStorage |
32 | 32 | { |
33 | - /** |
|
34 | - * An array of fetched object, accessible via table name and primary key. |
|
35 | - * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
36 | - * |
|
37 | - * @var array<string, array<string, TDBMObject>> |
|
38 | - */ |
|
39 | - private $objects = array(); |
|
33 | + /** |
|
34 | + * An array of fetched object, accessible via table name and primary key. |
|
35 | + * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
36 | + * |
|
37 | + * @var array<string, array<string, TDBMObject>> |
|
38 | + */ |
|
39 | + private $objects = array(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Sets an object in the storage. |
|
43 | - * |
|
44 | - * @param string $tableName |
|
45 | - * @param string $id |
|
46 | - * @param TDBMObject $dbRow |
|
47 | - */ |
|
48 | - public function set($tableName, $id, DbRow $dbRow) |
|
49 | - { |
|
50 | - $this->objects[$tableName][$id] = $dbRow; |
|
51 | - } |
|
41 | + /** |
|
42 | + * Sets an object in the storage. |
|
43 | + * |
|
44 | + * @param string $tableName |
|
45 | + * @param string $id |
|
46 | + * @param TDBMObject $dbRow |
|
47 | + */ |
|
48 | + public function set($tableName, $id, DbRow $dbRow) |
|
49 | + { |
|
50 | + $this->objects[$tableName][$id] = $dbRow; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * Checks if an object is in the storage. |
|
55 | - * |
|
56 | - * @param string $tableName |
|
57 | - * @param string $id |
|
58 | - * |
|
59 | - * @return bool |
|
60 | - */ |
|
61 | - public function has($tableName, $id) |
|
62 | - { |
|
63 | - return isset($this->objects[$tableName][$id]); |
|
64 | - } |
|
53 | + /** |
|
54 | + * Checks if an object is in the storage. |
|
55 | + * |
|
56 | + * @param string $tableName |
|
57 | + * @param string $id |
|
58 | + * |
|
59 | + * @return bool |
|
60 | + */ |
|
61 | + public function has($tableName, $id) |
|
62 | + { |
|
63 | + return isset($this->objects[$tableName][$id]); |
|
64 | + } |
|
65 | 65 | |
66 | - /** |
|
67 | - * Returns an object from the storage (or null if no object is set). |
|
68 | - * |
|
69 | - * @param string $tableName |
|
70 | - * @param string $id |
|
71 | - * |
|
72 | - * @return DbRow |
|
73 | - */ |
|
74 | - public function get($tableName, $id) |
|
75 | - { |
|
76 | - if (isset($this->objects[$tableName][$id])) { |
|
77 | - return $this->objects[$tableName][$id]; |
|
78 | - } else { |
|
79 | - return; |
|
80 | - } |
|
81 | - } |
|
66 | + /** |
|
67 | + * Returns an object from the storage (or null if no object is set). |
|
68 | + * |
|
69 | + * @param string $tableName |
|
70 | + * @param string $id |
|
71 | + * |
|
72 | + * @return DbRow |
|
73 | + */ |
|
74 | + public function get($tableName, $id) |
|
75 | + { |
|
76 | + if (isset($this->objects[$tableName][$id])) { |
|
77 | + return $this->objects[$tableName][$id]; |
|
78 | + } else { |
|
79 | + return; |
|
80 | + } |
|
81 | + } |
|
82 | 82 | |
83 | - /** |
|
84 | - * Removes an object from the storage. |
|
85 | - * |
|
86 | - * @param string $tableName |
|
87 | - * @param string $id |
|
88 | - */ |
|
89 | - public function remove($tableName, $id) |
|
90 | - { |
|
91 | - unset($this->objects[$tableName][$id]); |
|
92 | - } |
|
83 | + /** |
|
84 | + * Removes an object from the storage. |
|
85 | + * |
|
86 | + * @param string $tableName |
|
87 | + * @param string $id |
|
88 | + */ |
|
89 | + public function remove($tableName, $id) |
|
90 | + { |
|
91 | + unset($this->objects[$tableName][$id]); |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Applies the callback to all objects. |
|
96 | - * |
|
97 | - * @param callable $callback |
|
98 | - */ |
|
99 | - public function apply(callable $callback) |
|
100 | - { |
|
101 | - foreach ($this->objects as $tableName => $table) { |
|
102 | - foreach ($table as $id => $obj) { |
|
103 | - $callback($obj, $tableName, $id); |
|
104 | - } |
|
105 | - } |
|
106 | - } |
|
94 | + /** |
|
95 | + * Applies the callback to all objects. |
|
96 | + * |
|
97 | + * @param callable $callback |
|
98 | + */ |
|
99 | + public function apply(callable $callback) |
|
100 | + { |
|
101 | + foreach ($this->objects as $tableName => $table) { |
|
102 | + foreach ($table as $id => $obj) { |
|
103 | + $callback($obj, $tableName, $id); |
|
104 | + } |
|
105 | + } |
|
106 | + } |
|
107 | 107 | } |
@@ -8,7 +8,7 @@ |
||
8 | 8 | <input type="hidden" id="selfedit" name="selfedit" value="<?php echo plainstring_to_htmlprotected($this->selfedit) ?>" /> |
9 | 9 | |
10 | 10 | <?php if (!$this->autoloadDetected) { |
11 | - ?> |
|
11 | + ?> |
|
12 | 12 | <div class="alert">Warning! TDBM could not detect the autoload section of your composer.json file. |
13 | 13 | Unless you are developing your own autoload system, you should configure <strong>composer.json</strong> to <a href="http://getcomposer.org/doc/01-basic-usage.md#autoloading" target="_blank">define a source directory and a root namespace using PSR-0</a>.</div> |
14 | 14 | <?php |
@@ -15,176 +15,176 @@ |
||
15 | 15 | */ |
16 | 16 | class TdbmInstallController extends Controller |
17 | 17 | { |
18 | - /** |
|
19 | - * @var HtmlBlock |
|
20 | - */ |
|
21 | - public $content; |
|
22 | - |
|
23 | - public $selfedit; |
|
24 | - |
|
25 | - /** |
|
26 | - * The active MoufManager to be edited/viewed. |
|
27 | - * |
|
28 | - * @var MoufManager |
|
29 | - */ |
|
30 | - public $moufManager; |
|
31 | - |
|
32 | - /** |
|
33 | - * The template used by the main page for mouf. |
|
34 | - * |
|
35 | - * @Property |
|
36 | - * @Compulsory |
|
37 | - * |
|
38 | - * @var TemplateInterface |
|
39 | - */ |
|
40 | - public $template; |
|
41 | - |
|
42 | - /** |
|
43 | - * Displays the first install screen. |
|
44 | - * |
|
45 | - * @Action |
|
46 | - * @Logged |
|
47 | - * |
|
48 | - * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only) |
|
49 | - */ |
|
50 | - public function defaultAction($selfedit = 'false') |
|
51 | - { |
|
52 | - $this->selfedit = $selfedit; |
|
53 | - |
|
54 | - if ($selfedit == 'true') { |
|
55 | - $this->moufManager = MoufManager::getMoufManager(); |
|
56 | - } else { |
|
57 | - $this->moufManager = MoufManager::getMoufManagerHiddenInstance(); |
|
58 | - } |
|
59 | - |
|
60 | - $this->content->addFile(dirname(__FILE__).'/../../../../views/installStep1.php', $this); |
|
61 | - $this->template->toHtml(); |
|
62 | - } |
|
63 | - |
|
64 | - /** |
|
65 | - * Skips the install process. |
|
66 | - * |
|
67 | - * @Action |
|
68 | - * @Logged |
|
69 | - * |
|
70 | - * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only) |
|
71 | - */ |
|
72 | - public function skip($selfedit = 'false') |
|
73 | - { |
|
74 | - InstallUtils::continueInstall($selfedit == 'true'); |
|
75 | - } |
|
76 | - |
|
77 | - protected $daoNamespace; |
|
78 | - protected $beanNamespace; |
|
79 | - protected $autoloadDetected; |
|
80 | - protected $storeInUtc; |
|
81 | - |
|
82 | - /** |
|
83 | - * Displays the second install screen. |
|
84 | - * |
|
85 | - * @Action |
|
86 | - * @Logged |
|
87 | - * |
|
88 | - * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only) |
|
89 | - */ |
|
90 | - public function configure($selfedit = 'false') |
|
91 | - { |
|
92 | - $this->selfedit = $selfedit; |
|
93 | - |
|
94 | - if ($selfedit == 'true') { |
|
95 | - $this->moufManager = MoufManager::getMoufManager(); |
|
96 | - } else { |
|
97 | - $this->moufManager = MoufManager::getMoufManagerHiddenInstance(); |
|
98 | - } |
|
99 | - |
|
100 | - // Let's start by performing basic checks about the instances we assume to exist. |
|
101 | - if (!$this->moufManager->instanceExists('dbalConnection')) { |
|
102 | - $this->displayErrorMsg("The TDBM install process assumes your database connection instance is already created, and that the name of this instance is 'dbalConnection'. Could not find the 'dbalConnection' instance."); |
|
103 | - |
|
104 | - return; |
|
105 | - } |
|
106 | - |
|
107 | - if (!$this->moufManager->instanceExists('noCacheService')) { |
|
108 | - $this->displayErrorMsg("The TDBM install process assumes that a cache instance named 'noCacheService' exists. Could not find the 'noCacheService' instance."); |
|
109 | - |
|
110 | - return; |
|
111 | - } |
|
112 | - |
|
113 | - $this->daoNamespace = $this->moufManager->getVariable('tdbmDefaultDaoNamespace_tdbmService'); |
|
114 | - $this->beanNamespace = $this->moufManager->getVariable('tdbmDefaultBeanNamespace_tdbmService'); |
|
115 | - |
|
116 | - if ($this->daoNamespace == null && $this->beanNamespace == null) { |
|
117 | - $classNameMapper = ClassNameMapper::createFromComposerFile(__DIR__.'/../../../../../../../../composer.json'); |
|
118 | - |
|
119 | - $autoloadNamespaces = $classNameMapper->getManagedNamespaces(); |
|
120 | - if ($autoloadNamespaces) { |
|
121 | - $this->autoloadDetected = true; |
|
122 | - $rootNamespace = $autoloadNamespaces[0]; |
|
123 | - $this->daoNamespace = $rootNamespace.'Dao'; |
|
124 | - $this->beanNamespace = $rootNamespace.'Dao\\Bean'; |
|
125 | - } else { |
|
126 | - $this->autoloadDetected = false; |
|
127 | - $this->daoNamespace = 'YourApplication\\Dao'; |
|
128 | - $this->beanNamespace = 'YourApplication\\Dao\\Bean'; |
|
129 | - } |
|
130 | - } else { |
|
131 | - $this->autoloadDetected = true; |
|
132 | - } |
|
133 | - |
|
134 | - $this->castDatesToDateTime = true; |
|
135 | - |
|
136 | - $this->content->addFile(dirname(__FILE__).'/../../../../views/installStep2.php', $this); |
|
137 | - $this->template->toHtml(); |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * This action generates the TDBM instance, then the DAOs and Beans. |
|
142 | - * |
|
143 | - * @Action |
|
144 | - * |
|
145 | - * @param string $daonamespace |
|
146 | - * @param string $beannamespace |
|
147 | - * @param int $storeInUtc |
|
148 | - * @param string $selfedit |
|
149 | - * |
|
150 | - * @throws \Mouf\MoufException |
|
151 | - */ |
|
152 | - public function generate($daonamespace, $beannamespace, $storeInUtc = 0, $selfedit = 'false') |
|
153 | - { |
|
154 | - $this->selfedit = $selfedit; |
|
155 | - |
|
156 | - if ($selfedit == 'true') { |
|
157 | - $this->moufManager = MoufManager::getMoufManager(); |
|
158 | - } else { |
|
159 | - $this->moufManager = MoufManager::getMoufManagerHiddenInstance(); |
|
160 | - } |
|
161 | - |
|
162 | - if (!$this->moufManager->instanceExists('doctrineApcCache')) { |
|
163 | - $doctrineApcCache = $this->moufManager->createInstance('Doctrine\\Common\\Cache\\ApcCache')->setName('doctrineApcCache'); |
|
164 | - // TODO: set namespace |
|
165 | - } else { |
|
166 | - $doctrineApcCache = $this->moufManager->getInstanceDescriptor('doctrineApcCache'); |
|
167 | - } |
|
168 | - |
|
169 | - if (!$this->moufManager->instanceExists('tdbmService')) { |
|
170 | - $tdbmService = $this->moufManager->createInstance('Mouf\\Database\\TDBM\\TDBMService')->setName('tdbmService'); |
|
171 | - $tdbmService->getConstructorArgumentProperty('connection')->setValue($this->moufManager->getInstanceDescriptor('dbalConnection')); |
|
172 | - $tdbmService->getConstructorArgumentProperty('cache')->setValue($doctrineApcCache); |
|
173 | - } |
|
174 | - |
|
175 | - $this->moufManager->rewriteMouf(); |
|
176 | - |
|
177 | - TdbmController::generateDaos($this->moufManager, 'tdbmService', $daonamespace, $beannamespace, 'DaoFactory', 'daoFactory', $selfedit, $storeInUtc); |
|
178 | - |
|
179 | - InstallUtils::continueInstall($selfedit == 'true'); |
|
180 | - } |
|
181 | - |
|
182 | - protected $errorMsg; |
|
183 | - |
|
184 | - private function displayErrorMsg($msg) |
|
185 | - { |
|
186 | - $this->errorMsg = $msg; |
|
187 | - $this->content->addFile(dirname(__FILE__).'/../../../../views/installError.php', $this); |
|
188 | - $this->template->toHtml(); |
|
189 | - } |
|
18 | + /** |
|
19 | + * @var HtmlBlock |
|
20 | + */ |
|
21 | + public $content; |
|
22 | + |
|
23 | + public $selfedit; |
|
24 | + |
|
25 | + /** |
|
26 | + * The active MoufManager to be edited/viewed. |
|
27 | + * |
|
28 | + * @var MoufManager |
|
29 | + */ |
|
30 | + public $moufManager; |
|
31 | + |
|
32 | + /** |
|
33 | + * The template used by the main page for mouf. |
|
34 | + * |
|
35 | + * @Property |
|
36 | + * @Compulsory |
|
37 | + * |
|
38 | + * @var TemplateInterface |
|
39 | + */ |
|
40 | + public $template; |
|
41 | + |
|
42 | + /** |
|
43 | + * Displays the first install screen. |
|
44 | + * |
|
45 | + * @Action |
|
46 | + * @Logged |
|
47 | + * |
|
48 | + * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only) |
|
49 | + */ |
|
50 | + public function defaultAction($selfedit = 'false') |
|
51 | + { |
|
52 | + $this->selfedit = $selfedit; |
|
53 | + |
|
54 | + if ($selfedit == 'true') { |
|
55 | + $this->moufManager = MoufManager::getMoufManager(); |
|
56 | + } else { |
|
57 | + $this->moufManager = MoufManager::getMoufManagerHiddenInstance(); |
|
58 | + } |
|
59 | + |
|
60 | + $this->content->addFile(dirname(__FILE__).'/../../../../views/installStep1.php', $this); |
|
61 | + $this->template->toHtml(); |
|
62 | + } |
|
63 | + |
|
64 | + /** |
|
65 | + * Skips the install process. |
|
66 | + * |
|
67 | + * @Action |
|
68 | + * @Logged |
|
69 | + * |
|
70 | + * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only) |
|
71 | + */ |
|
72 | + public function skip($selfedit = 'false') |
|
73 | + { |
|
74 | + InstallUtils::continueInstall($selfedit == 'true'); |
|
75 | + } |
|
76 | + |
|
77 | + protected $daoNamespace; |
|
78 | + protected $beanNamespace; |
|
79 | + protected $autoloadDetected; |
|
80 | + protected $storeInUtc; |
|
81 | + |
|
82 | + /** |
|
83 | + * Displays the second install screen. |
|
84 | + * |
|
85 | + * @Action |
|
86 | + * @Logged |
|
87 | + * |
|
88 | + * @param string $selfedit If true, the name of the component must be a component from the Mouf framework itself (internal use only) |
|
89 | + */ |
|
90 | + public function configure($selfedit = 'false') |
|
91 | + { |
|
92 | + $this->selfedit = $selfedit; |
|
93 | + |
|
94 | + if ($selfedit == 'true') { |
|
95 | + $this->moufManager = MoufManager::getMoufManager(); |
|
96 | + } else { |
|
97 | + $this->moufManager = MoufManager::getMoufManagerHiddenInstance(); |
|
98 | + } |
|
99 | + |
|
100 | + // Let's start by performing basic checks about the instances we assume to exist. |
|
101 | + if (!$this->moufManager->instanceExists('dbalConnection')) { |
|
102 | + $this->displayErrorMsg("The TDBM install process assumes your database connection instance is already created, and that the name of this instance is 'dbalConnection'. Could not find the 'dbalConnection' instance."); |
|
103 | + |
|
104 | + return; |
|
105 | + } |
|
106 | + |
|
107 | + if (!$this->moufManager->instanceExists('noCacheService')) { |
|
108 | + $this->displayErrorMsg("The TDBM install process assumes that a cache instance named 'noCacheService' exists. Could not find the 'noCacheService' instance."); |
|
109 | + |
|
110 | + return; |
|
111 | + } |
|
112 | + |
|
113 | + $this->daoNamespace = $this->moufManager->getVariable('tdbmDefaultDaoNamespace_tdbmService'); |
|
114 | + $this->beanNamespace = $this->moufManager->getVariable('tdbmDefaultBeanNamespace_tdbmService'); |
|
115 | + |
|
116 | + if ($this->daoNamespace == null && $this->beanNamespace == null) { |
|
117 | + $classNameMapper = ClassNameMapper::createFromComposerFile(__DIR__.'/../../../../../../../../composer.json'); |
|
118 | + |
|
119 | + $autoloadNamespaces = $classNameMapper->getManagedNamespaces(); |
|
120 | + if ($autoloadNamespaces) { |
|
121 | + $this->autoloadDetected = true; |
|
122 | + $rootNamespace = $autoloadNamespaces[0]; |
|
123 | + $this->daoNamespace = $rootNamespace.'Dao'; |
|
124 | + $this->beanNamespace = $rootNamespace.'Dao\\Bean'; |
|
125 | + } else { |
|
126 | + $this->autoloadDetected = false; |
|
127 | + $this->daoNamespace = 'YourApplication\\Dao'; |
|
128 | + $this->beanNamespace = 'YourApplication\\Dao\\Bean'; |
|
129 | + } |
|
130 | + } else { |
|
131 | + $this->autoloadDetected = true; |
|
132 | + } |
|
133 | + |
|
134 | + $this->castDatesToDateTime = true; |
|
135 | + |
|
136 | + $this->content->addFile(dirname(__FILE__).'/../../../../views/installStep2.php', $this); |
|
137 | + $this->template->toHtml(); |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * This action generates the TDBM instance, then the DAOs and Beans. |
|
142 | + * |
|
143 | + * @Action |
|
144 | + * |
|
145 | + * @param string $daonamespace |
|
146 | + * @param string $beannamespace |
|
147 | + * @param int $storeInUtc |
|
148 | + * @param string $selfedit |
|
149 | + * |
|
150 | + * @throws \Mouf\MoufException |
|
151 | + */ |
|
152 | + public function generate($daonamespace, $beannamespace, $storeInUtc = 0, $selfedit = 'false') |
|
153 | + { |
|
154 | + $this->selfedit = $selfedit; |
|
155 | + |
|
156 | + if ($selfedit == 'true') { |
|
157 | + $this->moufManager = MoufManager::getMoufManager(); |
|
158 | + } else { |
|
159 | + $this->moufManager = MoufManager::getMoufManagerHiddenInstance(); |
|
160 | + } |
|
161 | + |
|
162 | + if (!$this->moufManager->instanceExists('doctrineApcCache')) { |
|
163 | + $doctrineApcCache = $this->moufManager->createInstance('Doctrine\\Common\\Cache\\ApcCache')->setName('doctrineApcCache'); |
|
164 | + // TODO: set namespace |
|
165 | + } else { |
|
166 | + $doctrineApcCache = $this->moufManager->getInstanceDescriptor('doctrineApcCache'); |
|
167 | + } |
|
168 | + |
|
169 | + if (!$this->moufManager->instanceExists('tdbmService')) { |
|
170 | + $tdbmService = $this->moufManager->createInstance('Mouf\\Database\\TDBM\\TDBMService')->setName('tdbmService'); |
|
171 | + $tdbmService->getConstructorArgumentProperty('connection')->setValue($this->moufManager->getInstanceDescriptor('dbalConnection')); |
|
172 | + $tdbmService->getConstructorArgumentProperty('cache')->setValue($doctrineApcCache); |
|
173 | + } |
|
174 | + |
|
175 | + $this->moufManager->rewriteMouf(); |
|
176 | + |
|
177 | + TdbmController::generateDaos($this->moufManager, 'tdbmService', $daonamespace, $beannamespace, 'DaoFactory', 'daoFactory', $selfedit, $storeInUtc); |
|
178 | + |
|
179 | + InstallUtils::continueInstall($selfedit == 'true'); |
|
180 | + } |
|
181 | + |
|
182 | + protected $errorMsg; |
|
183 | + |
|
184 | + private function displayErrorMsg($msg) |
|
185 | + { |
|
186 | + $this->errorMsg = $msg; |
|
187 | + $this->content->addFile(dirname(__FILE__).'/../../../../views/installError.php', $this); |
|
188 | + $this->template->toHtml(); |
|
189 | + } |
|
190 | 190 | } |
@@ -29,232 +29,232 @@ |
||
29 | 29 | */ |
30 | 30 | class PageIterator implements Page, \ArrayAccess, \JsonSerializable |
31 | 31 | { |
32 | - /** |
|
33 | - * @var Statement |
|
34 | - */ |
|
35 | - protected $statement; |
|
32 | + /** |
|
33 | + * @var Statement |
|
34 | + */ |
|
35 | + protected $statement; |
|
36 | 36 | |
37 | - protected $fetchStarted = false; |
|
38 | - private $objectStorage; |
|
39 | - private $className; |
|
37 | + protected $fetchStarted = false; |
|
38 | + private $objectStorage; |
|
39 | + private $className; |
|
40 | 40 | |
41 | - private $parentResult; |
|
42 | - private $tdbmService; |
|
43 | - private $magicSql; |
|
44 | - private $parameters; |
|
45 | - private $limit; |
|
46 | - private $offset; |
|
47 | - private $columnDescriptors; |
|
48 | - private $magicQuery; |
|
41 | + private $parentResult; |
|
42 | + private $tdbmService; |
|
43 | + private $magicSql; |
|
44 | + private $parameters; |
|
45 | + private $limit; |
|
46 | + private $offset; |
|
47 | + private $columnDescriptors; |
|
48 | + private $magicQuery; |
|
49 | 49 | |
50 | - /** |
|
51 | - * The key of the current retrieved object. |
|
52 | - * |
|
53 | - * @var int |
|
54 | - */ |
|
55 | - protected $key = -1; |
|
50 | + /** |
|
51 | + * The key of the current retrieved object. |
|
52 | + * |
|
53 | + * @var int |
|
54 | + */ |
|
55 | + protected $key = -1; |
|
56 | 56 | |
57 | - protected $current = null; |
|
57 | + protected $current = null; |
|
58 | 58 | |
59 | - private $databasePlatform; |
|
59 | + private $databasePlatform; |
|
60 | 60 | |
61 | - private $innerResultIterator; |
|
61 | + private $innerResultIterator; |
|
62 | 62 | |
63 | - private $mode; |
|
63 | + private $mode; |
|
64 | 64 | |
65 | - public function __construct(ResultIterator $parentResult, $magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode) |
|
66 | - { |
|
67 | - $this->parentResult = $parentResult; |
|
68 | - $this->magicSql = $magicSql; |
|
69 | - $this->objectStorage = $objectStorage; |
|
70 | - $this->className = $className; |
|
71 | - $this->tdbmService = $tdbmService; |
|
72 | - $this->parameters = $parameters; |
|
73 | - $this->limit = $limit; |
|
74 | - $this->offset = $offset; |
|
75 | - $this->columnDescriptors = $columnDescriptors; |
|
76 | - $this->magicQuery = $magicQuery; |
|
77 | - $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
78 | - $this->mode = $mode; |
|
79 | - } |
|
65 | + public function __construct(ResultIterator $parentResult, $magicSql, array $parameters, $limit, $offset, array $columnDescriptors, $objectStorage, $className, TDBMService $tdbmService, MagicQuery $magicQuery, $mode) |
|
66 | + { |
|
67 | + $this->parentResult = $parentResult; |
|
68 | + $this->magicSql = $magicSql; |
|
69 | + $this->objectStorage = $objectStorage; |
|
70 | + $this->className = $className; |
|
71 | + $this->tdbmService = $tdbmService; |
|
72 | + $this->parameters = $parameters; |
|
73 | + $this->limit = $limit; |
|
74 | + $this->offset = $offset; |
|
75 | + $this->columnDescriptors = $columnDescriptors; |
|
76 | + $this->magicQuery = $magicQuery; |
|
77 | + $this->databasePlatform = $this->tdbmService->getConnection()->getDatabasePlatform(); |
|
78 | + $this->mode = $mode; |
|
79 | + } |
|
80 | 80 | |
81 | - /** |
|
82 | - * Retrieve an external iterator. |
|
83 | - * |
|
84 | - * @link http://php.net/manual/en/iteratoraggregate.getiterator.php |
|
85 | - * |
|
86 | - * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or |
|
87 | - * <b>Traversable</b> |
|
88 | - * |
|
89 | - * @since 5.0.0 |
|
90 | - */ |
|
91 | - public function getIterator() |
|
92 | - { |
|
93 | - if ($this->innerResultIterator === null) { |
|
94 | - if ($this->mode === TDBMService::MODE_CURSOR) { |
|
95 | - $this->innerResultIterator = new InnerResultIterator($this->magicSql, $this->parameters, $this->limit, $this->offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery); |
|
96 | - } else { |
|
97 | - $this->innerResultIterator = new InnerResultArray($this->magicSql, $this->parameters, $this->limit, $this->offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery); |
|
98 | - } |
|
99 | - } |
|
81 | + /** |
|
82 | + * Retrieve an external iterator. |
|
83 | + * |
|
84 | + * @link http://php.net/manual/en/iteratoraggregate.getiterator.php |
|
85 | + * |
|
86 | + * @return InnerResultIterator An instance of an object implementing <b>Iterator</b> or |
|
87 | + * <b>Traversable</b> |
|
88 | + * |
|
89 | + * @since 5.0.0 |
|
90 | + */ |
|
91 | + public function getIterator() |
|
92 | + { |
|
93 | + if ($this->innerResultIterator === null) { |
|
94 | + if ($this->mode === TDBMService::MODE_CURSOR) { |
|
95 | + $this->innerResultIterator = new InnerResultIterator($this->magicSql, $this->parameters, $this->limit, $this->offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery); |
|
96 | + } else { |
|
97 | + $this->innerResultIterator = new InnerResultArray($this->magicSql, $this->parameters, $this->limit, $this->offset, $this->columnDescriptors, $this->objectStorage, $this->className, $this->tdbmService, $this->magicQuery); |
|
98 | + } |
|
99 | + } |
|
100 | 100 | |
101 | - return $this->innerResultIterator; |
|
102 | - } |
|
101 | + return $this->innerResultIterator; |
|
102 | + } |
|
103 | 103 | |
104 | - /** |
|
105 | - * @return int |
|
106 | - */ |
|
107 | - public function getCurrentOffset() |
|
108 | - { |
|
109 | - return $this->offset; |
|
110 | - } |
|
104 | + /** |
|
105 | + * @return int |
|
106 | + */ |
|
107 | + public function getCurrentOffset() |
|
108 | + { |
|
109 | + return $this->offset; |
|
110 | + } |
|
111 | 111 | |
112 | - /** |
|
113 | - * @return int |
|
114 | - */ |
|
115 | - public function getCurrentPage() |
|
116 | - { |
|
117 | - return floor($this->offset / $this->limit) + 1; |
|
118 | - } |
|
112 | + /** |
|
113 | + * @return int |
|
114 | + */ |
|
115 | + public function getCurrentPage() |
|
116 | + { |
|
117 | + return floor($this->offset / $this->limit) + 1; |
|
118 | + } |
|
119 | 119 | |
120 | - /** |
|
121 | - * @return int |
|
122 | - */ |
|
123 | - public function getCurrentLimit() |
|
124 | - { |
|
125 | - return $this->limit; |
|
126 | - } |
|
120 | + /** |
|
121 | + * @return int |
|
122 | + */ |
|
123 | + public function getCurrentLimit() |
|
124 | + { |
|
125 | + return $this->limit; |
|
126 | + } |
|
127 | 127 | |
128 | - /** |
|
129 | - * Return the number of results on the current page of the {@link Result}. |
|
130 | - * |
|
131 | - * @return int |
|
132 | - */ |
|
133 | - public function count() |
|
134 | - { |
|
135 | - return $this->getIterator()->count(); |
|
136 | - } |
|
128 | + /** |
|
129 | + * Return the number of results on the current page of the {@link Result}. |
|
130 | + * |
|
131 | + * @return int |
|
132 | + */ |
|
133 | + public function count() |
|
134 | + { |
|
135 | + return $this->getIterator()->count(); |
|
136 | + } |
|
137 | 137 | |
138 | - /** |
|
139 | - * Return the number of ALL results in the paginatable of {@link Result}. |
|
140 | - * |
|
141 | - * @return int |
|
142 | - */ |
|
143 | - public function totalCount() |
|
144 | - { |
|
145 | - return $this->parentResult->count(); |
|
146 | - } |
|
138 | + /** |
|
139 | + * Return the number of ALL results in the paginatable of {@link Result}. |
|
140 | + * |
|
141 | + * @return int |
|
142 | + */ |
|
143 | + public function totalCount() |
|
144 | + { |
|
145 | + return $this->parentResult->count(); |
|
146 | + } |
|
147 | 147 | |
148 | - /** |
|
149 | - * Casts the result set to a PHP array. |
|
150 | - * |
|
151 | - * @return array |
|
152 | - */ |
|
153 | - public function toArray() |
|
154 | - { |
|
155 | - return iterator_to_array($this->getIterator()); |
|
156 | - } |
|
148 | + /** |
|
149 | + * Casts the result set to a PHP array. |
|
150 | + * |
|
151 | + * @return array |
|
152 | + */ |
|
153 | + public function toArray() |
|
154 | + { |
|
155 | + return iterator_to_array($this->getIterator()); |
|
156 | + } |
|
157 | 157 | |
158 | - /** |
|
159 | - * Returns a new iterator mapping any call using the $callable function. |
|
160 | - * |
|
161 | - * @param callable $callable |
|
162 | - * |
|
163 | - * @return MapIterator |
|
164 | - */ |
|
165 | - public function map(callable $callable) |
|
166 | - { |
|
167 | - return new MapIterator($this->getIterator(), $callable); |
|
168 | - } |
|
158 | + /** |
|
159 | + * Returns a new iterator mapping any call using the $callable function. |
|
160 | + * |
|
161 | + * @param callable $callable |
|
162 | + * |
|
163 | + * @return MapIterator |
|
164 | + */ |
|
165 | + public function map(callable $callable) |
|
166 | + { |
|
167 | + return new MapIterator($this->getIterator(), $callable); |
|
168 | + } |
|
169 | 169 | |
170 | - /** |
|
171 | - * Whether a offset exists. |
|
172 | - * |
|
173 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
174 | - * |
|
175 | - * @param mixed $offset <p> |
|
176 | - * An offset to check for. |
|
177 | - * </p> |
|
178 | - * |
|
179 | - * @return bool true on success or false on failure. |
|
180 | - * </p> |
|
181 | - * <p> |
|
182 | - * The return value will be casted to boolean if non-boolean was returned. |
|
183 | - * |
|
184 | - * @since 5.0.0 |
|
185 | - */ |
|
186 | - public function offsetExists($offset) |
|
187 | - { |
|
188 | - return $this->getIterator()->offsetExists($offset); |
|
189 | - } |
|
170 | + /** |
|
171 | + * Whether a offset exists. |
|
172 | + * |
|
173 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
174 | + * |
|
175 | + * @param mixed $offset <p> |
|
176 | + * An offset to check for. |
|
177 | + * </p> |
|
178 | + * |
|
179 | + * @return bool true on success or false on failure. |
|
180 | + * </p> |
|
181 | + * <p> |
|
182 | + * The return value will be casted to boolean if non-boolean was returned. |
|
183 | + * |
|
184 | + * @since 5.0.0 |
|
185 | + */ |
|
186 | + public function offsetExists($offset) |
|
187 | + { |
|
188 | + return $this->getIterator()->offsetExists($offset); |
|
189 | + } |
|
190 | 190 | |
191 | - /** |
|
192 | - * Offset to retrieve. |
|
193 | - * |
|
194 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
195 | - * |
|
196 | - * @param mixed $offset <p> |
|
197 | - * The offset to retrieve. |
|
198 | - * </p> |
|
199 | - * |
|
200 | - * @return mixed Can return all value types. |
|
201 | - * |
|
202 | - * @since 5.0.0 |
|
203 | - */ |
|
204 | - public function offsetGet($offset) |
|
205 | - { |
|
206 | - return $this->getIterator()->offsetGet($offset); |
|
207 | - } |
|
191 | + /** |
|
192 | + * Offset to retrieve. |
|
193 | + * |
|
194 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
195 | + * |
|
196 | + * @param mixed $offset <p> |
|
197 | + * The offset to retrieve. |
|
198 | + * </p> |
|
199 | + * |
|
200 | + * @return mixed Can return all value types. |
|
201 | + * |
|
202 | + * @since 5.0.0 |
|
203 | + */ |
|
204 | + public function offsetGet($offset) |
|
205 | + { |
|
206 | + return $this->getIterator()->offsetGet($offset); |
|
207 | + } |
|
208 | 208 | |
209 | - /** |
|
210 | - * Offset to set. |
|
211 | - * |
|
212 | - * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
213 | - * |
|
214 | - * @param mixed $offset <p> |
|
215 | - * The offset to assign the value to. |
|
216 | - * </p> |
|
217 | - * @param mixed $value <p> |
|
218 | - * The value to set. |
|
219 | - * </p> |
|
220 | - * |
|
221 | - * @since 5.0.0 |
|
222 | - */ |
|
223 | - public function offsetSet($offset, $value) |
|
224 | - { |
|
225 | - return $this->getIterator()->offsetSet($offset, $value); |
|
226 | - } |
|
209 | + /** |
|
210 | + * Offset to set. |
|
211 | + * |
|
212 | + * @link http://php.net/manual/en/arrayaccess.offsetset.php |
|
213 | + * |
|
214 | + * @param mixed $offset <p> |
|
215 | + * The offset to assign the value to. |
|
216 | + * </p> |
|
217 | + * @param mixed $value <p> |
|
218 | + * The value to set. |
|
219 | + * </p> |
|
220 | + * |
|
221 | + * @since 5.0.0 |
|
222 | + */ |
|
223 | + public function offsetSet($offset, $value) |
|
224 | + { |
|
225 | + return $this->getIterator()->offsetSet($offset, $value); |
|
226 | + } |
|
227 | 227 | |
228 | - /** |
|
229 | - * Offset to unset. |
|
230 | - * |
|
231 | - * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
232 | - * |
|
233 | - * @param mixed $offset <p> |
|
234 | - * The offset to unset. |
|
235 | - * </p> |
|
236 | - * |
|
237 | - * @since 5.0.0 |
|
238 | - */ |
|
239 | - public function offsetUnset($offset) |
|
240 | - { |
|
241 | - return $this->getIterator()->offsetUnset($offset); |
|
242 | - } |
|
228 | + /** |
|
229 | + * Offset to unset. |
|
230 | + * |
|
231 | + * @link http://php.net/manual/en/arrayaccess.offsetunset.php |
|
232 | + * |
|
233 | + * @param mixed $offset <p> |
|
234 | + * The offset to unset. |
|
235 | + * </p> |
|
236 | + * |
|
237 | + * @since 5.0.0 |
|
238 | + */ |
|
239 | + public function offsetUnset($offset) |
|
240 | + { |
|
241 | + return $this->getIterator()->offsetUnset($offset); |
|
242 | + } |
|
243 | 243 | |
244 | - /** |
|
245 | - * Specify data which should be serialized to JSON. |
|
246 | - * |
|
247 | - * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
248 | - * |
|
249 | - * @return mixed data which can be serialized by <b>json_encode</b>, |
|
250 | - * which is a value of any type other than a resource. |
|
251 | - * |
|
252 | - * @since 5.4.0 |
|
253 | - */ |
|
254 | - public function jsonSerialize() |
|
255 | - { |
|
256 | - return array_map(function (AbstractTDBMObject $item) { |
|
257 | - return $item->jsonSerialize(); |
|
258 | - }, $this->toArray()); |
|
259 | - } |
|
244 | + /** |
|
245 | + * Specify data which should be serialized to JSON. |
|
246 | + * |
|
247 | + * @link http://php.net/manual/en/jsonserializable.jsonserialize.php |
|
248 | + * |
|
249 | + * @return mixed data which can be serialized by <b>json_encode</b>, |
|
250 | + * which is a value of any type other than a resource. |
|
251 | + * |
|
252 | + * @since 5.4.0 |
|
253 | + */ |
|
254 | + public function jsonSerialize() |
|
255 | + { |
|
256 | + return array_map(function (AbstractTDBMObject $item) { |
|
257 | + return $item->jsonSerialize(); |
|
258 | + }, $this->toArray()); |
|
259 | + } |
|
260 | 260 | } |
@@ -27,163 +27,163 @@ discard block |
||
27 | 27 | */ |
28 | 28 | class DbRow |
29 | 29 | { |
30 | - /** |
|
31 | - * The service this object is bound to. |
|
32 | - * |
|
33 | - * @var TDBMService |
|
34 | - */ |
|
35 | - protected $tdbmService; |
|
36 | - |
|
37 | - /** |
|
38 | - * The object containing this db row. |
|
39 | - * |
|
40 | - * @var AbstractTDBMObject |
|
41 | - */ |
|
42 | - private $object; |
|
43 | - |
|
44 | - /** |
|
45 | - * The name of the table the object if issued from. |
|
46 | - * |
|
47 | - * @var string |
|
48 | - */ |
|
49 | - private $dbTableName; |
|
50 | - |
|
51 | - /** |
|
52 | - * The array of columns returned from database. |
|
53 | - * |
|
54 | - * @var array |
|
55 | - */ |
|
56 | - private $dbRow = array(); |
|
57 | - |
|
58 | - /** |
|
59 | - * @var AbstractTDBMObject[] |
|
60 | - */ |
|
61 | - private $references = array(); |
|
62 | - |
|
63 | - /** |
|
64 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
65 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
66 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
67 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
68 | - * |
|
69 | - * @var string |
|
70 | - */ |
|
71 | - private $status; |
|
72 | - |
|
73 | - /** |
|
74 | - * The values of the primary key. |
|
75 | - * This is set when the object is in "loaded" state. |
|
76 | - * |
|
77 | - * @var array An array of column => value |
|
78 | - */ |
|
79 | - private $primaryKeys; |
|
80 | - |
|
81 | - /** |
|
82 | - * You should never call the constructor directly. Instead, you should use the |
|
83 | - * TDBMService class that will create TDBMObjects for you. |
|
84 | - * |
|
85 | - * Used with id!=false when we want to retrieve an existing object |
|
86 | - * and id==false if we want a new object |
|
87 | - * |
|
88 | - * @param AbstractTDBMObject $object The object containing this db row. |
|
89 | - * @param string $table_name |
|
90 | - * @param array $primaryKeys |
|
91 | - * @param TDBMService $tdbmService |
|
92 | - * |
|
93 | - * @throws TDBMException |
|
94 | - * @throws TDBMInvalidOperationException |
|
95 | - */ |
|
96 | - public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array()) |
|
97 | - { |
|
98 | - $this->object = $object; |
|
99 | - $this->dbTableName = $table_name; |
|
100 | - |
|
101 | - $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
102 | - |
|
103 | - if ($tdbmService === null) { |
|
104 | - if (!empty($primaryKeys)) { |
|
105 | - throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.'); |
|
106 | - } |
|
107 | - } else { |
|
108 | - $this->tdbmService = $tdbmService; |
|
109 | - |
|
110 | - if (!empty($primaryKeys)) { |
|
111 | - $this->_setPrimaryKeys($primaryKeys); |
|
112 | - if (!empty($dbRow)) { |
|
113 | - $this->dbRow = $dbRow; |
|
114 | - $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
115 | - } else { |
|
116 | - $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
117 | - } |
|
118 | - $tdbmService->_addToCache($this); |
|
119 | - } else { |
|
120 | - $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
121 | - $this->tdbmService->_addToToSaveObjectList($this); |
|
122 | - } |
|
123 | - } |
|
124 | - } |
|
125 | - |
|
126 | - public function _attach(TDBMService $tdbmService) |
|
127 | - { |
|
128 | - if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
129 | - throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
130 | - } |
|
131 | - $this->tdbmService = $tdbmService; |
|
132 | - $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
133 | - $this->tdbmService->_addToToSaveObjectList($this); |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * Sets the state of the TDBM Object |
|
138 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
139 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
140 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
141 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
142 | - * |
|
143 | - * @param string $state |
|
144 | - */ |
|
145 | - public function _setStatus($state) |
|
146 | - { |
|
147 | - $this->status = $state; |
|
148 | - } |
|
149 | - |
|
150 | - /** |
|
151 | - * This is an internal method. You should not call this method yourself. The TDBM library will do it for you. |
|
152 | - * If the object is in state 'not loaded', this method performs a query in database to load the object. |
|
153 | - * |
|
154 | - * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified |
|
155 | - * cannot be found). |
|
156 | - */ |
|
157 | - public function _dbLoadIfNotLoaded() |
|
158 | - { |
|
159 | - if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) { |
|
160 | - $connection = $this->tdbmService->getConnection(); |
|
161 | - |
|
162 | - /// buildFilterFromFilterBag($filter_bag) |
|
163 | - list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys); |
|
164 | - |
|
165 | - $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where; |
|
166 | - $result = $connection->executeQuery($sql, $parameters); |
|
167 | - |
|
168 | - if ($result->rowCount() === 0) { |
|
169 | - throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\"."); |
|
170 | - } |
|
171 | - |
|
172 | - $this->dbRow = $result->fetch(\PDO::FETCH_ASSOC); |
|
173 | - |
|
174 | - $result->closeCursor(); |
|
175 | - |
|
176 | - $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
177 | - } |
|
178 | - } |
|
179 | - |
|
180 | - public function get($var) |
|
181 | - { |
|
182 | - $this->_dbLoadIfNotLoaded(); |
|
183 | - |
|
184 | - // Let's first check if the key exist. |
|
185 | - if (!isset($this->dbRow[$var])) { |
|
186 | - /* |
|
30 | + /** |
|
31 | + * The service this object is bound to. |
|
32 | + * |
|
33 | + * @var TDBMService |
|
34 | + */ |
|
35 | + protected $tdbmService; |
|
36 | + |
|
37 | + /** |
|
38 | + * The object containing this db row. |
|
39 | + * |
|
40 | + * @var AbstractTDBMObject |
|
41 | + */ |
|
42 | + private $object; |
|
43 | + |
|
44 | + /** |
|
45 | + * The name of the table the object if issued from. |
|
46 | + * |
|
47 | + * @var string |
|
48 | + */ |
|
49 | + private $dbTableName; |
|
50 | + |
|
51 | + /** |
|
52 | + * The array of columns returned from database. |
|
53 | + * |
|
54 | + * @var array |
|
55 | + */ |
|
56 | + private $dbRow = array(); |
|
57 | + |
|
58 | + /** |
|
59 | + * @var AbstractTDBMObject[] |
|
60 | + */ |
|
61 | + private $references = array(); |
|
62 | + |
|
63 | + /** |
|
64 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
65 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
66 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
67 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
68 | + * |
|
69 | + * @var string |
|
70 | + */ |
|
71 | + private $status; |
|
72 | + |
|
73 | + /** |
|
74 | + * The values of the primary key. |
|
75 | + * This is set when the object is in "loaded" state. |
|
76 | + * |
|
77 | + * @var array An array of column => value |
|
78 | + */ |
|
79 | + private $primaryKeys; |
|
80 | + |
|
81 | + /** |
|
82 | + * You should never call the constructor directly. Instead, you should use the |
|
83 | + * TDBMService class that will create TDBMObjects for you. |
|
84 | + * |
|
85 | + * Used with id!=false when we want to retrieve an existing object |
|
86 | + * and id==false if we want a new object |
|
87 | + * |
|
88 | + * @param AbstractTDBMObject $object The object containing this db row. |
|
89 | + * @param string $table_name |
|
90 | + * @param array $primaryKeys |
|
91 | + * @param TDBMService $tdbmService |
|
92 | + * |
|
93 | + * @throws TDBMException |
|
94 | + * @throws TDBMInvalidOperationException |
|
95 | + */ |
|
96 | + public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array()) |
|
97 | + { |
|
98 | + $this->object = $object; |
|
99 | + $this->dbTableName = $table_name; |
|
100 | + |
|
101 | + $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
102 | + |
|
103 | + if ($tdbmService === null) { |
|
104 | + if (!empty($primaryKeys)) { |
|
105 | + throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.'); |
|
106 | + } |
|
107 | + } else { |
|
108 | + $this->tdbmService = $tdbmService; |
|
109 | + |
|
110 | + if (!empty($primaryKeys)) { |
|
111 | + $this->_setPrimaryKeys($primaryKeys); |
|
112 | + if (!empty($dbRow)) { |
|
113 | + $this->dbRow = $dbRow; |
|
114 | + $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
115 | + } else { |
|
116 | + $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
117 | + } |
|
118 | + $tdbmService->_addToCache($this); |
|
119 | + } else { |
|
120 | + $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
121 | + $this->tdbmService->_addToToSaveObjectList($this); |
|
122 | + } |
|
123 | + } |
|
124 | + } |
|
125 | + |
|
126 | + public function _attach(TDBMService $tdbmService) |
|
127 | + { |
|
128 | + if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
129 | + throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
130 | + } |
|
131 | + $this->tdbmService = $tdbmService; |
|
132 | + $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
133 | + $this->tdbmService->_addToToSaveObjectList($this); |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * Sets the state of the TDBM Object |
|
138 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
139 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
140 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
141 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
142 | + * |
|
143 | + * @param string $state |
|
144 | + */ |
|
145 | + public function _setStatus($state) |
|
146 | + { |
|
147 | + $this->status = $state; |
|
148 | + } |
|
149 | + |
|
150 | + /** |
|
151 | + * This is an internal method. You should not call this method yourself. The TDBM library will do it for you. |
|
152 | + * If the object is in state 'not loaded', this method performs a query in database to load the object. |
|
153 | + * |
|
154 | + * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified |
|
155 | + * cannot be found). |
|
156 | + */ |
|
157 | + public function _dbLoadIfNotLoaded() |
|
158 | + { |
|
159 | + if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) { |
|
160 | + $connection = $this->tdbmService->getConnection(); |
|
161 | + |
|
162 | + /// buildFilterFromFilterBag($filter_bag) |
|
163 | + list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys); |
|
164 | + |
|
165 | + $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where; |
|
166 | + $result = $connection->executeQuery($sql, $parameters); |
|
167 | + |
|
168 | + if ($result->rowCount() === 0) { |
|
169 | + throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\"."); |
|
170 | + } |
|
171 | + |
|
172 | + $this->dbRow = $result->fetch(\PDO::FETCH_ASSOC); |
|
173 | + |
|
174 | + $result->closeCursor(); |
|
175 | + |
|
176 | + $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
177 | + } |
|
178 | + } |
|
179 | + |
|
180 | + public function get($var) |
|
181 | + { |
|
182 | + $this->_dbLoadIfNotLoaded(); |
|
183 | + |
|
184 | + // Let's first check if the key exist. |
|
185 | + if (!isset($this->dbRow[$var])) { |
|
186 | + /* |
|
187 | 187 | // Unable to find column.... this is an error if the object has been retrieved from database. |
188 | 188 | // If it's a new object, well, that may not be an error after all! |
189 | 189 | // Let's check if the column does exist in the table |
@@ -203,30 +203,30 @@ discard block |
||
203 | 203 | $str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'"; |
204 | 204 | |
205 | 205 | throw new TDBMException($str);*/ |
206 | - return; |
|
207 | - } |
|
208 | - |
|
209 | - return $this->dbRow[$var]; |
|
210 | - } |
|
211 | - |
|
212 | - /** |
|
213 | - * Returns true if a column is set, false otherwise. |
|
214 | - * |
|
215 | - * @param string $var |
|
216 | - * |
|
217 | - * @return bool |
|
218 | - */ |
|
219 | - /*public function has($var) { |
|
206 | + return; |
|
207 | + } |
|
208 | + |
|
209 | + return $this->dbRow[$var]; |
|
210 | + } |
|
211 | + |
|
212 | + /** |
|
213 | + * Returns true if a column is set, false otherwise. |
|
214 | + * |
|
215 | + * @param string $var |
|
216 | + * |
|
217 | + * @return bool |
|
218 | + */ |
|
219 | + /*public function has($var) { |
|
220 | 220 | $this->_dbLoadIfNotLoaded(); |
221 | 221 | |
222 | 222 | return isset($this->dbRow[$var]); |
223 | 223 | }*/ |
224 | 224 | |
225 | - public function set($var, $value) |
|
226 | - { |
|
227 | - $this->_dbLoadIfNotLoaded(); |
|
225 | + public function set($var, $value) |
|
226 | + { |
|
227 | + $this->_dbLoadIfNotLoaded(); |
|
228 | 228 | |
229 | - /* |
|
229 | + /* |
|
230 | 230 | // Ok, let's start by checking the column type |
231 | 231 | $type = $this->db_connection->getColumnType($this->dbTableName, $var); |
232 | 232 | |
@@ -236,173 +236,173 @@ discard block |
||
236 | 236 | } |
237 | 237 | */ |
238 | 238 | |
239 | - /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var])) |
|
239 | + /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var])) |
|
240 | 240 | throw new TDBMException("Error! Changing primary key value is forbidden.");*/ |
241 | - $this->dbRow[$var] = $value; |
|
242 | - if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
243 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
244 | - $this->tdbmService->_addToToSaveObjectList($this); |
|
245 | - } |
|
246 | - } |
|
247 | - |
|
248 | - /** |
|
249 | - * @param string $foreignKeyName |
|
250 | - * @param AbstractTDBMObject $bean |
|
251 | - */ |
|
252 | - public function setRef($foreignKeyName, AbstractTDBMObject $bean = null) |
|
253 | - { |
|
254 | - $this->references[$foreignKeyName] = $bean; |
|
255 | - |
|
256 | - if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
257 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
258 | - $this->tdbmService->_addToToSaveObjectList($this); |
|
259 | - } |
|
260 | - } |
|
261 | - |
|
262 | - /** |
|
263 | - * @param string $foreignKeyName A unique name for this reference |
|
264 | - * |
|
265 | - * @return AbstractTDBMObject|null |
|
266 | - */ |
|
267 | - public function getRef($foreignKeyName) |
|
268 | - { |
|
269 | - if (isset($this->references[$foreignKeyName])) { |
|
270 | - return $this->references[$foreignKeyName]; |
|
271 | - } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) { |
|
272 | - // If the object is new and has no property, then it has to be empty. |
|
273 | - return; |
|
274 | - } else { |
|
275 | - $this->_dbLoadIfNotLoaded(); |
|
276 | - |
|
277 | - // Let's match the name of the columns to the primary key values |
|
278 | - $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName); |
|
279 | - |
|
280 | - $values = []; |
|
281 | - foreach ($fk->getLocalColumns() as $column) { |
|
282 | - $values[] = $this->dbRow[$column]; |
|
283 | - } |
|
284 | - |
|
285 | - $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values); |
|
286 | - |
|
287 | - return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true); |
|
288 | - } |
|
289 | - } |
|
290 | - |
|
291 | - /** |
|
292 | - * Returns the name of the table this object comes from. |
|
293 | - * |
|
294 | - * @return string |
|
295 | - */ |
|
296 | - public function _getDbTableName() |
|
297 | - { |
|
298 | - return $this->dbTableName; |
|
299 | - } |
|
300 | - |
|
301 | - /** |
|
302 | - * Method used internally by TDBM. You should not use it directly. |
|
303 | - * This method returns the status of the TDBMObject. |
|
304 | - * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
305 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
306 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
307 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
308 | - * |
|
309 | - * @return string |
|
310 | - */ |
|
311 | - public function _getStatus() |
|
312 | - { |
|
313 | - return $this->status; |
|
314 | - } |
|
315 | - |
|
316 | - /** |
|
317 | - * Override the native php clone function for TDBMObjects. |
|
318 | - */ |
|
319 | - public function __clone() |
|
320 | - { |
|
321 | - // Let's load the row (before we lose the ID!) |
|
322 | - $this->_dbLoadIfNotLoaded(); |
|
323 | - |
|
324 | - //Let's set the status to detached |
|
325 | - $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
326 | - |
|
327 | - $this->primaryKeys = []; |
|
328 | - |
|
329 | - //Now unset the PK from the row |
|
330 | - if ($this->tdbmService) { |
|
331 | - $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName); |
|
332 | - foreach ($pk_array as $pk) { |
|
333 | - $this->dbRow[$pk] = null; |
|
334 | - } |
|
335 | - } |
|
336 | - } |
|
337 | - |
|
338 | - /** |
|
339 | - * Returns raw database row. |
|
340 | - * |
|
341 | - * @return array |
|
342 | - */ |
|
343 | - public function _getDbRow() |
|
344 | - { |
|
345 | - // Let's merge $dbRow and $references |
|
346 | - $dbRow = $this->dbRow; |
|
347 | - |
|
348 | - foreach ($this->references as $foreignKeyName => $reference) { |
|
349 | - // Let's match the name of the columns to the primary key values |
|
350 | - $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName); |
|
351 | - $refDbRows = $reference->_getDbRows(); |
|
352 | - $firstRefDbRow = reset($refDbRows); |
|
353 | - $pkValues = array_values($firstRefDbRow->_getPrimaryKeys()); |
|
354 | - $localColumns = $fk->getLocalColumns(); |
|
355 | - |
|
356 | - for ($i = 0, $count = count($localColumns); $i < $count; ++$i) { |
|
357 | - $dbRow[$localColumns[$i]] = $pkValues[$i]; |
|
358 | - } |
|
359 | - } |
|
360 | - |
|
361 | - return $dbRow; |
|
362 | - } |
|
363 | - |
|
364 | - /** |
|
365 | - * Returns references array. |
|
366 | - * |
|
367 | - * @return AbstractTDBMObject[] |
|
368 | - */ |
|
369 | - public function _getReferences() |
|
370 | - { |
|
371 | - return $this->references; |
|
372 | - } |
|
373 | - |
|
374 | - /** |
|
375 | - * Returns the values of the primary key. |
|
376 | - * This is set when the object is in "loaded" state. |
|
377 | - * |
|
378 | - * @return array |
|
379 | - */ |
|
380 | - public function _getPrimaryKeys() |
|
381 | - { |
|
382 | - return $this->primaryKeys; |
|
383 | - } |
|
384 | - |
|
385 | - /** |
|
386 | - * Sets the values of the primary key. |
|
387 | - * This is set when the object is in "loaded" state. |
|
388 | - * |
|
389 | - * @param array $primaryKeys |
|
390 | - */ |
|
391 | - public function _setPrimaryKeys(array $primaryKeys) |
|
392 | - { |
|
393 | - $this->primaryKeys = $primaryKeys; |
|
394 | - foreach ($this->primaryKeys as $column => $value) { |
|
395 | - $this->dbRow[$column] = $value; |
|
396 | - } |
|
397 | - } |
|
398 | - |
|
399 | - /** |
|
400 | - * Returns the TDBMObject this bean is associated to. |
|
401 | - * |
|
402 | - * @return AbstractTDBMObject |
|
403 | - */ |
|
404 | - public function getTDBMObject() |
|
405 | - { |
|
406 | - return $this->object; |
|
407 | - } |
|
241 | + $this->dbRow[$var] = $value; |
|
242 | + if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
243 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
244 | + $this->tdbmService->_addToToSaveObjectList($this); |
|
245 | + } |
|
246 | + } |
|
247 | + |
|
248 | + /** |
|
249 | + * @param string $foreignKeyName |
|
250 | + * @param AbstractTDBMObject $bean |
|
251 | + */ |
|
252 | + public function setRef($foreignKeyName, AbstractTDBMObject $bean = null) |
|
253 | + { |
|
254 | + $this->references[$foreignKeyName] = $bean; |
|
255 | + |
|
256 | + if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
257 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
258 | + $this->tdbmService->_addToToSaveObjectList($this); |
|
259 | + } |
|
260 | + } |
|
261 | + |
|
262 | + /** |
|
263 | + * @param string $foreignKeyName A unique name for this reference |
|
264 | + * |
|
265 | + * @return AbstractTDBMObject|null |
|
266 | + */ |
|
267 | + public function getRef($foreignKeyName) |
|
268 | + { |
|
269 | + if (isset($this->references[$foreignKeyName])) { |
|
270 | + return $this->references[$foreignKeyName]; |
|
271 | + } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) { |
|
272 | + // If the object is new and has no property, then it has to be empty. |
|
273 | + return; |
|
274 | + } else { |
|
275 | + $this->_dbLoadIfNotLoaded(); |
|
276 | + |
|
277 | + // Let's match the name of the columns to the primary key values |
|
278 | + $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName); |
|
279 | + |
|
280 | + $values = []; |
|
281 | + foreach ($fk->getLocalColumns() as $column) { |
|
282 | + $values[] = $this->dbRow[$column]; |
|
283 | + } |
|
284 | + |
|
285 | + $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values); |
|
286 | + |
|
287 | + return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true); |
|
288 | + } |
|
289 | + } |
|
290 | + |
|
291 | + /** |
|
292 | + * Returns the name of the table this object comes from. |
|
293 | + * |
|
294 | + * @return string |
|
295 | + */ |
|
296 | + public function _getDbTableName() |
|
297 | + { |
|
298 | + return $this->dbTableName; |
|
299 | + } |
|
300 | + |
|
301 | + /** |
|
302 | + * Method used internally by TDBM. You should not use it directly. |
|
303 | + * This method returns the status of the TDBMObject. |
|
304 | + * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
305 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
306 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
307 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
308 | + * |
|
309 | + * @return string |
|
310 | + */ |
|
311 | + public function _getStatus() |
|
312 | + { |
|
313 | + return $this->status; |
|
314 | + } |
|
315 | + |
|
316 | + /** |
|
317 | + * Override the native php clone function for TDBMObjects. |
|
318 | + */ |
|
319 | + public function __clone() |
|
320 | + { |
|
321 | + // Let's load the row (before we lose the ID!) |
|
322 | + $this->_dbLoadIfNotLoaded(); |
|
323 | + |
|
324 | + //Let's set the status to detached |
|
325 | + $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
326 | + |
|
327 | + $this->primaryKeys = []; |
|
328 | + |
|
329 | + //Now unset the PK from the row |
|
330 | + if ($this->tdbmService) { |
|
331 | + $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName); |
|
332 | + foreach ($pk_array as $pk) { |
|
333 | + $this->dbRow[$pk] = null; |
|
334 | + } |
|
335 | + } |
|
336 | + } |
|
337 | + |
|
338 | + /** |
|
339 | + * Returns raw database row. |
|
340 | + * |
|
341 | + * @return array |
|
342 | + */ |
|
343 | + public function _getDbRow() |
|
344 | + { |
|
345 | + // Let's merge $dbRow and $references |
|
346 | + $dbRow = $this->dbRow; |
|
347 | + |
|
348 | + foreach ($this->references as $foreignKeyName => $reference) { |
|
349 | + // Let's match the name of the columns to the primary key values |
|
350 | + $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName); |
|
351 | + $refDbRows = $reference->_getDbRows(); |
|
352 | + $firstRefDbRow = reset($refDbRows); |
|
353 | + $pkValues = array_values($firstRefDbRow->_getPrimaryKeys()); |
|
354 | + $localColumns = $fk->getLocalColumns(); |
|
355 | + |
|
356 | + for ($i = 0, $count = count($localColumns); $i < $count; ++$i) { |
|
357 | + $dbRow[$localColumns[$i]] = $pkValues[$i]; |
|
358 | + } |
|
359 | + } |
|
360 | + |
|
361 | + return $dbRow; |
|
362 | + } |
|
363 | + |
|
364 | + /** |
|
365 | + * Returns references array. |
|
366 | + * |
|
367 | + * @return AbstractTDBMObject[] |
|
368 | + */ |
|
369 | + public function _getReferences() |
|
370 | + { |
|
371 | + return $this->references; |
|
372 | + } |
|
373 | + |
|
374 | + /** |
|
375 | + * Returns the values of the primary key. |
|
376 | + * This is set when the object is in "loaded" state. |
|
377 | + * |
|
378 | + * @return array |
|
379 | + */ |
|
380 | + public function _getPrimaryKeys() |
|
381 | + { |
|
382 | + return $this->primaryKeys; |
|
383 | + } |
|
384 | + |
|
385 | + /** |
|
386 | + * Sets the values of the primary key. |
|
387 | + * This is set when the object is in "loaded" state. |
|
388 | + * |
|
389 | + * @param array $primaryKeys |
|
390 | + */ |
|
391 | + public function _setPrimaryKeys(array $primaryKeys) |
|
392 | + { |
|
393 | + $this->primaryKeys = $primaryKeys; |
|
394 | + foreach ($this->primaryKeys as $column => $value) { |
|
395 | + $this->dbRow[$column] = $value; |
|
396 | + } |
|
397 | + } |
|
398 | + |
|
399 | + /** |
|
400 | + * Returns the TDBMObject this bean is associated to. |
|
401 | + * |
|
402 | + * @return AbstractTDBMObject |
|
403 | + */ |
|
404 | + public function getTDBMObject() |
|
405 | + { |
|
406 | + return $this->object; |
|
407 | + } |
|
408 | 408 | } |
@@ -31,493 +31,493 @@ |
||
31 | 31 | */ |
32 | 32 | abstract class AbstractTDBMObject implements JsonSerializable |
33 | 33 | { |
34 | - /** |
|
35 | - * The service this object is bound to. |
|
36 | - * |
|
37 | - * @var TDBMService |
|
38 | - */ |
|
39 | - protected $tdbmService; |
|
40 | - |
|
41 | - /** |
|
42 | - * An array of DbRow, indexed by table name. |
|
43 | - * |
|
44 | - * @var DbRow[] |
|
45 | - */ |
|
46 | - protected $dbRows = array(); |
|
47 | - |
|
48 | - /** |
|
49 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
50 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
51 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
52 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
53 | - * |
|
54 | - * @var string |
|
55 | - */ |
|
56 | - private $status; |
|
57 | - |
|
58 | - /** |
|
59 | - * Array storing beans related via many to many relationships (pivot tables). |
|
60 | - * |
|
61 | - * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage |
|
62 | - */ |
|
63 | - private $relationships = []; |
|
64 | - |
|
65 | - /** |
|
66 | - * @var bool[] Key: pivot table name, value: whether a query was performed to load the data. |
|
67 | - */ |
|
68 | - private $loadedRelationships = []; |
|
69 | - |
|
70 | - /** |
|
71 | - * Used with $primaryKeys when we want to retrieve an existing object |
|
72 | - * and $primaryKeys=[] if we want a new object. |
|
73 | - * |
|
74 | - * @param string $tableName |
|
75 | - * @param array $primaryKeys |
|
76 | - * @param TDBMService $tdbmService |
|
77 | - * |
|
78 | - * @throws TDBMException |
|
79 | - * @throws TDBMInvalidOperationException |
|
80 | - */ |
|
81 | - public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) |
|
82 | - { |
|
83 | - // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation... |
|
84 | - if (!empty($tableName)) { |
|
85 | - $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
86 | - } |
|
87 | - |
|
88 | - if ($tdbmService === null) { |
|
89 | - $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED); |
|
90 | - } else { |
|
91 | - $this->_attach($tdbmService); |
|
92 | - if (!empty($primaryKeys)) { |
|
93 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
94 | - } else { |
|
95 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NEW); |
|
96 | - } |
|
97 | - } |
|
98 | - } |
|
99 | - |
|
100 | - /** |
|
101 | - * Alternative constructor called when data is fetched from database via a SELECT. |
|
102 | - * |
|
103 | - * @param array $beanData array<table, array<column, value>> |
|
104 | - * @param TDBMService $tdbmService |
|
105 | - */ |
|
106 | - public function _constructFromData(array $beanData, TDBMService $tdbmService) |
|
107 | - { |
|
108 | - $this->tdbmService = $tdbmService; |
|
109 | - |
|
110 | - foreach ($beanData as $table => $columns) { |
|
111 | - $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns); |
|
112 | - } |
|
113 | - |
|
114 | - $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * Alternative constructor called when bean is lazily loaded. |
|
119 | - * |
|
120 | - * @param string $tableName |
|
121 | - * @param array $primaryKeys |
|
122 | - * @param TDBMService $tdbmService |
|
123 | - */ |
|
124 | - public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService) |
|
125 | - { |
|
126 | - $this->tdbmService = $tdbmService; |
|
127 | - |
|
128 | - $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
129 | - |
|
130 | - $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
131 | - } |
|
132 | - |
|
133 | - public function _attach(TDBMService $tdbmService) |
|
134 | - { |
|
135 | - if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
136 | - throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
137 | - } |
|
138 | - $this->tdbmService = $tdbmService; |
|
139 | - |
|
140 | - // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level) |
|
141 | - $tableNames = array_keys($this->dbRows); |
|
142 | - $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames); |
|
143 | - $tableNames = array_reverse($tableNames); |
|
144 | - |
|
145 | - $newDbRows = []; |
|
146 | - |
|
147 | - foreach ($tableNames as $table) { |
|
148 | - if (!isset($this->dbRows[$table])) { |
|
149 | - $this->registerTable($table); |
|
150 | - } |
|
151 | - $newDbRows[$table] = $this->dbRows[$table]; |
|
152 | - } |
|
153 | - $this->dbRows = $newDbRows; |
|
154 | - |
|
155 | - $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
156 | - foreach ($this->dbRows as $dbRow) { |
|
157 | - $dbRow->_attach($tdbmService); |
|
158 | - } |
|
159 | - } |
|
160 | - |
|
161 | - /** |
|
162 | - * Sets the state of the TDBM Object |
|
163 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
164 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
165 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
166 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
167 | - * |
|
168 | - * @param string $state |
|
169 | - */ |
|
170 | - public function _setStatus($state) |
|
171 | - { |
|
172 | - $this->status = $state; |
|
173 | - |
|
174 | - // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself. |
|
175 | - foreach ($this->dbRows as $dbRow) { |
|
176 | - $dbRow->_setStatus($state); |
|
177 | - } |
|
178 | - } |
|
179 | - |
|
180 | - protected function get($var, $tableName = null) |
|
181 | - { |
|
182 | - if ($tableName === null) { |
|
183 | - if (count($this->dbRows) > 1) { |
|
184 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
185 | - } elseif (count($this->dbRows) === 1) { |
|
186 | - $tableName = array_keys($this->dbRows)[0]; |
|
187 | - } |
|
188 | - } |
|
189 | - |
|
190 | - if (!isset($this->dbRows[$tableName])) { |
|
191 | - if (count($this->dbRows[$tableName] === 0)) { |
|
192 | - throw new TDBMException('Object is not yet bound to any table.'); |
|
193 | - } else { |
|
194 | - throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
195 | - } |
|
196 | - } |
|
197 | - |
|
198 | - return $this->dbRows[$tableName]->get($var); |
|
199 | - } |
|
200 | - |
|
201 | - protected function set($var, $value, $tableName = null) |
|
202 | - { |
|
203 | - if ($tableName === null) { |
|
204 | - if (count($this->dbRows) > 1) { |
|
205 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
206 | - } elseif (count($this->dbRows) === 1) { |
|
207 | - $tableName = array_keys($this->dbRows)[0]; |
|
208 | - } else { |
|
209 | - throw new TDBMException('Please specify a table for this object.'); |
|
210 | - } |
|
211 | - } |
|
212 | - |
|
213 | - if (!isset($this->dbRows[$tableName])) { |
|
214 | - $this->registerTable($tableName); |
|
215 | - } |
|
216 | - |
|
217 | - $this->dbRows[$tableName]->set($var, $value); |
|
218 | - if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
219 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
220 | - } |
|
221 | - } |
|
222 | - |
|
223 | - /** |
|
224 | - * @param string $foreignKeyName |
|
225 | - * @param AbstractTDBMObject $bean |
|
226 | - */ |
|
227 | - protected function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null) |
|
228 | - { |
|
229 | - if ($tableName === null) { |
|
230 | - if (count($this->dbRows) > 1) { |
|
231 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
232 | - } elseif (count($this->dbRows) === 1) { |
|
233 | - $tableName = array_keys($this->dbRows)[0]; |
|
234 | - } else { |
|
235 | - throw new TDBMException('Please specify a table for this object.'); |
|
236 | - } |
|
237 | - } |
|
238 | - |
|
239 | - if (!isset($this->dbRows[$tableName])) { |
|
240 | - $this->registerTable($tableName); |
|
241 | - } |
|
242 | - |
|
243 | - $this->dbRows[$tableName]->setRef($foreignKeyName, $bean); |
|
244 | - if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
245 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
246 | - } |
|
247 | - } |
|
248 | - |
|
249 | - /** |
|
250 | - * @param string $foreignKeyName A unique name for this reference |
|
251 | - * |
|
252 | - * @return AbstractTDBMObject|null |
|
253 | - */ |
|
254 | - protected function getRef($foreignKeyName, $tableName = null) |
|
255 | - { |
|
256 | - if ($tableName === null) { |
|
257 | - if (count($this->dbRows) > 1) { |
|
258 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
259 | - } elseif (count($this->dbRows) === 1) { |
|
260 | - $tableName = array_keys($this->dbRows)[0]; |
|
261 | - } |
|
262 | - } |
|
263 | - |
|
264 | - if (!isset($this->dbRows[$tableName])) { |
|
265 | - if (count($this->dbRows[$tableName] === 0)) { |
|
266 | - throw new TDBMException('Object is not yet bound to any table.'); |
|
267 | - } else { |
|
268 | - throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
269 | - } |
|
270 | - } |
|
271 | - |
|
272 | - return $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
273 | - } |
|
274 | - |
|
275 | - /** |
|
276 | - * Adds a many to many relationship to this bean. |
|
277 | - * |
|
278 | - * @param string $pivotTableName |
|
279 | - * @param AbstractTDBMObject $remoteBean |
|
280 | - */ |
|
281 | - protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
282 | - { |
|
283 | - $this->setRelationship($pivotTableName, $remoteBean, 'new'); |
|
284 | - } |
|
285 | - |
|
286 | - /** |
|
287 | - * Returns true if there is a relationship to this bean. |
|
288 | - * |
|
289 | - * @param string $pivotTableName |
|
290 | - * @param AbstractTDBMObject $remoteBean |
|
291 | - * |
|
292 | - * @return bool |
|
293 | - */ |
|
294 | - protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
295 | - { |
|
296 | - $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
297 | - |
|
298 | - if ($storage->contains($remoteBean)) { |
|
299 | - if ($storage[$remoteBean]['status'] !== 'delete') { |
|
300 | - return true; |
|
301 | - } |
|
302 | - } |
|
303 | - |
|
304 | - return false; |
|
305 | - } |
|
306 | - |
|
307 | - /** |
|
308 | - * Internal TDBM method. Removes a many to many relationship from this bean. |
|
309 | - * |
|
310 | - * @param string $pivotTableName |
|
311 | - * @param AbstractTDBMObject $remoteBean |
|
312 | - */ |
|
313 | - public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
314 | - { |
|
315 | - if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') { |
|
316 | - unset($this->relationships[$pivotTableName][$remoteBean]); |
|
317 | - unset($remoteBean->relationships[$pivotTableName][$this]); |
|
318 | - } else { |
|
319 | - $this->setRelationship($pivotTableName, $remoteBean, 'delete'); |
|
320 | - } |
|
321 | - } |
|
322 | - |
|
323 | - /** |
|
324 | - * Returns the list of objects linked to this bean via $pivotTableName. |
|
325 | - * |
|
326 | - * @param $pivotTableName |
|
327 | - * |
|
328 | - * @return \SplObjectStorage |
|
329 | - */ |
|
330 | - private function retrieveRelationshipsStorage($pivotTableName) |
|
331 | - { |
|
332 | - $storage = $this->getRelationshipStorage($pivotTableName); |
|
333 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) { |
|
334 | - return $storage; |
|
335 | - } |
|
336 | - |
|
337 | - $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this); |
|
338 | - $this->loadedRelationships[$pivotTableName] = true; |
|
339 | - |
|
340 | - foreach ($beans as $bean) { |
|
341 | - if (isset($storage[$bean])) { |
|
342 | - $oldStatus = $storage[$bean]['status']; |
|
343 | - if ($oldStatus === 'delete') { |
|
344 | - // Keep deleted things deleted |
|
345 | - continue; |
|
346 | - } |
|
347 | - } |
|
348 | - $this->setRelationship($pivotTableName, $bean, 'loaded'); |
|
349 | - } |
|
350 | - |
|
351 | - return $storage; |
|
352 | - } |
|
353 | - |
|
354 | - /** |
|
355 | - * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName. |
|
356 | - * |
|
357 | - * @param $pivotTableName |
|
358 | - * |
|
359 | - * @return AbstractTDBMObject[] |
|
360 | - */ |
|
361 | - public function _getRelationships($pivotTableName) |
|
362 | - { |
|
363 | - return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName)); |
|
364 | - } |
|
365 | - |
|
366 | - private function relationshipStorageToArray(\SplObjectStorage $storage) |
|
367 | - { |
|
368 | - $beans = []; |
|
369 | - foreach ($storage as $bean) { |
|
370 | - $statusArr = $storage[$bean]; |
|
371 | - if ($statusArr['status'] !== 'delete') { |
|
372 | - $beans[] = $bean; |
|
373 | - } |
|
374 | - } |
|
375 | - |
|
376 | - return $beans; |
|
377 | - } |
|
378 | - |
|
379 | - /** |
|
380 | - * Declares a relationship between. |
|
381 | - * |
|
382 | - * @param string $pivotTableName |
|
383 | - * @param AbstractTDBMObject $remoteBean |
|
384 | - * @param string $status |
|
385 | - */ |
|
386 | - private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) |
|
387 | - { |
|
388 | - $storage = $this->getRelationshipStorage($pivotTableName); |
|
389 | - $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]); |
|
390 | - if ($this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
391 | - $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY); |
|
392 | - } |
|
393 | - |
|
394 | - $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName); |
|
395 | - $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]); |
|
396 | - } |
|
397 | - |
|
398 | - /** |
|
399 | - * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
400 | - * |
|
401 | - * @param $pivotTableName |
|
402 | - * |
|
403 | - * @return \SplObjectStorage |
|
404 | - */ |
|
405 | - private function getRelationshipStorage($pivotTableName) |
|
406 | - { |
|
407 | - if (isset($this->relationships[$pivotTableName])) { |
|
408 | - $storage = $this->relationships[$pivotTableName]; |
|
409 | - } else { |
|
410 | - $storage = new \SplObjectStorage(); |
|
411 | - $this->relationships[$pivotTableName] = $storage; |
|
412 | - } |
|
413 | - |
|
414 | - return $storage; |
|
415 | - } |
|
416 | - |
|
417 | - /** |
|
418 | - * Reverts any changes made to the object and resumes it to its DB state. |
|
419 | - * This can only be called on objects that come from database and that have not been deleted. |
|
420 | - * Otherwise, this will throw an exception. |
|
421 | - * |
|
422 | - * @throws TDBMException |
|
423 | - */ |
|
424 | - public function discardChanges() |
|
425 | - { |
|
426 | - if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
427 | - throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved."); |
|
428 | - } |
|
429 | - |
|
430 | - if ($this->status === TDBMObjectStateEnum::STATE_DELETED) { |
|
431 | - throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.'); |
|
432 | - } |
|
433 | - |
|
434 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
435 | - } |
|
436 | - |
|
437 | - /** |
|
438 | - * Method used internally by TDBM. You should not use it directly. |
|
439 | - * This method returns the status of the TDBMObject. |
|
440 | - * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
441 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
442 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
443 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
444 | - * |
|
445 | - * @return string |
|
446 | - */ |
|
447 | - public function _getStatus() |
|
448 | - { |
|
449 | - return $this->status; |
|
450 | - } |
|
451 | - |
|
452 | - /** |
|
453 | - * Override the native php clone function for TDBMObjects. |
|
454 | - */ |
|
455 | - public function __clone() |
|
456 | - { |
|
457 | - // Let's clone the many to many relationships |
|
458 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
459 | - $pivotTableList = array_keys($this->relationships); |
|
460 | - } else { |
|
461 | - $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this); |
|
462 | - } |
|
463 | - |
|
464 | - foreach ($pivotTableList as $pivotTable) { |
|
465 | - $storage = $this->retrieveRelationshipsStorage($pivotTable); |
|
466 | - |
|
467 | - // Let's duplicate the reverse side of the relationship |
|
468 | - foreach ($storage as $remoteBean) { |
|
469 | - $metadata = $storage[$remoteBean]; |
|
470 | - |
|
471 | - $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable); |
|
472 | - $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]); |
|
473 | - } |
|
474 | - } |
|
475 | - |
|
476 | - // Let's clone each row |
|
477 | - foreach ($this->dbRows as $key => $dbRow) { |
|
478 | - $this->dbRows[$key] = clone $dbRow; |
|
479 | - } |
|
480 | - |
|
481 | - // Let's set the status to new (to enter the save function) |
|
482 | - $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
483 | - } |
|
484 | - |
|
485 | - /** |
|
486 | - * Returns raw database rows. |
|
487 | - * |
|
488 | - * @return DbRow[] Key: table name, Value: DbRow object |
|
489 | - */ |
|
490 | - public function _getDbRows() |
|
491 | - { |
|
492 | - return $this->dbRows; |
|
493 | - } |
|
494 | - |
|
495 | - private function registerTable($tableName) |
|
496 | - { |
|
497 | - $dbRow = new DbRow($this, $tableName); |
|
498 | - |
|
499 | - if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) { |
|
500 | - // Let's get the primary key for the new table |
|
501 | - $anotherDbRow = array_values($this->dbRows)[0]; |
|
502 | - /* @var $anotherDbRow DbRow */ |
|
503 | - $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys()); |
|
504 | - $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys); |
|
505 | - $dbRow->_setPrimaryKeys($primaryKeys); |
|
506 | - } |
|
507 | - |
|
508 | - $dbRow->_setStatus($this->status); |
|
509 | - |
|
510 | - $this->dbRows[$tableName] = $dbRow; |
|
511 | - // TODO: look at status (if not new)=> get primary key from tdbmservice |
|
512 | - } |
|
513 | - |
|
514 | - /** |
|
515 | - * Internal function: return the list of relationships. |
|
516 | - * |
|
517 | - * @return \SplObjectStorage[] |
|
518 | - */ |
|
519 | - public function _getCachedRelationships() |
|
520 | - { |
|
521 | - return $this->relationships; |
|
522 | - } |
|
34 | + /** |
|
35 | + * The service this object is bound to. |
|
36 | + * |
|
37 | + * @var TDBMService |
|
38 | + */ |
|
39 | + protected $tdbmService; |
|
40 | + |
|
41 | + /** |
|
42 | + * An array of DbRow, indexed by table name. |
|
43 | + * |
|
44 | + * @var DbRow[] |
|
45 | + */ |
|
46 | + protected $dbRows = array(); |
|
47 | + |
|
48 | + /** |
|
49 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
50 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
51 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
52 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
53 | + * |
|
54 | + * @var string |
|
55 | + */ |
|
56 | + private $status; |
|
57 | + |
|
58 | + /** |
|
59 | + * Array storing beans related via many to many relationships (pivot tables). |
|
60 | + * |
|
61 | + * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage |
|
62 | + */ |
|
63 | + private $relationships = []; |
|
64 | + |
|
65 | + /** |
|
66 | + * @var bool[] Key: pivot table name, value: whether a query was performed to load the data. |
|
67 | + */ |
|
68 | + private $loadedRelationships = []; |
|
69 | + |
|
70 | + /** |
|
71 | + * Used with $primaryKeys when we want to retrieve an existing object |
|
72 | + * and $primaryKeys=[] if we want a new object. |
|
73 | + * |
|
74 | + * @param string $tableName |
|
75 | + * @param array $primaryKeys |
|
76 | + * @param TDBMService $tdbmService |
|
77 | + * |
|
78 | + * @throws TDBMException |
|
79 | + * @throws TDBMInvalidOperationException |
|
80 | + */ |
|
81 | + public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) |
|
82 | + { |
|
83 | + // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation... |
|
84 | + if (!empty($tableName)) { |
|
85 | + $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
86 | + } |
|
87 | + |
|
88 | + if ($tdbmService === null) { |
|
89 | + $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED); |
|
90 | + } else { |
|
91 | + $this->_attach($tdbmService); |
|
92 | + if (!empty($primaryKeys)) { |
|
93 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
94 | + } else { |
|
95 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NEW); |
|
96 | + } |
|
97 | + } |
|
98 | + } |
|
99 | + |
|
100 | + /** |
|
101 | + * Alternative constructor called when data is fetched from database via a SELECT. |
|
102 | + * |
|
103 | + * @param array $beanData array<table, array<column, value>> |
|
104 | + * @param TDBMService $tdbmService |
|
105 | + */ |
|
106 | + public function _constructFromData(array $beanData, TDBMService $tdbmService) |
|
107 | + { |
|
108 | + $this->tdbmService = $tdbmService; |
|
109 | + |
|
110 | + foreach ($beanData as $table => $columns) { |
|
111 | + $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns); |
|
112 | + } |
|
113 | + |
|
114 | + $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * Alternative constructor called when bean is lazily loaded. |
|
119 | + * |
|
120 | + * @param string $tableName |
|
121 | + * @param array $primaryKeys |
|
122 | + * @param TDBMService $tdbmService |
|
123 | + */ |
|
124 | + public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService) |
|
125 | + { |
|
126 | + $this->tdbmService = $tdbmService; |
|
127 | + |
|
128 | + $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
129 | + |
|
130 | + $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
131 | + } |
|
132 | + |
|
133 | + public function _attach(TDBMService $tdbmService) |
|
134 | + { |
|
135 | + if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
136 | + throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
137 | + } |
|
138 | + $this->tdbmService = $tdbmService; |
|
139 | + |
|
140 | + // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level) |
|
141 | + $tableNames = array_keys($this->dbRows); |
|
142 | + $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames); |
|
143 | + $tableNames = array_reverse($tableNames); |
|
144 | + |
|
145 | + $newDbRows = []; |
|
146 | + |
|
147 | + foreach ($tableNames as $table) { |
|
148 | + if (!isset($this->dbRows[$table])) { |
|
149 | + $this->registerTable($table); |
|
150 | + } |
|
151 | + $newDbRows[$table] = $this->dbRows[$table]; |
|
152 | + } |
|
153 | + $this->dbRows = $newDbRows; |
|
154 | + |
|
155 | + $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
156 | + foreach ($this->dbRows as $dbRow) { |
|
157 | + $dbRow->_attach($tdbmService); |
|
158 | + } |
|
159 | + } |
|
160 | + |
|
161 | + /** |
|
162 | + * Sets the state of the TDBM Object |
|
163 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
164 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
165 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
166 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
167 | + * |
|
168 | + * @param string $state |
|
169 | + */ |
|
170 | + public function _setStatus($state) |
|
171 | + { |
|
172 | + $this->status = $state; |
|
173 | + |
|
174 | + // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself. |
|
175 | + foreach ($this->dbRows as $dbRow) { |
|
176 | + $dbRow->_setStatus($state); |
|
177 | + } |
|
178 | + } |
|
179 | + |
|
180 | + protected function get($var, $tableName = null) |
|
181 | + { |
|
182 | + if ($tableName === null) { |
|
183 | + if (count($this->dbRows) > 1) { |
|
184 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
185 | + } elseif (count($this->dbRows) === 1) { |
|
186 | + $tableName = array_keys($this->dbRows)[0]; |
|
187 | + } |
|
188 | + } |
|
189 | + |
|
190 | + if (!isset($this->dbRows[$tableName])) { |
|
191 | + if (count($this->dbRows[$tableName] === 0)) { |
|
192 | + throw new TDBMException('Object is not yet bound to any table.'); |
|
193 | + } else { |
|
194 | + throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
195 | + } |
|
196 | + } |
|
197 | + |
|
198 | + return $this->dbRows[$tableName]->get($var); |
|
199 | + } |
|
200 | + |
|
201 | + protected function set($var, $value, $tableName = null) |
|
202 | + { |
|
203 | + if ($tableName === null) { |
|
204 | + if (count($this->dbRows) > 1) { |
|
205 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
206 | + } elseif (count($this->dbRows) === 1) { |
|
207 | + $tableName = array_keys($this->dbRows)[0]; |
|
208 | + } else { |
|
209 | + throw new TDBMException('Please specify a table for this object.'); |
|
210 | + } |
|
211 | + } |
|
212 | + |
|
213 | + if (!isset($this->dbRows[$tableName])) { |
|
214 | + $this->registerTable($tableName); |
|
215 | + } |
|
216 | + |
|
217 | + $this->dbRows[$tableName]->set($var, $value); |
|
218 | + if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
219 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
220 | + } |
|
221 | + } |
|
222 | + |
|
223 | + /** |
|
224 | + * @param string $foreignKeyName |
|
225 | + * @param AbstractTDBMObject $bean |
|
226 | + */ |
|
227 | + protected function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null) |
|
228 | + { |
|
229 | + if ($tableName === null) { |
|
230 | + if (count($this->dbRows) > 1) { |
|
231 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
232 | + } elseif (count($this->dbRows) === 1) { |
|
233 | + $tableName = array_keys($this->dbRows)[0]; |
|
234 | + } else { |
|
235 | + throw new TDBMException('Please specify a table for this object.'); |
|
236 | + } |
|
237 | + } |
|
238 | + |
|
239 | + if (!isset($this->dbRows[$tableName])) { |
|
240 | + $this->registerTable($tableName); |
|
241 | + } |
|
242 | + |
|
243 | + $this->dbRows[$tableName]->setRef($foreignKeyName, $bean); |
|
244 | + if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
245 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
246 | + } |
|
247 | + } |
|
248 | + |
|
249 | + /** |
|
250 | + * @param string $foreignKeyName A unique name for this reference |
|
251 | + * |
|
252 | + * @return AbstractTDBMObject|null |
|
253 | + */ |
|
254 | + protected function getRef($foreignKeyName, $tableName = null) |
|
255 | + { |
|
256 | + if ($tableName === null) { |
|
257 | + if (count($this->dbRows) > 1) { |
|
258 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
259 | + } elseif (count($this->dbRows) === 1) { |
|
260 | + $tableName = array_keys($this->dbRows)[0]; |
|
261 | + } |
|
262 | + } |
|
263 | + |
|
264 | + if (!isset($this->dbRows[$tableName])) { |
|
265 | + if (count($this->dbRows[$tableName] === 0)) { |
|
266 | + throw new TDBMException('Object is not yet bound to any table.'); |
|
267 | + } else { |
|
268 | + throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
269 | + } |
|
270 | + } |
|
271 | + |
|
272 | + return $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
273 | + } |
|
274 | + |
|
275 | + /** |
|
276 | + * Adds a many to many relationship to this bean. |
|
277 | + * |
|
278 | + * @param string $pivotTableName |
|
279 | + * @param AbstractTDBMObject $remoteBean |
|
280 | + */ |
|
281 | + protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
282 | + { |
|
283 | + $this->setRelationship($pivotTableName, $remoteBean, 'new'); |
|
284 | + } |
|
285 | + |
|
286 | + /** |
|
287 | + * Returns true if there is a relationship to this bean. |
|
288 | + * |
|
289 | + * @param string $pivotTableName |
|
290 | + * @param AbstractTDBMObject $remoteBean |
|
291 | + * |
|
292 | + * @return bool |
|
293 | + */ |
|
294 | + protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
295 | + { |
|
296 | + $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
297 | + |
|
298 | + if ($storage->contains($remoteBean)) { |
|
299 | + if ($storage[$remoteBean]['status'] !== 'delete') { |
|
300 | + return true; |
|
301 | + } |
|
302 | + } |
|
303 | + |
|
304 | + return false; |
|
305 | + } |
|
306 | + |
|
307 | + /** |
|
308 | + * Internal TDBM method. Removes a many to many relationship from this bean. |
|
309 | + * |
|
310 | + * @param string $pivotTableName |
|
311 | + * @param AbstractTDBMObject $remoteBean |
|
312 | + */ |
|
313 | + public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
314 | + { |
|
315 | + if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') { |
|
316 | + unset($this->relationships[$pivotTableName][$remoteBean]); |
|
317 | + unset($remoteBean->relationships[$pivotTableName][$this]); |
|
318 | + } else { |
|
319 | + $this->setRelationship($pivotTableName, $remoteBean, 'delete'); |
|
320 | + } |
|
321 | + } |
|
322 | + |
|
323 | + /** |
|
324 | + * Returns the list of objects linked to this bean via $pivotTableName. |
|
325 | + * |
|
326 | + * @param $pivotTableName |
|
327 | + * |
|
328 | + * @return \SplObjectStorage |
|
329 | + */ |
|
330 | + private function retrieveRelationshipsStorage($pivotTableName) |
|
331 | + { |
|
332 | + $storage = $this->getRelationshipStorage($pivotTableName); |
|
333 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) { |
|
334 | + return $storage; |
|
335 | + } |
|
336 | + |
|
337 | + $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this); |
|
338 | + $this->loadedRelationships[$pivotTableName] = true; |
|
339 | + |
|
340 | + foreach ($beans as $bean) { |
|
341 | + if (isset($storage[$bean])) { |
|
342 | + $oldStatus = $storage[$bean]['status']; |
|
343 | + if ($oldStatus === 'delete') { |
|
344 | + // Keep deleted things deleted |
|
345 | + continue; |
|
346 | + } |
|
347 | + } |
|
348 | + $this->setRelationship($pivotTableName, $bean, 'loaded'); |
|
349 | + } |
|
350 | + |
|
351 | + return $storage; |
|
352 | + } |
|
353 | + |
|
354 | + /** |
|
355 | + * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName. |
|
356 | + * |
|
357 | + * @param $pivotTableName |
|
358 | + * |
|
359 | + * @return AbstractTDBMObject[] |
|
360 | + */ |
|
361 | + public function _getRelationships($pivotTableName) |
|
362 | + { |
|
363 | + return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName)); |
|
364 | + } |
|
365 | + |
|
366 | + private function relationshipStorageToArray(\SplObjectStorage $storage) |
|
367 | + { |
|
368 | + $beans = []; |
|
369 | + foreach ($storage as $bean) { |
|
370 | + $statusArr = $storage[$bean]; |
|
371 | + if ($statusArr['status'] !== 'delete') { |
|
372 | + $beans[] = $bean; |
|
373 | + } |
|
374 | + } |
|
375 | + |
|
376 | + return $beans; |
|
377 | + } |
|
378 | + |
|
379 | + /** |
|
380 | + * Declares a relationship between. |
|
381 | + * |
|
382 | + * @param string $pivotTableName |
|
383 | + * @param AbstractTDBMObject $remoteBean |
|
384 | + * @param string $status |
|
385 | + */ |
|
386 | + private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) |
|
387 | + { |
|
388 | + $storage = $this->getRelationshipStorage($pivotTableName); |
|
389 | + $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]); |
|
390 | + if ($this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
391 | + $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY); |
|
392 | + } |
|
393 | + |
|
394 | + $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName); |
|
395 | + $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]); |
|
396 | + } |
|
397 | + |
|
398 | + /** |
|
399 | + * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
400 | + * |
|
401 | + * @param $pivotTableName |
|
402 | + * |
|
403 | + * @return \SplObjectStorage |
|
404 | + */ |
|
405 | + private function getRelationshipStorage($pivotTableName) |
|
406 | + { |
|
407 | + if (isset($this->relationships[$pivotTableName])) { |
|
408 | + $storage = $this->relationships[$pivotTableName]; |
|
409 | + } else { |
|
410 | + $storage = new \SplObjectStorage(); |
|
411 | + $this->relationships[$pivotTableName] = $storage; |
|
412 | + } |
|
413 | + |
|
414 | + return $storage; |
|
415 | + } |
|
416 | + |
|
417 | + /** |
|
418 | + * Reverts any changes made to the object and resumes it to its DB state. |
|
419 | + * This can only be called on objects that come from database and that have not been deleted. |
|
420 | + * Otherwise, this will throw an exception. |
|
421 | + * |
|
422 | + * @throws TDBMException |
|
423 | + */ |
|
424 | + public function discardChanges() |
|
425 | + { |
|
426 | + if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
427 | + throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved."); |
|
428 | + } |
|
429 | + |
|
430 | + if ($this->status === TDBMObjectStateEnum::STATE_DELETED) { |
|
431 | + throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.'); |
|
432 | + } |
|
433 | + |
|
434 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
435 | + } |
|
436 | + |
|
437 | + /** |
|
438 | + * Method used internally by TDBM. You should not use it directly. |
|
439 | + * This method returns the status of the TDBMObject. |
|
440 | + * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
441 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
442 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
443 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
444 | + * |
|
445 | + * @return string |
|
446 | + */ |
|
447 | + public function _getStatus() |
|
448 | + { |
|
449 | + return $this->status; |
|
450 | + } |
|
451 | + |
|
452 | + /** |
|
453 | + * Override the native php clone function for TDBMObjects. |
|
454 | + */ |
|
455 | + public function __clone() |
|
456 | + { |
|
457 | + // Let's clone the many to many relationships |
|
458 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
459 | + $pivotTableList = array_keys($this->relationships); |
|
460 | + } else { |
|
461 | + $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this); |
|
462 | + } |
|
463 | + |
|
464 | + foreach ($pivotTableList as $pivotTable) { |
|
465 | + $storage = $this->retrieveRelationshipsStorage($pivotTable); |
|
466 | + |
|
467 | + // Let's duplicate the reverse side of the relationship |
|
468 | + foreach ($storage as $remoteBean) { |
|
469 | + $metadata = $storage[$remoteBean]; |
|
470 | + |
|
471 | + $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable); |
|
472 | + $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]); |
|
473 | + } |
|
474 | + } |
|
475 | + |
|
476 | + // Let's clone each row |
|
477 | + foreach ($this->dbRows as $key => $dbRow) { |
|
478 | + $this->dbRows[$key] = clone $dbRow; |
|
479 | + } |
|
480 | + |
|
481 | + // Let's set the status to new (to enter the save function) |
|
482 | + $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
483 | + } |
|
484 | + |
|
485 | + /** |
|
486 | + * Returns raw database rows. |
|
487 | + * |
|
488 | + * @return DbRow[] Key: table name, Value: DbRow object |
|
489 | + */ |
|
490 | + public function _getDbRows() |
|
491 | + { |
|
492 | + return $this->dbRows; |
|
493 | + } |
|
494 | + |
|
495 | + private function registerTable($tableName) |
|
496 | + { |
|
497 | + $dbRow = new DbRow($this, $tableName); |
|
498 | + |
|
499 | + if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) { |
|
500 | + // Let's get the primary key for the new table |
|
501 | + $anotherDbRow = array_values($this->dbRows)[0]; |
|
502 | + /* @var $anotherDbRow DbRow */ |
|
503 | + $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys()); |
|
504 | + $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys); |
|
505 | + $dbRow->_setPrimaryKeys($primaryKeys); |
|
506 | + } |
|
507 | + |
|
508 | + $dbRow->_setStatus($this->status); |
|
509 | + |
|
510 | + $this->dbRows[$tableName] = $dbRow; |
|
511 | + // TODO: look at status (if not new)=> get primary key from tdbmservice |
|
512 | + } |
|
513 | + |
|
514 | + /** |
|
515 | + * Internal function: return the list of relationships. |
|
516 | + * |
|
517 | + * @return \SplObjectStorage[] |
|
518 | + */ |
|
519 | + public function _getCachedRelationships() |
|
520 | + { |
|
521 | + return $this->relationships; |
|
522 | + } |
|
523 | 523 | } |
@@ -17,196 +17,196 @@ discard block |
||
17 | 17 | */ |
18 | 18 | class TDBMDaoGenerator |
19 | 19 | { |
20 | - /** |
|
21 | - * @var SchemaAnalyzer |
|
22 | - */ |
|
23 | - private $schemaAnalyzer; |
|
24 | - |
|
25 | - /** |
|
26 | - * @var Schema |
|
27 | - */ |
|
28 | - private $schema; |
|
29 | - |
|
30 | - /** |
|
31 | - * The root directory of the project. |
|
32 | - * |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - private $rootPath; |
|
36 | - |
|
37 | - /** |
|
38 | - * @var TDBMSchemaAnalyzer |
|
39 | - */ |
|
40 | - private $tdbmSchemaAnalyzer; |
|
41 | - |
|
42 | - /** |
|
43 | - * Constructor. |
|
44 | - * |
|
45 | - * @param SchemaAnalyzer $schemaAnalyzer |
|
46 | - * @param Schema $schema |
|
47 | - * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer |
|
48 | - */ |
|
49 | - public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
50 | - { |
|
51 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
52 | - $this->schema = $schema; |
|
53 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
54 | - $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
55 | - } |
|
56 | - |
|
57 | - /** |
|
58 | - * Generates all the daos and beans. |
|
59 | - * |
|
60 | - * @param string $daoFactoryClassName The classe name of the DAO factory |
|
61 | - * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
62 | - * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
63 | - * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone. |
|
64 | - * |
|
65 | - * @return \string[] the list of tables |
|
66 | - * |
|
67 | - * @throws TDBMException |
|
68 | - */ |
|
69 | - public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
70 | - { |
|
71 | - // TODO: extract ClassNameMapper in its own package! |
|
72 | - $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.'composer.json'); |
|
73 | - |
|
74 | - // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
75 | - |
|
76 | - $tableList = $this->schema->getTables(); |
|
77 | - |
|
78 | - // Remove all beans and daos from junction tables |
|
79 | - $junctionTables = $this->schemaAnalyzer->detectJunctionTables(); |
|
80 | - $junctionTableNames = array_map(function (Table $table) { |
|
81 | - return $table->getName(); |
|
82 | - }, $junctionTables); |
|
83 | - |
|
84 | - $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
85 | - return !in_array($table->getName(), $junctionTableNames); |
|
86 | - }); |
|
87 | - |
|
88 | - foreach ($tableList as $table) { |
|
89 | - $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
90 | - } |
|
91 | - |
|
92 | - $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
93 | - |
|
94 | - // Ok, let's return the list of all tables. |
|
95 | - // These will be used by the calling script to create Mouf instances. |
|
96 | - |
|
97 | - return array_map(function (Table $table) { return $table->getName(); }, $tableList); |
|
98 | - } |
|
99 | - |
|
100 | - /** |
|
101 | - * Generates in one method call the daos and the beans for one table. |
|
102 | - * |
|
103 | - * @param Table $table |
|
104 | - * @param string $daonamespace |
|
105 | - * @param string $beannamespace |
|
106 | - * @param ClassNameMapper $classNameMapper |
|
107 | - * @param bool $storeInUtc |
|
108 | - * |
|
109 | - * @throws TDBMException |
|
110 | - */ |
|
111 | - public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
112 | - { |
|
113 | - $tableName = $table->getName(); |
|
114 | - $daoName = $this->getDaoNameFromTableName($tableName); |
|
115 | - $beanName = $this->getBeanNameFromTableName($tableName); |
|
116 | - $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
117 | - $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
118 | - |
|
119 | - $this->generateBean($beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
120 | - $this->generateDao($daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Returns the name of the bean class from the table name. |
|
125 | - * |
|
126 | - * @param $tableName |
|
127 | - * |
|
128 | - * @return string |
|
129 | - */ |
|
130 | - public static function getBeanNameFromTableName($tableName) |
|
131 | - { |
|
132 | - return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
133 | - } |
|
134 | - |
|
135 | - /** |
|
136 | - * Returns the name of the DAO class from the table name. |
|
137 | - * |
|
138 | - * @param $tableName |
|
139 | - * |
|
140 | - * @return string |
|
141 | - */ |
|
142 | - public static function getDaoNameFromTableName($tableName) |
|
143 | - { |
|
144 | - return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
145 | - } |
|
146 | - |
|
147 | - /** |
|
148 | - * Returns the name of the base bean class from the table name. |
|
149 | - * |
|
150 | - * @param $tableName |
|
151 | - * |
|
152 | - * @return string |
|
153 | - */ |
|
154 | - public static function getBaseBeanNameFromTableName($tableName) |
|
155 | - { |
|
156 | - return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
157 | - } |
|
158 | - |
|
159 | - /** |
|
160 | - * Returns the name of the base DAO class from the table name. |
|
161 | - * |
|
162 | - * @param $tableName |
|
163 | - * |
|
164 | - * @return string |
|
165 | - */ |
|
166 | - public static function getBaseDaoNameFromTableName($tableName) |
|
167 | - { |
|
168 | - return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
169 | - } |
|
170 | - |
|
171 | - /** |
|
172 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
173 | - * |
|
174 | - * @param string $className The name of the class |
|
175 | - * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
176 | - * @param Table $table The table |
|
177 | - * @param string $beannamespace The namespace of the bean |
|
178 | - * @param ClassNameMapper $classNameMapper |
|
179 | - * |
|
180 | - * @throws TDBMException |
|
181 | - */ |
|
182 | - public function generateBean($className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
183 | - { |
|
184 | - $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
185 | - |
|
186 | - $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
187 | - |
|
188 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$baseClassName); |
|
189 | - if (empty($possibleBaseFileNames)) { |
|
190 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
191 | - } |
|
192 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
193 | - |
|
194 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
195 | - file_put_contents($possibleBaseFileName, $str); |
|
196 | - @chmod($possibleBaseFileName, 0664); |
|
197 | - |
|
198 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
199 | - if (empty($possibleFileNames)) { |
|
200 | - // @codeCoverageIgnoreStart |
|
201 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
202 | - // @codeCoverageIgnoreEnd |
|
203 | - } |
|
204 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
205 | - |
|
206 | - if (!file_exists($possibleFileName)) { |
|
207 | - $tableName = $table->getName(); |
|
208 | - |
|
209 | - $str = "<?php |
|
20 | + /** |
|
21 | + * @var SchemaAnalyzer |
|
22 | + */ |
|
23 | + private $schemaAnalyzer; |
|
24 | + |
|
25 | + /** |
|
26 | + * @var Schema |
|
27 | + */ |
|
28 | + private $schema; |
|
29 | + |
|
30 | + /** |
|
31 | + * The root directory of the project. |
|
32 | + * |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + private $rootPath; |
|
36 | + |
|
37 | + /** |
|
38 | + * @var TDBMSchemaAnalyzer |
|
39 | + */ |
|
40 | + private $tdbmSchemaAnalyzer; |
|
41 | + |
|
42 | + /** |
|
43 | + * Constructor. |
|
44 | + * |
|
45 | + * @param SchemaAnalyzer $schemaAnalyzer |
|
46 | + * @param Schema $schema |
|
47 | + * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer |
|
48 | + */ |
|
49 | + public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
50 | + { |
|
51 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
52 | + $this->schema = $schema; |
|
53 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
54 | + $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
55 | + } |
|
56 | + |
|
57 | + /** |
|
58 | + * Generates all the daos and beans. |
|
59 | + * |
|
60 | + * @param string $daoFactoryClassName The classe name of the DAO factory |
|
61 | + * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
62 | + * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
63 | + * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone. |
|
64 | + * |
|
65 | + * @return \string[] the list of tables |
|
66 | + * |
|
67 | + * @throws TDBMException |
|
68 | + */ |
|
69 | + public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
70 | + { |
|
71 | + // TODO: extract ClassNameMapper in its own package! |
|
72 | + $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.'composer.json'); |
|
73 | + |
|
74 | + // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
75 | + |
|
76 | + $tableList = $this->schema->getTables(); |
|
77 | + |
|
78 | + // Remove all beans and daos from junction tables |
|
79 | + $junctionTables = $this->schemaAnalyzer->detectJunctionTables(); |
|
80 | + $junctionTableNames = array_map(function (Table $table) { |
|
81 | + return $table->getName(); |
|
82 | + }, $junctionTables); |
|
83 | + |
|
84 | + $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
85 | + return !in_array($table->getName(), $junctionTableNames); |
|
86 | + }); |
|
87 | + |
|
88 | + foreach ($tableList as $table) { |
|
89 | + $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
90 | + } |
|
91 | + |
|
92 | + $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
93 | + |
|
94 | + // Ok, let's return the list of all tables. |
|
95 | + // These will be used by the calling script to create Mouf instances. |
|
96 | + |
|
97 | + return array_map(function (Table $table) { return $table->getName(); }, $tableList); |
|
98 | + } |
|
99 | + |
|
100 | + /** |
|
101 | + * Generates in one method call the daos and the beans for one table. |
|
102 | + * |
|
103 | + * @param Table $table |
|
104 | + * @param string $daonamespace |
|
105 | + * @param string $beannamespace |
|
106 | + * @param ClassNameMapper $classNameMapper |
|
107 | + * @param bool $storeInUtc |
|
108 | + * |
|
109 | + * @throws TDBMException |
|
110 | + */ |
|
111 | + public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
112 | + { |
|
113 | + $tableName = $table->getName(); |
|
114 | + $daoName = $this->getDaoNameFromTableName($tableName); |
|
115 | + $beanName = $this->getBeanNameFromTableName($tableName); |
|
116 | + $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
117 | + $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
118 | + |
|
119 | + $this->generateBean($beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
120 | + $this->generateDao($daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Returns the name of the bean class from the table name. |
|
125 | + * |
|
126 | + * @param $tableName |
|
127 | + * |
|
128 | + * @return string |
|
129 | + */ |
|
130 | + public static function getBeanNameFromTableName($tableName) |
|
131 | + { |
|
132 | + return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
133 | + } |
|
134 | + |
|
135 | + /** |
|
136 | + * Returns the name of the DAO class from the table name. |
|
137 | + * |
|
138 | + * @param $tableName |
|
139 | + * |
|
140 | + * @return string |
|
141 | + */ |
|
142 | + public static function getDaoNameFromTableName($tableName) |
|
143 | + { |
|
144 | + return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
145 | + } |
|
146 | + |
|
147 | + /** |
|
148 | + * Returns the name of the base bean class from the table name. |
|
149 | + * |
|
150 | + * @param $tableName |
|
151 | + * |
|
152 | + * @return string |
|
153 | + */ |
|
154 | + public static function getBaseBeanNameFromTableName($tableName) |
|
155 | + { |
|
156 | + return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
157 | + } |
|
158 | + |
|
159 | + /** |
|
160 | + * Returns the name of the base DAO class from the table name. |
|
161 | + * |
|
162 | + * @param $tableName |
|
163 | + * |
|
164 | + * @return string |
|
165 | + */ |
|
166 | + public static function getBaseDaoNameFromTableName($tableName) |
|
167 | + { |
|
168 | + return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
169 | + } |
|
170 | + |
|
171 | + /** |
|
172 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
173 | + * |
|
174 | + * @param string $className The name of the class |
|
175 | + * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
176 | + * @param Table $table The table |
|
177 | + * @param string $beannamespace The namespace of the bean |
|
178 | + * @param ClassNameMapper $classNameMapper |
|
179 | + * |
|
180 | + * @throws TDBMException |
|
181 | + */ |
|
182 | + public function generateBean($className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
183 | + { |
|
184 | + $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
185 | + |
|
186 | + $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
187 | + |
|
188 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$baseClassName); |
|
189 | + if (empty($possibleBaseFileNames)) { |
|
190 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
191 | + } |
|
192 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
193 | + |
|
194 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
195 | + file_put_contents($possibleBaseFileName, $str); |
|
196 | + @chmod($possibleBaseFileName, 0664); |
|
197 | + |
|
198 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
199 | + if (empty($possibleFileNames)) { |
|
200 | + // @codeCoverageIgnoreStart |
|
201 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
202 | + // @codeCoverageIgnoreEnd |
|
203 | + } |
|
204 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
205 | + |
|
206 | + if (!file_exists($possibleFileName)) { |
|
207 | + $tableName = $table->getName(); |
|
208 | + |
|
209 | + $str = "<?php |
|
210 | 210 | /* |
211 | 211 | * This file has been automatically generated by TDBM. |
212 | 212 | * You can edit this file as it will not be overwritten. |
@@ -221,66 +221,66 @@ discard block |
||
221 | 221 | { |
222 | 222 | |
223 | 223 | }"; |
224 | - $this->ensureDirectoryExist($possibleFileName); |
|
225 | - file_put_contents($possibleFileName, $str); |
|
226 | - @chmod($possibleFileName, 0664); |
|
227 | - } |
|
228 | - } |
|
229 | - |
|
230 | - /** |
|
231 | - * Tries to find a @defaultSort annotation in one of the columns. |
|
232 | - * |
|
233 | - * @param Table $table |
|
234 | - * |
|
235 | - * @return array First item: column name, Second item: column order (asc/desc) |
|
236 | - */ |
|
237 | - private function getDefaultSortColumnFromAnnotation(Table $table) |
|
238 | - { |
|
239 | - $defaultSort = null; |
|
240 | - $defaultSortDirection = null; |
|
241 | - foreach ($table->getColumns() as $column) { |
|
242 | - $comments = $column->getComment(); |
|
243 | - $matches = array(); |
|
244 | - if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
245 | - $defaultSort = $column->getName(); |
|
246 | - if (count($matches) === 3) { |
|
247 | - $defaultSortDirection = $matches[2]; |
|
248 | - } else { |
|
249 | - $defaultSortDirection = 'ASC'; |
|
250 | - } |
|
251 | - } |
|
252 | - } |
|
253 | - |
|
254 | - return [$defaultSort, $defaultSortDirection]; |
|
255 | - } |
|
256 | - |
|
257 | - /** |
|
258 | - * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
259 | - * |
|
260 | - * @param string $className The name of the class |
|
261 | - * @param string $baseClassName |
|
262 | - * @param string $beanClassName |
|
263 | - * @param Table $table |
|
264 | - * @param string $daonamespace |
|
265 | - * @param string $beannamespace |
|
266 | - * @param ClassNameMapper $classNameMapper |
|
267 | - * |
|
268 | - * @throws TDBMException |
|
269 | - */ |
|
270 | - public function generateDao($className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
271 | - { |
|
272 | - $tableName = $table->getName(); |
|
273 | - $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
274 | - |
|
275 | - list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table); |
|
276 | - |
|
277 | - // FIXME: lowercase tables with _ in the name should work! |
|
278 | - $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
279 | - |
|
280 | - $beanClassWithoutNameSpace = $beanClassName; |
|
281 | - $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
282 | - |
|
283 | - $str = "<?php |
|
224 | + $this->ensureDirectoryExist($possibleFileName); |
|
225 | + file_put_contents($possibleFileName, $str); |
|
226 | + @chmod($possibleFileName, 0664); |
|
227 | + } |
|
228 | + } |
|
229 | + |
|
230 | + /** |
|
231 | + * Tries to find a @defaultSort annotation in one of the columns. |
|
232 | + * |
|
233 | + * @param Table $table |
|
234 | + * |
|
235 | + * @return array First item: column name, Second item: column order (asc/desc) |
|
236 | + */ |
|
237 | + private function getDefaultSortColumnFromAnnotation(Table $table) |
|
238 | + { |
|
239 | + $defaultSort = null; |
|
240 | + $defaultSortDirection = null; |
|
241 | + foreach ($table->getColumns() as $column) { |
|
242 | + $comments = $column->getComment(); |
|
243 | + $matches = array(); |
|
244 | + if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
245 | + $defaultSort = $column->getName(); |
|
246 | + if (count($matches) === 3) { |
|
247 | + $defaultSortDirection = $matches[2]; |
|
248 | + } else { |
|
249 | + $defaultSortDirection = 'ASC'; |
|
250 | + } |
|
251 | + } |
|
252 | + } |
|
253 | + |
|
254 | + return [$defaultSort, $defaultSortDirection]; |
|
255 | + } |
|
256 | + |
|
257 | + /** |
|
258 | + * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
259 | + * |
|
260 | + * @param string $className The name of the class |
|
261 | + * @param string $baseClassName |
|
262 | + * @param string $beanClassName |
|
263 | + * @param Table $table |
|
264 | + * @param string $daonamespace |
|
265 | + * @param string $beannamespace |
|
266 | + * @param ClassNameMapper $classNameMapper |
|
267 | + * |
|
268 | + * @throws TDBMException |
|
269 | + */ |
|
270 | + public function generateDao($className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
271 | + { |
|
272 | + $tableName = $table->getName(); |
|
273 | + $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
274 | + |
|
275 | + list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table); |
|
276 | + |
|
277 | + // FIXME: lowercase tables with _ in the name should work! |
|
278 | + $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
279 | + |
|
280 | + $beanClassWithoutNameSpace = $beanClassName; |
|
281 | + $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
282 | + |
|
283 | + $str = "<?php |
|
284 | 284 | |
285 | 285 | /* |
286 | 286 | * This file has been automatically generated by TDBM. |
@@ -357,9 +357,9 @@ discard block |
||
357 | 357 | } |
358 | 358 | "; |
359 | 359 | |
360 | - if (count($primaryKeyColumns) === 1) { |
|
361 | - $primaryKeyColumn = $primaryKeyColumns[0]; |
|
362 | - $str .= " |
|
360 | + if (count($primaryKeyColumns) === 1) { |
|
361 | + $primaryKeyColumn = $primaryKeyColumns[0]; |
|
362 | + $str .= " |
|
363 | 363 | /** |
364 | 364 | * Get $beanClassWithoutNameSpace specified by its ID (its primary key) |
365 | 365 | * If the primary key does not exist, an exception is thrown. |
@@ -374,8 +374,8 @@ discard block |
||
374 | 374 | return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading); |
375 | 375 | } |
376 | 376 | "; |
377 | - } |
|
378 | - $str .= " |
|
377 | + } |
|
378 | + $str .= " |
|
379 | 379 | /** |
380 | 380 | * Deletes the $beanClassWithoutNameSpace passed in parameter. |
381 | 381 | * |
@@ -433,33 +433,33 @@ discard block |
||
433 | 433 | } |
434 | 434 | "; |
435 | 435 | |
436 | - $str .= ' |
|
436 | + $str .= ' |
|
437 | 437 | } |
438 | 438 | '; |
439 | 439 | |
440 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$baseClassName); |
|
441 | - if (empty($possibleBaseFileNames)) { |
|
442 | - // @codeCoverageIgnoreStart |
|
443 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
444 | - // @codeCoverageIgnoreEnd |
|
445 | - } |
|
446 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
447 | - |
|
448 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
449 | - file_put_contents($possibleBaseFileName, $str); |
|
450 | - @chmod($possibleBaseFileName, 0664); |
|
451 | - |
|
452 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
453 | - if (empty($possibleFileNames)) { |
|
454 | - // @codeCoverageIgnoreStart |
|
455 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
456 | - // @codeCoverageIgnoreEnd |
|
457 | - } |
|
458 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
459 | - |
|
460 | - // Now, let's generate the "editable" class |
|
461 | - if (!file_exists($possibleFileName)) { |
|
462 | - $str = "<?php |
|
440 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$baseClassName); |
|
441 | + if (empty($possibleBaseFileNames)) { |
|
442 | + // @codeCoverageIgnoreStart |
|
443 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
444 | + // @codeCoverageIgnoreEnd |
|
445 | + } |
|
446 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
447 | + |
|
448 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
449 | + file_put_contents($possibleBaseFileName, $str); |
|
450 | + @chmod($possibleBaseFileName, 0664); |
|
451 | + |
|
452 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
453 | + if (empty($possibleFileNames)) { |
|
454 | + // @codeCoverageIgnoreStart |
|
455 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
456 | + // @codeCoverageIgnoreEnd |
|
457 | + } |
|
458 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
459 | + |
|
460 | + // Now, let's generate the "editable" class |
|
461 | + if (!file_exists($possibleFileName)) { |
|
462 | + $str = "<?php |
|
463 | 463 | |
464 | 464 | /* |
465 | 465 | * This file has been automatically generated by TDBM. |
@@ -476,22 +476,22 @@ discard block |
||
476 | 476 | |
477 | 477 | } |
478 | 478 | "; |
479 | - $this->ensureDirectoryExist($possibleFileName); |
|
480 | - file_put_contents($possibleFileName, $str); |
|
481 | - @chmod($possibleFileName, 0664); |
|
482 | - } |
|
483 | - } |
|
484 | - |
|
485 | - /** |
|
486 | - * Generates the factory bean. |
|
487 | - * |
|
488 | - * @param Table[] $tableList |
|
489 | - */ |
|
490 | - private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
491 | - { |
|
492 | - // For each table, let's write a property. |
|
493 | - |
|
494 | - $str = "<?php |
|
479 | + $this->ensureDirectoryExist($possibleFileName); |
|
480 | + file_put_contents($possibleFileName, $str); |
|
481 | + @chmod($possibleFileName, 0664); |
|
482 | + } |
|
483 | + } |
|
484 | + |
|
485 | + /** |
|
486 | + * Generates the factory bean. |
|
487 | + * |
|
488 | + * @param Table[] $tableList |
|
489 | + */ |
|
490 | + private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
491 | + { |
|
492 | + // For each table, let's write a property. |
|
493 | + |
|
494 | + $str = "<?php |
|
495 | 495 | |
496 | 496 | /* |
497 | 497 | * This file has been automatically generated by TDBM. |
@@ -508,12 +508,12 @@ discard block |
||
508 | 508 | { |
509 | 509 | "; |
510 | 510 | |
511 | - foreach ($tableList as $table) { |
|
512 | - $tableName = $table->getName(); |
|
513 | - $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
514 | - $daoInstanceName = self::toVariableName($daoClassName); |
|
511 | + foreach ($tableList as $table) { |
|
512 | + $tableName = $table->getName(); |
|
513 | + $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
514 | + $daoInstanceName = self::toVariableName($daoClassName); |
|
515 | 515 | |
516 | - $str .= ' /** |
|
516 | + $str .= ' /** |
|
517 | 517 | * @var '.$daoClassName.' |
518 | 518 | */ |
519 | 519 | private $'.$daoInstanceName.'; |
@@ -538,155 +538,155 @@ discard block |
||
538 | 538 | } |
539 | 539 | |
540 | 540 | '; |
541 | - } |
|
541 | + } |
|
542 | 542 | |
543 | - $str .= ' |
|
543 | + $str .= ' |
|
544 | 544 | } |
545 | 545 | '; |
546 | 546 | |
547 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\'.$daoFactoryClassName); |
|
548 | - if (empty($possibleFileNames)) { |
|
549 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
550 | - } |
|
551 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
552 | - |
|
553 | - $this->ensureDirectoryExist($possibleFileName); |
|
554 | - file_put_contents($possibleFileName, $str); |
|
555 | - @chmod($possibleFileName, 0664); |
|
556 | - } |
|
557 | - |
|
558 | - /** |
|
559 | - * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
560 | - * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
561 | - * |
|
562 | - * @param $str string |
|
563 | - * |
|
564 | - * @return string |
|
565 | - */ |
|
566 | - public static function toCamelCase($str) |
|
567 | - { |
|
568 | - $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
569 | - while (true) { |
|
570 | - if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
571 | - break; |
|
572 | - } |
|
573 | - |
|
574 | - $pos = strpos($str, '_'); |
|
575 | - if ($pos === false) { |
|
576 | - $pos = strpos($str, ' '); |
|
577 | - } |
|
578 | - $before = substr($str, 0, $pos); |
|
579 | - $after = substr($str, $pos + 1); |
|
580 | - $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
581 | - } |
|
582 | - |
|
583 | - return $str; |
|
584 | - } |
|
585 | - |
|
586 | - /** |
|
587 | - * Tries to put string to the singular form (if it is plural). |
|
588 | - * We assume the table names are in english. |
|
589 | - * |
|
590 | - * @param $str string |
|
591 | - * |
|
592 | - * @return string |
|
593 | - */ |
|
594 | - public static function toSingular($str) |
|
595 | - { |
|
596 | - return Inflector::singularize($str); |
|
597 | - } |
|
598 | - |
|
599 | - /** |
|
600 | - * Put the first letter of the string in lower case. |
|
601 | - * Very useful to transform a class name into a variable name. |
|
602 | - * |
|
603 | - * @param $str string |
|
604 | - * |
|
605 | - * @return string |
|
606 | - */ |
|
607 | - public static function toVariableName($str) |
|
608 | - { |
|
609 | - return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
610 | - } |
|
611 | - |
|
612 | - /** |
|
613 | - * Ensures the file passed in parameter can be written in its directory. |
|
614 | - * |
|
615 | - * @param string $fileName |
|
616 | - * |
|
617 | - * @throws TDBMException |
|
618 | - */ |
|
619 | - private function ensureDirectoryExist($fileName) |
|
620 | - { |
|
621 | - $dirName = dirname($fileName); |
|
622 | - if (!file_exists($dirName)) { |
|
623 | - $old = umask(0); |
|
624 | - $result = mkdir($dirName, 0775, true); |
|
625 | - umask($old); |
|
626 | - if ($result === false) { |
|
627 | - throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
628 | - } |
|
629 | - } |
|
630 | - } |
|
631 | - |
|
632 | - /** |
|
633 | - * @param string $rootPath |
|
634 | - */ |
|
635 | - public function setRootPath($rootPath) |
|
636 | - { |
|
637 | - $this->rootPath = $rootPath; |
|
638 | - } |
|
639 | - |
|
640 | - /** |
|
641 | - * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
642 | - * |
|
643 | - * @param Type $type The DBAL type |
|
644 | - * |
|
645 | - * @return string The PHP type |
|
646 | - */ |
|
647 | - public static function dbalTypeToPhpType(Type $type) |
|
648 | - { |
|
649 | - $map = [ |
|
650 | - Type::TARRAY => 'array', |
|
651 | - Type::SIMPLE_ARRAY => 'array', |
|
652 | - Type::JSON_ARRAY => 'array', |
|
653 | - Type::BIGINT => 'string', |
|
654 | - Type::BOOLEAN => 'bool', |
|
655 | - Type::DATETIME => '\DateTimeInterface', |
|
656 | - Type::DATETIMETZ => '\DateTimeInterface', |
|
657 | - Type::DATE => '\DateTimeInterface', |
|
658 | - Type::TIME => '\DateTimeInterface', |
|
659 | - Type::DECIMAL => 'float', |
|
660 | - Type::INTEGER => 'int', |
|
661 | - Type::OBJECT => 'string', |
|
662 | - Type::SMALLINT => 'int', |
|
663 | - Type::STRING => 'string', |
|
664 | - Type::TEXT => 'string', |
|
665 | - Type::BINARY => 'string', |
|
666 | - Type::BLOB => 'string', |
|
667 | - Type::FLOAT => 'float', |
|
668 | - Type::GUID => 'string', |
|
669 | - ]; |
|
670 | - |
|
671 | - return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
672 | - } |
|
673 | - |
|
674 | - /** |
|
675 | - * @param string $beanNamespace |
|
676 | - * |
|
677 | - * @return \string[] Returns a map mapping table name to beans name |
|
678 | - */ |
|
679 | - public function buildTableToBeanMap($beanNamespace) |
|
680 | - { |
|
681 | - $tableToBeanMap = []; |
|
682 | - |
|
683 | - $tables = $this->schema->getTables(); |
|
684 | - |
|
685 | - foreach ($tables as $table) { |
|
686 | - $tableName = $table->getName(); |
|
687 | - $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
688 | - } |
|
689 | - |
|
690 | - return $tableToBeanMap; |
|
691 | - } |
|
547 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\'.$daoFactoryClassName); |
|
548 | + if (empty($possibleFileNames)) { |
|
549 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
550 | + } |
|
551 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
552 | + |
|
553 | + $this->ensureDirectoryExist($possibleFileName); |
|
554 | + file_put_contents($possibleFileName, $str); |
|
555 | + @chmod($possibleFileName, 0664); |
|
556 | + } |
|
557 | + |
|
558 | + /** |
|
559 | + * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
560 | + * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
561 | + * |
|
562 | + * @param $str string |
|
563 | + * |
|
564 | + * @return string |
|
565 | + */ |
|
566 | + public static function toCamelCase($str) |
|
567 | + { |
|
568 | + $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
569 | + while (true) { |
|
570 | + if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
571 | + break; |
|
572 | + } |
|
573 | + |
|
574 | + $pos = strpos($str, '_'); |
|
575 | + if ($pos === false) { |
|
576 | + $pos = strpos($str, ' '); |
|
577 | + } |
|
578 | + $before = substr($str, 0, $pos); |
|
579 | + $after = substr($str, $pos + 1); |
|
580 | + $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
581 | + } |
|
582 | + |
|
583 | + return $str; |
|
584 | + } |
|
585 | + |
|
586 | + /** |
|
587 | + * Tries to put string to the singular form (if it is plural). |
|
588 | + * We assume the table names are in english. |
|
589 | + * |
|
590 | + * @param $str string |
|
591 | + * |
|
592 | + * @return string |
|
593 | + */ |
|
594 | + public static function toSingular($str) |
|
595 | + { |
|
596 | + return Inflector::singularize($str); |
|
597 | + } |
|
598 | + |
|
599 | + /** |
|
600 | + * Put the first letter of the string in lower case. |
|
601 | + * Very useful to transform a class name into a variable name. |
|
602 | + * |
|
603 | + * @param $str string |
|
604 | + * |
|
605 | + * @return string |
|
606 | + */ |
|
607 | + public static function toVariableName($str) |
|
608 | + { |
|
609 | + return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
610 | + } |
|
611 | + |
|
612 | + /** |
|
613 | + * Ensures the file passed in parameter can be written in its directory. |
|
614 | + * |
|
615 | + * @param string $fileName |
|
616 | + * |
|
617 | + * @throws TDBMException |
|
618 | + */ |
|
619 | + private function ensureDirectoryExist($fileName) |
|
620 | + { |
|
621 | + $dirName = dirname($fileName); |
|
622 | + if (!file_exists($dirName)) { |
|
623 | + $old = umask(0); |
|
624 | + $result = mkdir($dirName, 0775, true); |
|
625 | + umask($old); |
|
626 | + if ($result === false) { |
|
627 | + throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
628 | + } |
|
629 | + } |
|
630 | + } |
|
631 | + |
|
632 | + /** |
|
633 | + * @param string $rootPath |
|
634 | + */ |
|
635 | + public function setRootPath($rootPath) |
|
636 | + { |
|
637 | + $this->rootPath = $rootPath; |
|
638 | + } |
|
639 | + |
|
640 | + /** |
|
641 | + * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
642 | + * |
|
643 | + * @param Type $type The DBAL type |
|
644 | + * |
|
645 | + * @return string The PHP type |
|
646 | + */ |
|
647 | + public static function dbalTypeToPhpType(Type $type) |
|
648 | + { |
|
649 | + $map = [ |
|
650 | + Type::TARRAY => 'array', |
|
651 | + Type::SIMPLE_ARRAY => 'array', |
|
652 | + Type::JSON_ARRAY => 'array', |
|
653 | + Type::BIGINT => 'string', |
|
654 | + Type::BOOLEAN => 'bool', |
|
655 | + Type::DATETIME => '\DateTimeInterface', |
|
656 | + Type::DATETIMETZ => '\DateTimeInterface', |
|
657 | + Type::DATE => '\DateTimeInterface', |
|
658 | + Type::TIME => '\DateTimeInterface', |
|
659 | + Type::DECIMAL => 'float', |
|
660 | + Type::INTEGER => 'int', |
|
661 | + Type::OBJECT => 'string', |
|
662 | + Type::SMALLINT => 'int', |
|
663 | + Type::STRING => 'string', |
|
664 | + Type::TEXT => 'string', |
|
665 | + Type::BINARY => 'string', |
|
666 | + Type::BLOB => 'string', |
|
667 | + Type::FLOAT => 'float', |
|
668 | + Type::GUID => 'string', |
|
669 | + ]; |
|
670 | + |
|
671 | + return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
672 | + } |
|
673 | + |
|
674 | + /** |
|
675 | + * @param string $beanNamespace |
|
676 | + * |
|
677 | + * @return \string[] Returns a map mapping table name to beans name |
|
678 | + */ |
|
679 | + public function buildTableToBeanMap($beanNamespace) |
|
680 | + { |
|
681 | + $tableToBeanMap = []; |
|
682 | + |
|
683 | + $tables = $this->schema->getTables(); |
|
684 | + |
|
685 | + foreach ($tables as $table) { |
|
686 | + $tableName = $table->getName(); |
|
687 | + $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
688 | + } |
|
689 | + |
|
690 | + return $tableToBeanMap; |
|
691 | + } |
|
692 | 692 | } |
@@ -15,213 +15,213 @@ discard block |
||
15 | 15 | */ |
16 | 16 | class BeanDescriptor |
17 | 17 | { |
18 | - /** |
|
19 | - * @var Table |
|
20 | - */ |
|
21 | - private $table; |
|
22 | - |
|
23 | - /** |
|
24 | - * @var SchemaAnalyzer |
|
25 | - */ |
|
26 | - private $schemaAnalyzer; |
|
27 | - |
|
28 | - /** |
|
29 | - * @var Schema |
|
30 | - */ |
|
31 | - private $schema; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var AbstractBeanPropertyDescriptor[] |
|
35 | - */ |
|
36 | - private $beanPropertyDescriptors = []; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var TDBMSchemaAnalyzer |
|
40 | - */ |
|
41 | - private $tdbmSchemaAnalyzer; |
|
42 | - |
|
43 | - public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
44 | - { |
|
45 | - $this->table = $table; |
|
46 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
47 | - $this->schema = $schema; |
|
48 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
49 | - $this->initBeanPropertyDescriptors(); |
|
50 | - } |
|
51 | - |
|
52 | - private function initBeanPropertyDescriptors() |
|
53 | - { |
|
54 | - $this->beanPropertyDescriptors = $this->getProperties($this->table); |
|
55 | - } |
|
56 | - |
|
57 | - /** |
|
58 | - * Returns the foreignkey the column is part of, if any. null otherwise. |
|
59 | - * |
|
60 | - * @param Table $table |
|
61 | - * @param Column $column |
|
62 | - * |
|
63 | - * @return ForeignKeyConstraint|null |
|
64 | - */ |
|
65 | - private function isPartOfForeignKey(Table $table, Column $column) |
|
66 | - { |
|
67 | - $localColumnName = $column->getName(); |
|
68 | - foreach ($table->getForeignKeys() as $foreignKey) { |
|
69 | - foreach ($foreignKey->getColumns() as $columnName) { |
|
70 | - if ($columnName === $localColumnName) { |
|
71 | - return $foreignKey; |
|
72 | - } |
|
73 | - } |
|
74 | - } |
|
75 | - |
|
76 | - return; |
|
77 | - } |
|
78 | - |
|
79 | - /** |
|
80 | - * @return AbstractBeanPropertyDescriptor[] |
|
81 | - */ |
|
82 | - public function getBeanPropertyDescriptors() |
|
83 | - { |
|
84 | - return $this->beanPropertyDescriptors; |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent. |
|
89 | - * |
|
90 | - * @return AbstractBeanPropertyDescriptor[] |
|
91 | - */ |
|
92 | - public function getConstructorProperties() |
|
93 | - { |
|
94 | - $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
95 | - return $property->isCompulsory(); |
|
96 | - }); |
|
97 | - |
|
98 | - return $constructorProperties; |
|
99 | - } |
|
100 | - |
|
101 | - /** |
|
102 | - * Returns the list of properties exposed as getters and setters in this class. |
|
103 | - * |
|
104 | - * @return AbstractBeanPropertyDescriptor[] |
|
105 | - */ |
|
106 | - public function getExposedProperties() |
|
107 | - { |
|
108 | - $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
109 | - return $property->getTable()->getName() == $this->table->getName(); |
|
110 | - }); |
|
111 | - |
|
112 | - return $exposedProperties; |
|
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Returns the list of properties for this table (including parent tables). |
|
117 | - * |
|
118 | - * @param Table $table |
|
119 | - * |
|
120 | - * @return AbstractBeanPropertyDescriptor[] |
|
121 | - */ |
|
122 | - private function getProperties(Table $table) |
|
123 | - { |
|
124 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
125 | - if ($parentRelationship) { |
|
126 | - $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName()); |
|
127 | - $properties = $this->getProperties($parentTable); |
|
128 | - // we merge properties by overriding property names. |
|
129 | - $localProperties = $this->getPropertiesForTable($table); |
|
130 | - foreach ($localProperties as $name => $property) { |
|
131 | - // We do not override properties if this is a primary key! |
|
132 | - if ($property->isPrimaryKey()) { |
|
133 | - continue; |
|
134 | - } |
|
135 | - $properties[$name] = $property; |
|
136 | - } |
|
137 | - } else { |
|
138 | - $properties = $this->getPropertiesForTable($table); |
|
139 | - } |
|
140 | - |
|
141 | - return $properties; |
|
142 | - } |
|
143 | - |
|
144 | - /** |
|
145 | - * Returns the list of properties for this table (ignoring parent tables). |
|
146 | - * |
|
147 | - * @param Table $table |
|
148 | - * |
|
149 | - * @return AbstractBeanPropertyDescriptor[] |
|
150 | - */ |
|
151 | - private function getPropertiesForTable(Table $table) |
|
152 | - { |
|
153 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
154 | - if ($parentRelationship) { |
|
155 | - $ignoreColumns = $parentRelationship->getLocalColumns(); |
|
156 | - } else { |
|
157 | - $ignoreColumns = []; |
|
158 | - } |
|
159 | - |
|
160 | - $beanPropertyDescriptors = []; |
|
161 | - |
|
162 | - foreach ($table->getColumns() as $column) { |
|
163 | - if (array_search($column->getName(), $ignoreColumns) !== false) { |
|
164 | - continue; |
|
165 | - } |
|
166 | - |
|
167 | - $fk = $this->isPartOfForeignKey($table, $column); |
|
168 | - if ($fk !== null) { |
|
169 | - // Check that previously added descriptors are not added on same FK (can happen with multi key FK). |
|
170 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
171 | - if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) { |
|
172 | - continue 2; |
|
173 | - } |
|
174 | - } |
|
175 | - // Check that this property is not an inheritance relationship |
|
176 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
177 | - if ($parentRelationship === $fk) { |
|
178 | - continue; |
|
179 | - } |
|
180 | - |
|
181 | - $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer); |
|
182 | - } else { |
|
183 | - $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column); |
|
184 | - } |
|
185 | - } |
|
186 | - |
|
187 | - // Now, let's get the name of all properties and let's check there is no duplicate. |
|
188 | - /** @var $names AbstractBeanPropertyDescriptor[] */ |
|
189 | - $names = []; |
|
190 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
191 | - $name = $beanDescriptor->getUpperCamelCaseName(); |
|
192 | - if (isset($names[$name])) { |
|
193 | - $names[$name]->useAlternativeName(); |
|
194 | - $beanDescriptor->useAlternativeName(); |
|
195 | - } else { |
|
196 | - $names[$name] = $beanDescriptor; |
|
197 | - } |
|
198 | - } |
|
199 | - |
|
200 | - // Final check (throw exceptions if problem arises) |
|
201 | - $names = []; |
|
202 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
203 | - $name = $beanDescriptor->getUpperCamelCaseName(); |
|
204 | - if (isset($names[$name])) { |
|
205 | - throw new TDBMException('Unsolvable name conflict while generating method name'); |
|
206 | - } else { |
|
207 | - $names[$name] = $beanDescriptor; |
|
208 | - } |
|
209 | - } |
|
210 | - |
|
211 | - // Last step, let's rebuild the list with a map: |
|
212 | - $beanPropertyDescriptorsMap = []; |
|
213 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
214 | - $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor; |
|
215 | - } |
|
216 | - |
|
217 | - return $beanPropertyDescriptorsMap; |
|
218 | - } |
|
219 | - |
|
220 | - public function generateBeanConstructor() |
|
221 | - { |
|
222 | - $constructorProperties = $this->getConstructorProperties(); |
|
223 | - |
|
224 | - $constructorCode = ' /** |
|
18 | + /** |
|
19 | + * @var Table |
|
20 | + */ |
|
21 | + private $table; |
|
22 | + |
|
23 | + /** |
|
24 | + * @var SchemaAnalyzer |
|
25 | + */ |
|
26 | + private $schemaAnalyzer; |
|
27 | + |
|
28 | + /** |
|
29 | + * @var Schema |
|
30 | + */ |
|
31 | + private $schema; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var AbstractBeanPropertyDescriptor[] |
|
35 | + */ |
|
36 | + private $beanPropertyDescriptors = []; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var TDBMSchemaAnalyzer |
|
40 | + */ |
|
41 | + private $tdbmSchemaAnalyzer; |
|
42 | + |
|
43 | + public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
44 | + { |
|
45 | + $this->table = $table; |
|
46 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
47 | + $this->schema = $schema; |
|
48 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
49 | + $this->initBeanPropertyDescriptors(); |
|
50 | + } |
|
51 | + |
|
52 | + private function initBeanPropertyDescriptors() |
|
53 | + { |
|
54 | + $this->beanPropertyDescriptors = $this->getProperties($this->table); |
|
55 | + } |
|
56 | + |
|
57 | + /** |
|
58 | + * Returns the foreignkey the column is part of, if any. null otherwise. |
|
59 | + * |
|
60 | + * @param Table $table |
|
61 | + * @param Column $column |
|
62 | + * |
|
63 | + * @return ForeignKeyConstraint|null |
|
64 | + */ |
|
65 | + private function isPartOfForeignKey(Table $table, Column $column) |
|
66 | + { |
|
67 | + $localColumnName = $column->getName(); |
|
68 | + foreach ($table->getForeignKeys() as $foreignKey) { |
|
69 | + foreach ($foreignKey->getColumns() as $columnName) { |
|
70 | + if ($columnName === $localColumnName) { |
|
71 | + return $foreignKey; |
|
72 | + } |
|
73 | + } |
|
74 | + } |
|
75 | + |
|
76 | + return; |
|
77 | + } |
|
78 | + |
|
79 | + /** |
|
80 | + * @return AbstractBeanPropertyDescriptor[] |
|
81 | + */ |
|
82 | + public function getBeanPropertyDescriptors() |
|
83 | + { |
|
84 | + return $this->beanPropertyDescriptors; |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent. |
|
89 | + * |
|
90 | + * @return AbstractBeanPropertyDescriptor[] |
|
91 | + */ |
|
92 | + public function getConstructorProperties() |
|
93 | + { |
|
94 | + $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
95 | + return $property->isCompulsory(); |
|
96 | + }); |
|
97 | + |
|
98 | + return $constructorProperties; |
|
99 | + } |
|
100 | + |
|
101 | + /** |
|
102 | + * Returns the list of properties exposed as getters and setters in this class. |
|
103 | + * |
|
104 | + * @return AbstractBeanPropertyDescriptor[] |
|
105 | + */ |
|
106 | + public function getExposedProperties() |
|
107 | + { |
|
108 | + $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
109 | + return $property->getTable()->getName() == $this->table->getName(); |
|
110 | + }); |
|
111 | + |
|
112 | + return $exposedProperties; |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Returns the list of properties for this table (including parent tables). |
|
117 | + * |
|
118 | + * @param Table $table |
|
119 | + * |
|
120 | + * @return AbstractBeanPropertyDescriptor[] |
|
121 | + */ |
|
122 | + private function getProperties(Table $table) |
|
123 | + { |
|
124 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
125 | + if ($parentRelationship) { |
|
126 | + $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName()); |
|
127 | + $properties = $this->getProperties($parentTable); |
|
128 | + // we merge properties by overriding property names. |
|
129 | + $localProperties = $this->getPropertiesForTable($table); |
|
130 | + foreach ($localProperties as $name => $property) { |
|
131 | + // We do not override properties if this is a primary key! |
|
132 | + if ($property->isPrimaryKey()) { |
|
133 | + continue; |
|
134 | + } |
|
135 | + $properties[$name] = $property; |
|
136 | + } |
|
137 | + } else { |
|
138 | + $properties = $this->getPropertiesForTable($table); |
|
139 | + } |
|
140 | + |
|
141 | + return $properties; |
|
142 | + } |
|
143 | + |
|
144 | + /** |
|
145 | + * Returns the list of properties for this table (ignoring parent tables). |
|
146 | + * |
|
147 | + * @param Table $table |
|
148 | + * |
|
149 | + * @return AbstractBeanPropertyDescriptor[] |
|
150 | + */ |
|
151 | + private function getPropertiesForTable(Table $table) |
|
152 | + { |
|
153 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
154 | + if ($parentRelationship) { |
|
155 | + $ignoreColumns = $parentRelationship->getLocalColumns(); |
|
156 | + } else { |
|
157 | + $ignoreColumns = []; |
|
158 | + } |
|
159 | + |
|
160 | + $beanPropertyDescriptors = []; |
|
161 | + |
|
162 | + foreach ($table->getColumns() as $column) { |
|
163 | + if (array_search($column->getName(), $ignoreColumns) !== false) { |
|
164 | + continue; |
|
165 | + } |
|
166 | + |
|
167 | + $fk = $this->isPartOfForeignKey($table, $column); |
|
168 | + if ($fk !== null) { |
|
169 | + // Check that previously added descriptors are not added on same FK (can happen with multi key FK). |
|
170 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
171 | + if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) { |
|
172 | + continue 2; |
|
173 | + } |
|
174 | + } |
|
175 | + // Check that this property is not an inheritance relationship |
|
176 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
177 | + if ($parentRelationship === $fk) { |
|
178 | + continue; |
|
179 | + } |
|
180 | + |
|
181 | + $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer); |
|
182 | + } else { |
|
183 | + $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column); |
|
184 | + } |
|
185 | + } |
|
186 | + |
|
187 | + // Now, let's get the name of all properties and let's check there is no duplicate. |
|
188 | + /** @var $names AbstractBeanPropertyDescriptor[] */ |
|
189 | + $names = []; |
|
190 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
191 | + $name = $beanDescriptor->getUpperCamelCaseName(); |
|
192 | + if (isset($names[$name])) { |
|
193 | + $names[$name]->useAlternativeName(); |
|
194 | + $beanDescriptor->useAlternativeName(); |
|
195 | + } else { |
|
196 | + $names[$name] = $beanDescriptor; |
|
197 | + } |
|
198 | + } |
|
199 | + |
|
200 | + // Final check (throw exceptions if problem arises) |
|
201 | + $names = []; |
|
202 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
203 | + $name = $beanDescriptor->getUpperCamelCaseName(); |
|
204 | + if (isset($names[$name])) { |
|
205 | + throw new TDBMException('Unsolvable name conflict while generating method name'); |
|
206 | + } else { |
|
207 | + $names[$name] = $beanDescriptor; |
|
208 | + } |
|
209 | + } |
|
210 | + |
|
211 | + // Last step, let's rebuild the list with a map: |
|
212 | + $beanPropertyDescriptorsMap = []; |
|
213 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
214 | + $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor; |
|
215 | + } |
|
216 | + |
|
217 | + return $beanPropertyDescriptorsMap; |
|
218 | + } |
|
219 | + |
|
220 | + public function generateBeanConstructor() |
|
221 | + { |
|
222 | + $constructorProperties = $this->getConstructorProperties(); |
|
223 | + |
|
224 | + $constructorCode = ' /** |
|
225 | 225 | * The constructor takes all compulsory arguments. |
226 | 226 | * |
227 | 227 | %s |
@@ -231,65 +231,65 @@ discard block |
||
231 | 231 | } |
232 | 232 | '; |
233 | 233 | |
234 | - $paramAnnotations = []; |
|
235 | - $arguments = []; |
|
236 | - $assigns = []; |
|
237 | - $parentConstructorArguments = []; |
|
238 | - |
|
239 | - foreach ($constructorProperties as $property) { |
|
240 | - $className = $property->getClassName(); |
|
241 | - if ($className) { |
|
242 | - $arguments[] = $className.' '.$property->getVariableName(); |
|
243 | - } else { |
|
244 | - $arguments[] = $property->getVariableName(); |
|
245 | - } |
|
246 | - $paramAnnotations[] = $property->getParamAnnotation(); |
|
247 | - if ($property->getTable()->getName() === $this->table->getName()) { |
|
248 | - $assigns[] = $property->getConstructorAssignCode(); |
|
249 | - } else { |
|
250 | - $parentConstructorArguments[] = $property->getVariableName(); |
|
251 | - } |
|
252 | - } |
|
253 | - |
|
254 | - $parentConstrutorCode = sprintf(" parent::__construct(%s);\n", implode(', ', $parentConstructorArguments)); |
|
255 | - |
|
256 | - return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstrutorCode, implode("\n", $assigns)); |
|
257 | - } |
|
258 | - |
|
259 | - public function generateDirectForeignKeysCode() |
|
260 | - { |
|
261 | - $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
262 | - |
|
263 | - $fksByTable = []; |
|
264 | - |
|
265 | - foreach ($fks as $fk) { |
|
266 | - $fksByTable[$fk->getLocalTableName()][] = $fk; |
|
267 | - } |
|
268 | - |
|
269 | - /* @var $fksByMethodName ForeignKeyConstraint[] */ |
|
270 | - $fksByMethodName = []; |
|
271 | - |
|
272 | - foreach ($fksByTable as $tableName => $fksForTable) { |
|
273 | - if (count($fksForTable) > 1) { |
|
274 | - foreach ($fksForTable as $fk) { |
|
275 | - $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By'; |
|
276 | - |
|
277 | - $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns()); |
|
278 | - |
|
279 | - $methodName .= implode('And', $camelizedColumns); |
|
280 | - |
|
281 | - $fksByMethodName[$methodName] = $fk; |
|
282 | - } |
|
283 | - } else { |
|
284 | - $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName()); |
|
285 | - $fksByMethodName[$methodName] = $fksForTable[0]; |
|
286 | - } |
|
287 | - } |
|
288 | - |
|
289 | - $code = ''; |
|
290 | - |
|
291 | - foreach ($fksByMethodName as $methodName => $fk) { |
|
292 | - $getterCode = ' /** |
|
234 | + $paramAnnotations = []; |
|
235 | + $arguments = []; |
|
236 | + $assigns = []; |
|
237 | + $parentConstructorArguments = []; |
|
238 | + |
|
239 | + foreach ($constructorProperties as $property) { |
|
240 | + $className = $property->getClassName(); |
|
241 | + if ($className) { |
|
242 | + $arguments[] = $className.' '.$property->getVariableName(); |
|
243 | + } else { |
|
244 | + $arguments[] = $property->getVariableName(); |
|
245 | + } |
|
246 | + $paramAnnotations[] = $property->getParamAnnotation(); |
|
247 | + if ($property->getTable()->getName() === $this->table->getName()) { |
|
248 | + $assigns[] = $property->getConstructorAssignCode(); |
|
249 | + } else { |
|
250 | + $parentConstructorArguments[] = $property->getVariableName(); |
|
251 | + } |
|
252 | + } |
|
253 | + |
|
254 | + $parentConstrutorCode = sprintf(" parent::__construct(%s);\n", implode(', ', $parentConstructorArguments)); |
|
255 | + |
|
256 | + return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstrutorCode, implode("\n", $assigns)); |
|
257 | + } |
|
258 | + |
|
259 | + public function generateDirectForeignKeysCode() |
|
260 | + { |
|
261 | + $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
262 | + |
|
263 | + $fksByTable = []; |
|
264 | + |
|
265 | + foreach ($fks as $fk) { |
|
266 | + $fksByTable[$fk->getLocalTableName()][] = $fk; |
|
267 | + } |
|
268 | + |
|
269 | + /* @var $fksByMethodName ForeignKeyConstraint[] */ |
|
270 | + $fksByMethodName = []; |
|
271 | + |
|
272 | + foreach ($fksByTable as $tableName => $fksForTable) { |
|
273 | + if (count($fksForTable) > 1) { |
|
274 | + foreach ($fksForTable as $fk) { |
|
275 | + $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By'; |
|
276 | + |
|
277 | + $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns()); |
|
278 | + |
|
279 | + $methodName .= implode('And', $camelizedColumns); |
|
280 | + |
|
281 | + $fksByMethodName[$methodName] = $fk; |
|
282 | + } |
|
283 | + } else { |
|
284 | + $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName()); |
|
285 | + $fksByMethodName[$methodName] = $fksForTable[0]; |
|
286 | + } |
|
287 | + } |
|
288 | + |
|
289 | + $code = ''; |
|
290 | + |
|
291 | + foreach ($fksByMethodName as $methodName => $fk) { |
|
292 | + $getterCode = ' /** |
|
293 | 293 | * Returns the list of %s pointing to this bean via the %s column. |
294 | 294 | * |
295 | 295 | * @return %s[]|ResultIterator |
@@ -301,111 +301,111 @@ discard block |
||
301 | 301 | |
302 | 302 | '; |
303 | 303 | |
304 | - list($sql, $parametersCode) = $this->getFilters($fk); |
|
305 | - |
|
306 | - $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
307 | - $code .= sprintf($getterCode, |
|
308 | - $beanClass, |
|
309 | - implode(', ', $fk->getColumns()), |
|
310 | - $beanClass, |
|
311 | - $methodName, |
|
312 | - var_export($fk->getLocalTableName(), true), |
|
313 | - $sql, |
|
314 | - $parametersCode |
|
315 | - ); |
|
316 | - } |
|
317 | - |
|
318 | - return $code; |
|
319 | - } |
|
320 | - |
|
321 | - private function getFilters(ForeignKeyConstraint $fk) |
|
322 | - { |
|
323 | - $sqlParts = []; |
|
324 | - $counter = 0; |
|
325 | - $parameters = []; |
|
326 | - |
|
327 | - $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
328 | - |
|
329 | - foreach ($fk->getLocalColumns() as $columnName) { |
|
330 | - $paramName = 'tdbmparam'.$counter; |
|
331 | - $sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName; |
|
332 | - |
|
333 | - $pkColumn = $pkColumns[$counter]; |
|
334 | - $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true)); |
|
335 | - ++$counter; |
|
336 | - } |
|
337 | - $sql = "'".implode(' AND ', $sqlParts)."'"; |
|
338 | - $parametersCode = '[ '.implode(', ', $parameters).' ]'; |
|
339 | - |
|
340 | - return [$sql, $parametersCode]; |
|
341 | - } |
|
342 | - |
|
343 | - /** |
|
344 | - * Generate code section about pivot tables. |
|
345 | - * |
|
346 | - * @return string |
|
347 | - */ |
|
348 | - public function generatePivotTableCode() |
|
349 | - { |
|
350 | - $finalDescs = $this->getPivotTableDescriptors(); |
|
351 | - |
|
352 | - $code = ''; |
|
353 | - |
|
354 | - foreach ($finalDescs as $desc) { |
|
355 | - $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']); |
|
356 | - } |
|
357 | - |
|
358 | - return $code; |
|
359 | - } |
|
360 | - |
|
361 | - private function getPivotTableDescriptors() |
|
362 | - { |
|
363 | - $descs = []; |
|
364 | - foreach ($this->schemaAnalyzer->detectJunctionTables() as $table) { |
|
365 | - // There are exactly 2 FKs since this is a pivot table. |
|
366 | - $fks = array_values($table->getForeignKeys()); |
|
367 | - |
|
368 | - if ($fks[0]->getForeignTableName() === $this->table->getName()) { |
|
369 | - $localFK = $fks[0]; |
|
370 | - $remoteFK = $fks[1]; |
|
371 | - } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) { |
|
372 | - $localFK = $fks[1]; |
|
373 | - $remoteFK = $fks[0]; |
|
374 | - } else { |
|
375 | - continue; |
|
376 | - } |
|
377 | - |
|
378 | - $descs[$remoteFK->getForeignTableName()][] = [ |
|
379 | - 'table' => $table, |
|
380 | - 'localFK' => $localFK, |
|
381 | - 'remoteFK' => $remoteFK, |
|
382 | - ]; |
|
383 | - } |
|
384 | - |
|
385 | - $finalDescs = []; |
|
386 | - foreach ($descs as $descArray) { |
|
387 | - if (count($descArray) > 1) { |
|
388 | - foreach ($descArray as $desc) { |
|
389 | - $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName()); |
|
390 | - $finalDescs[] = $desc; |
|
391 | - } |
|
392 | - } else { |
|
393 | - $desc = $descArray[0]; |
|
394 | - $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()); |
|
395 | - $finalDescs[] = $desc; |
|
396 | - } |
|
397 | - } |
|
398 | - |
|
399 | - return $finalDescs; |
|
400 | - } |
|
401 | - |
|
402 | - public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK) |
|
403 | - { |
|
404 | - $singularName = TDBMDaoGenerator::toSingular($name); |
|
405 | - $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
406 | - $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
407 | - |
|
408 | - $str = ' /** |
|
304 | + list($sql, $parametersCode) = $this->getFilters($fk); |
|
305 | + |
|
306 | + $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
307 | + $code .= sprintf($getterCode, |
|
308 | + $beanClass, |
|
309 | + implode(', ', $fk->getColumns()), |
|
310 | + $beanClass, |
|
311 | + $methodName, |
|
312 | + var_export($fk->getLocalTableName(), true), |
|
313 | + $sql, |
|
314 | + $parametersCode |
|
315 | + ); |
|
316 | + } |
|
317 | + |
|
318 | + return $code; |
|
319 | + } |
|
320 | + |
|
321 | + private function getFilters(ForeignKeyConstraint $fk) |
|
322 | + { |
|
323 | + $sqlParts = []; |
|
324 | + $counter = 0; |
|
325 | + $parameters = []; |
|
326 | + |
|
327 | + $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
328 | + |
|
329 | + foreach ($fk->getLocalColumns() as $columnName) { |
|
330 | + $paramName = 'tdbmparam'.$counter; |
|
331 | + $sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName; |
|
332 | + |
|
333 | + $pkColumn = $pkColumns[$counter]; |
|
334 | + $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true)); |
|
335 | + ++$counter; |
|
336 | + } |
|
337 | + $sql = "'".implode(' AND ', $sqlParts)."'"; |
|
338 | + $parametersCode = '[ '.implode(', ', $parameters).' ]'; |
|
339 | + |
|
340 | + return [$sql, $parametersCode]; |
|
341 | + } |
|
342 | + |
|
343 | + /** |
|
344 | + * Generate code section about pivot tables. |
|
345 | + * |
|
346 | + * @return string |
|
347 | + */ |
|
348 | + public function generatePivotTableCode() |
|
349 | + { |
|
350 | + $finalDescs = $this->getPivotTableDescriptors(); |
|
351 | + |
|
352 | + $code = ''; |
|
353 | + |
|
354 | + foreach ($finalDescs as $desc) { |
|
355 | + $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']); |
|
356 | + } |
|
357 | + |
|
358 | + return $code; |
|
359 | + } |
|
360 | + |
|
361 | + private function getPivotTableDescriptors() |
|
362 | + { |
|
363 | + $descs = []; |
|
364 | + foreach ($this->schemaAnalyzer->detectJunctionTables() as $table) { |
|
365 | + // There are exactly 2 FKs since this is a pivot table. |
|
366 | + $fks = array_values($table->getForeignKeys()); |
|
367 | + |
|
368 | + if ($fks[0]->getForeignTableName() === $this->table->getName()) { |
|
369 | + $localFK = $fks[0]; |
|
370 | + $remoteFK = $fks[1]; |
|
371 | + } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) { |
|
372 | + $localFK = $fks[1]; |
|
373 | + $remoteFK = $fks[0]; |
|
374 | + } else { |
|
375 | + continue; |
|
376 | + } |
|
377 | + |
|
378 | + $descs[$remoteFK->getForeignTableName()][] = [ |
|
379 | + 'table' => $table, |
|
380 | + 'localFK' => $localFK, |
|
381 | + 'remoteFK' => $remoteFK, |
|
382 | + ]; |
|
383 | + } |
|
384 | + |
|
385 | + $finalDescs = []; |
|
386 | + foreach ($descs as $descArray) { |
|
387 | + if (count($descArray) > 1) { |
|
388 | + foreach ($descArray as $desc) { |
|
389 | + $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName()); |
|
390 | + $finalDescs[] = $desc; |
|
391 | + } |
|
392 | + } else { |
|
393 | + $desc = $descArray[0]; |
|
394 | + $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()); |
|
395 | + $finalDescs[] = $desc; |
|
396 | + } |
|
397 | + } |
|
398 | + |
|
399 | + return $finalDescs; |
|
400 | + } |
|
401 | + |
|
402 | + public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK) |
|
403 | + { |
|
404 | + $singularName = TDBMDaoGenerator::toSingular($name); |
|
405 | + $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
406 | + $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
407 | + |
|
408 | + $str = ' /** |
|
409 | 409 | * Returns the list of %s associated to this bean via the %s pivot table. |
410 | 410 | * |
411 | 411 | * @return %s[] |
@@ -415,9 +415,9 @@ discard block |
||
415 | 415 | } |
416 | 416 | '; |
417 | 417 | |
418 | - $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true)); |
|
418 | + $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true)); |
|
419 | 419 | |
420 | - $str = ' /** |
|
420 | + $str = ' /** |
|
421 | 421 | * Adds a relationship with %s associated to this bean via the %s pivot table. |
422 | 422 | * |
423 | 423 | * @param %s %s |
@@ -427,9 +427,9 @@ discard block |
||
427 | 427 | } |
428 | 428 | '; |
429 | 429 | |
430 | - $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
430 | + $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
431 | 431 | |
432 | - $str = ' /** |
|
432 | + $str = ' /** |
|
433 | 433 | * Deletes the relationship with %s associated to this bean via the %s pivot table. |
434 | 434 | * |
435 | 435 | * @param %s %s |
@@ -439,9 +439,9 @@ discard block |
||
439 | 439 | } |
440 | 440 | '; |
441 | 441 | |
442 | - $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
442 | + $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
443 | 443 | |
444 | - $str = ' /** |
|
444 | + $str = ' /** |
|
445 | 445 | * Returns whether this bean is associated with %s via the %s pivot table. |
446 | 446 | * |
447 | 447 | * @param %s %s |
@@ -452,24 +452,24 @@ discard block |
||
452 | 452 | } |
453 | 453 | '; |
454 | 454 | |
455 | - $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
455 | + $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
456 | 456 | |
457 | - $code = $getterCode.$adderCode.$removerCode.$hasCode; |
|
457 | + $code = $getterCode.$adderCode.$removerCode.$hasCode; |
|
458 | 458 | |
459 | - return $code; |
|
460 | - } |
|
459 | + return $code; |
|
460 | + } |
|
461 | 461 | |
462 | - public function generateJsonSerialize() |
|
463 | - { |
|
464 | - $tableName = $this->table->getName(); |
|
465 | - $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
466 | - if ($parentFk !== null) { |
|
467 | - $initializer = '$array = parent::jsonSerialize();'; |
|
468 | - } else { |
|
469 | - $initializer = '$array = [];'; |
|
470 | - } |
|
462 | + public function generateJsonSerialize() |
|
463 | + { |
|
464 | + $tableName = $this->table->getName(); |
|
465 | + $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
466 | + if ($parentFk !== null) { |
|
467 | + $initializer = '$array = parent::jsonSerialize();'; |
|
468 | + } else { |
|
469 | + $initializer = '$array = [];'; |
|
470 | + } |
|
471 | 471 | |
472 | - $str = ' |
|
472 | + $str = ' |
|
473 | 473 | /** |
474 | 474 | * Serializes the object for JSON encoding |
475 | 475 | * |
@@ -485,54 +485,54 @@ discard block |
||
485 | 485 | } |
486 | 486 | '; |
487 | 487 | |
488 | - $propertiesCode = ''; |
|
489 | - foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) { |
|
490 | - $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode(); |
|
491 | - } |
|
488 | + $propertiesCode = ''; |
|
489 | + foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) { |
|
490 | + $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode(); |
|
491 | + } |
|
492 | 492 | |
493 | - // Many to many relationships: |
|
493 | + // Many to many relationships: |
|
494 | 494 | |
495 | - $descs = $this->getPivotTableDescriptors(); |
|
495 | + $descs = $this->getPivotTableDescriptors(); |
|
496 | 496 | |
497 | - $many2manyCode = ''; |
|
497 | + $many2manyCode = ''; |
|
498 | 498 | |
499 | - foreach ($descs as $desc) { |
|
500 | - $remoteFK = $desc['remoteFK']; |
|
501 | - $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
502 | - $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
499 | + foreach ($descs as $desc) { |
|
500 | + $remoteFK = $desc['remoteFK']; |
|
501 | + $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
502 | + $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
503 | 503 | |
504 | - $many2manyCode .= ' if (!$stopRecursion) { |
|
504 | + $many2manyCode .= ' if (!$stopRecursion) { |
|
505 | 505 | $array[\''.lcfirst($desc['name']).'\'] = array_map(function('.$remoteBeanName.' '.$variableName.') { |
506 | 506 | return '.$variableName.'->jsonSerialize(true); |
507 | 507 | }, $this->get'.$desc['name'].'()); |
508 | 508 | } |
509 | 509 | '; |
510 | - } |
|
511 | - |
|
512 | - return sprintf($str, $initializer, $propertiesCode, $many2manyCode); |
|
513 | - } |
|
514 | - |
|
515 | - /** |
|
516 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
517 | - * |
|
518 | - * @param string $beannamespace The namespace of the bean |
|
519 | - */ |
|
520 | - public function generatePhpCode($beannamespace) |
|
521 | - { |
|
522 | - $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($this->table->getName()); |
|
523 | - $className = TDBMDaoGenerator::getBeanNameFromTableName($this->table->getName()); |
|
524 | - $tableName = $this->table->getName(); |
|
525 | - |
|
526 | - $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
527 | - if ($parentFk !== null) { |
|
528 | - $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
529 | - $use = ''; |
|
530 | - } else { |
|
531 | - $extends = 'AbstractTDBMObject'; |
|
532 | - $use = "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n\n"; |
|
533 | - } |
|
534 | - |
|
535 | - $str = "<?php |
|
510 | + } |
|
511 | + |
|
512 | + return sprintf($str, $initializer, $propertiesCode, $many2manyCode); |
|
513 | + } |
|
514 | + |
|
515 | + /** |
|
516 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
517 | + * |
|
518 | + * @param string $beannamespace The namespace of the bean |
|
519 | + */ |
|
520 | + public function generatePhpCode($beannamespace) |
|
521 | + { |
|
522 | + $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($this->table->getName()); |
|
523 | + $className = TDBMDaoGenerator::getBeanNameFromTableName($this->table->getName()); |
|
524 | + $tableName = $this->table->getName(); |
|
525 | + |
|
526 | + $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
527 | + if ($parentFk !== null) { |
|
528 | + $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
529 | + $use = ''; |
|
530 | + } else { |
|
531 | + $extends = 'AbstractTDBMObject'; |
|
532 | + $use = "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n\n"; |
|
533 | + } |
|
534 | + |
|
535 | + $str = "<?php |
|
536 | 536 | namespace {$beannamespace}; |
537 | 537 | |
538 | 538 | use Mouf\\Database\\TDBM\\ResultIterator; |
@@ -550,19 +550,19 @@ discard block |
||
550 | 550 | { |
551 | 551 | "; |
552 | 552 | |
553 | - $str .= $this->generateBeanConstructor(); |
|
553 | + $str .= $this->generateBeanConstructor(); |
|
554 | 554 | |
555 | - foreach ($this->getExposedProperties() as $property) { |
|
556 | - $str .= $property->getGetterSetterCode(); |
|
557 | - } |
|
555 | + foreach ($this->getExposedProperties() as $property) { |
|
556 | + $str .= $property->getGetterSetterCode(); |
|
557 | + } |
|
558 | 558 | |
559 | - $str .= $this->generateDirectForeignKeysCode(); |
|
560 | - $str .= $this->generatePivotTableCode(); |
|
561 | - $str .= $this->generateJsonSerialize(); |
|
559 | + $str .= $this->generateDirectForeignKeysCode(); |
|
560 | + $str .= $this->generatePivotTableCode(); |
|
561 | + $str .= $this->generateJsonSerialize(); |
|
562 | 562 | |
563 | - $str .= '} |
|
563 | + $str .= '} |
|
564 | 564 | '; |
565 | 565 | |
566 | - return $str; |
|
567 | - } |
|
566 | + return $str; |
|
567 | + } |
|
568 | 568 | } |
@@ -11,98 +11,98 @@ discard block |
||
11 | 11 | */ |
12 | 12 | class ScalarBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor |
13 | 13 | { |
14 | - /** |
|
15 | - * @var Column |
|
16 | - */ |
|
17 | - private $column; |
|
18 | - |
|
19 | - public function __construct(Table $table, Column $column) |
|
20 | - { |
|
21 | - parent::__construct($table); |
|
22 | - $this->table = $table; |
|
23 | - $this->column = $column; |
|
24 | - } |
|
25 | - |
|
26 | - /** |
|
27 | - * Returns the foreign-key the column is part of, if any. null otherwise. |
|
28 | - * |
|
29 | - * @return ForeignKeyConstraint|null |
|
30 | - */ |
|
31 | - public function getForeignKey() |
|
32 | - { |
|
33 | - return false; |
|
34 | - } |
|
35 | - |
|
36 | - /** |
|
37 | - * Returns the param annotation for this property (useful for constructor). |
|
38 | - * |
|
39 | - * @return string |
|
40 | - */ |
|
41 | - public function getParamAnnotation() |
|
42 | - { |
|
43 | - $className = $this->getClassName(); |
|
44 | - $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType()); |
|
45 | - |
|
46 | - $str = ' * @param %s %s'; |
|
47 | - |
|
48 | - return sprintf($str, $paramType, $this->getVariableName()); |
|
49 | - } |
|
50 | - |
|
51 | - public function getUpperCamelCaseName() |
|
52 | - { |
|
53 | - return TDBMDaoGenerator::toCamelCase($this->column->getName()); |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
58 | - * |
|
59 | - * @return null|string |
|
60 | - */ |
|
61 | - public function getClassName() |
|
62 | - { |
|
63 | - return; |
|
64 | - } |
|
65 | - |
|
66 | - /** |
|
67 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
68 | - * |
|
69 | - * @return bool |
|
70 | - */ |
|
71 | - public function isCompulsory() |
|
72 | - { |
|
73 | - return $this->column->getNotnull() && !$this->column->getAutoincrement(); |
|
74 | - } |
|
75 | - |
|
76 | - /** |
|
77 | - * Returns true if the property is the primary key. |
|
78 | - * |
|
79 | - * @return bool |
|
80 | - */ |
|
81 | - public function isPrimaryKey() |
|
82 | - { |
|
83 | - return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
84 | - } |
|
85 | - |
|
86 | - /** |
|
87 | - * Returns the PHP code for getters and setters. |
|
88 | - * |
|
89 | - * @return string |
|
90 | - */ |
|
91 | - public function getGetterSetterCode() |
|
92 | - { |
|
93 | - $type = $this->column->getType(); |
|
94 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
95 | - |
|
96 | - $columnGetterName = $this->getGetterName(); |
|
97 | - $columnSetterName = $this->getSetterName(); |
|
98 | - |
|
99 | - if ($normalizedType == '\\DateTimeInterface') { |
|
100 | - $castTo = '\\DateTimeInterface '; |
|
101 | - } else { |
|
102 | - $castTo = ''; |
|
103 | - } |
|
104 | - |
|
105 | - $getterAndSetterCode = ' /** |
|
14 | + /** |
|
15 | + * @var Column |
|
16 | + */ |
|
17 | + private $column; |
|
18 | + |
|
19 | + public function __construct(Table $table, Column $column) |
|
20 | + { |
|
21 | + parent::__construct($table); |
|
22 | + $this->table = $table; |
|
23 | + $this->column = $column; |
|
24 | + } |
|
25 | + |
|
26 | + /** |
|
27 | + * Returns the foreign-key the column is part of, if any. null otherwise. |
|
28 | + * |
|
29 | + * @return ForeignKeyConstraint|null |
|
30 | + */ |
|
31 | + public function getForeignKey() |
|
32 | + { |
|
33 | + return false; |
|
34 | + } |
|
35 | + |
|
36 | + /** |
|
37 | + * Returns the param annotation for this property (useful for constructor). |
|
38 | + * |
|
39 | + * @return string |
|
40 | + */ |
|
41 | + public function getParamAnnotation() |
|
42 | + { |
|
43 | + $className = $this->getClassName(); |
|
44 | + $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType()); |
|
45 | + |
|
46 | + $str = ' * @param %s %s'; |
|
47 | + |
|
48 | + return sprintf($str, $paramType, $this->getVariableName()); |
|
49 | + } |
|
50 | + |
|
51 | + public function getUpperCamelCaseName() |
|
52 | + { |
|
53 | + return TDBMDaoGenerator::toCamelCase($this->column->getName()); |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
58 | + * |
|
59 | + * @return null|string |
|
60 | + */ |
|
61 | + public function getClassName() |
|
62 | + { |
|
63 | + return; |
|
64 | + } |
|
65 | + |
|
66 | + /** |
|
67 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
68 | + * |
|
69 | + * @return bool |
|
70 | + */ |
|
71 | + public function isCompulsory() |
|
72 | + { |
|
73 | + return $this->column->getNotnull() && !$this->column->getAutoincrement(); |
|
74 | + } |
|
75 | + |
|
76 | + /** |
|
77 | + * Returns true if the property is the primary key. |
|
78 | + * |
|
79 | + * @return bool |
|
80 | + */ |
|
81 | + public function isPrimaryKey() |
|
82 | + { |
|
83 | + return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
84 | + } |
|
85 | + |
|
86 | + /** |
|
87 | + * Returns the PHP code for getters and setters. |
|
88 | + * |
|
89 | + * @return string |
|
90 | + */ |
|
91 | + public function getGetterSetterCode() |
|
92 | + { |
|
93 | + $type = $this->column->getType(); |
|
94 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
95 | + |
|
96 | + $columnGetterName = $this->getGetterName(); |
|
97 | + $columnSetterName = $this->getSetterName(); |
|
98 | + |
|
99 | + if ($normalizedType == '\\DateTimeInterface') { |
|
100 | + $castTo = '\\DateTimeInterface '; |
|
101 | + } else { |
|
102 | + $castTo = ''; |
|
103 | + } |
|
104 | + |
|
105 | + $getterAndSetterCode = ' /** |
|
106 | 106 | * The getter for the "%s" column. |
107 | 107 | * |
108 | 108 | * @return %s |
@@ -122,40 +122,40 @@ discard block |
||
122 | 122 | |
123 | 123 | '; |
124 | 124 | |
125 | - return sprintf($getterAndSetterCode, |
|
126 | - // Getter |
|
127 | - $this->column->getName(), |
|
128 | - $normalizedType, |
|
129 | - $columnGetterName, |
|
130 | - var_export($this->column->getName(), true), |
|
131 | - var_export($this->table->getName(), true), |
|
132 | - // Setter |
|
133 | - $this->column->getName(), |
|
134 | - $normalizedType, |
|
135 | - $this->column->getName(), |
|
136 | - $columnSetterName, |
|
137 | - $castTo, |
|
138 | - $this->column->getName(), |
|
139 | - var_export($this->column->getName(), true), |
|
140 | - $this->column->getName(), |
|
141 | - var_export($this->table->getName(), true) |
|
142 | - ); |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Returns the part of code useful when doing json serialization. |
|
147 | - * |
|
148 | - * @return string |
|
149 | - */ |
|
150 | - public function getJsonSerializeCode() |
|
151 | - { |
|
152 | - $type = $this->column->getType(); |
|
153 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
154 | - |
|
155 | - if ($normalizedType == '\\DateTimeInterface') { |
|
156 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."()->format('c');\n"; |
|
157 | - } else { |
|
158 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
159 | - } |
|
160 | - } |
|
125 | + return sprintf($getterAndSetterCode, |
|
126 | + // Getter |
|
127 | + $this->column->getName(), |
|
128 | + $normalizedType, |
|
129 | + $columnGetterName, |
|
130 | + var_export($this->column->getName(), true), |
|
131 | + var_export($this->table->getName(), true), |
|
132 | + // Setter |
|
133 | + $this->column->getName(), |
|
134 | + $normalizedType, |
|
135 | + $this->column->getName(), |
|
136 | + $columnSetterName, |
|
137 | + $castTo, |
|
138 | + $this->column->getName(), |
|
139 | + var_export($this->column->getName(), true), |
|
140 | + $this->column->getName(), |
|
141 | + var_export($this->table->getName(), true) |
|
142 | + ); |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Returns the part of code useful when doing json serialization. |
|
147 | + * |
|
148 | + * @return string |
|
149 | + */ |
|
150 | + public function getJsonSerializeCode() |
|
151 | + { |
|
152 | + $type = $this->column->getType(); |
|
153 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
154 | + |
|
155 | + if ($normalizedType == '\\DateTimeInterface') { |
|
156 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."()->format('c');\n"; |
|
157 | + } else { |
|
158 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
159 | + } |
|
160 | + } |
|
161 | 161 | } |