How to generate docs for custom date classes?

[joelstein]

Versions:

• ide-helper Version: 3.6.0
• Laravel Version: 12.28.1
• PHP Version: 8.4.12

Question:

I have a custom class that extends Carbon. For example:

namespace App\Services;

use Carbon\CarbonImmutable;

class Date extends CarbonImmutable
{
    public function local(): self
    {
        return $this->setTimezone('America/Chicago')->locale('en_US');
    }
}

I then instruct the Date facade to use this class when constructing new dates:

Date::useClass(App\Services\Date::class);

How can I help laravel-ide-helper generate docs for my custom class?

[mfn]

It actually is supposed to figure this out, see this code

laravel-ide-helper/src/Console/ModelsCommand.php

Lines 192 to 194 in 53854ea

	$this->dateClass = class_exists(\Illuminate\Support\Facades\Date::class)
	? '\\' . get_class(\Illuminate\Support\Facades\Date::now())
	: '\Illuminate\Support\Carbon';

It uses the very same facade, creates a ::now() and gets the class from it.

Haven't used it in a long time with custom classes, but you can see this test tests/Console/ModelsCommand/CustomDate/Test.php.

• Do you initialize it "early" enough so ide-helper can see your custom class already?
• do you maybe have a specific cast on your property, preventing this? Possibly you are not supposed to use immutable_*, because that's hardcoded to \Carbon\CarbonImmutable

HTH

[joelstein]

Thank you. This package is correctly finding my Date class and using it on things like model properties:

/**
 * @property \App\Services\Date $created_at
 */
class User extends Model {}

I am registering the custom class in AppServiceProvider::boot().

However, VS Code doesn't recognize the methods in my custom class, and I was trying to figure out how to fix this. I don't see any generated docs for my custom class in _ide_helper.php.

Make sense?

[mfn]

You need to use an appropriate VS code plugin for such support.

ide-helper already generated the correct code.