thecodingmachine / DBFaker

src/Generators/DateIntervalGenerator.php

<?php
namespace DBFaker\Generators;

use Faker\Factory;
use Faker\Generator;

class DateIntervalGenerator implements FakeDataGeneratorInterface
{

    /**
     * @var Generator
     */
    private $faker;

    /**
     * ComplexObjectGenerator constructor.
     * @param bool $generateUniqueValues
     */
    public function __construct(bool $generateUniqueValues = false)
    {
        $this->faker = Factory::create();
        if ($generateUniqueValues) {
            $this->faker->unique();
        }
    }

    /**
     * @return \DateInterval
     */
    public function __invoke() : \DateInterval
    {
        return $this->faker->dateTime->diff($this->faker->dateTime);

The expression return $this->faker->dateTime->diff($this->faker->dateTime) could return the type false which is incompatible with the type-hinted return DateInterval. Consider adding an additional type-check to rule them out.

    }
}