[Request] Support overriding methods

[hailwood]

I want to be able to specify what model in particular something like Auth::user() returns, to do this I was hoping I could just add a couple of lines to the config file:

'Auth' => array(
    'user' => 'User::__construct'
)

This kind of works, in that the method is generated successfully, however this means we now have two user methods in the helper under auth instead of just the more explicit one.

[barryvdh]

What do you think would be the best? Add a phpdoc that the function should use?

[danielboendergaard]

I think just overriding the return type would be sufficient.

[Anahkiasen]

Any news on this ? Would make Auth::user() usable.

[barryvdh]

Hmm haven't really had much time to work on this. I started working in the dev branch to make things a bit more easy to change, so I'll hope to add some more functionality soon.

[barryvdh]

Closing in favor of #93

[barryvdh]

Can you try with the latest dev-master?

[gonzalom]

Hi,

I've been researching...

For Laravel version 5.2 and barryvdh/laravel-ide-helper version 2.2.2

The Auth Facade is defined here:
https://laravel.com/api/5.2/Illuminate/Auth/AuthServiceProvider.html
https://github.com/illuminate/auth/blob/5.2/AuthServiceProvider.php

But it also uses the guard

In the generator, the Auth driver ide helper is defined here:
https://github.com/barryvdh/laravel-ide-helper/blob/v2.2.2/src/Generator.php#L123

As I have more than one guard, I don't have a default one.

In my generator, by default, it only include the class "\Illuminate\Auth\AuthManager" methods.

So I had to implement all of them, and this is how I did it:

For the interfaces, we have to do it with the methods, one by one:

<?php
return [
    'magic' => array(
        /**
         * @see https://laravel.com/docs/5.2/authentication
         * @see https://laravel.com/api/5.2/Illuminate/Auth.html
         * @see \Illuminate\Auth\AuthServiceProvider
         * @see \Illuminate\Auth\AuthManager::__call
         * @see \Illuminate\Contracts\Auth\Guard
         * @see \Illuminate\Contracts\Auth\StatefulGuard
         */
        'Auth' => [
            'check'     => 'Illuminate\Contracts\Auth\Guard::check',
            'guest'     => 'Illuminate\Contracts\Auth\Guard::guest',
            'user'      => 'Illuminate\Contracts\Auth\Guard::user',
            'id'        => 'Illuminate\Contracts\Auth\Guard::id',
            'validate'  => 'Illuminate\Contracts\Auth\Guard::validate',
            'setUser'   => 'Illuminate\Contracts\Auth\Guard::setUser',
            // 'attempt'       => 'Illuminate\Contracts\Auth\StatefulGuard::attempt',
            // 'once'          => 'Illuminate\Contracts\Auth\StatefulGuard::once',
            // 'login'         => 'Illuminate\Contracts\Auth\StatefulGuard::login',
            // 'loginUsingId'  => 'Illuminate\Contracts\Auth\StatefulGuard::loginUsingId',
            // 'onceUsingId'   => 'Illuminate\Contracts\Auth\StatefulGuard::onceUsingId',
            // 'viaRemember'   => 'Illuminate\Contracts\Auth\StatefulGuard::viaRemember',
            // 'logout'        => 'Illuminate\Contracts\Auth\StatefulGuard::logout',
        ],
    ),
];

Illuminate\Contracts\Auth\Guard is always used, as all the Guards are implementing it.

For the classes, we can add just the class:

<?php
return [
    'extra' => array(
        /**
         * The auth settings are defined in config/auth.php
         * 
         * \Illuminate\Auth\AuthManager already added by default
         * @see \Illuminate\Auth\AuthServiceProvider::registerAuthenticator()
         * @see \Illuminate\Auth\AuthManager
         * 
         * \Illuminate\Auth\RequestGuard is not a supported guard driver.
         * @see \Illuminate\Auth\AuthManager::viaRequest()
         * @see \Illuminate\Auth\RequestGuard
         *
         * Supported: "session", "token"
         * @see \Illuminate\Auth\AuthManager::resolve()
         * @see \Illuminate\Auth\AuthManager::createSessionDriver()
         * @see \Illuminate\Auth\AuthManager::createTokenDriver()
         * @see \Illuminate\Auth\SessionGuard
         * @see \Illuminate\Auth\TokenGuard
         */
        'Auth' => [
            // \Illuminate\Auth\SessionGuard::class,
            // \Illuminate\Auth\TokenGuard::class,
        ],
    ),
];

Now you can uncomment the ones you are using...

If it is an interface method, it will point to the interface itself, but if the method is not in any interface, it will point to the class. This way, if it could use more than one class, it's not forced to point to one only class in every part in your code.

If you are using just API, you may want to use just:

<?php
return [
    'extra' => array(
        'Auth' => [\Illuminate\Auth\TokenGuard::class],
    ),
];

If you are using just Website, you may want to use just:

<?php
return [
    'extra' => array(
        'Auth' => [\Illuminate\Auth\SessionGuard::class],
    ),
];

If you are using both:

<?php
return [

    'extra' => array(
        /**
         * The auth settings are defined in config/auth.php
         * 
         * \Illuminate\Auth\AuthManager already added by default
         * @see \Illuminate\Auth\AuthServiceProvider::registerAuthenticator()
         * @see \Illuminate\Auth\AuthManager
         * 
         * \Illuminate\Auth\RequestGuard is not a supported guard driver.
         * @see \Illuminate\Auth\AuthManager::viaRequest()
         * @see \Illuminate\Auth\RequestGuard
         *
         * Supported: "session", "token"
         * @see \Illuminate\Auth\AuthManager::resolve()
         * @see \Illuminate\Auth\AuthManager::createSessionDriver()
         * @see \Illuminate\Auth\AuthManager::createTokenDriver()
         * @see \Illuminate\Auth\SessionGuard
         * @see \Illuminate\Auth\TokenGuard
         */
        'Auth' => [
             \Illuminate\Auth\SessionGuard::class,
             \Illuminate\Auth\TokenGuard::class,
        ],
    ),

    'magic' => array(
        /**
         * @see https://laravel.com/docs/5.2/authentication
         * @see https://laravel.com/api/5.2/Illuminate/Auth.html
         * @see \Illuminate\Auth\AuthServiceProvider
         * @see \Illuminate\Auth\AuthManager::__call
         * @see \Illuminate\Contracts\Auth\Guard
         * @see \Illuminate\Contracts\Auth\StatefulGuard
         */
        'Auth' => [
            'check'     => 'Illuminate\Contracts\Auth\Guard::check',
            'guest'     => 'Illuminate\Contracts\Auth\Guard::guest',
            'user'      => 'Illuminate\Contracts\Auth\Guard::user',
            'id'        => 'Illuminate\Contracts\Auth\Guard::id',
            'validate'  => 'Illuminate\Contracts\Auth\Guard::validate',
            'setUser'   => 'Illuminate\Contracts\Auth\Guard::setUser',
            'attempt'       => 'Illuminate\Contracts\Auth\StatefulGuard::attempt',
            'once'          => 'Illuminate\Contracts\Auth\StatefulGuard::once',
            'login'         => 'Illuminate\Contracts\Auth\StatefulGuard::login',
            'loginUsingId'  => 'Illuminate\Contracts\Auth\StatefulGuard::loginUsingId',
            'onceUsingId'   => 'Illuminate\Contracts\Auth\StatefulGuard::onceUsingId',
            'viaRemember'   => 'Illuminate\Contracts\Auth\StatefulGuard::viaRemember',
            'logout'        => 'Illuminate\Contracts\Auth\StatefulGuard::logout',
        ],
    ),

];