flack /
midgard-portable
| Total Complexity | 57 |
| Total Lines | 275 |
| Duplicated Lines | 0 % |
| Coverage | 77.72% |
| Changes | 17 | ||
| Bugs | 2 | Features | 1 |
Complex classes like subscriber often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use subscriber, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 27 | class subscriber implements EventSubscriber |
||
| 28 | { |
||
| 29 | const ACTION_NONE = 0; |
||
| 30 | const ACTION_DELETE = 1; |
||
| 31 | const ACTION_PURGE = 2; |
||
| 32 | const ACTION_CREATE = 3; |
||
| 33 | const ACTION_UPDATE = 4; |
||
| 34 | |||
| 35 | 116 | public function onFlush(OnFlushEventArgs $args) |
|
| 36 | { |
||
| 37 | 116 | $em = $args->getEntityManager(); |
|
| 38 | 116 | $uow = $em->getUnitOfWork(); |
|
| 39 | |||
| 40 | 116 | foreach ($uow->getScheduledEntityInsertions() as $entity) { |
|
| 41 | 116 | $this->on_create($entity, $em); |
|
| 42 | 116 | } |
|
| 43 | |||
| 44 | 116 | foreach ($uow->getScheduledEntityUpdates() as $entity) { |
|
| 45 | 40 | $this->on_update($entity, $em); |
|
| 46 | 116 | } |
|
| 47 | |||
| 48 | 116 | foreach ($uow->getScheduledEntityDeletions() as $entity) { |
|
| 49 | 18 | $this->on_remove($entity, $em); |
|
| 50 | 116 | } |
|
| 51 | 116 | } |
|
| 52 | |||
| 53 | 116 | private function on_create(dbobject $entity, EntityManagerInterface $em) |
|
| 54 | { |
||
| 55 | 116 | $cm = $em->getClassMetadata(get_class($entity)); |
|
| 56 | 116 | if (!($entity instanceof repligard)) { |
|
| 57 | 116 | if (empty($entity->guid)) { |
|
|
Bug
Best Practice
introduced
by
|
|||
| 58 | 103 | $entity->set_guid(connection::generate_guid()); |
|
| 59 | 103 | $em->getUnitOfWork()->recomputeSingleEntityChangeSet($cm, $entity); |
|
| 60 | 103 | } |
|
| 61 | |||
| 62 | 116 | $om = new objectmanager($em); |
|
| 63 | 116 | $repligard_cm = $em->getClassMetadata('midgard:midgard_repligard'); |
|
| 64 | 116 | $repligard_entry = $om->new_instance($repligard_cm->getName()); |
|
| 65 | 116 | $repligard_entry->typename = $cm->getReflectionClass()->getShortName(); |
|
| 66 | 116 | $repligard_entry->guid = $entity->guid; |
|
| 67 | 116 | $repligard_entry->object_action = self::ACTION_CREATE; |
|
| 68 | 116 | $em->persist($repligard_entry); |
|
| 69 | 116 | $em->getUnitOfWork()->computeChangeSet($repligard_cm, $repligard_entry); |
|
| 70 | 116 | } |
|
| 71 | |||
| 72 | 116 | if ($entity instanceof metadata) { |
|
| 73 | 98 | $entity->metadata->created = new \midgard_datetime(); |
|
| 74 | // we copy here instead of creating a new, because otherwise we might have |
||
| 75 | // a one second difference if the code runs at the right millisecond |
||
| 76 | 98 | $entity->metadata->revised = $entity->metadata->created; |
|
| 77 | 98 | if ($user = connection::get_user()) { |
|
| 78 | 7 | $entity->metadata_creator = $user->person; |
|
| 79 | 7 | $entity->metadata_revisor = $user->person; |
|
| 80 | 7 | } |
|
| 81 | 98 | $entity->metadata->size = $this->calculate_size($cm, $entity); |
|
| 82 | 98 | $em->getUnitOfWork()->recomputeSingleEntityChangeSet($cm, $entity); |
|
| 83 | 98 | } |
|
| 84 | 116 | } |
|
| 85 | |||
| 86 | 40 | private function on_update(dbobject $entity, EntityManagerInterface $em) |
|
| 87 | { |
||
| 88 | 40 | if ($entity instanceof repligard) { |
|
| 89 | return; |
||
| 90 | } |
||
| 91 | 40 | $check_repligard = true; |
|
| 92 | 40 | $deleted = false; |
|
| 93 | 40 | if ($entity instanceof metadata) { |
|
| 94 | 39 | $deleted = $entity->{metadata::DELETED_FIELD}; |
|
| 95 | 39 | $cs = $em->getUnitOfWork()->getEntityChangeSet($entity); |
|
| 96 | // We only need to update repligard if we're coming from create (revision 0) |
||
| 97 | // or if we delete/undelete |
||
| 98 | 39 | if ( !array_key_exists('metadata_deleted', $cs) |
|
| 99 | 39 | && $entity->metadata_revision > 0) { |
|
| 100 | 4 | $check_repligard = false; |
|
| 101 | 4 | } |
|
| 102 | |||
| 103 | 39 | $create_revision = true; |
|
| 104 | 39 | if (array_key_exists('metadata_locked', $cs)) { |
|
| 105 | 37 | $lock_fields = array_flip(['metadata_locked', 'metadata_islocked', 'metadata_locker']); |
|
| 106 | 37 | $create_revision = !empty(array_diff_key($cs, $lock_fields)); |
|
| 107 | 37 | } |
|
| 108 | |||
| 109 | 39 | if ($create_revision) { |
|
| 110 | 38 | $cm = $em->getClassMetadata(get_class($entity)); |
|
| 111 | 38 | $entity->metadata_revised = new \midgard_datetime(); |
|
| 112 | 38 | $entity->metadata_revision++; |
|
| 113 | 38 | if ($user = connection::get_user()) { |
|
| 114 | 6 | $entity->metadata_revisor = $user->person; |
|
| 115 | 6 | } |
|
| 116 | 38 | $entity->metadata->size = $this->calculate_size($cm, $entity); |
|
| 117 | 38 | $em->getUnitOfWork()->recomputeSingleEntityChangeSet($cm, $entity); |
|
| 118 | 38 | } |
|
| 119 | 39 | } |
|
| 120 | |||
| 121 | 40 | if ($check_repligard) { |
|
| 122 | 40 | $repligard_entry = $em->getRepository('midgard:midgard_repligard')->findOneBy(['guid' => $entity->guid]); |
|
| 123 | |||
| 124 | 40 | if ($deleted) { |
|
| 125 | 27 | $repligard_entry->object_action = self::ACTION_DELETE; |
|
| 126 | 27 | } else { |
|
| 127 | 21 | $repligard_entry->object_action = self::ACTION_UPDATE; |
|
| 128 | } |
||
| 129 | 40 | $em->persist($repligard_entry); |
|
| 130 | 40 | $em->getUnitOfWork()->computeChangeSet($em->getClassMetadata('midgard:midgard_repligard'), $repligard_entry); |
|
| 131 | 40 | } |
|
| 132 | 40 | } |
|
| 133 | |||
| 134 | 18 | private function on_remove(dbobject $entity, EntityManagerInterface $em) |
|
| 135 | { |
||
| 136 | 18 | if (!($entity instanceof repligard)) { |
|
| 137 | 18 | $repligard_entry = $em->getRepository('midgard:midgard_repligard')->findOneBy(['guid' => $entity->guid]); |
|
| 138 | 18 | if (empty($repligard_entry)) { |
|
| 139 | connection::log()->error('No repligard entry found for GUID ' . $entity->guid); |
||
| 140 | } else { |
||
| 141 | 18 | $repligard_entry->object_action = self::ACTION_PURGE; |
|
| 142 | 18 | $em->persist($repligard_entry); |
|
| 143 | 18 | $em->getUnitOfWork()->computeChangeSet($em->getClassMetadata('midgard:midgard_repligard'), $repligard_entry); |
|
| 144 | } |
||
| 145 | 18 | } |
|
| 146 | 18 | } |
|
| 147 | |||
| 148 | 98 | private function calculate_size(ClassMetadata $cm, metadata $entity) |
|
| 149 | { |
||
| 150 | 98 | $size = 0; |
|
| 151 | 98 | foreach ($cm->getAssociationNames() as $name) { |
|
| 152 | 94 | $size += strlen($entity->$name); |
|
| 153 | 98 | } |
|
| 154 | 98 | foreach ($cm->getFieldNames() as $name) { |
|
| 155 | 98 | $size += strlen($entity->$name); |
|
| 156 | 98 | } |
|
| 157 | 98 | return $size; |
|
| 158 | } |
||
| 159 | |||
| 160 | 7 | public function onSchemaCreateTable(SchemaCreateTableEventArgs $args) |
|
| 241 | } |
||
| 242 | } |
||
| 243 | 6 | } |
|
| 244 | |||
| 245 | /** |
||
| 246 | * This function contains workarounds for reading existing Midgard databases |
||
| 247 | * |
||
| 248 | * ENUM fields are converted to string for now (Like in the XML reader) |
||
| 249 | * DATETIME files use our custom datetime type |
||
| 250 | */ |
||
| 251 | 2 | public function onSchemaColumnDefinition(SchemaColumnDefinitionEventArgs $args) |
|
| 252 | { |
||
| 253 | 2 | $column = array_change_key_case($args->getTableColumn(), CASE_LOWER); |
|
| 254 | 2 | $type = strtok($column['type'], '()'); |
|
| 255 | |||
| 256 | 2 | if ($type == 'enum') { |
|
| 257 | $options = [ |
||
| 258 | 'length' => 255, |
||
| 259 | 'default' => $column['default'] ?? null, |
||
| 260 | 'notnull' => $column['null'] != 'YES', |
||
| 261 | 'comment' => $column['type'] |
||
| 262 | ]; |
||
| 263 | |||
| 264 | $args->preventDefault(); |
||
| 265 | $args->setColumn(new Column($column['field'], Type::getType(Type::STRING), $options)); |
||
| 266 | 2 | } elseif ($type == 'datetime') { |
|
| 267 | $options = [ |
||
| 268 | 'default' => $column['default'] ?? null, |
||
| 269 | 'notnull' => $column['null'] != 'YES', |
||
| 270 | ]; |
||
| 271 | |||
| 272 | $args->preventDefault(); |
||
| 273 | $args->setColumn(new Column($column['field'], Type::getType(datetime::TYPE), $options)); |
||
| 274 | } |
||
| 275 | 2 | } |
|
| 276 | |||
| 277 | /** |
||
| 278 | * This is mostly a workaround for the fact that SchemaTool wants to create FKs on |
||
| 279 | * each run since it doesn't detect that MyISAM tables don't support them |
||
| 280 | * |
||
| 281 | * @see http://www.doctrine-project.org/jira/browse/DDC-3460 |
||
| 282 | * @param GenerateSchemaTableEventArgs $args |
||
| 283 | */ |
||
| 284 | 4 | public function postGenerateSchemaTable(GenerateSchemaTableEventArgs $args) |
|
| 285 | { |
||
| 286 | 4 | $table = $args->getClassTable(); |
|
| 287 | 4 | if ( !$table->hasOption('engine') |
|
| 288 | 4 | || $table->getOption('engine') !== 'MyISAM') { |
|
| 289 | return; |
||
| 290 | } |
||
| 291 | 4 | foreach ($table->getForeignKeys() as $key) { |
|
| 292 | 3 | $table->removeForeignKey($key->getName()); |
|
| 293 | 4 | } |
|
| 294 | 4 | } |
|
| 295 | |||
| 296 | 10 | public function getSubscribedEvents() |
|
| 302 | 10 | ]; |
|
| 303 | } |
||
| 304 | } |
||
| 305 |
Loading history...
