IntervalDayComponentAsTotal

warning native off by default quick-fix

Group: Probable bugs

Detect a DateInterval produced by diff whose format consists solely of %d when the opt-in contract requires total elapsed days.

Example

Before

<?php
$start=new DateTimeImmutable(); $end=new DateTimeImmutable(); $days=$start->diff($end)->format('%d');

After fix

<?php
$start=new DateTimeImmutable(); $end=new DateTimeImmutable(); $days=$start->diff($end)->format('%a');

Reported:

• line 2: Use total days instead of the day component.

Detection

• Report a DateInterval produced by diff whose format consists solely of %d when the opt-in contract requires total elapsed days.
• Resolve builtin calls and named arguments before checking the contract. Project-local callees are considered only when their bodies or immutable summaries establish the required facts. The default is disabled; enable only when the stated intent matches the application.
• For flow-dependent conditions, require a reachable source-to-use path with no intervening invalidation. Unknown calls, ambiguous aliases, recursion or analysis-budget exhaustion cannot establish definite facts.

Exceptions (no report)

• Other interval origins, formats describing components with years/months, %a and unknown receivers are excluded.
• Unresolved targets, incomplete required facts, suppressed findings and PHP versions lacking the referenced API or language feature produce no report. User declarations shadowing builtin names are not builtin contracts.

Fix

Replace the sole %d token with %a for a diff-derived interval under this opt-in total-days contract.

A fix is offered only when the concrete prerequisites above are proven. Edits use exact source byte ranges, preserve comments and argument evaluation order, and introduce syntax supported by the configured PHP version. Never invent error-handling policy.

PHP versions

Apply only on PHP versions supporting the referenced APIs and syntax (within PHP 5.3–8.5). Builtin behavior and argument contracts follow the configured PHP version. Extension-specific calls require resolved extension API symbols; do not treat same-named application functions as extension calls.

Options

None. Enable or disable this rule through normal rule configuration.

Configure

In custos.json:

{
  "rules": {
    "IntervalDayComponentAsTotal": {
      "enabled": true
    }
  }
}

Suppress

Before the statement or declaration (or the first statement of the file):

// @custos-ignore IntervalDayComponentAsTotal