>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3619212. --> Reported by: [mably](https://www.drupal.org/user/3375160) Related to !52 >>> <p>Alpha5 closed two naming passes and both missed the same thing, because both went looking for shapes I had already thought of. This pass enumerated instead, and counted against core rather than judging: all 425 methods, all 65 declared types, plus every constant, property, base field, config key, service id, route name, permission, plugin id, enum case and local variable.</p> <p>The public accessor surface was in good shape, and one measurement was not.</p> <h3>Core names its non-public methods verb-first. Kessai did not.</h3> <p>Counting distinct private and protected method names, core is 76.0 percent verb-led, 1897 of 2497. In core's own test classes it is 83.2 percent. Kessai was <strong>31.8 percent</strong> in production and <strong>2.5 percent</strong> in tests. The module was full of methods named after what they return rather than what they do: <code class="language-php">paymentStorage()</code>, <code class="language-php">refundStorage()</code>, <code class="language-php">latestToken()</code>, <code class="language-php">sessionMinutes()</code>, <code class="language-php">webhookSecret()</code>, and in the tests a <code class="language-php">payment()</code> helper in nine separate classes.</p> <p>They now say what they do, taking the verb from each method's own docblock summary, which had it right all along: <code class="language-php">getPaymentStorage()</code>, <code class="language-php">getRefundStorage()</code>, <code class="language-php">findExistingPayment()</code>, <code class="language-php">loadGateway()</code>, <code class="language-php">resolveApiSecret()</code>, <code class="language-php">buildReturnUrl()</code>, <code class="language-php">formatResponseErrors()</code>, <code class="language-php">createPayment()</code>. After the change kessai is <strong>78.8 percent</strong> in production and <strong>82.9 percent</strong> in tests, which is core's own ratio in both.</p> <p>80 identifiers move: 77 method names, one class and two local variables, across 44 files. 67 of the methods are private and 4 are protected, so all but 6 of them are invisible from outside the module. Nothing changes behavior.</p> <h3>The abstract entity was missing core's suffix</h3> <p>Alpha5 introduced <code class="language-php">Drupal\kessai\Entity\Movement</code> as the abstract parent of the claim, refund and reversal entities. 337 of core's 383 abstract classes end in <code class="language-php">Base</code>, 88 percent, and the entity ones are exactly this pattern: <code class="language-php">EntityBase</code>, <code class="language-php">ContentEntityBase</code>, <code class="language-php">ConfigEntityBase</code>. It becomes <code class="language-php">MovementBase</code>. <code class="language-php">MovementInterface</code> keeps its name, because core suffixes the class and not the interface.</p> <h3>The public methods that read as nouns</h3> <ul> <li><code class="language-php">PaymentManagerInterface::tokenPaymentsQuery()</code> becomes <code class="language-php">getTokenPaymentsQuery()</code>. The only one on an <code class="language-php">@api</code> interface. Core splits evenly on the shape, 19 <code class="language-php">get*Query</code> against 18 <code class="language-php">build*Query</code>, so the tie breaks on core's <code class="language-php">getBaseQuery()</code> and on the module's other accessors all being <code class="language-php">get</code>.</li> <li><code class="language-php">PaymentHandoffController::handoffUrl()</code> becomes <code class="language-php">getHandoffUrl()</code>. Core has 139 <code class="language-php">get*Url</code> methods against 8 <code class="language-php">build*Url</code>, and no noun-only static returning a URL at all.</li> <li><code class="language-php">handoffToken()</code>, <code class="language-php">checkoutToken()</code> and <code class="language-php">returnToken()</code> become <code class="language-php">getHandoffToken()</code>, <code class="language-php">getCheckoutToken()</code> and <code class="language-php">getReturnToken()</code>. Core has 4 <code class="language-php">get*Token</code> and no <code class="language-php">build*Token</code>.</li> <li><code class="language-php">MovementBase::describeFields()</code> becomes <code class="language-php">getFieldDescriptions()</code>, and <code class="language-php">StubGateway::callCount()</code> becomes <code class="language-php">getCallCount()</code>.</li> </ul> <p><code class="language-php">PaymentStorageSchema::indexes()</code> becomes <code class="language-php">getIndexes()</code>. It is a documented extension seam, so the rename reaches the architecture guide and the test stub that overrides it, not just the declaration.</p> <h3>Four things the enumeration turned up that were not about verbs</h3> <ul> <li>A method name carried a British spelling: the test helper <code class="language-php">paymentsCancelling()</code>, now <code class="language-php">buildCancelingPaymentsClient()</code>. Core spells it with one L.</li> <li>Two local variables were camelCase, which Drupal reserves for class properties: <code class="language-php">$hostedInput</code> and <code class="language-php">$paymentHandler</code> are now snake_case. Every other camelCase name in the module is a real property, and phpcs never flagged these.</li> <li>A docblock documented a property that does not exist. <code class="language-php">SessionGateway</code> told the reader to set <code class="language-php">$reconcileCaptures</code>, which was renamed to <code class="language-php">$outcome</code> at some point without the prose following.</li> <li>Two docblock summaries contradicted their own method. One said "Builds" on a getter; the other said "Mints", a word core never uses, for a method that derives a reproducible HMAC. A third, <code class="language-php">derive()</code>, was verb-led but said nothing about what it derives, and is now <code class="language-php">deriveKey()</code>; core never uses a bare <code class="language-php">derive()</code> either, always a qualified one like <code class="language-php">deriveContextsFromRoute()</code>.</li> </ul> <h3>The nine methods that keep a non-verb name, and why</h3> <p>These were each checked against core and kept, so a later pass does not undo them.</p> <ul> <li><code class="language-php">amountMatches()</code>, <code class="language-php">cardExpiresBeforeDeadline()</code> and <code class="language-php">checkoutReturnMatches()</code> read as a subject followed by a verb rather than as <code class="language-php">is</code> or <code class="language-php">has</code>. Core does the same in <code class="language-php">tableExists()</code>, <code class="language-php">indexExists()</code>, <code class="language-php">fieldExists()</code> and <code class="language-php">themeExists()</code>.</li> <li><code class="language-php">baseFieldDefinitions()</code> and <code class="language-php">tearDown()</code> are core's own signatures, and <code class="language-php">entityTypeAlter()</code> is named after the hook it implements. Core spells the hook methods this module implements exactly as this module does: <code class="language-php">cron()</code> 15 times, <code class="language-php">entityTypeAlter()</code> 26 times, and <code class="language-php">runtime()</code> 13 times against 3 for <code class="language-php">runtimeRequirements()</code>.</li> <li><code class="language-php">onPaymentEvent()</code> is an event listener, which core prefixes with <code class="language-php">on</code>.</li> <li><code class="language-php">PaymentDeadline::siteDefault()</code> is a named constructor, the shape of <code class="language-php">AccessResult::allowed()</code>.</li> <li><code class="language-php">RecordingAuditTrail::event()</code> implements <code class="language-php">AuditTrailInterface</code> from the audit_trail module. It is not ours to rename.</li> </ul> <p>Three more were considered and kept for reasons that are not about shape. <code class="language-php">ReconcileOutcome</code> would be <code class="language-php">ReconciliationOutcome</code> under core's noun-phrase pattern for enums, but core uses <code class="language-php">reconcile</code> and <code class="language-php">reconciled</code> and never once <code class="language-php">reconciliation</code>, so taking the shape means inventing a word form core does not have. <code class="language-php">PaymentOperationKey::forCapture()</code> and its siblings stay because core has no static named this way and also no class of this shape, and <code class="language-php">createForCapture()</code> would promise an object from a method returning a string.</p> <h3>What this costs</h3> <p>Nothing stored changes. Entity type ids, base tables, columns, config keys and event names are all untouched, so this needs no reinstall on its own account.</p> <p>Three call sites outside kessai move, one line each, and yoyaku and orchestra carry them inside their own renaming issues.</p> <p>AI-Generated: Yes (Claude Code was used to run the audit, gather the core counts, draft this summary and write the renames on the merge request. I reviewed and ran the work myself before posting it.)</p>