@@ -33,121 +33,121 @@ |
||
33 | 33 | */ |
34 | 34 | class TDBMObject extends AbstractTDBMObject implements \ArrayAccess, \Iterator |
35 | 35 | { |
36 | - public function __get($var) |
|
37 | - { |
|
38 | - return $this->get($var); |
|
39 | - } |
|
40 | - |
|
41 | - /** |
|
42 | - * Returns true if a column is set, false otherwise. |
|
43 | - * |
|
44 | - * @param string $var |
|
45 | - * |
|
46 | - * @return bool |
|
47 | - */ |
|
48 | - public function __isset($var) |
|
49 | - { |
|
50 | - return $this->has($var); |
|
51 | - } |
|
52 | - |
|
53 | - public function __set($var, $value) |
|
54 | - { |
|
55 | - $this->set($var, $value); |
|
56 | - } |
|
57 | - |
|
58 | - /** |
|
59 | - * Implements array behaviour for our object. |
|
60 | - * |
|
61 | - * @param string $offset |
|
62 | - * @param string $value |
|
63 | - */ |
|
64 | - public function offsetSet($offset, $value) |
|
65 | - { |
|
66 | - $this->__set($offset, $value); |
|
67 | - } |
|
68 | - |
|
69 | - /** |
|
70 | - * Implements array behaviour for our object. |
|
71 | - * |
|
72 | - * @param string $offset |
|
73 | - * |
|
74 | - * @return bool |
|
75 | - */ |
|
76 | - public function offsetExists($offset) |
|
77 | - { |
|
78 | - $this->_dbLoadIfNotLoaded(); |
|
79 | - |
|
80 | - return isset($this->dbRow[$offset]); |
|
81 | - } |
|
82 | - |
|
83 | - /** |
|
84 | - * Implements array behaviour for our object. |
|
85 | - * |
|
86 | - * @param string $offset |
|
87 | - */ |
|
88 | - public function offsetUnset($offset) |
|
89 | - { |
|
90 | - $this->__set($offset, null); |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * Implements array behaviour for our object. |
|
95 | - * |
|
96 | - * @param string $offset |
|
97 | - * |
|
98 | - * @return mixed|null |
|
99 | - */ |
|
100 | - public function offsetGet($offset) |
|
101 | - { |
|
102 | - return $this->__get($offset); |
|
103 | - } |
|
104 | - |
|
105 | - private $_validIterator = false; |
|
106 | - |
|
107 | - /** |
|
108 | - * Implements iterator behaviour for our object (so we can each column). |
|
109 | - */ |
|
110 | - public function rewind() |
|
111 | - { |
|
112 | - $this->_dbLoadIfNotLoaded(); |
|
113 | - if (count($this->dbRow) > 0) { |
|
114 | - $this->_validIterator = true; |
|
115 | - } else { |
|
116 | - $this->_validIterator = false; |
|
117 | - } |
|
118 | - reset($this->dbRow); |
|
119 | - } |
|
120 | - |
|
121 | - /** |
|
122 | - * Implements iterator behaviour for our object (so we can each column). |
|
123 | - */ |
|
124 | - public function next() |
|
125 | - { |
|
126 | - $val = next($this->dbRow); |
|
127 | - $this->_validIterator = !($val === false); |
|
128 | - } |
|
129 | - |
|
130 | - /** |
|
131 | - * Implements iterator behaviour for our object (so we can each column). |
|
132 | - */ |
|
133 | - public function key() |
|
134 | - { |
|
135 | - return key($this->dbRow); |
|
136 | - } |
|
137 | - |
|
138 | - /** |
|
139 | - * Implements iterator behaviour for our object (so we can each column). |
|
140 | - */ |
|
141 | - public function current() |
|
142 | - { |
|
143 | - return current($this->dbRow); |
|
144 | - } |
|
145 | - |
|
146 | - /** |
|
147 | - * Implements iterator behaviour for our object (so we can each column). |
|
148 | - */ |
|
149 | - public function valid() |
|
150 | - { |
|
151 | - return $this->_validIterator; |
|
152 | - } |
|
36 | + public function __get($var) |
|
37 | + { |
|
38 | + return $this->get($var); |
|
39 | + } |
|
40 | + |
|
41 | + /** |
|
42 | + * Returns true if a column is set, false otherwise. |
|
43 | + * |
|
44 | + * @param string $var |
|
45 | + * |
|
46 | + * @return bool |
|
47 | + */ |
|
48 | + public function __isset($var) |
|
49 | + { |
|
50 | + return $this->has($var); |
|
51 | + } |
|
52 | + |
|
53 | + public function __set($var, $value) |
|
54 | + { |
|
55 | + $this->set($var, $value); |
|
56 | + } |
|
57 | + |
|
58 | + /** |
|
59 | + * Implements array behaviour for our object. |
|
60 | + * |
|
61 | + * @param string $offset |
|
62 | + * @param string $value |
|
63 | + */ |
|
64 | + public function offsetSet($offset, $value) |
|
65 | + { |
|
66 | + $this->__set($offset, $value); |
|
67 | + } |
|
68 | + |
|
69 | + /** |
|
70 | + * Implements array behaviour for our object. |
|
71 | + * |
|
72 | + * @param string $offset |
|
73 | + * |
|
74 | + * @return bool |
|
75 | + */ |
|
76 | + public function offsetExists($offset) |
|
77 | + { |
|
78 | + $this->_dbLoadIfNotLoaded(); |
|
79 | + |
|
80 | + return isset($this->dbRow[$offset]); |
|
81 | + } |
|
82 | + |
|
83 | + /** |
|
84 | + * Implements array behaviour for our object. |
|
85 | + * |
|
86 | + * @param string $offset |
|
87 | + */ |
|
88 | + public function offsetUnset($offset) |
|
89 | + { |
|
90 | + $this->__set($offset, null); |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * Implements array behaviour for our object. |
|
95 | + * |
|
96 | + * @param string $offset |
|
97 | + * |
|
98 | + * @return mixed|null |
|
99 | + */ |
|
100 | + public function offsetGet($offset) |
|
101 | + { |
|
102 | + return $this->__get($offset); |
|
103 | + } |
|
104 | + |
|
105 | + private $_validIterator = false; |
|
106 | + |
|
107 | + /** |
|
108 | + * Implements iterator behaviour for our object (so we can each column). |
|
109 | + */ |
|
110 | + public function rewind() |
|
111 | + { |
|
112 | + $this->_dbLoadIfNotLoaded(); |
|
113 | + if (count($this->dbRow) > 0) { |
|
114 | + $this->_validIterator = true; |
|
115 | + } else { |
|
116 | + $this->_validIterator = false; |
|
117 | + } |
|
118 | + reset($this->dbRow); |
|
119 | + } |
|
120 | + |
|
121 | + /** |
|
122 | + * Implements iterator behaviour for our object (so we can each column). |
|
123 | + */ |
|
124 | + public function next() |
|
125 | + { |
|
126 | + $val = next($this->dbRow); |
|
127 | + $this->_validIterator = !($val === false); |
|
128 | + } |
|
129 | + |
|
130 | + /** |
|
131 | + * Implements iterator behaviour for our object (so we can each column). |
|
132 | + */ |
|
133 | + public function key() |
|
134 | + { |
|
135 | + return key($this->dbRow); |
|
136 | + } |
|
137 | + |
|
138 | + /** |
|
139 | + * Implements iterator behaviour for our object (so we can each column). |
|
140 | + */ |
|
141 | + public function current() |
|
142 | + { |
|
143 | + return current($this->dbRow); |
|
144 | + } |
|
145 | + |
|
146 | + /** |
|
147 | + * Implements iterator behaviour for our object (so we can each column). |
|
148 | + */ |
|
149 | + public function valid() |
|
150 | + { |
|
151 | + return $this->_validIterator; |
|
152 | + } |
|
153 | 153 | } |
@@ -9,115 +9,115 @@ |
||
9 | 9 | */ |
10 | 10 | abstract class AbstractBeanPropertyDescriptor |
11 | 11 | { |
12 | - /** |
|
13 | - * @var Table |
|
14 | - */ |
|
15 | - protected $table; |
|
16 | - |
|
17 | - /** |
|
18 | - * Whether to use the more complex name in case of conflict. |
|
19 | - * |
|
20 | - * @var bool |
|
21 | - */ |
|
22 | - protected $alternativeName = false; |
|
23 | - |
|
24 | - /** |
|
25 | - * @param Table $table |
|
26 | - */ |
|
27 | - public function __construct(Table $table) |
|
28 | - { |
|
29 | - $this->table = $table; |
|
30 | - } |
|
31 | - |
|
32 | - /** |
|
33 | - * Use the more complex name in case of conflict. |
|
34 | - */ |
|
35 | - public function useAlternativeName() |
|
36 | - { |
|
37 | - $this->alternativeName = true; |
|
38 | - } |
|
39 | - |
|
40 | - /** |
|
41 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
42 | - * |
|
43 | - * @return null|string |
|
44 | - */ |
|
45 | - abstract public function getClassName(); |
|
46 | - |
|
47 | - /** |
|
48 | - * Returns the param annotation for this property (useful for constructor). |
|
49 | - * |
|
50 | - * @return string |
|
51 | - */ |
|
52 | - abstract public function getParamAnnotation(); |
|
53 | - |
|
54 | - public function getVariableName() |
|
55 | - { |
|
56 | - return '$'.$this->getLowerCamelCaseName(); |
|
57 | - } |
|
58 | - |
|
59 | - public function getLowerCamelCaseName() |
|
60 | - { |
|
61 | - return TDBMDaoGenerator::toVariableName($this->getUpperCamelCaseName()); |
|
62 | - } |
|
63 | - |
|
64 | - abstract public function getUpperCamelCaseName(); |
|
65 | - |
|
66 | - public function getSetterName() |
|
67 | - { |
|
68 | - return 'set'.$this->getUpperCamelCaseName(); |
|
69 | - } |
|
70 | - |
|
71 | - public function getGetterName() |
|
72 | - { |
|
73 | - return 'get'.$this->getUpperCamelCaseName(); |
|
74 | - } |
|
75 | - |
|
76 | - /** |
|
77 | - * Returns the PHP code used in the ben constructor for this property. |
|
78 | - * |
|
79 | - * @return string |
|
80 | - */ |
|
81 | - public function getConstructorAssignCode() |
|
82 | - { |
|
83 | - $str = ' $this->%s(%s);'; |
|
84 | - |
|
85 | - return sprintf($str, $this->getSetterName(), $this->getVariableName()); |
|
86 | - } |
|
87 | - |
|
88 | - /** |
|
89 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
90 | - * |
|
91 | - * @return bool |
|
92 | - */ |
|
93 | - abstract public function isCompulsory(); |
|
94 | - |
|
95 | - /** |
|
96 | - * Returns true if the property is the primary key. |
|
97 | - * |
|
98 | - * @return bool |
|
99 | - */ |
|
100 | - abstract public function isPrimaryKey(); |
|
101 | - |
|
102 | - /** |
|
103 | - * @return Table |
|
104 | - */ |
|
105 | - public function getTable() |
|
106 | - { |
|
107 | - return $this->table; |
|
108 | - } |
|
109 | - |
|
110 | - /** |
|
111 | - * Returns the PHP code for getters and setters. |
|
112 | - * |
|
113 | - * @return string |
|
114 | - */ |
|
115 | - abstract public function getGetterSetterCode(); |
|
116 | - |
|
117 | - /** |
|
118 | - * Returns the part of code useful when doing json serialization. |
|
119 | - * |
|
120 | - * @return string |
|
121 | - */ |
|
122 | - abstract public function getJsonSerializeCode(); |
|
12 | + /** |
|
13 | + * @var Table |
|
14 | + */ |
|
15 | + protected $table; |
|
16 | + |
|
17 | + /** |
|
18 | + * Whether to use the more complex name in case of conflict. |
|
19 | + * |
|
20 | + * @var bool |
|
21 | + */ |
|
22 | + protected $alternativeName = false; |
|
23 | + |
|
24 | + /** |
|
25 | + * @param Table $table |
|
26 | + */ |
|
27 | + public function __construct(Table $table) |
|
28 | + { |
|
29 | + $this->table = $table; |
|
30 | + } |
|
31 | + |
|
32 | + /** |
|
33 | + * Use the more complex name in case of conflict. |
|
34 | + */ |
|
35 | + public function useAlternativeName() |
|
36 | + { |
|
37 | + $this->alternativeName = true; |
|
38 | + } |
|
39 | + |
|
40 | + /** |
|
41 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
42 | + * |
|
43 | + * @return null|string |
|
44 | + */ |
|
45 | + abstract public function getClassName(); |
|
46 | + |
|
47 | + /** |
|
48 | + * Returns the param annotation for this property (useful for constructor). |
|
49 | + * |
|
50 | + * @return string |
|
51 | + */ |
|
52 | + abstract public function getParamAnnotation(); |
|
53 | + |
|
54 | + public function getVariableName() |
|
55 | + { |
|
56 | + return '$'.$this->getLowerCamelCaseName(); |
|
57 | + } |
|
58 | + |
|
59 | + public function getLowerCamelCaseName() |
|
60 | + { |
|
61 | + return TDBMDaoGenerator::toVariableName($this->getUpperCamelCaseName()); |
|
62 | + } |
|
63 | + |
|
64 | + abstract public function getUpperCamelCaseName(); |
|
65 | + |
|
66 | + public function getSetterName() |
|
67 | + { |
|
68 | + return 'set'.$this->getUpperCamelCaseName(); |
|
69 | + } |
|
70 | + |
|
71 | + public function getGetterName() |
|
72 | + { |
|
73 | + return 'get'.$this->getUpperCamelCaseName(); |
|
74 | + } |
|
75 | + |
|
76 | + /** |
|
77 | + * Returns the PHP code used in the ben constructor for this property. |
|
78 | + * |
|
79 | + * @return string |
|
80 | + */ |
|
81 | + public function getConstructorAssignCode() |
|
82 | + { |
|
83 | + $str = ' $this->%s(%s);'; |
|
84 | + |
|
85 | + return sprintf($str, $this->getSetterName(), $this->getVariableName()); |
|
86 | + } |
|
87 | + |
|
88 | + /** |
|
89 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
90 | + * |
|
91 | + * @return bool |
|
92 | + */ |
|
93 | + abstract public function isCompulsory(); |
|
94 | + |
|
95 | + /** |
|
96 | + * Returns true if the property is the primary key. |
|
97 | + * |
|
98 | + * @return bool |
|
99 | + */ |
|
100 | + abstract public function isPrimaryKey(); |
|
101 | + |
|
102 | + /** |
|
103 | + * @return Table |
|
104 | + */ |
|
105 | + public function getTable() |
|
106 | + { |
|
107 | + return $this->table; |
|
108 | + } |
|
109 | + |
|
110 | + /** |
|
111 | + * Returns the PHP code for getters and setters. |
|
112 | + * |
|
113 | + * @return string |
|
114 | + */ |
|
115 | + abstract public function getGetterSetterCode(); |
|
116 | + |
|
117 | + /** |
|
118 | + * Returns the part of code useful when doing json serialization. |
|
119 | + * |
|
120 | + * @return string |
|
121 | + */ |
|
122 | + abstract public function getJsonSerializeCode(); |
|
123 | 123 | } |
@@ -18,188 +18,188 @@ discard block |
||
18 | 18 | */ |
19 | 19 | class TDBMDaoGenerator |
20 | 20 | { |
21 | - /** |
|
22 | - * @var SchemaAnalyzer |
|
23 | - */ |
|
24 | - private $schemaAnalyzer; |
|
25 | - |
|
26 | - /** |
|
27 | - * @var Schema |
|
28 | - */ |
|
29 | - private $schema; |
|
30 | - |
|
31 | - /** |
|
32 | - * The root directory of the project. |
|
33 | - * |
|
34 | - * @var string |
|
35 | - */ |
|
36 | - private $rootPath; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var TDBMSchemaAnalyzer |
|
40 | - */ |
|
41 | - private $tdbmSchemaAnalyzer; |
|
42 | - |
|
43 | - /** |
|
44 | - * Constructor. |
|
45 | - * |
|
46 | - * @param Connection $dbConnection The connection to the database. |
|
47 | - */ |
|
48 | - public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
49 | - { |
|
50 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
51 | - $this->schema = $schema; |
|
52 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
53 | - $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * Generates all the daos and beans. |
|
58 | - * |
|
59 | - * @param string $daoFactoryClassName The classe name of the DAO factory |
|
60 | - * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
61 | - * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
62 | - * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone. |
|
63 | - * |
|
64 | - * @return \string[] the list of tables |
|
65 | - * |
|
66 | - * @throws TDBMException |
|
67 | - */ |
|
68 | - public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
69 | - { |
|
70 | - // TODO: extract ClassNameMapper in its own package! |
|
71 | - $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.'composer.json'); |
|
72 | - |
|
73 | - // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
74 | - |
|
75 | - $tableList = $this->schema->getTables(); |
|
76 | - |
|
77 | - // Remove all beans and daos from junction tables |
|
78 | - $junctionTables = $this->schemaAnalyzer->detectJunctionTables(); |
|
79 | - $junctionTableNames = array_map(function (Table $table) { |
|
80 | - return $table->getName(); |
|
81 | - }, $junctionTables); |
|
82 | - |
|
83 | - $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
84 | - return !in_array($table->getName(), $junctionTableNames); |
|
85 | - }); |
|
86 | - |
|
87 | - foreach ($tableList as $table) { |
|
88 | - $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
89 | - } |
|
90 | - |
|
91 | - $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
92 | - |
|
93 | - // Ok, let's return the list of all tables. |
|
94 | - // These will be used by the calling script to create Mouf instances. |
|
95 | - |
|
96 | - return array_map(function (Table $table) { return $table->getName(); }, $tableList); |
|
97 | - } |
|
98 | - |
|
99 | - /** |
|
100 | - * Generates in one method call the daos and the beans for one table. |
|
101 | - * |
|
102 | - * @param $tableName |
|
103 | - */ |
|
104 | - public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
105 | - { |
|
106 | - $tableName = $table->getName(); |
|
107 | - $daoName = $this->getDaoNameFromTableName($tableName); |
|
108 | - $beanName = $this->getBeanNameFromTableName($tableName); |
|
109 | - $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
110 | - $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
111 | - |
|
112 | - $this->generateBean($beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
113 | - $this->generateDao($daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * Returns the name of the bean class from the table name. |
|
118 | - * |
|
119 | - * @param $tableName |
|
120 | - * |
|
121 | - * @return string |
|
122 | - */ |
|
123 | - public static function getBeanNameFromTableName($tableName) |
|
124 | - { |
|
125 | - return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
126 | - } |
|
127 | - |
|
128 | - /** |
|
129 | - * Returns the name of the DAO class from the table name. |
|
130 | - * |
|
131 | - * @param $tableName |
|
132 | - * |
|
133 | - * @return string |
|
134 | - */ |
|
135 | - public static function getDaoNameFromTableName($tableName) |
|
136 | - { |
|
137 | - return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
138 | - } |
|
139 | - |
|
140 | - /** |
|
141 | - * Returns the name of the base bean class from the table name. |
|
142 | - * |
|
143 | - * @param $tableName |
|
144 | - * |
|
145 | - * @return string |
|
146 | - */ |
|
147 | - public static function getBaseBeanNameFromTableName($tableName) |
|
148 | - { |
|
149 | - return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
150 | - } |
|
151 | - |
|
152 | - /** |
|
153 | - * Returns the name of the base DAO class from the table name. |
|
154 | - * |
|
155 | - * @param $tableName |
|
156 | - * |
|
157 | - * @return string |
|
158 | - */ |
|
159 | - public static function getBaseDaoNameFromTableName($tableName) |
|
160 | - { |
|
161 | - return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
162 | - } |
|
163 | - |
|
164 | - /** |
|
165 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
166 | - * |
|
167 | - * @param string $className The name of the class |
|
168 | - * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
169 | - * @param Table $table The table |
|
170 | - * @param string $beannamespace The namespace of the bean |
|
171 | - * @param ClassNameMapper $classNameMapper |
|
172 | - * |
|
173 | - * @throws TDBMException |
|
174 | - */ |
|
175 | - public function generateBean($className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
176 | - { |
|
177 | - $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
178 | - |
|
179 | - $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
180 | - |
|
181 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$baseClassName); |
|
182 | - if (!$possibleBaseFileNames) { |
|
183 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
184 | - } |
|
185 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
186 | - |
|
187 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
188 | - file_put_contents($possibleBaseFileName, $str); |
|
189 | - @chmod($possibleBaseFileName, 0664); |
|
190 | - |
|
191 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
192 | - if (!$possibleFileNames) { |
|
193 | - // @codeCoverageIgnoreStart |
|
194 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
195 | - // @codeCoverageIgnoreEnd |
|
196 | - } |
|
197 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
198 | - |
|
199 | - if (!file_exists($possibleFileName)) { |
|
200 | - $tableName = $table->getName(); |
|
201 | - |
|
202 | - $str = "<?php |
|
21 | + /** |
|
22 | + * @var SchemaAnalyzer |
|
23 | + */ |
|
24 | + private $schemaAnalyzer; |
|
25 | + |
|
26 | + /** |
|
27 | + * @var Schema |
|
28 | + */ |
|
29 | + private $schema; |
|
30 | + |
|
31 | + /** |
|
32 | + * The root directory of the project. |
|
33 | + * |
|
34 | + * @var string |
|
35 | + */ |
|
36 | + private $rootPath; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var TDBMSchemaAnalyzer |
|
40 | + */ |
|
41 | + private $tdbmSchemaAnalyzer; |
|
42 | + |
|
43 | + /** |
|
44 | + * Constructor. |
|
45 | + * |
|
46 | + * @param Connection $dbConnection The connection to the database. |
|
47 | + */ |
|
48 | + public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
49 | + { |
|
50 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
51 | + $this->schema = $schema; |
|
52 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
53 | + $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * Generates all the daos and beans. |
|
58 | + * |
|
59 | + * @param string $daoFactoryClassName The classe name of the DAO factory |
|
60 | + * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
61 | + * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
62 | + * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone. |
|
63 | + * |
|
64 | + * @return \string[] the list of tables |
|
65 | + * |
|
66 | + * @throws TDBMException |
|
67 | + */ |
|
68 | + public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
69 | + { |
|
70 | + // TODO: extract ClassNameMapper in its own package! |
|
71 | + $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.'composer.json'); |
|
72 | + |
|
73 | + // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
74 | + |
|
75 | + $tableList = $this->schema->getTables(); |
|
76 | + |
|
77 | + // Remove all beans and daos from junction tables |
|
78 | + $junctionTables = $this->schemaAnalyzer->detectJunctionTables(); |
|
79 | + $junctionTableNames = array_map(function (Table $table) { |
|
80 | + return $table->getName(); |
|
81 | + }, $junctionTables); |
|
82 | + |
|
83 | + $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
84 | + return !in_array($table->getName(), $junctionTableNames); |
|
85 | + }); |
|
86 | + |
|
87 | + foreach ($tableList as $table) { |
|
88 | + $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
89 | + } |
|
90 | + |
|
91 | + $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
92 | + |
|
93 | + // Ok, let's return the list of all tables. |
|
94 | + // These will be used by the calling script to create Mouf instances. |
|
95 | + |
|
96 | + return array_map(function (Table $table) { return $table->getName(); }, $tableList); |
|
97 | + } |
|
98 | + |
|
99 | + /** |
|
100 | + * Generates in one method call the daos and the beans for one table. |
|
101 | + * |
|
102 | + * @param $tableName |
|
103 | + */ |
|
104 | + public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
105 | + { |
|
106 | + $tableName = $table->getName(); |
|
107 | + $daoName = $this->getDaoNameFromTableName($tableName); |
|
108 | + $beanName = $this->getBeanNameFromTableName($tableName); |
|
109 | + $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
110 | + $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
111 | + |
|
112 | + $this->generateBean($beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
113 | + $this->generateDao($daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * Returns the name of the bean class from the table name. |
|
118 | + * |
|
119 | + * @param $tableName |
|
120 | + * |
|
121 | + * @return string |
|
122 | + */ |
|
123 | + public static function getBeanNameFromTableName($tableName) |
|
124 | + { |
|
125 | + return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
126 | + } |
|
127 | + |
|
128 | + /** |
|
129 | + * Returns the name of the DAO class from the table name. |
|
130 | + * |
|
131 | + * @param $tableName |
|
132 | + * |
|
133 | + * @return string |
|
134 | + */ |
|
135 | + public static function getDaoNameFromTableName($tableName) |
|
136 | + { |
|
137 | + return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
138 | + } |
|
139 | + |
|
140 | + /** |
|
141 | + * Returns the name of the base bean class from the table name. |
|
142 | + * |
|
143 | + * @param $tableName |
|
144 | + * |
|
145 | + * @return string |
|
146 | + */ |
|
147 | + public static function getBaseBeanNameFromTableName($tableName) |
|
148 | + { |
|
149 | + return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
150 | + } |
|
151 | + |
|
152 | + /** |
|
153 | + * Returns the name of the base DAO class from the table name. |
|
154 | + * |
|
155 | + * @param $tableName |
|
156 | + * |
|
157 | + * @return string |
|
158 | + */ |
|
159 | + public static function getBaseDaoNameFromTableName($tableName) |
|
160 | + { |
|
161 | + return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
162 | + } |
|
163 | + |
|
164 | + /** |
|
165 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
166 | + * |
|
167 | + * @param string $className The name of the class |
|
168 | + * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
169 | + * @param Table $table The table |
|
170 | + * @param string $beannamespace The namespace of the bean |
|
171 | + * @param ClassNameMapper $classNameMapper |
|
172 | + * |
|
173 | + * @throws TDBMException |
|
174 | + */ |
|
175 | + public function generateBean($className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
176 | + { |
|
177 | + $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
178 | + |
|
179 | + $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
180 | + |
|
181 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$baseClassName); |
|
182 | + if (!$possibleBaseFileNames) { |
|
183 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
184 | + } |
|
185 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
186 | + |
|
187 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
188 | + file_put_contents($possibleBaseFileName, $str); |
|
189 | + @chmod($possibleBaseFileName, 0664); |
|
190 | + |
|
191 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
192 | + if (!$possibleFileNames) { |
|
193 | + // @codeCoverageIgnoreStart |
|
194 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
195 | + // @codeCoverageIgnoreEnd |
|
196 | + } |
|
197 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
198 | + |
|
199 | + if (!file_exists($possibleFileName)) { |
|
200 | + $tableName = $table->getName(); |
|
201 | + |
|
202 | + $str = "<?php |
|
203 | 203 | /* |
204 | 204 | * This file has been automatically generated by TDBM. |
205 | 205 | * You can edit this file as it will not be overwritten. |
@@ -214,45 +214,45 @@ discard block |
||
214 | 214 | { |
215 | 215 | |
216 | 216 | }"; |
217 | - $this->ensureDirectoryExist($possibleFileName); |
|
218 | - file_put_contents($possibleFileName, $str); |
|
219 | - @chmod($possibleFileName, 0664); |
|
220 | - } |
|
221 | - } |
|
222 | - |
|
223 | - /** |
|
224 | - * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
225 | - * |
|
226 | - * @param string $fileName The file that will be written (without the directory) |
|
227 | - * @param string $className The name of the class |
|
228 | - * @param string $tableName The name of the table |
|
229 | - */ |
|
230 | - public function generateDao($className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
231 | - { |
|
232 | - $tableName = $table->getName(); |
|
233 | - $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
234 | - |
|
235 | - $defaultSort = null; |
|
236 | - foreach ($table->getColumns() as $column) { |
|
237 | - $comments = $column->getComment(); |
|
238 | - $matches = array(); |
|
239 | - if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
240 | - $defaultSort = $data['column_name']; |
|
241 | - if (count($matches == 3)) { |
|
242 | - $defaultSortDirection = $matches[2]; |
|
243 | - } else { |
|
244 | - $defaultSortDirection = 'ASC'; |
|
245 | - } |
|
246 | - } |
|
247 | - } |
|
248 | - |
|
249 | - // FIXME: lowercase tables with _ in the name should work! |
|
250 | - $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
251 | - |
|
252 | - $beanClassWithoutNameSpace = $beanClassName; |
|
253 | - $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
254 | - |
|
255 | - $str = "<?php |
|
217 | + $this->ensureDirectoryExist($possibleFileName); |
|
218 | + file_put_contents($possibleFileName, $str); |
|
219 | + @chmod($possibleFileName, 0664); |
|
220 | + } |
|
221 | + } |
|
222 | + |
|
223 | + /** |
|
224 | + * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
225 | + * |
|
226 | + * @param string $fileName The file that will be written (without the directory) |
|
227 | + * @param string $className The name of the class |
|
228 | + * @param string $tableName The name of the table |
|
229 | + */ |
|
230 | + public function generateDao($className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
231 | + { |
|
232 | + $tableName = $table->getName(); |
|
233 | + $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
234 | + |
|
235 | + $defaultSort = null; |
|
236 | + foreach ($table->getColumns() as $column) { |
|
237 | + $comments = $column->getComment(); |
|
238 | + $matches = array(); |
|
239 | + if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
240 | + $defaultSort = $data['column_name']; |
|
241 | + if (count($matches == 3)) { |
|
242 | + $defaultSortDirection = $matches[2]; |
|
243 | + } else { |
|
244 | + $defaultSortDirection = 'ASC'; |
|
245 | + } |
|
246 | + } |
|
247 | + } |
|
248 | + |
|
249 | + // FIXME: lowercase tables with _ in the name should work! |
|
250 | + $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
251 | + |
|
252 | + $beanClassWithoutNameSpace = $beanClassName; |
|
253 | + $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
254 | + |
|
255 | + $str = "<?php |
|
256 | 256 | |
257 | 257 | /* |
258 | 258 | * This file has been automatically generated by TDBM. |
@@ -339,9 +339,9 @@ discard block |
||
339 | 339 | } |
340 | 340 | "; |
341 | 341 | |
342 | - if (count($primaryKeyColumns) === 1) { |
|
343 | - $primaryKeyColumn = $primaryKeyColumns[0]; |
|
344 | - $str .= " |
|
342 | + if (count($primaryKeyColumns) === 1) { |
|
343 | + $primaryKeyColumn = $primaryKeyColumns[0]; |
|
344 | + $str .= " |
|
345 | 345 | /** |
346 | 346 | * Get $beanClassWithoutNameSpace specified by its ID (its primary key) |
347 | 347 | * If the primary key does not exist, an exception is thrown. |
@@ -356,8 +356,8 @@ discard block |
||
356 | 356 | return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading); |
357 | 357 | } |
358 | 358 | "; |
359 | - } |
|
360 | - $str .= " |
|
359 | + } |
|
360 | + $str .= " |
|
361 | 361 | /** |
362 | 362 | * Deletes the $beanClassWithoutNameSpace passed in parameter. |
363 | 363 | * |
@@ -415,33 +415,33 @@ discard block |
||
415 | 415 | } |
416 | 416 | "; |
417 | 417 | |
418 | - $str .= ' |
|
418 | + $str .= ' |
|
419 | 419 | } |
420 | 420 | '; |
421 | 421 | |
422 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$baseClassName); |
|
423 | - if (!$possibleBaseFileNames) { |
|
424 | - // @codeCoverageIgnoreStart |
|
425 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
426 | - // @codeCoverageIgnoreEnd |
|
427 | - } |
|
428 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
429 | - |
|
430 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
431 | - file_put_contents($possibleBaseFileName, $str); |
|
432 | - @chmod($possibleBaseFileName, 0664); |
|
433 | - |
|
434 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
435 | - if (!$possibleFileNames) { |
|
436 | - // @codeCoverageIgnoreStart |
|
437 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
438 | - // @codeCoverageIgnoreEnd |
|
439 | - } |
|
440 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
441 | - |
|
442 | - // Now, let's generate the "editable" class |
|
443 | - if (!file_exists($possibleFileName)) { |
|
444 | - $str = "<?php |
|
422 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$baseClassName); |
|
423 | + if (!$possibleBaseFileNames) { |
|
424 | + // @codeCoverageIgnoreStart |
|
425 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
426 | + // @codeCoverageIgnoreEnd |
|
427 | + } |
|
428 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
429 | + |
|
430 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
431 | + file_put_contents($possibleBaseFileName, $str); |
|
432 | + @chmod($possibleBaseFileName, 0664); |
|
433 | + |
|
434 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
435 | + if (!$possibleFileNames) { |
|
436 | + // @codeCoverageIgnoreStart |
|
437 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
438 | + // @codeCoverageIgnoreEnd |
|
439 | + } |
|
440 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
441 | + |
|
442 | + // Now, let's generate the "editable" class |
|
443 | + if (!file_exists($possibleFileName)) { |
|
444 | + $str = "<?php |
|
445 | 445 | |
446 | 446 | /* |
447 | 447 | * This file has been automatically generated by TDBM. |
@@ -458,22 +458,22 @@ discard block |
||
458 | 458 | |
459 | 459 | } |
460 | 460 | "; |
461 | - $this->ensureDirectoryExist($possibleFileName); |
|
462 | - file_put_contents($possibleFileName, $str); |
|
463 | - @chmod($possibleFileName, 0664); |
|
464 | - } |
|
465 | - } |
|
466 | - |
|
467 | - /** |
|
468 | - * Generates the factory bean. |
|
469 | - * |
|
470 | - * @param Table[] $tableList |
|
471 | - */ |
|
472 | - private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
473 | - { |
|
474 | - // For each table, let's write a property. |
|
475 | - |
|
476 | - $str = "<?php |
|
461 | + $this->ensureDirectoryExist($possibleFileName); |
|
462 | + file_put_contents($possibleFileName, $str); |
|
463 | + @chmod($possibleFileName, 0664); |
|
464 | + } |
|
465 | + } |
|
466 | + |
|
467 | + /** |
|
468 | + * Generates the factory bean. |
|
469 | + * |
|
470 | + * @param Table[] $tableList |
|
471 | + */ |
|
472 | + private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
473 | + { |
|
474 | + // For each table, let's write a property. |
|
475 | + |
|
476 | + $str = "<?php |
|
477 | 477 | |
478 | 478 | /* |
479 | 479 | * This file has been automatically generated by TDBM. |
@@ -490,12 +490,12 @@ discard block |
||
490 | 490 | { |
491 | 491 | "; |
492 | 492 | |
493 | - foreach ($tableList as $table) { |
|
494 | - $tableName = $table->getName(); |
|
495 | - $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
496 | - $daoInstanceName = self::toVariableName($daoClassName); |
|
493 | + foreach ($tableList as $table) { |
|
494 | + $tableName = $table->getName(); |
|
495 | + $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
496 | + $daoInstanceName = self::toVariableName($daoClassName); |
|
497 | 497 | |
498 | - $str .= ' /** |
|
498 | + $str .= ' /** |
|
499 | 499 | * @var '.$daoClassName.' |
500 | 500 | */ |
501 | 501 | private $'.$daoInstanceName.'; |
@@ -520,155 +520,155 @@ discard block |
||
520 | 520 | } |
521 | 521 | |
522 | 522 | '; |
523 | - } |
|
523 | + } |
|
524 | 524 | |
525 | - $str .= ' |
|
525 | + $str .= ' |
|
526 | 526 | } |
527 | 527 | '; |
528 | 528 | |
529 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\'.$daoFactoryClassName); |
|
530 | - if (!$possibleFileNames) { |
|
531 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
532 | - } |
|
533 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
534 | - |
|
535 | - $this->ensureDirectoryExist($possibleFileName); |
|
536 | - file_put_contents($possibleFileName, $str); |
|
537 | - @chmod($possibleFileName, 0664); |
|
538 | - } |
|
539 | - |
|
540 | - /** |
|
541 | - * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
542 | - * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
543 | - * |
|
544 | - * @param $str string |
|
545 | - * |
|
546 | - * @return string |
|
547 | - */ |
|
548 | - public static function toCamelCase($str) |
|
549 | - { |
|
550 | - $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
551 | - while (true) { |
|
552 | - if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
553 | - break; |
|
554 | - } |
|
555 | - |
|
556 | - $pos = strpos($str, '_'); |
|
557 | - if ($pos === false) { |
|
558 | - $pos = strpos($str, ' '); |
|
559 | - } |
|
560 | - $before = substr($str, 0, $pos); |
|
561 | - $after = substr($str, $pos + 1); |
|
562 | - $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
563 | - } |
|
564 | - |
|
565 | - return $str; |
|
566 | - } |
|
567 | - |
|
568 | - /** |
|
569 | - * Tries to put string to the singular form (if it is plural). |
|
570 | - * We assume the table names are in english. |
|
571 | - * |
|
572 | - * @param $str string |
|
573 | - * |
|
574 | - * @return string |
|
575 | - */ |
|
576 | - public static function toSingular($str) |
|
577 | - { |
|
578 | - return Inflector::singularize($str); |
|
579 | - } |
|
580 | - |
|
581 | - /** |
|
582 | - * Put the first letter of the string in lower case. |
|
583 | - * Very useful to transform a class name into a variable name. |
|
584 | - * |
|
585 | - * @param $str string |
|
586 | - * |
|
587 | - * @return string |
|
588 | - */ |
|
589 | - public static function toVariableName($str) |
|
590 | - { |
|
591 | - return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
592 | - } |
|
593 | - |
|
594 | - /** |
|
595 | - * Ensures the file passed in parameter can be written in its directory. |
|
596 | - * |
|
597 | - * @param string $fileName |
|
598 | - * |
|
599 | - * @throws TDBMException |
|
600 | - */ |
|
601 | - private function ensureDirectoryExist($fileName) |
|
602 | - { |
|
603 | - $dirName = dirname($fileName); |
|
604 | - if (!file_exists($dirName)) { |
|
605 | - $old = umask(0); |
|
606 | - $result = mkdir($dirName, 0775, true); |
|
607 | - umask($old); |
|
608 | - if ($result === false) { |
|
609 | - throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
610 | - } |
|
611 | - } |
|
612 | - } |
|
613 | - |
|
614 | - /** |
|
615 | - * @param string $rootPath |
|
616 | - */ |
|
617 | - public function setRootPath($rootPath) |
|
618 | - { |
|
619 | - $this->rootPath = $rootPath; |
|
620 | - } |
|
621 | - |
|
622 | - /** |
|
623 | - * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
624 | - * |
|
625 | - * @param Type $type The DBAL type |
|
626 | - * |
|
627 | - * @return string The PHP type |
|
628 | - */ |
|
629 | - public static function dbalTypeToPhpType(Type $type) |
|
630 | - { |
|
631 | - $map = [ |
|
632 | - Type::TARRAY => 'array', |
|
633 | - Type::SIMPLE_ARRAY => 'array', |
|
634 | - Type::JSON_ARRAY => 'array', |
|
635 | - Type::BIGINT => 'string', |
|
636 | - Type::BOOLEAN => 'bool', |
|
637 | - Type::DATETIME => '\DateTimeInterface', |
|
638 | - Type::DATETIMETZ => '\DateTimeInterface', |
|
639 | - Type::DATE => '\DateTimeInterface', |
|
640 | - Type::TIME => '\DateTimeInterface', |
|
641 | - Type::DECIMAL => 'float', |
|
642 | - Type::INTEGER => 'int', |
|
643 | - Type::OBJECT => 'string', |
|
644 | - Type::SMALLINT => 'int', |
|
645 | - Type::STRING => 'string', |
|
646 | - Type::TEXT => 'string', |
|
647 | - Type::BINARY => 'string', |
|
648 | - Type::BLOB => 'string', |
|
649 | - Type::FLOAT => 'float', |
|
650 | - Type::GUID => 'string', |
|
651 | - ]; |
|
652 | - |
|
653 | - return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
654 | - } |
|
655 | - |
|
656 | - /** |
|
657 | - * @param string $beanNamespace |
|
658 | - * |
|
659 | - * @return \string[] Returns a map mapping table name to beans name |
|
660 | - */ |
|
661 | - public function buildTableToBeanMap($beanNamespace) |
|
662 | - { |
|
663 | - $tableToBeanMap = []; |
|
664 | - |
|
665 | - $tables = $this->schema->getTables(); |
|
666 | - |
|
667 | - foreach ($tables as $table) { |
|
668 | - $tableName = $table->getName(); |
|
669 | - $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
670 | - } |
|
671 | - |
|
672 | - return $tableToBeanMap; |
|
673 | - } |
|
529 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\'.$daoFactoryClassName); |
|
530 | + if (!$possibleFileNames) { |
|
531 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
532 | + } |
|
533 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
534 | + |
|
535 | + $this->ensureDirectoryExist($possibleFileName); |
|
536 | + file_put_contents($possibleFileName, $str); |
|
537 | + @chmod($possibleFileName, 0664); |
|
538 | + } |
|
539 | + |
|
540 | + /** |
|
541 | + * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
542 | + * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
543 | + * |
|
544 | + * @param $str string |
|
545 | + * |
|
546 | + * @return string |
|
547 | + */ |
|
548 | + public static function toCamelCase($str) |
|
549 | + { |
|
550 | + $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
551 | + while (true) { |
|
552 | + if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
553 | + break; |
|
554 | + } |
|
555 | + |
|
556 | + $pos = strpos($str, '_'); |
|
557 | + if ($pos === false) { |
|
558 | + $pos = strpos($str, ' '); |
|
559 | + } |
|
560 | + $before = substr($str, 0, $pos); |
|
561 | + $after = substr($str, $pos + 1); |
|
562 | + $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
563 | + } |
|
564 | + |
|
565 | + return $str; |
|
566 | + } |
|
567 | + |
|
568 | + /** |
|
569 | + * Tries to put string to the singular form (if it is plural). |
|
570 | + * We assume the table names are in english. |
|
571 | + * |
|
572 | + * @param $str string |
|
573 | + * |
|
574 | + * @return string |
|
575 | + */ |
|
576 | + public static function toSingular($str) |
|
577 | + { |
|
578 | + return Inflector::singularize($str); |
|
579 | + } |
|
580 | + |
|
581 | + /** |
|
582 | + * Put the first letter of the string in lower case. |
|
583 | + * Very useful to transform a class name into a variable name. |
|
584 | + * |
|
585 | + * @param $str string |
|
586 | + * |
|
587 | + * @return string |
|
588 | + */ |
|
589 | + public static function toVariableName($str) |
|
590 | + { |
|
591 | + return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
592 | + } |
|
593 | + |
|
594 | + /** |
|
595 | + * Ensures the file passed in parameter can be written in its directory. |
|
596 | + * |
|
597 | + * @param string $fileName |
|
598 | + * |
|
599 | + * @throws TDBMException |
|
600 | + */ |
|
601 | + private function ensureDirectoryExist($fileName) |
|
602 | + { |
|
603 | + $dirName = dirname($fileName); |
|
604 | + if (!file_exists($dirName)) { |
|
605 | + $old = umask(0); |
|
606 | + $result = mkdir($dirName, 0775, true); |
|
607 | + umask($old); |
|
608 | + if ($result === false) { |
|
609 | + throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
610 | + } |
|
611 | + } |
|
612 | + } |
|
613 | + |
|
614 | + /** |
|
615 | + * @param string $rootPath |
|
616 | + */ |
|
617 | + public function setRootPath($rootPath) |
|
618 | + { |
|
619 | + $this->rootPath = $rootPath; |
|
620 | + } |
|
621 | + |
|
622 | + /** |
|
623 | + * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
624 | + * |
|
625 | + * @param Type $type The DBAL type |
|
626 | + * |
|
627 | + * @return string The PHP type |
|
628 | + */ |
|
629 | + public static function dbalTypeToPhpType(Type $type) |
|
630 | + { |
|
631 | + $map = [ |
|
632 | + Type::TARRAY => 'array', |
|
633 | + Type::SIMPLE_ARRAY => 'array', |
|
634 | + Type::JSON_ARRAY => 'array', |
|
635 | + Type::BIGINT => 'string', |
|
636 | + Type::BOOLEAN => 'bool', |
|
637 | + Type::DATETIME => '\DateTimeInterface', |
|
638 | + Type::DATETIMETZ => '\DateTimeInterface', |
|
639 | + Type::DATE => '\DateTimeInterface', |
|
640 | + Type::TIME => '\DateTimeInterface', |
|
641 | + Type::DECIMAL => 'float', |
|
642 | + Type::INTEGER => 'int', |
|
643 | + Type::OBJECT => 'string', |
|
644 | + Type::SMALLINT => 'int', |
|
645 | + Type::STRING => 'string', |
|
646 | + Type::TEXT => 'string', |
|
647 | + Type::BINARY => 'string', |
|
648 | + Type::BLOB => 'string', |
|
649 | + Type::FLOAT => 'float', |
|
650 | + Type::GUID => 'string', |
|
651 | + ]; |
|
652 | + |
|
653 | + return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
654 | + } |
|
655 | + |
|
656 | + /** |
|
657 | + * @param string $beanNamespace |
|
658 | + * |
|
659 | + * @return \string[] Returns a map mapping table name to beans name |
|
660 | + */ |
|
661 | + public function buildTableToBeanMap($beanNamespace) |
|
662 | + { |
|
663 | + $tableToBeanMap = []; |
|
664 | + |
|
665 | + $tables = $this->schema->getTables(); |
|
666 | + |
|
667 | + foreach ($tables as $table) { |
|
668 | + $tableName = $table->getName(); |
|
669 | + $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
670 | + } |
|
671 | + |
|
672 | + return $tableToBeanMap; |
|
673 | + } |
|
674 | 674 | } |
@@ -15,214 +15,214 @@ 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 | - //$properties = array_merge($properties, $localProperties); |
|
138 | - } else { |
|
139 | - $properties = $this->getPropertiesForTable($table); |
|
140 | - } |
|
141 | - |
|
142 | - return $properties; |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Returns the list of properties for this table (ignoring parent tables). |
|
147 | - * |
|
148 | - * @param Table $table |
|
149 | - * |
|
150 | - * @return AbstractBeanPropertyDescriptor[] |
|
151 | - */ |
|
152 | - private function getPropertiesForTable(Table $table) |
|
153 | - { |
|
154 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
155 | - if ($parentRelationship) { |
|
156 | - $ignoreColumns = $parentRelationship->getLocalColumns(); |
|
157 | - } else { |
|
158 | - $ignoreColumns = []; |
|
159 | - } |
|
160 | - |
|
161 | - $beanPropertyDescriptors = []; |
|
162 | - |
|
163 | - foreach ($table->getColumns() as $column) { |
|
164 | - if (array_search($column->getName(), $ignoreColumns) !== false) { |
|
165 | - continue; |
|
166 | - } |
|
167 | - |
|
168 | - $fk = $this->isPartOfForeignKey($table, $column); |
|
169 | - if ($fk !== null) { |
|
170 | - // Check that previously added descriptors are not added on same FK (can happen with multi key FK). |
|
171 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
172 | - if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) { |
|
173 | - continue 2; |
|
174 | - } |
|
175 | - } |
|
176 | - // Check that this property is not an inheritance relationship |
|
177 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
178 | - if ($parentRelationship === $fk) { |
|
179 | - continue; |
|
180 | - } |
|
181 | - |
|
182 | - $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer); |
|
183 | - } else { |
|
184 | - $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column); |
|
185 | - } |
|
186 | - } |
|
187 | - |
|
188 | - // Now, let's get the name of all properties and let's check there is no duplicate. |
|
189 | - /** @var $names AbstractBeanPropertyDescriptor[] */ |
|
190 | - $names = []; |
|
191 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
192 | - $name = $beanDescriptor->getUpperCamelCaseName(); |
|
193 | - if (isset($names[$name])) { |
|
194 | - $names[$name]->useAlternativeName(); |
|
195 | - $beanDescriptor->useAlternativeName(); |
|
196 | - } else { |
|
197 | - $names[$name] = $beanDescriptor; |
|
198 | - } |
|
199 | - } |
|
200 | - |
|
201 | - // Final check (throw exceptions if problem arises) |
|
202 | - $names = []; |
|
203 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
204 | - $name = $beanDescriptor->getUpperCamelCaseName(); |
|
205 | - if (isset($names[$name])) { |
|
206 | - throw new TDBMException('Unsolvable name conflict while generating method name'); |
|
207 | - } else { |
|
208 | - $names[$name] = $beanDescriptor; |
|
209 | - } |
|
210 | - } |
|
211 | - |
|
212 | - // Last step, let's rebuild the list with a map: |
|
213 | - $beanPropertyDescriptorsMap = []; |
|
214 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
215 | - $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor; |
|
216 | - } |
|
217 | - |
|
218 | - return $beanPropertyDescriptorsMap; |
|
219 | - } |
|
220 | - |
|
221 | - public function generateBeanConstructor() |
|
222 | - { |
|
223 | - $constructorProperties = $this->getConstructorProperties(); |
|
224 | - |
|
225 | - $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 | + //$properties = array_merge($properties, $localProperties); |
|
138 | + } else { |
|
139 | + $properties = $this->getPropertiesForTable($table); |
|
140 | + } |
|
141 | + |
|
142 | + return $properties; |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Returns the list of properties for this table (ignoring parent tables). |
|
147 | + * |
|
148 | + * @param Table $table |
|
149 | + * |
|
150 | + * @return AbstractBeanPropertyDescriptor[] |
|
151 | + */ |
|
152 | + private function getPropertiesForTable(Table $table) |
|
153 | + { |
|
154 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
155 | + if ($parentRelationship) { |
|
156 | + $ignoreColumns = $parentRelationship->getLocalColumns(); |
|
157 | + } else { |
|
158 | + $ignoreColumns = []; |
|
159 | + } |
|
160 | + |
|
161 | + $beanPropertyDescriptors = []; |
|
162 | + |
|
163 | + foreach ($table->getColumns() as $column) { |
|
164 | + if (array_search($column->getName(), $ignoreColumns) !== false) { |
|
165 | + continue; |
|
166 | + } |
|
167 | + |
|
168 | + $fk = $this->isPartOfForeignKey($table, $column); |
|
169 | + if ($fk !== null) { |
|
170 | + // Check that previously added descriptors are not added on same FK (can happen with multi key FK). |
|
171 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
172 | + if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) { |
|
173 | + continue 2; |
|
174 | + } |
|
175 | + } |
|
176 | + // Check that this property is not an inheritance relationship |
|
177 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
178 | + if ($parentRelationship === $fk) { |
|
179 | + continue; |
|
180 | + } |
|
181 | + |
|
182 | + $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer); |
|
183 | + } else { |
|
184 | + $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column); |
|
185 | + } |
|
186 | + } |
|
187 | + |
|
188 | + // Now, let's get the name of all properties and let's check there is no duplicate. |
|
189 | + /** @var $names AbstractBeanPropertyDescriptor[] */ |
|
190 | + $names = []; |
|
191 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
192 | + $name = $beanDescriptor->getUpperCamelCaseName(); |
|
193 | + if (isset($names[$name])) { |
|
194 | + $names[$name]->useAlternativeName(); |
|
195 | + $beanDescriptor->useAlternativeName(); |
|
196 | + } else { |
|
197 | + $names[$name] = $beanDescriptor; |
|
198 | + } |
|
199 | + } |
|
200 | + |
|
201 | + // Final check (throw exceptions if problem arises) |
|
202 | + $names = []; |
|
203 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
204 | + $name = $beanDescriptor->getUpperCamelCaseName(); |
|
205 | + if (isset($names[$name])) { |
|
206 | + throw new TDBMException('Unsolvable name conflict while generating method name'); |
|
207 | + } else { |
|
208 | + $names[$name] = $beanDescriptor; |
|
209 | + } |
|
210 | + } |
|
211 | + |
|
212 | + // Last step, let's rebuild the list with a map: |
|
213 | + $beanPropertyDescriptorsMap = []; |
|
214 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
215 | + $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor; |
|
216 | + } |
|
217 | + |
|
218 | + return $beanPropertyDescriptorsMap; |
|
219 | + } |
|
220 | + |
|
221 | + public function generateBeanConstructor() |
|
222 | + { |
|
223 | + $constructorProperties = $this->getConstructorProperties(); |
|
224 | + |
|
225 | + $constructorCode = ' /** |
|
226 | 226 | * The constructor takes all compulsory arguments. |
227 | 227 | * |
228 | 228 | %s |
@@ -232,65 +232,65 @@ discard block |
||
232 | 232 | } |
233 | 233 | '; |
234 | 234 | |
235 | - $paramAnnotations = []; |
|
236 | - $arguments = []; |
|
237 | - $assigns = []; |
|
238 | - $parentConstructorArguments = []; |
|
239 | - |
|
240 | - foreach ($constructorProperties as $property) { |
|
241 | - $className = $property->getClassName(); |
|
242 | - if ($className) { |
|
243 | - $arguments[] = $className.' '.$property->getVariableName(); |
|
244 | - } else { |
|
245 | - $arguments[] = $property->getVariableName(); |
|
246 | - } |
|
247 | - $paramAnnotations[] = $property->getParamAnnotation(); |
|
248 | - if ($property->getTable()->getName() === $this->table->getName()) { |
|
249 | - $assigns[] = $property->getConstructorAssignCode(); |
|
250 | - } else { |
|
251 | - $parentConstructorArguments[] = $property->getVariableName(); |
|
252 | - } |
|
253 | - } |
|
254 | - |
|
255 | - $parentConstrutorCode = sprintf(" parent::__construct(%s);\n", implode(', ', $parentConstructorArguments)); |
|
256 | - |
|
257 | - return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstrutorCode, implode("\n", $assigns)); |
|
258 | - } |
|
259 | - |
|
260 | - public function generateDirectForeignKeysCode() |
|
261 | - { |
|
262 | - $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
263 | - |
|
264 | - $fksByTable = []; |
|
265 | - |
|
266 | - foreach ($fks as $fk) { |
|
267 | - $fksByTable[$fk->getLocalTableName()][] = $fk; |
|
268 | - } |
|
269 | - |
|
270 | - /* @var $fksByMethodName ForeignKeyConstraint[] */ |
|
271 | - $fksByMethodName = []; |
|
272 | - |
|
273 | - foreach ($fksByTable as $tableName => $fksForTable) { |
|
274 | - if (count($fksForTable) > 1) { |
|
275 | - foreach ($fksForTable as $fk) { |
|
276 | - $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By'; |
|
277 | - |
|
278 | - $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns()); |
|
279 | - |
|
280 | - $methodName .= implode('And', $camelizedColumns); |
|
281 | - |
|
282 | - $fksByMethodName[$methodName] = $fk; |
|
283 | - } |
|
284 | - } else { |
|
285 | - $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName()); |
|
286 | - $fksByMethodName[$methodName] = $fk; |
|
287 | - } |
|
288 | - } |
|
289 | - |
|
290 | - $code = ''; |
|
291 | - |
|
292 | - foreach ($fksByMethodName as $methodName => $fk) { |
|
293 | - $getterCode = ' /** |
|
235 | + $paramAnnotations = []; |
|
236 | + $arguments = []; |
|
237 | + $assigns = []; |
|
238 | + $parentConstructorArguments = []; |
|
239 | + |
|
240 | + foreach ($constructorProperties as $property) { |
|
241 | + $className = $property->getClassName(); |
|
242 | + if ($className) { |
|
243 | + $arguments[] = $className.' '.$property->getVariableName(); |
|
244 | + } else { |
|
245 | + $arguments[] = $property->getVariableName(); |
|
246 | + } |
|
247 | + $paramAnnotations[] = $property->getParamAnnotation(); |
|
248 | + if ($property->getTable()->getName() === $this->table->getName()) { |
|
249 | + $assigns[] = $property->getConstructorAssignCode(); |
|
250 | + } else { |
|
251 | + $parentConstructorArguments[] = $property->getVariableName(); |
|
252 | + } |
|
253 | + } |
|
254 | + |
|
255 | + $parentConstrutorCode = sprintf(" parent::__construct(%s);\n", implode(', ', $parentConstructorArguments)); |
|
256 | + |
|
257 | + return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstrutorCode, implode("\n", $assigns)); |
|
258 | + } |
|
259 | + |
|
260 | + public function generateDirectForeignKeysCode() |
|
261 | + { |
|
262 | + $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
263 | + |
|
264 | + $fksByTable = []; |
|
265 | + |
|
266 | + foreach ($fks as $fk) { |
|
267 | + $fksByTable[$fk->getLocalTableName()][] = $fk; |
|
268 | + } |
|
269 | + |
|
270 | + /* @var $fksByMethodName ForeignKeyConstraint[] */ |
|
271 | + $fksByMethodName = []; |
|
272 | + |
|
273 | + foreach ($fksByTable as $tableName => $fksForTable) { |
|
274 | + if (count($fksForTable) > 1) { |
|
275 | + foreach ($fksForTable as $fk) { |
|
276 | + $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By'; |
|
277 | + |
|
278 | + $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns()); |
|
279 | + |
|
280 | + $methodName .= implode('And', $camelizedColumns); |
|
281 | + |
|
282 | + $fksByMethodName[$methodName] = $fk; |
|
283 | + } |
|
284 | + } else { |
|
285 | + $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName()); |
|
286 | + $fksByMethodName[$methodName] = $fk; |
|
287 | + } |
|
288 | + } |
|
289 | + |
|
290 | + $code = ''; |
|
291 | + |
|
292 | + foreach ($fksByMethodName as $methodName => $fk) { |
|
293 | + $getterCode = ' /** |
|
294 | 294 | * Returns the list of %s pointing to this bean via the %s column. |
295 | 295 | * |
296 | 296 | * @return %s[]|ResultIterator |
@@ -302,111 +302,111 @@ discard block |
||
302 | 302 | |
303 | 303 | '; |
304 | 304 | |
305 | - list($sql, $parametersCode) = $this->getFilters($fk); |
|
306 | - |
|
307 | - $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
308 | - $code .= sprintf($getterCode, |
|
309 | - $beanClass, |
|
310 | - implode(', ', $fk->getColumns()), |
|
311 | - $beanClass, |
|
312 | - $methodName, |
|
313 | - var_export($fk->getLocalTableName(), true), |
|
314 | - $sql, |
|
315 | - $parametersCode |
|
316 | - ); |
|
317 | - } |
|
318 | - |
|
319 | - return $code; |
|
320 | - } |
|
321 | - |
|
322 | - private function getFilters(ForeignKeyConstraint $fk) |
|
323 | - { |
|
324 | - $sqlParts = []; |
|
325 | - $counter = 0; |
|
326 | - $parameters = []; |
|
327 | - |
|
328 | - $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
329 | - |
|
330 | - foreach ($fk->getLocalColumns() as $columnName) { |
|
331 | - $paramName = 'tdbmparam'.$counter; |
|
332 | - $sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName; |
|
333 | - |
|
334 | - $pkColumn = $pkColumns[$counter]; |
|
335 | - $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true)); |
|
336 | - ++$counter; |
|
337 | - } |
|
338 | - $sql = "'".implode(' AND ', $sqlParts)."'"; |
|
339 | - $parametersCode = '[ '.implode(', ', $parameters).' ]'; |
|
340 | - |
|
341 | - return [$sql, $parametersCode]; |
|
342 | - } |
|
343 | - |
|
344 | - /** |
|
345 | - * Generate code section about pivot tables. |
|
346 | - * |
|
347 | - * @return string; |
|
348 | - */ |
|
349 | - public function generatePivotTableCode() |
|
350 | - { |
|
351 | - $finalDescs = $this->getPivotTableDescriptors(); |
|
352 | - |
|
353 | - $code = ''; |
|
354 | - |
|
355 | - foreach ($finalDescs as $desc) { |
|
356 | - $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']); |
|
357 | - } |
|
358 | - |
|
359 | - return $code; |
|
360 | - } |
|
361 | - |
|
362 | - private function getPivotTableDescriptors() |
|
363 | - { |
|
364 | - $descs = []; |
|
365 | - foreach ($this->schemaAnalyzer->detectJunctionTables() as $table) { |
|
366 | - // There are exactly 2 FKs since this is a pivot table. |
|
367 | - $fks = array_values($table->getForeignKeys()); |
|
368 | - |
|
369 | - if ($fks[0]->getForeignTableName() === $this->table->getName()) { |
|
370 | - $localFK = $fks[0]; |
|
371 | - $remoteFK = $fks[1]; |
|
372 | - } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) { |
|
373 | - $localFK = $fks[1]; |
|
374 | - $remoteFK = $fks[0]; |
|
375 | - } else { |
|
376 | - continue; |
|
377 | - } |
|
378 | - |
|
379 | - $descs[$remoteFK->getForeignTableName()][] = [ |
|
380 | - 'table' => $table, |
|
381 | - 'localFK' => $localFK, |
|
382 | - 'remoteFK' => $remoteFK, |
|
383 | - ]; |
|
384 | - } |
|
385 | - |
|
386 | - $finalDescs = []; |
|
387 | - foreach ($descs as $descArray) { |
|
388 | - if (count($descArray) > 1) { |
|
389 | - foreach ($descArray as $desc) { |
|
390 | - $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName()); |
|
391 | - $finalDescs[] = $desc; |
|
392 | - } |
|
393 | - } else { |
|
394 | - $desc = $descArray[0]; |
|
395 | - $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()); |
|
396 | - $finalDescs[] = $desc; |
|
397 | - } |
|
398 | - } |
|
399 | - |
|
400 | - return $finalDescs; |
|
401 | - } |
|
402 | - |
|
403 | - public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK) |
|
404 | - { |
|
405 | - $singularName = TDBMDaoGenerator::toSingular($name); |
|
406 | - $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
407 | - $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
408 | - |
|
409 | - $str = ' /** |
|
305 | + list($sql, $parametersCode) = $this->getFilters($fk); |
|
306 | + |
|
307 | + $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
308 | + $code .= sprintf($getterCode, |
|
309 | + $beanClass, |
|
310 | + implode(', ', $fk->getColumns()), |
|
311 | + $beanClass, |
|
312 | + $methodName, |
|
313 | + var_export($fk->getLocalTableName(), true), |
|
314 | + $sql, |
|
315 | + $parametersCode |
|
316 | + ); |
|
317 | + } |
|
318 | + |
|
319 | + return $code; |
|
320 | + } |
|
321 | + |
|
322 | + private function getFilters(ForeignKeyConstraint $fk) |
|
323 | + { |
|
324 | + $sqlParts = []; |
|
325 | + $counter = 0; |
|
326 | + $parameters = []; |
|
327 | + |
|
328 | + $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
329 | + |
|
330 | + foreach ($fk->getLocalColumns() as $columnName) { |
|
331 | + $paramName = 'tdbmparam'.$counter; |
|
332 | + $sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName; |
|
333 | + |
|
334 | + $pkColumn = $pkColumns[$counter]; |
|
335 | + $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true)); |
|
336 | + ++$counter; |
|
337 | + } |
|
338 | + $sql = "'".implode(' AND ', $sqlParts)."'"; |
|
339 | + $parametersCode = '[ '.implode(', ', $parameters).' ]'; |
|
340 | + |
|
341 | + return [$sql, $parametersCode]; |
|
342 | + } |
|
343 | + |
|
344 | + /** |
|
345 | + * Generate code section about pivot tables. |
|
346 | + * |
|
347 | + * @return string; |
|
348 | + */ |
|
349 | + public function generatePivotTableCode() |
|
350 | + { |
|
351 | + $finalDescs = $this->getPivotTableDescriptors(); |
|
352 | + |
|
353 | + $code = ''; |
|
354 | + |
|
355 | + foreach ($finalDescs as $desc) { |
|
356 | + $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']); |
|
357 | + } |
|
358 | + |
|
359 | + return $code; |
|
360 | + } |
|
361 | + |
|
362 | + private function getPivotTableDescriptors() |
|
363 | + { |
|
364 | + $descs = []; |
|
365 | + foreach ($this->schemaAnalyzer->detectJunctionTables() as $table) { |
|
366 | + // There are exactly 2 FKs since this is a pivot table. |
|
367 | + $fks = array_values($table->getForeignKeys()); |
|
368 | + |
|
369 | + if ($fks[0]->getForeignTableName() === $this->table->getName()) { |
|
370 | + $localFK = $fks[0]; |
|
371 | + $remoteFK = $fks[1]; |
|
372 | + } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) { |
|
373 | + $localFK = $fks[1]; |
|
374 | + $remoteFK = $fks[0]; |
|
375 | + } else { |
|
376 | + continue; |
|
377 | + } |
|
378 | + |
|
379 | + $descs[$remoteFK->getForeignTableName()][] = [ |
|
380 | + 'table' => $table, |
|
381 | + 'localFK' => $localFK, |
|
382 | + 'remoteFK' => $remoteFK, |
|
383 | + ]; |
|
384 | + } |
|
385 | + |
|
386 | + $finalDescs = []; |
|
387 | + foreach ($descs as $descArray) { |
|
388 | + if (count($descArray) > 1) { |
|
389 | + foreach ($descArray as $desc) { |
|
390 | + $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName()); |
|
391 | + $finalDescs[] = $desc; |
|
392 | + } |
|
393 | + } else { |
|
394 | + $desc = $descArray[0]; |
|
395 | + $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()); |
|
396 | + $finalDescs[] = $desc; |
|
397 | + } |
|
398 | + } |
|
399 | + |
|
400 | + return $finalDescs; |
|
401 | + } |
|
402 | + |
|
403 | + public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK) |
|
404 | + { |
|
405 | + $singularName = TDBMDaoGenerator::toSingular($name); |
|
406 | + $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
407 | + $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
408 | + |
|
409 | + $str = ' /** |
|
410 | 410 | * Returns the list of %s associated to this bean via the %s pivot table. |
411 | 411 | * |
412 | 412 | * @return %s[] |
@@ -416,9 +416,9 @@ discard block |
||
416 | 416 | } |
417 | 417 | '; |
418 | 418 | |
419 | - $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true)); |
|
419 | + $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true)); |
|
420 | 420 | |
421 | - $str = ' /** |
|
421 | + $str = ' /** |
|
422 | 422 | * Adds a relationship with %s associated to this bean via the %s pivot table. |
423 | 423 | * |
424 | 424 | * @param %s %s |
@@ -428,9 +428,9 @@ discard block |
||
428 | 428 | } |
429 | 429 | '; |
430 | 430 | |
431 | - $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
431 | + $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
432 | 432 | |
433 | - $str = ' /** |
|
433 | + $str = ' /** |
|
434 | 434 | * Deletes the relationship with %s associated to this bean via the %s pivot table. |
435 | 435 | * |
436 | 436 | * @param %s %s |
@@ -440,9 +440,9 @@ discard block |
||
440 | 440 | } |
441 | 441 | '; |
442 | 442 | |
443 | - $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
443 | + $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
444 | 444 | |
445 | - $str = ' /** |
|
445 | + $str = ' /** |
|
446 | 446 | * Returns whether this bean is associated with %s via the %s pivot table. |
447 | 447 | * |
448 | 448 | * @param %s %s |
@@ -453,24 +453,24 @@ discard block |
||
453 | 453 | } |
454 | 454 | '; |
455 | 455 | |
456 | - $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
456 | + $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
457 | 457 | |
458 | - $code = $getterCode.$adderCode.$removerCode.$hasCode; |
|
458 | + $code = $getterCode.$adderCode.$removerCode.$hasCode; |
|
459 | 459 | |
460 | - return $code; |
|
461 | - } |
|
460 | + return $code; |
|
461 | + } |
|
462 | 462 | |
463 | - public function generateJsonSerialize() |
|
464 | - { |
|
465 | - $tableName = $this->table->getName(); |
|
466 | - $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
467 | - if ($parentFk !== null) { |
|
468 | - $initializer = '$array = parent::jsonSerialize();'; |
|
469 | - } else { |
|
470 | - $initializer = '$array = [];'; |
|
471 | - } |
|
463 | + public function generateJsonSerialize() |
|
464 | + { |
|
465 | + $tableName = $this->table->getName(); |
|
466 | + $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
467 | + if ($parentFk !== null) { |
|
468 | + $initializer = '$array = parent::jsonSerialize();'; |
|
469 | + } else { |
|
470 | + $initializer = '$array = [];'; |
|
471 | + } |
|
472 | 472 | |
473 | - $str = ' |
|
473 | + $str = ' |
|
474 | 474 | /** |
475 | 475 | * Serializes the object for JSON encoding |
476 | 476 | * |
@@ -486,54 +486,54 @@ discard block |
||
486 | 486 | } |
487 | 487 | '; |
488 | 488 | |
489 | - $propertiesCode = ''; |
|
490 | - foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) { |
|
491 | - $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode(); |
|
492 | - } |
|
489 | + $propertiesCode = ''; |
|
490 | + foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) { |
|
491 | + $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode(); |
|
492 | + } |
|
493 | 493 | |
494 | - // Many to many relationships: |
|
494 | + // Many to many relationships: |
|
495 | 495 | |
496 | - $descs = $this->getPivotTableDescriptors(); |
|
496 | + $descs = $this->getPivotTableDescriptors(); |
|
497 | 497 | |
498 | - $many2manyCode = ''; |
|
498 | + $many2manyCode = ''; |
|
499 | 499 | |
500 | - foreach ($descs as $desc) { |
|
501 | - $remoteFK = $desc['remoteFK']; |
|
502 | - $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
503 | - $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
500 | + foreach ($descs as $desc) { |
|
501 | + $remoteFK = $desc['remoteFK']; |
|
502 | + $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
503 | + $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
504 | 504 | |
505 | - $many2manyCode .= ' if (!$stopRecursion) { |
|
505 | + $many2manyCode .= ' if (!$stopRecursion) { |
|
506 | 506 | $array[\''.lcfirst($desc['name']).'\'] = array_map(function('.$remoteBeanName.' '.$variableName.') { |
507 | 507 | return '.$variableName.'->jsonSerialize(true); |
508 | 508 | }, $this->get'.$desc['name'].'()); |
509 | 509 | } |
510 | 510 | '; |
511 | - } |
|
512 | - |
|
513 | - return sprintf($str, $initializer, $propertiesCode, $many2manyCode); |
|
514 | - } |
|
515 | - |
|
516 | - /** |
|
517 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
518 | - * |
|
519 | - * @param string $beannamespace The namespace of the bean |
|
520 | - */ |
|
521 | - public function generatePhpCode($beannamespace) |
|
522 | - { |
|
523 | - $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($this->table->getName()); |
|
524 | - $className = TDBMDaoGenerator::getBeanNameFromTableName($this->table->getName()); |
|
525 | - $tableName = $this->table->getName(); |
|
526 | - |
|
527 | - $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
528 | - if ($parentFk !== null) { |
|
529 | - $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
530 | - $use = ''; |
|
531 | - } else { |
|
532 | - $extends = 'AbstractTDBMObject'; |
|
533 | - $use = "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n\n"; |
|
534 | - } |
|
535 | - |
|
536 | - $str = "<?php |
|
511 | + } |
|
512 | + |
|
513 | + return sprintf($str, $initializer, $propertiesCode, $many2manyCode); |
|
514 | + } |
|
515 | + |
|
516 | + /** |
|
517 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
518 | + * |
|
519 | + * @param string $beannamespace The namespace of the bean |
|
520 | + */ |
|
521 | + public function generatePhpCode($beannamespace) |
|
522 | + { |
|
523 | + $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($this->table->getName()); |
|
524 | + $className = TDBMDaoGenerator::getBeanNameFromTableName($this->table->getName()); |
|
525 | + $tableName = $this->table->getName(); |
|
526 | + |
|
527 | + $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
528 | + if ($parentFk !== null) { |
|
529 | + $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
530 | + $use = ''; |
|
531 | + } else { |
|
532 | + $extends = 'AbstractTDBMObject'; |
|
533 | + $use = "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n\n"; |
|
534 | + } |
|
535 | + |
|
536 | + $str = "<?php |
|
537 | 537 | namespace {$beannamespace}; |
538 | 538 | |
539 | 539 | use Mouf\\Database\\TDBM\\ResultIterator; |
@@ -551,19 +551,19 @@ discard block |
||
551 | 551 | { |
552 | 552 | "; |
553 | 553 | |
554 | - $str .= $this->generateBeanConstructor(); |
|
554 | + $str .= $this->generateBeanConstructor(); |
|
555 | 555 | |
556 | - foreach ($this->getExposedProperties() as $property) { |
|
557 | - $str .= $property->getGetterSetterCode(); |
|
558 | - } |
|
556 | + foreach ($this->getExposedProperties() as $property) { |
|
557 | + $str .= $property->getGetterSetterCode(); |
|
558 | + } |
|
559 | 559 | |
560 | - $str .= $this->generateDirectForeignKeysCode(); |
|
561 | - $str .= $this->generatePivotTableCode(); |
|
562 | - $str .= $this->generateJsonSerialize(); |
|
560 | + $str .= $this->generateDirectForeignKeysCode(); |
|
561 | + $str .= $this->generatePivotTableCode(); |
|
562 | + $str .= $this->generateJsonSerialize(); |
|
563 | 563 | |
564 | - $str .= '} |
|
564 | + $str .= '} |
|
565 | 565 | '; |
566 | 566 | |
567 | - return $str; |
|
568 | - } |
|
567 | + return $str; |
|
568 | + } |
|
569 | 569 | } |
@@ -12,134 +12,134 @@ discard block |
||
12 | 12 | */ |
13 | 13 | class ObjectBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor |
14 | 14 | { |
15 | - /** |
|
16 | - * @var ForeignKeyConstraint |
|
17 | - */ |
|
18 | - private $foreignKey; |
|
19 | - |
|
20 | - /** |
|
21 | - * @var SchemaAnalyzer |
|
22 | - */ |
|
23 | - private $schemaAnalyzer; |
|
24 | - |
|
25 | - public function __construct(Table $table, ForeignKeyConstraint $foreignKey, SchemaAnalyzer $schemaAnalyzer) |
|
26 | - { |
|
27 | - parent::__construct($table); |
|
28 | - $this->foreignKey = $foreignKey; |
|
29 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
30 | - } |
|
31 | - |
|
32 | - /** |
|
33 | - * Returns the foreignkey the column is part of, if any. null otherwise. |
|
34 | - * |
|
35 | - * @return ForeignKeyConstraint|null |
|
36 | - */ |
|
37 | - public function getForeignKey() |
|
38 | - { |
|
39 | - return $this->foreignKey; |
|
40 | - } |
|
41 | - |
|
42 | - /** |
|
43 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
44 | - * |
|
45 | - * @return null|string |
|
46 | - */ |
|
47 | - public function getClassName() |
|
48 | - { |
|
49 | - return TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
50 | - } |
|
51 | - |
|
52 | - /** |
|
53 | - * Returns the param annotation for this property (useful for constructor). |
|
54 | - * |
|
55 | - * @return string |
|
56 | - */ |
|
57 | - public function getParamAnnotation() |
|
58 | - { |
|
59 | - $str = ' * @param %s %s'; |
|
60 | - |
|
61 | - return sprintf($str, $this->getClassName(), $this->getVariableName()); |
|
62 | - } |
|
63 | - |
|
64 | - public function getUpperCamelCaseName() |
|
65 | - { |
|
66 | - // First, are there many column or only one? |
|
67 | - // If one column, we name the setter after it. Otherwise, we name the setter after the table name |
|
68 | - if (count($this->foreignKey->getLocalColumns()) > 1) { |
|
69 | - $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName())); |
|
70 | - if ($this->alternativeName) { |
|
71 | - $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns()); |
|
72 | - |
|
73 | - $name .= 'By'.implode('And', $camelizedColumns); |
|
74 | - } |
|
75 | - } else { |
|
76 | - $column = $this->foreignKey->getLocalColumns()[0]; |
|
77 | - // Let's remove any _id or id_. |
|
78 | - if (strpos(strtolower($column), 'id_') === 0) { |
|
79 | - $column = substr($column, 3); |
|
80 | - } |
|
81 | - if (strrpos(strtolower($column), '_id') === strlen($column) - 3) { |
|
82 | - $column = substr($column, 0, strlen($column) - 3); |
|
83 | - } |
|
84 | - $name = TDBMDaoGenerator::toCamelCase($column); |
|
85 | - if ($this->alternativeName) { |
|
86 | - $name .= 'Object'; |
|
87 | - } |
|
88 | - } |
|
89 | - |
|
90 | - return $name; |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
95 | - * |
|
96 | - * @return bool |
|
97 | - */ |
|
98 | - public function isCompulsory() |
|
99 | - { |
|
100 | - // Are all columns nullable? |
|
101 | - $localColumnNames = $this->foreignKey->getLocalColumns(); |
|
102 | - |
|
103 | - foreach ($localColumnNames as $name) { |
|
104 | - $column = $this->table->getColumn($name); |
|
105 | - if ($column->getNotnull()) { |
|
106 | - return true; |
|
107 | - } |
|
108 | - } |
|
109 | - |
|
110 | - return false; |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * Returns true if the property is the primary key. |
|
115 | - * |
|
116 | - * @return bool |
|
117 | - */ |
|
118 | - public function isPrimaryKey() |
|
119 | - { |
|
120 | - $fkColumns = $this->foreignKey->getLocalColumns(); |
|
121 | - sort($fkColumns); |
|
122 | - |
|
123 | - $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
124 | - sort($pkColumns); |
|
125 | - |
|
126 | - return $fkColumns == $pkColumns; |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * Returns the PHP code for getters and setters. |
|
131 | - * |
|
132 | - * @return string |
|
133 | - */ |
|
134 | - public function getGetterSetterCode() |
|
135 | - { |
|
136 | - $tableName = $this->table->getName(); |
|
137 | - $getterName = $this->getGetterName(); |
|
138 | - $setterName = $this->getSetterName(); |
|
139 | - |
|
140 | - $referencedBeanName = TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
141 | - |
|
142 | - $str = ' /** |
|
15 | + /** |
|
16 | + * @var ForeignKeyConstraint |
|
17 | + */ |
|
18 | + private $foreignKey; |
|
19 | + |
|
20 | + /** |
|
21 | + * @var SchemaAnalyzer |
|
22 | + */ |
|
23 | + private $schemaAnalyzer; |
|
24 | + |
|
25 | + public function __construct(Table $table, ForeignKeyConstraint $foreignKey, SchemaAnalyzer $schemaAnalyzer) |
|
26 | + { |
|
27 | + parent::__construct($table); |
|
28 | + $this->foreignKey = $foreignKey; |
|
29 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
30 | + } |
|
31 | + |
|
32 | + /** |
|
33 | + * Returns the foreignkey the column is part of, if any. null otherwise. |
|
34 | + * |
|
35 | + * @return ForeignKeyConstraint|null |
|
36 | + */ |
|
37 | + public function getForeignKey() |
|
38 | + { |
|
39 | + return $this->foreignKey; |
|
40 | + } |
|
41 | + |
|
42 | + /** |
|
43 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
44 | + * |
|
45 | + * @return null|string |
|
46 | + */ |
|
47 | + public function getClassName() |
|
48 | + { |
|
49 | + return TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
50 | + } |
|
51 | + |
|
52 | + /** |
|
53 | + * Returns the param annotation for this property (useful for constructor). |
|
54 | + * |
|
55 | + * @return string |
|
56 | + */ |
|
57 | + public function getParamAnnotation() |
|
58 | + { |
|
59 | + $str = ' * @param %s %s'; |
|
60 | + |
|
61 | + return sprintf($str, $this->getClassName(), $this->getVariableName()); |
|
62 | + } |
|
63 | + |
|
64 | + public function getUpperCamelCaseName() |
|
65 | + { |
|
66 | + // First, are there many column or only one? |
|
67 | + // If one column, we name the setter after it. Otherwise, we name the setter after the table name |
|
68 | + if (count($this->foreignKey->getLocalColumns()) > 1) { |
|
69 | + $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName())); |
|
70 | + if ($this->alternativeName) { |
|
71 | + $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns()); |
|
72 | + |
|
73 | + $name .= 'By'.implode('And', $camelizedColumns); |
|
74 | + } |
|
75 | + } else { |
|
76 | + $column = $this->foreignKey->getLocalColumns()[0]; |
|
77 | + // Let's remove any _id or id_. |
|
78 | + if (strpos(strtolower($column), 'id_') === 0) { |
|
79 | + $column = substr($column, 3); |
|
80 | + } |
|
81 | + if (strrpos(strtolower($column), '_id') === strlen($column) - 3) { |
|
82 | + $column = substr($column, 0, strlen($column) - 3); |
|
83 | + } |
|
84 | + $name = TDBMDaoGenerator::toCamelCase($column); |
|
85 | + if ($this->alternativeName) { |
|
86 | + $name .= 'Object'; |
|
87 | + } |
|
88 | + } |
|
89 | + |
|
90 | + return $name; |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
95 | + * |
|
96 | + * @return bool |
|
97 | + */ |
|
98 | + public function isCompulsory() |
|
99 | + { |
|
100 | + // Are all columns nullable? |
|
101 | + $localColumnNames = $this->foreignKey->getLocalColumns(); |
|
102 | + |
|
103 | + foreach ($localColumnNames as $name) { |
|
104 | + $column = $this->table->getColumn($name); |
|
105 | + if ($column->getNotnull()) { |
|
106 | + return true; |
|
107 | + } |
|
108 | + } |
|
109 | + |
|
110 | + return false; |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * Returns true if the property is the primary key. |
|
115 | + * |
|
116 | + * @return bool |
|
117 | + */ |
|
118 | + public function isPrimaryKey() |
|
119 | + { |
|
120 | + $fkColumns = $this->foreignKey->getLocalColumns(); |
|
121 | + sort($fkColumns); |
|
122 | + |
|
123 | + $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
124 | + sort($pkColumns); |
|
125 | + |
|
126 | + return $fkColumns == $pkColumns; |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * Returns the PHP code for getters and setters. |
|
131 | + * |
|
132 | + * @return string |
|
133 | + */ |
|
134 | + public function getGetterSetterCode() |
|
135 | + { |
|
136 | + $tableName = $this->table->getName(); |
|
137 | + $getterName = $this->getGetterName(); |
|
138 | + $setterName = $this->getSetterName(); |
|
139 | + |
|
140 | + $referencedBeanName = TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
141 | + |
|
142 | + $str = ' /** |
|
143 | 143 | * Returns the '.$referencedBeanName.' object bound to this object via the '.implode(' and ', $this->foreignKey->getLocalColumns()).' column. |
144 | 144 | * |
145 | 145 | * @return '.$referencedBeanName.' |
@@ -159,19 +159,19 @@ discard block |
||
159 | 159 | |
160 | 160 | '; |
161 | 161 | |
162 | - return $str; |
|
163 | - } |
|
164 | - |
|
165 | - /** |
|
166 | - * Returns the part of code useful when doing json serialization. |
|
167 | - * |
|
168 | - * @return string |
|
169 | - */ |
|
170 | - public function getJsonSerializeCode() |
|
171 | - { |
|
172 | - return ' if (!$stopRecursion) { |
|
162 | + return $str; |
|
163 | + } |
|
164 | + |
|
165 | + /** |
|
166 | + * Returns the part of code useful when doing json serialization. |
|
167 | + * |
|
168 | + * @return string |
|
169 | + */ |
|
170 | + public function getJsonSerializeCode() |
|
171 | + { |
|
172 | + return ' if (!$stopRecursion) { |
|
173 | 173 | $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName().'()->jsonSerialize(true); |
174 | 174 | } |
175 | 175 | '; |
176 | - } |
|
176 | + } |
|
177 | 177 | } |
@@ -11,100 +11,100 @@ 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 foreignkey the column is part of, if any. null otherwise. |
|
28 | - * |
|
29 | - * @param Column $column |
|
30 | - * |
|
31 | - * @return ForeignKeyConstraint|null |
|
32 | - */ |
|
33 | - public function getForeignKey() |
|
34 | - { |
|
35 | - return false; |
|
36 | - } |
|
37 | - |
|
38 | - /** |
|
39 | - * Returns the param annotation for this property (useful for constructor). |
|
40 | - * |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function getParamAnnotation() |
|
44 | - { |
|
45 | - $className = $this->getClassName(); |
|
46 | - $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType()); |
|
47 | - |
|
48 | - $str = ' * @param %s %s'; |
|
49 | - |
|
50 | - return sprintf($str, $paramType, $this->getVariableName()); |
|
51 | - } |
|
52 | - |
|
53 | - public function getUpperCamelCaseName() |
|
54 | - { |
|
55 | - return TDBMDaoGenerator::toCamelCase($this->column->getName()); |
|
56 | - } |
|
57 | - |
|
58 | - /** |
|
59 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
60 | - * |
|
61 | - * @return null|string |
|
62 | - */ |
|
63 | - public function getClassName() |
|
64 | - { |
|
65 | - return; |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
70 | - * |
|
71 | - * @return bool |
|
72 | - */ |
|
73 | - public function isCompulsory() |
|
74 | - { |
|
75 | - return $this->column->getNotnull() && !$this->column->getAutoincrement(); |
|
76 | - } |
|
77 | - |
|
78 | - /** |
|
79 | - * Returns true if the property is the primary key. |
|
80 | - * |
|
81 | - * @return bool |
|
82 | - */ |
|
83 | - public function isPrimaryKey() |
|
84 | - { |
|
85 | - return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
86 | - } |
|
87 | - |
|
88 | - /** |
|
89 | - * Returns the PHP code for getters and setters. |
|
90 | - * |
|
91 | - * @return string |
|
92 | - */ |
|
93 | - public function getGetterSetterCode() |
|
94 | - { |
|
95 | - $type = $this->column->getType(); |
|
96 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
97 | - |
|
98 | - $columnGetterName = $this->getGetterName(); |
|
99 | - $columnSetterName = $this->getSetterName(); |
|
100 | - |
|
101 | - if ($normalizedType == '\\DateTimeInterface') { |
|
102 | - $castTo = '\\DateTimeInterface '; |
|
103 | - } else { |
|
104 | - $castTo = ''; |
|
105 | - } |
|
106 | - |
|
107 | - $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 foreignkey the column is part of, if any. null otherwise. |
|
28 | + * |
|
29 | + * @param Column $column |
|
30 | + * |
|
31 | + * @return ForeignKeyConstraint|null |
|
32 | + */ |
|
33 | + public function getForeignKey() |
|
34 | + { |
|
35 | + return false; |
|
36 | + } |
|
37 | + |
|
38 | + /** |
|
39 | + * Returns the param annotation for this property (useful for constructor). |
|
40 | + * |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function getParamAnnotation() |
|
44 | + { |
|
45 | + $className = $this->getClassName(); |
|
46 | + $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType()); |
|
47 | + |
|
48 | + $str = ' * @param %s %s'; |
|
49 | + |
|
50 | + return sprintf($str, $paramType, $this->getVariableName()); |
|
51 | + } |
|
52 | + |
|
53 | + public function getUpperCamelCaseName() |
|
54 | + { |
|
55 | + return TDBMDaoGenerator::toCamelCase($this->column->getName()); |
|
56 | + } |
|
57 | + |
|
58 | + /** |
|
59 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
60 | + * |
|
61 | + * @return null|string |
|
62 | + */ |
|
63 | + public function getClassName() |
|
64 | + { |
|
65 | + return; |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
70 | + * |
|
71 | + * @return bool |
|
72 | + */ |
|
73 | + public function isCompulsory() |
|
74 | + { |
|
75 | + return $this->column->getNotnull() && !$this->column->getAutoincrement(); |
|
76 | + } |
|
77 | + |
|
78 | + /** |
|
79 | + * Returns true if the property is the primary key. |
|
80 | + * |
|
81 | + * @return bool |
|
82 | + */ |
|
83 | + public function isPrimaryKey() |
|
84 | + { |
|
85 | + return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
86 | + } |
|
87 | + |
|
88 | + /** |
|
89 | + * Returns the PHP code for getters and setters. |
|
90 | + * |
|
91 | + * @return string |
|
92 | + */ |
|
93 | + public function getGetterSetterCode() |
|
94 | + { |
|
95 | + $type = $this->column->getType(); |
|
96 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
97 | + |
|
98 | + $columnGetterName = $this->getGetterName(); |
|
99 | + $columnSetterName = $this->getSetterName(); |
|
100 | + |
|
101 | + if ($normalizedType == '\\DateTimeInterface') { |
|
102 | + $castTo = '\\DateTimeInterface '; |
|
103 | + } else { |
|
104 | + $castTo = ''; |
|
105 | + } |
|
106 | + |
|
107 | + $getterAndSetterCode = ' /** |
|
108 | 108 | * The getter for the "%s" column. |
109 | 109 | * |
110 | 110 | * @return %s |
@@ -124,40 +124,40 @@ discard block |
||
124 | 124 | |
125 | 125 | '; |
126 | 126 | |
127 | - return sprintf($getterAndSetterCode, |
|
128 | - // Getter |
|
129 | - $this->column->getName(), |
|
130 | - $normalizedType, |
|
131 | - $columnGetterName, |
|
132 | - var_export($this->column->getName(), true), |
|
133 | - var_export($this->table->getName(), true), |
|
134 | - // Setter |
|
135 | - $this->column->getName(), |
|
136 | - $normalizedType, |
|
137 | - $this->column->getName(), |
|
138 | - $columnSetterName, |
|
139 | - $castTo, |
|
140 | - $this->column->getName(), |
|
141 | - var_export($this->column->getName(), true), |
|
142 | - $this->column->getName(), |
|
143 | - var_export($this->table->getName(), true) |
|
144 | - ); |
|
145 | - } |
|
146 | - |
|
147 | - /** |
|
148 | - * Returns the part of code useful when doing json serialization. |
|
149 | - * |
|
150 | - * @return string |
|
151 | - */ |
|
152 | - public function getJsonSerializeCode() |
|
153 | - { |
|
154 | - $type = $this->column->getType(); |
|
155 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
156 | - |
|
157 | - if ($normalizedType == '\\DateTimeInterface') { |
|
158 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."()->format('c');\n"; |
|
159 | - } else { |
|
160 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
161 | - } |
|
162 | - } |
|
127 | + return sprintf($getterAndSetterCode, |
|
128 | + // Getter |
|
129 | + $this->column->getName(), |
|
130 | + $normalizedType, |
|
131 | + $columnGetterName, |
|
132 | + var_export($this->column->getName(), true), |
|
133 | + var_export($this->table->getName(), true), |
|
134 | + // Setter |
|
135 | + $this->column->getName(), |
|
136 | + $normalizedType, |
|
137 | + $this->column->getName(), |
|
138 | + $columnSetterName, |
|
139 | + $castTo, |
|
140 | + $this->column->getName(), |
|
141 | + var_export($this->column->getName(), true), |
|
142 | + $this->column->getName(), |
|
143 | + var_export($this->table->getName(), true) |
|
144 | + ); |
|
145 | + } |
|
146 | + |
|
147 | + /** |
|
148 | + * Returns the part of code useful when doing json serialization. |
|
149 | + * |
|
150 | + * @return string |
|
151 | + */ |
|
152 | + public function getJsonSerializeCode() |
|
153 | + { |
|
154 | + $type = $this->column->getType(); |
|
155 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
156 | + |
|
157 | + if ($normalizedType == '\\DateTimeInterface') { |
|
158 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."()->format('c');\n"; |
|
159 | + } else { |
|
160 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
161 | + } |
|
162 | + } |
|
163 | 163 | } |
@@ -27,100 +27,100 @@ |
||
27 | 27 | */ |
28 | 28 | class InnerResultArray extends InnerResultIterator |
29 | 29 | { |
30 | - /** |
|
31 | - * The list of results already fetched. |
|
32 | - * |
|
33 | - * @var AbstractTDBMObject[] |
|
34 | - */ |
|
35 | - private $results = []; |
|
30 | + /** |
|
31 | + * The list of results already fetched. |
|
32 | + * |
|
33 | + * @var AbstractTDBMObject[] |
|
34 | + */ |
|
35 | + private $results = []; |
|
36 | 36 | |
37 | - /** |
|
38 | - * Whether a offset exists. |
|
39 | - * |
|
40 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
41 | - * |
|
42 | - * @param mixed $offset <p> |
|
43 | - * An offset to check for. |
|
44 | - * </p> |
|
45 | - * |
|
46 | - * @return bool true on success or false on failure. |
|
47 | - * </p> |
|
48 | - * <p> |
|
49 | - * The return value will be casted to boolean if non-boolean was returned. |
|
50 | - * |
|
51 | - * @since 5.0.0 |
|
52 | - */ |
|
53 | - public function offsetExists($offset) |
|
54 | - { |
|
55 | - try { |
|
56 | - $this->toIndex($offset); |
|
57 | - } catch (TDBMInvalidOffsetException $e) { |
|
58 | - return false; |
|
59 | - } |
|
37 | + /** |
|
38 | + * Whether a offset exists. |
|
39 | + * |
|
40 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
41 | + * |
|
42 | + * @param mixed $offset <p> |
|
43 | + * An offset to check for. |
|
44 | + * </p> |
|
45 | + * |
|
46 | + * @return bool true on success or false on failure. |
|
47 | + * </p> |
|
48 | + * <p> |
|
49 | + * The return value will be casted to boolean if non-boolean was returned. |
|
50 | + * |
|
51 | + * @since 5.0.0 |
|
52 | + */ |
|
53 | + public function offsetExists($offset) |
|
54 | + { |
|
55 | + try { |
|
56 | + $this->toIndex($offset); |
|
57 | + } catch (TDBMInvalidOffsetException $e) { |
|
58 | + return false; |
|
59 | + } |
|
60 | 60 | |
61 | - return true; |
|
62 | - } |
|
61 | + return true; |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * Offset to retrieve. |
|
66 | - * |
|
67 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
68 | - * |
|
69 | - * @param mixed $offset <p> |
|
70 | - * The offset to retrieve. |
|
71 | - * </p> |
|
72 | - * |
|
73 | - * @return mixed Can return all value types. |
|
74 | - * |
|
75 | - * @since 5.0.0 |
|
76 | - */ |
|
77 | - public function offsetGet($offset) |
|
78 | - { |
|
79 | - $this->toIndex($offset); |
|
64 | + /** |
|
65 | + * Offset to retrieve. |
|
66 | + * |
|
67 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
68 | + * |
|
69 | + * @param mixed $offset <p> |
|
70 | + * The offset to retrieve. |
|
71 | + * </p> |
|
72 | + * |
|
73 | + * @return mixed Can return all value types. |
|
74 | + * |
|
75 | + * @since 5.0.0 |
|
76 | + */ |
|
77 | + public function offsetGet($offset) |
|
78 | + { |
|
79 | + $this->toIndex($offset); |
|
80 | 80 | |
81 | - return $this->results[$offset]; |
|
82 | - } |
|
81 | + return $this->results[$offset]; |
|
82 | + } |
|
83 | 83 | |
84 | - private function toIndex($offset) |
|
85 | - { |
|
86 | - if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) { |
|
87 | - throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.'); |
|
88 | - } |
|
89 | - if ($this->statement === null) { |
|
90 | - $this->executeQuery(); |
|
91 | - } |
|
92 | - while (!isset($this->results[$offset])) { |
|
93 | - $this->next(); |
|
94 | - if ($this->current === null) { |
|
95 | - throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.'); |
|
96 | - } |
|
97 | - } |
|
98 | - } |
|
84 | + private function toIndex($offset) |
|
85 | + { |
|
86 | + if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) { |
|
87 | + throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.'); |
|
88 | + } |
|
89 | + if ($this->statement === null) { |
|
90 | + $this->executeQuery(); |
|
91 | + } |
|
92 | + while (!isset($this->results[$offset])) { |
|
93 | + $this->next(); |
|
94 | + if ($this->current === null) { |
|
95 | + throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.'); |
|
96 | + } |
|
97 | + } |
|
98 | + } |
|
99 | 99 | |
100 | - public function next() |
|
101 | - { |
|
102 | - // Let's overload the next() method to store the result. |
|
103 | - if (isset($this->results[$this->key + 1])) { |
|
104 | - ++$this->key; |
|
105 | - $this->current = $this->results[$this->key]; |
|
106 | - } else { |
|
107 | - parent::next(); |
|
108 | - if ($this->current !== null) { |
|
109 | - $this->results[$this->key] = $this->current; |
|
110 | - } |
|
111 | - } |
|
112 | - } |
|
100 | + public function next() |
|
101 | + { |
|
102 | + // Let's overload the next() method to store the result. |
|
103 | + if (isset($this->results[$this->key + 1])) { |
|
104 | + ++$this->key; |
|
105 | + $this->current = $this->results[$this->key]; |
|
106 | + } else { |
|
107 | + parent::next(); |
|
108 | + if ($this->current !== null) { |
|
109 | + $this->results[$this->key] = $this->current; |
|
110 | + } |
|
111 | + } |
|
112 | + } |
|
113 | 113 | |
114 | - /** |
|
115 | - * Overloads the rewind implementation. |
|
116 | - * Do not reexecute the query. |
|
117 | - */ |
|
118 | - public function rewind() |
|
119 | - { |
|
120 | - if (!$this->fetchStarted) { |
|
121 | - $this->executeQuery(); |
|
122 | - } |
|
123 | - $this->key = -1; |
|
124 | - $this->next(); |
|
125 | - } |
|
114 | + /** |
|
115 | + * Overloads the rewind implementation. |
|
116 | + * Do not reexecute the query. |
|
117 | + */ |
|
118 | + public function rewind() |
|
119 | + { |
|
120 | + if (!$this->fetchStarted) { |
|
121 | + $this->executeQuery(); |
|
122 | + } |
|
123 | + $this->key = -1; |
|
124 | + $this->next(); |
|
125 | + } |
|
126 | 126 | } |
@@ -27,10 +27,10 @@ |
||
27 | 27 | */ |
28 | 28 | final class TDBMObjectStateEnum extends AbstractTDBMObject |
29 | 29 | { |
30 | - const STATE_DETACHED = 'detached'; |
|
31 | - const STATE_NEW = 'new'; |
|
32 | - const STATE_NOT_LOADED = 'not loaded'; |
|
33 | - const STATE_LOADED = 'loaded'; |
|
34 | - const STATE_DIRTY = 'dirty'; |
|
35 | - const STATE_DELETED = 'deleted'; |
|
30 | + const STATE_DETACHED = 'detached'; |
|
31 | + const STATE_NEW = 'new'; |
|
32 | + const STATE_NOT_LOADED = 'not loaded'; |
|
33 | + const STATE_LOADED = 'loaded'; |
|
34 | + const STATE_DIRTY = 'dirty'; |
|
35 | + const STATE_DELETED = 'deleted'; |
|
36 | 36 | } |
@@ -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\" with ID \"".$this->TDBMObject_id.'".'); |
|
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\" with ID \"".$this->TDBMObject_id.'".'); |
|
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 = null; |
|
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 = null; |
|
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 | } |