Upgrade to ^2.0 causes doctrine id fields to suggest removing the type

[gnat42]

We upgraded from phpstan 1.X to 2.X and received many many more errors that 1.X reporting. One of the common ones is that it suggests removing the type from ID fields. For example an int field is designated as ?int $id.

---

Line CoreDomain/Settlement/Matter/Application.php

---

42 Property NS\CoreDomain\Settlement\Matter\Application::$id (int|null)
is never assigned int so it can be removed from the property type.
🪪 property.unusedType

How do we fix this? Is there something we need to change in the configuration between v1-v2?

[ondrejmirtes]

Please show the code with the entity that reports this + output of vendor/bin/phpstan diagnose.

[gnat42]

Sure thing! One thing to note is although diagnose says php 8.4 this also happens on 8.3

Note: Using configuration file /home/gnat/Projects/Web/prolegis/phpstan.neon.
PHP runtime version: 8.4.10
PHP composer.json required version: 8.3-8.4.99
PHP version for analysis: 8.4.10 (from runtime)

PHPStan version: 2.1.19
PHPStan running from:
/home/gnat/Projects/Web/prolegis/vendor/phpstan/phpstan

Extension installer: Not installed

Included configs from Composer packages:
phpstan/phpstan-symfony (extension.neon): 2.0.7
phpstan/phpstan-doctrine (extension.neon): 2.0.4
phpstan/phpstan-symfony (rules.neon): 2.0.7

Discovered Composer project root:
/home/gnat/Projects/Web/prolegis

Symfony's consoleApplicationLoader: No

Doctrine's objectManagerLoader: No
Installed Doctrine packages:
doctrine/dbal: 3.10.0
doctrine/orm: 2.20.5
doctrine/common: 3.5.0
doctrine/collections: 2.3.0
doctrine/persistence: 3.4.0

The class isn't particularly interesting (this is happening with all the entities)

<?php declare(strict_types=1);

namespace NS\CoreDomain\Settlement\Matter;

use InvalidArgumentException;
use RuntimeException;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use NS\CoreDomain\Firm\Client;
use NS\CoreDomain\Firm\Firm;
use NS\CoreDomain\Firm\Matter;
use NS\CoreDomain\Firm\MatterTargetInterface;
use NS\CoreDomain\Firm\User;
use NS\CoreDomain\Payment\BCRound;
use NS\CoreDomain\Settlement\Document\SettlementDocument;
use NS\CoreDomain\Settlement\Document\SupportDocumentRequest;

class Application implements MatterTargetInterface
{
    public const string
        FILE_INITIATED = 'File Initiated',
        PENDING_REVIEW = 'Pending Review',
        ADDITIONAL_OR_AMENDED_DOCS_REQUIRED = 'Additional or Amended Documents Required',
        REVIEW_COMPLETED = 'Review Completed',
        PENDING_CLIENT_AUTHORIZATION = 'Pending Client Authorization',
        READY_TO_FUND = 'Ready to Fund',
        CANCELLED = 'Cancelled',
        AWAITING_DOCUMENTATION = 'Awaiting for Documentation',
        INACTIVE = 'Inactive',
        FUNDING_SCHEDULED = 'Funding Scheduled',

        PAYFREQ_WEEKLY = 'Weekly',
        PAYFREQ_BIWEEKLY = 'Bi-Weekly',
        PAYFREQ_SEMIMONTHLY = 'Semi-Monthly',
        PAYFREQ_MONTHLY = 'Monthly',
        PAYFREQ_QUARTERLY = 'Quarterly',
        PAYFREQ_SEMIANNUALLY = 'Semi-Annually',
        PAYFREQ_ANNUALLY = 'Annually',

        CALCULATION_BLENDED = 'Blended',
        CALCULATION_INTEREST_ONLY = 'Interest Only';

    private ?int $id = null;
    private Firm $firm;
    private Matter $matter;
//.... More properties...
    public const int
        SEND_DOC_STATUS_NA = 0,
        SEND_DOC_STATUS_REQUESTED = 1,
        SEND_DOC_STATUS_PROCESSING = 2,
        SEND_DOC_STATUS_COMPLETE = 3,
        SEND_DOC_STATUS_FAILED = 4;

    private ?User $mortgageCreator = null;

    public function __construct(Matter $matter, User $fileOwner)
    {
        $this->firm                    = $matter->getFirm();
        $this->matter                  = $matter;
        $this->matterNumber            = $matter->getNumber();
        $this->fileOwner               = $fileOwner;
        $this->properties              = new ArrayCollection();
        $this->lenders                 = new ArrayCollection();
        $this->supportDocumentsRequest = new ArrayCollection();
        $this->jurisdiction            = $matter->getJurisdiction() ?? 'AB';
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getFirm(): Firm
    {
        return $this->firm;
    }

    public function getMatter(): Matter
    {
        return $this->matter;
    }

    public function getMatterNumber(): string
    {
        return $this->matterNumber;
    }
//.... more methods ... nothing related to the id
}

Mapping

<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
                          https://www.doctrine-project.org/schemas/orm/doctrine-mapping.xsd">
    <entity name="NS\CoreDomain\Settlement\Matter\Application" table="nsst_matters" repository-class="NS\CoreDomain\Settlement\Repository\ApplicationRepository">
        <unique-constraints>
            <unique-constraint columns="firm_id,matterNumber" name="settlement_firm_matter_idx"/>
        </unique-constraints>
        <id name="id" type="integer">
            <generator strategy="IDENTITY"/>
        </id>
        <field name="matterNumber" type="string" length="64"/>
        <field name="status" type="string" length="64"/>
        <field name="jurisdiction" type="string" length="64"/>

