delboy1978uk / bone-doctrine

src/Traits/HasDeletedAtDate.php

<?php

declare(strict_types=1);

namespace Bone\BoneDoctrine\Traits;

use DateTimeImmutable;
use DateTimeInterface;
use DateTimeZone;
use Doctrine\ORM\Mapping as ORM;

#[ORM\HasLifecycleCallbacks]
trait HasDeletedAtDate
{
    #[ORM\Column(type: 'datetime_immutable', nullable:true)]
    private ?DateTimeImmutable $deletedAt = null;

    public function getDeletedAt(): DateTimeInterface
    {
        return $this->deletedAt;

The expression return $this->deletedAt could return the type null which is incompatible with the type-hinted return DateTimeInterface. Consider adding an additional type-check to rule them out.

    }

    #[ORM\PreUpdate]
    public function setDeletedAt(): void
    {
        $this->deletedAt = new DateTimeImmutable('now', new DateTimeZone('UTC'));
    }
}