chamilo /
chamilo-lms
| Total Complexity | 43 |
| Total Lines | 252 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like Version20251020121000 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 Version20251020121000, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 18 | final class Version20251020121000 extends AbstractMigrationChamilo |
||
| 19 | { |
||
| 20 | private const DEBUG = true; |
||
| 21 | |||
| 22 | public function getDescription(): string |
||
| 23 | { |
||
| 24 | return 'Migrate gradebook certificates from PersonalFile into resource-based storage; delete PersonalFile only after a successful migration.'; |
||
| 25 | } |
||
| 26 | |||
| 27 | public function up(Schema $schema): void |
||
| 28 | { |
||
| 29 | /** @var GradebookCertificateRepository $certRepo */ |
||
| 30 | $certRepo = $this->container->get(GradebookCertificateRepository::class); |
||
|
|
|||
| 31 | /** @var PersonalFileRepository $personalRepo */ |
||
| 32 | $personalRepo = $this->container->get(PersonalFileRepository::class); |
||
| 33 | /** @var ResourceNodeRepository $rnRepo */ |
||
| 34 | $rnRepo = $this->container->get(ResourceNodeRepository::class); |
||
| 35 | |||
| 36 | $em = $this->entityManager; |
||
| 37 | |||
| 38 | // missing resource node but having a legacy path. |
||
| 39 | $dql = 'SELECT gc |
||
| 40 | FROM Chamilo\CoreBundle\Entity\GradebookCertificate gc |
||
| 41 | WHERE gc.resourceNode IS NULL |
||
| 42 | AND gc.pathCertificate IS NOT NULL |
||
| 43 | AND gc.pathCertificate <> :empty |
||
| 44 | ORDER BY gc.id ASC'; |
||
| 45 | |||
| 46 | $q = $em->createQuery($dql)->setParameter('empty', ''); |
||
| 47 | |||
| 48 | $migrated = 0; |
||
| 49 | $skipped = 0; |
||
| 50 | $errors = 0; |
||
| 51 | |||
| 52 | foreach ($q->toIterable() as $gc) { |
||
| 53 | \assert($gc instanceof GradebookCertificate); |
||
| 54 | |||
| 55 | $user = $gc->getUser(); |
||
| 56 | $userId = (int) $user->getId(); |
||
| 57 | $catId = $gc->getCategory() ? (int) $gc->getCategory()->getId() : 0; |
||
| 58 | $score = (float) $gc->getScoreCertificate(); |
||
| 59 | $path = (string) ($gc->getPathCertificate() ?? ''); |
||
| 60 | |||
| 61 | // Find the legacy PersonalFile (robust title search + optional creator-scope search). |
||
| 62 | $pf = $this->findLegacyPersonalFile($personalRepo, $gc); |
||
| 63 | if (!$pf) { |
||
| 64 | $this->dbg(sprintf( |
||
| 65 | '[skip] gc#%d user=%d cat=%d -> legacy PersonalFile not found for "%s"', |
||
| 66 | (int) $gc->getId(), $userId, $catId, $path |
||
| 67 | )); |
||
| 68 | $skipped++; |
||
| 69 | continue; |
||
| 70 | } |
||
| 71 | |||
| 72 | // Read the legacy HTML (robust strategy). |
||
| 73 | $html = $this->readLegacyHtml($personalRepo, $rnRepo, $pf); |
||
| 74 | if (!is_string($html) || $html === '') { |
||
| 75 | $this->dbg(sprintf( |
||
| 76 | '[error] gc#%d user=%d cat=%d -> failed to read legacy HTML content from PF (title="%s")', |
||
| 77 | (int) $gc->getId(), $userId, $catId, (string) $pf->getTitle() |
||
| 78 | )); |
||
| 79 | $errors++; |
||
| 80 | continue; |
||
| 81 | } |
||
| 82 | |||
| 83 | try { |
||
| 84 | // Move to Resource (resource type "files") |
||
| 85 | $cert = $certRepo->upsertCertificateResource($catId, $userId, $score, $html, null); |
||
| 86 | |||
| 87 | // Remove legacy PF only after a successful migration |
||
| 88 | $em->remove($pf); |
||
| 89 | $em->flush(); |
||
| 90 | $em->clear(); |
||
| 91 | |||
| 92 | $migrated++; |
||
| 93 | $this->dbg(sprintf( |
||
| 94 | '[ok] gc#%d user=%d cat=%d -> migrated to resource (cert id=%d) and removed PF "%s"', |
||
| 95 | (int) $gc->getId(), $userId, $catId, (int) $cert->getId(), (string) $pf->getTitle() |
||
| 96 | )); |
||
| 97 | } catch (\Throwable $e) { |
||
| 98 | $this->dbg(sprintf( |
||
| 99 | '[error] gc#%d user=%d cat=%d -> upsert failed: %s', |
||
| 100 | (int) $gc->getId(), $userId, $catId, $e->getMessage() |
||
| 101 | )); |
||
| 102 | $errors++; |
||
| 103 | // Do not remove PF on failure |
||
| 104 | } |
||
| 105 | } |
||
| 106 | |||
| 107 | $summary = sprintf('Summary: migrated=%d skipped=%d errors=%d', $migrated, $skipped, $errors); |
||
| 108 | $this->write("\n".$summary."\n"); |
||
| 109 | $this->dbg($summary); |
||
| 110 | } |
||
| 111 | |||
| 112 | /** |
||
| 113 | * Run outside a single big transaction so we can flush/clear per item. |
||
| 114 | */ |
||
| 115 | public function isTransactional(): bool |
||
| 116 | { |
||
| 117 | return false; |
||
| 118 | } |
||
| 119 | |||
| 120 | /** |
||
| 121 | * Debug helper: send messages to PHP error_log only when DEBUG is enabled. |
||
| 122 | */ |
||
| 123 | private function dbg(string $message): void |
||
| 124 | { |
||
| 125 | if (self::DEBUG) { |
||
| 126 | error_log('[CERT MIGRATION] '.$message); |
||
| 127 | } |
||
| 128 | } |
||
| 129 | |||
| 130 | /** |
||
| 131 | * Try to locate the PersonalFile using common title variants and (if available) |
||
| 132 | * a creator-scoped lookup to reduce ambiguity. |
||
| 133 | */ |
||
| 134 | private function findLegacyPersonalFile( |
||
| 135 | PersonalFileRepository $personalRepo, |
||
| 136 | GradebookCertificate $gc |
||
| 137 | ): ?PersonalFile { |
||
| 138 | $title = (string) ($gc->getPathCertificate() ?? ''); |
||
| 139 | if ($title === '') { |
||
| 140 | return null; |
||
| 141 | } |
||
| 142 | |||
| 143 | $variants = [$title]; |
||
| 144 | |||
| 145 | // With and without a leading slash |
||
| 146 | if ($title[0] !== '/') { |
||
| 147 | $variants[] = '/'.$title; |
||
| 148 | } |
||
| 149 | |||
| 150 | // Also try by basename (in case a full path was stored) |
||
| 151 | $base = \basename($title); |
||
| 152 | if ($base !== $title) { |
||
| 153 | $variants[] = $base; |
||
| 154 | } |
||
| 155 | |||
| 156 | // Also try with/without ".html" |
||
| 157 | $noExt = preg_replace('/\.html$/i', '', $base); |
||
| 158 | if ($noExt && $noExt !== $base) { |
||
| 159 | $variants[] = $noExt; |
||
| 160 | } elseif ($base !== '' && stripos($base, '.html') === false) { |
||
| 161 | $variants[] = $base.'.html'; |
||
| 162 | } |
||
| 163 | |||
| 164 | foreach (array_unique($variants) as $v) { |
||
| 165 | $found = $personalRepo->findOneBy(['title' => $v]); |
||
| 166 | if ($found instanceof PersonalFile) { |
||
| 167 | return $found; |
||
| 168 | } |
||
| 169 | } |
||
| 170 | |||
| 171 | // search by creator scope if the helper exists |
||
| 172 | $user = $gc->getUser(); |
||
| 173 | if (\method_exists($personalRepo, 'getResourceByCreatorFromTitle')) { |
||
| 174 | try { |
||
| 175 | $candidate = $personalRepo->getResourceByCreatorFromTitle( |
||
| 176 | $base !== '' ? $base : $title, |
||
| 177 | $user, |
||
| 178 | $user->getResourceNode() |
||
| 179 | ); |
||
| 180 | if ($candidate instanceof PersonalFile) { |
||
| 181 | return $candidate; |
||
| 182 | } |
||
| 183 | } catch (\Throwable $e) { |
||
| 184 | $this->dbg('Creator-scoped PF lookup failed: '.$e->getMessage()); |
||
| 185 | } |
||
| 186 | } |
||
| 187 | |||
| 188 | return null; |
||
| 189 | } |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Read HTML from PersonalFile |
||
| 193 | */ |
||
| 194 | private function readLegacyHtml( |
||
| 270 | } |
||
| 271 | } |
||
| 272 |
Loading history...
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.
This is most likely a typographical error or the method has been renamed.