        <field name="closingDate" type="datetime" />
        <field name="fundingMethod" type="string" nullable="true"/>

        <field name="faceValueOfMortgage" type="string" nullable="true" />
        <field name="interestRate" type="string" nullable="true" />
        <field name="calculationMethod" type="string" nullable="true" />
        <field name="compoundingFrequency" type="string" nullable="true" />
        <field name="amortizationYears" type="string" nullable="true" />
        <field name="amortizationMonths" type="string" nullable="true" />
        <field name="paymentFrequency" type="string" nullable="true" />
        <field name="interestAdjustmentDate" type="datetime" nullable="true" />
        <field name="firstPaymentDate" type="datetime" nullable="true" />
        <field name="mortgageMaturityDate" type="datetime" nullable="true" />
        <field name="balloonPayment" type="string" nullable="true" />

        <field name="borrowerFees" type="boolean" nullable="true" />
        <field name="nsfLateFee" type="string" nullable="true" />
        <field name="renewalFee" type="string" nullable="true" />
        <field name="dischargeFee" type="string" nullable="true" />
        <field name="prepaymentPenaltyFee" type="integer" nullable="true" />
        <field name="prepaymentPenaltyFeeValue" type="string" nullable="true" />
        <field name="otherFees" type="text" nullable="true" />

        <field name="mtgPaymentInstitutionNumber" type="string" nullable="true" />
        <field name="mtgPaymentTransitNumber" type="string" nullable="true" />
        <field name="mtgPaymentAccountNumber" type="string" nullable="true" />
        <field name="readOnly" type="boolean" nullable="true" />

        <many-to-one field="firm" target-entity="NS\CoreDomain\Firm\Firm">
            <join-columns>
                <join-column name="firm_id" nullable="false" on-delete="CASCADE"/>
            </join-columns>
        </many-to-one>
        <many-to-one field="fileOwner" target-entity="NS\CoreDomain\Firm\User">
            <join-columns>
                <join-column name="file_owner_id" nullable="true" />
            </join-columns>
        </many-to-one>
        <many-to-one field="lawyer" target-entity="NS\CoreDomain\Firm\User">
            <join-columns>
                <join-column name="lawyer_id" nullable="true" />
            </join-columns>
        </many-to-one>
        <many-to-one field="broker" target-entity="NS\CoreDomain\Firm\User">
            <join-columns>
                <join-column name="broker_id" nullable="true" />
            </join-columns>
        </many-to-one>
        <many-to-one field="mortgageCreator" target-entity="NS\CoreDomain\Firm\User">
            <join-columns>
                <join-column name="mortgage_creator_id" nullable="true" />
            </join-columns>
        </many-to-one>

        <one-to-one field="matter" target-entity="NS\CoreDomain\Firm\Matter" orphan-removal="false">
            <cascade><cascade-persist/></cascade>
        </one-to-one>
        <one-to-many field="properties" target-entity="NS\CoreDomain\Settlement\Matter\Property" mapped-by="application" orphan-removal="true">
            <cascade><cascade-persist/></cascade>
        </one-to-many>
        <one-to-many field="lenders" target-entity="NS\CoreDomain\Settlement\Matter\LenderDetails" mapped-by="application" orphan-removal="true">
            <cascade><cascade-persist/></cascade>
        </one-to-many>
        <one-to-one field="mortgageDocument" target-entity="NS\CoreDomain\Settlement\Document\SettlementDocument">
            <cascade><cascade-persist/></cascade>
            <join-columns>
                <join-column name="mortgageDocument_id" on-delete="SET NULL" nullable="true"/>
            </join-columns>
        </one-to-one>
        <one-to-one field="paymentAuthorizationFormDocument" target-entity="NS\CoreDomain\Settlement\Document\SettlementDocument">
            <cascade><cascade-persist/></cascade>
            <join-columns>
                <join-column name="paymentAuthorizationFormDocument_id" on-delete="SET NULL" nullable="true"/>
            </join-columns>
        </one-to-one>

        <one-to-one field="borrowersVoidChequeDocument" target-entity="NS\CoreDomain\Settlement\Document\SettlementDocument">
            <cascade><cascade-persist/></cascade>
            <join-columns>
                <join-column name="borrowersVoidChequeDocument_id" on-delete="SET NULL" nullable="true"/>
            </join-columns>
        </one-to-one>

        <one-to-one field="lawFirmVoidChequeDocument" target-entity="NS\CoreDomain\Settlement\Document\SettlementDocument">
            <cascade><cascade-persist/></cascade>
            <join-columns>
                <join-column name="lawFirmVoidChequeDocument_id" on-delete="SET NULL" nullable="true"/>
            </join-columns>
        </one-to-one>

        <one-to-one field="corporateSearchDocument" target-entity="NS\CoreDomain\Settlement\Document\SettlementDocument">
            <cascade><cascade-persist/></cascade>
            <join-columns>
                <join-column name="corporateSearchDocument_id" on-delete="SET NULL" nullable="true"/>
            </join-columns>
        </one-to-one>

        <one-to-many field="supportDocumentsRequest" target-entity="NS\CoreDomain\Settlement\Document\SupportDocumentRequest" mapped-by="application" orphan-removal="true">
            <cascade><cascade-persist/></cascade>
        </one-to-many>
    </entity>
</doctrine-mapping>

[gnat42]

Hmm, it looks like adding the

  doctrine:
    objectManagerLoader: tests/object-manager.php

config to phpstan fixes the issue. I'm not sure if that's required (it didn't need it with phpstan 1.0). However if this is expected behaviour feel free to close this as user error.

[ondrejmirtes]

Yes, without it we can't read the mapping 😊