Зачем нужен двойной return при использовании $this в контроллере Laravel?

Question

[jazzus]

Пробую использовать $this-> в контроллерах Laravel. Пока только примерно понимаю зачем они нужны. Типа вместо одной длинной логики в одном методе, можно разделить ее на мелкую, расплодить множество методов (а методы в классах и контроллерах) и затем подключать нужный метод через $this->. Конечно если я все правильно представляю (я новичок:)). Так вот. Делаю переадресацию в /home. В методе index определяю тип юзера и обращаюсь к методу client():

public function index()
    {
        $user = User::where('id', Auth::id())
                          ->firstOrFail();

        $type = $user->type;

        if ($type == 10) {
           return $this->client();
        }
    }

В методе client() переадресация

public function client()
    {
           return redirect('/clients');
    }

И вопрос такой – почему в методе index мне нужно делать return $this->client(); и не работает просто $this->client();? Ведь в методе client() уже есть return с редиректом, но он почему то не работает без return в методе index. Зачем нужен двойной return? Странно, что return в методе client() не запускается при вызове метода. Я просто просматривал ларавелевские файлы и там они просто обращаются к нужному методу через this без всяких returnov

Answer 1

[Евгений Педя]

Каждая функция или метод отвечает за свой возврат сама.
function client() - возвращает своё
function index() - возвращает своё

Comments

[jazzus]

А this тогда что делает? Получается не запускает новый метод, а запрашивает данные из нового метода в родительский (в отличие от this VUE где каждый метод также возвращает свое, но мне не нужен второй ретурн т.к. он есть в запускаемом методе)

[Евгений Педя]

$this это способ сослаться на текущий экземпляр объекта, для вызова его метода или атрибута.
В данном случае $this позволяет обратится к методу client() (включил режим гадалки) контроллера.

[D3lphi]

jazzus, в языке сперва разберитесь, потом во фреймворки лезьте.

[Евгений Педя]

Ниже избыточная информация - размышления над кодом.

Да и магическое число 10 лучше заменить на константу, которую прописать в модели User.

if ($user->type === User::ROLE_CLIENT) {
    // ...
}

Но не идеально.
В идеале (но не совсем) бы было красивее.

if ($user->isClient()) { // На самом деле customer :)
    // ...
}

Как вариант, если речь идёт о ролях, то возможно.

if ($user->isRole(new RoleClient)) {
    // ...
}

Это уже зависит от сложности проекта и возможности развития или изменения ролей.

И метод client имеет странное название, не отражающее его смысл. :)
Может проще redirectToClientsProfile() или что-то подобное или хотя бы goClients().
Впрочем всё относительно.
По мне метод вообще избыточен и следовательно не нужен.
Достаточно просто return redirect('/clients'); , ведь данный метод ничего другого не делает.

if ($user->isClient()) {
    return redirect('/clients');
}

Ну и $user = User::where('id', Auth::id())->firstOrFail(); то же избыточно
Достаточно $user = Auth::user();
Ведь речь идёт о Laravel и текущем авторизованном пользователе.

// В файле контроллера

    public function index()
    {
        $user = Auth::user();
        if ($user->isClient()) {
           return redirect('/clients');
        }
        // ...
    }

// В файле модели пользователя
class User extends Authenticatable
{
    const TYPE_CLIENT = 10;
    // ...
    public function isClient()
    {
        return (self::TYPE_CLIENT == $this->type);
    }
}

И если проверка делается во всех методах контроллера (контроллер не работает с клиентами),
то проще вынести проверку в миделвея и прикрутить к роутам с контроллером. :)

[jazzus]

Евгений Педя, Спасибо за идеи по сокращению кода! По-поводу ролей - я уже сделал роли с пермишенами с несколькими связанными таблицами и т.д.. type - здесь тип аккаунта для редиректов, чтобы не лезть в отношения.

Но по-поводу this Laravel все равно есть вопросы :)

$this это способ сослаться на текущий экземпляр объекта, для вызова его метода или атрибута.
В данном случае $this позволяет обратится к методу client() (включил режим гадалки) контроллера.

В смысле "способ сослаться"? Можно человеческим языком?) Вызывает он метод на исполнение или запрашивает инфу из метода?

[jazzus]

Евгений Педя, по поводу избыточности метода.. Я в итоге сделал отдельный трейт только для редиректов) Сегодня узнал, что в Laravel есть трейты. Пока не понял, чем они отличаются от контроллеров.. Но видимо придется переписать свои разработки тк. это очень удобно делать много методов типа 2+2=4 и собирать их в контроллерах

[jazzus]

Евгений Педя, еще раз спасибо за идеи по поводу кода (не знал, что в моделях можно делать такие обращения). Единственное я не понял этот кусок

class User extends Authenticatable
{
    const TYPE_CLIENT = 10;
    // ...
    public function isClient()
    {
        return (self::TYPE_CLIENT == $this->type);
    }
}

я сделал просто проверку:

public function isClient()
    {
            if ($this->type==10) return true;
            return false;
    }

есть какое-то преимущество с константой? $user->isClient() проверил работает

[Евгений Педя]

В смысле "способ сослаться"? Можно человеческим языком?) Вызывает он метод на исполнение или запрашивает инфу из метода?

Откуда php по вашему знает как вызвать нечто с именем client()?
Это может быть функция. Это может быть метод другого класса.
Это может быть метод данного класса.

php.net/manual/ru/language.oop5.basic.php

узнал, что в Laravel есть трейты.

Они есть в языке php, а не в laravel.

php.net/manual/ru/language.oop5.traits.php

Трейты - это один из способов избежать дублирования кода. Может быть несколько классов, которые не имеют к друг другу отношения прямого, но в них могут использоваться схожие методы реализующие нечто. Иногда их проще вынести в трет и подключить в начале классов. Но это не идеальное решение. Оно подходит если нет смысла в создании отдельного объекта или наследования от общего класса.

По редиректам в laravel.
Смысл создания метода для редиректа есть если в redirect('/clients') может изменится '/clients' (правим в одном методе - работает везде). Но это легко решается именованными роутами. Имя в редиректах сохраняется, а правится url роута, если нужно.
По этому я считаю метод избыточным.
Да и при нормальной IDE найти и заменить redirect('/clients') скажем на redirect('/customers') довольно легко. А лишний метод заставит через некоторое время себя искать, что бы посмотреть, для чего он создан.

это очень удобно делать много методов

Всё имеет минусы. Много методов у класса скорее свидетельствует о том, что он выполняет много функций, а не ту одну, для которой создан. В случае изменения придётся править больше кода. По этому нужно делать не много методов, а разделять код на необходимые классы, которые делают что-то одно.

[jazzus]

В общем я понял (наверное). задэдэшил этот this и увидел RedirectResponse, который в глубинах Ларавеля прописан)
получается, как и писал Евгений - this возвращает объект и редирект оказывается тоже может быть объектом с различными свойствами, атрибутами итд и который будет исполняться по запросу (в моем случае вторым ретурном). И можно сделать вывод, что this Laravel не запускает метод (как в Vue), а запрашивает объект метода (но это не точно))

[Евгений Педя]

И можно сделать вывод, что this Laravel не запускает метод (как в Vue), а запрашивает объект метода (но это не точно))

Нет! Я описал всё в комментарии к другому ответу подробно.

[Евгений Педя]

есть какое-то преимущество с константой? $user->isClient() проверил работает

По имени константы кто-то другой или вы сами (через пол года) можете понять смысл кроющийся в числе 10.
Или вы думаете, что будите помнить что скрывается за числом 10 и другими числами?
Кроме того в коде может быть куча чисел 10 с разными смыслами, а вам вдруг понадобилось сменить 10 на другое число для одного из контекстов. По имени константы можно сменить в любом нормальном IDE автоматом, а вот при замене 10ки можно зацепить и что-то не связанной в данном случае с типом пользователя.

[jazzus]

Евгений Педя, по поводу константы. В модели 1 раз пишем

public function isClient()
    {
            if ($this->type==10) return true;
            return false;
    }

и уже во всем приложении потом исключительно $user->isClient() и все. Максимально просто. Мне кажется запутаться нереально т.к. "10" указывается один раз в одном месте c названием метода isClient() и более 10 нигде не появляется.

[jazzus]

Нет! Я описал всё в комментарии к другому ответу подробно.

Почему нет-то? ( Я не увидел в вашем ответе противоречий

[jazzus]

$this это способ сослаться на текущий экземпляр объекта, для вызова его метода или атрибута.

В моем случае this вызывает объект RedirectResponse из метода сlient(). Верно?
И этим можно объяснить почему this->сlient() не запускает сразу редирект т.к. мы только запросили объект редиректа, а чтобы его вернуть мы и используем второй return. Правильно??

[Евгений Педя]

Да. В начале в методе сlient() мы получаем объект редиректа из функции и тут же его возвращаем из метода (return). Далее в index() мы так же его возвращаем.

https://laravel.com/docs/5.7/responses

[jazzus]

Евгений Педя, так я в соседней ветке и здесь тоже самое написал)

[Alex Wells]

О боже.. выучите язык сначала, это же элементарные основы. Зачем тут люди вообще пытаются что-то говорить про качество кода, если человек вообще не понимает что делает?

[jazzus]

Alex Wells, я и спрашиваю основы, чтобы разобраться. Если бы выучил язык не спрашивал. Учу) Написал же что новичок и занимаюсь этим недавно

Answer 2

[Dnebl]

return $this->client();
Возвращает то что вернет client т.е вот это:
return redirect('/clients');

Comments

[jazzus]

Т.е. это просто особенность синтаксиса Laravel? Чисто логически если в подключаемом методе уже есть ретурн зачем мне еще один. Я просто привык во vue без всяких ретурнов вызывать методы через this и уже в них любые редиректы и т.д..

Либо. Возможно такая схема: при использовании this во vue вызывается исполнение нового метода. Тогда как в Laravel запрашиваются данные из метода. В этом случае можно объяснить второй ретурн тем, что через $this-> мы просто получили данные, которые были возвращены методом client(). И все - client() отвалился со своими ретурнами, и тогда нам приходится запускать новый return, чтобы отдать данные пользователю. И тогда можно сделать вывод, что $this в Laravel (в отличие от this VUE) только запрашивает данные из дочерних методов в корневой и ничего больше. Так??

[Евгений Педя]

jazzus, в Vue редирект не то же самое, что редирект в Laravel.
В Laravel метод контроллера отвечающий за какое либо действие должен вернуть объект ответа. Этот объект может будет выполнен позже.
В Vue редирект выполняется в том месте, где он вызван.
И редиректы эти разные. Тот что в Vue выполняется на уровне браузера, а второй ещё и сервер.

На самом деле вам рано ещё заниматься подобной разработкой.
Вы не знаете основ. Работы HTTP и работы JS в браузере.

[jazzus]

Я не про редирект писал. Я про this.

В VUE я могу написать this.Metod(). а в методе Metod(){ return ...} т.е. мне не нужно писать return this.Metod() как в LAravel

[jazzus]

значит способы сослаться this в Vue и LAravel разные

[Константин Б.]

jazzus, это не синтаксис Laravel, а PHP в целом так работает. Сначала выучите основы и потом будет проще.
И это не тзюменка языка PHP, так и на питоне пишут например

[Евгений Педя]

значит способы сослаться this в Vue и LAravel разные

В данной ситуации - одинаковые.

class FooController
{
    public function client()
    {
           return redirect('/clients');
    }

    public function index()
    {
        //...
        if ($type == 10) {
           return $this->client();
        }
        //...
    }
}

Можно переписать

class FooController
{
    public function client()
    {
           return redirect('/clients');
    }

    public function index()
    {
        //...
        if ($type == 10) {
           $redirect = $this->client();
           return $redirect;
        }
        //...
    }
}

Я уже выше написал, что метод контроллера в laravel должен вернуть в приложение которое его вызвало объект ответа (response). Функция хэлпер redirect() возвращает такой объект, а не выполняет редирект немедленно. Вы запихнули получение этого объекта в отдельный метод. Но без return он не покинет index(). И значит метод объекта возврата отвечающий за его выполнение не будет вызван.

Почему не выполняется редирект сразу, а возвращается какой-то объект из метода контроллера, отвечающего за ответ?
Это особенность реализации laravel и не только. В фреймвоке предусмотрена необходимость выполнения кода как до выполнения бизнес логики (в данном случае она в методе index()), так и после.

В Vue редирект, например, window.location = 'https://foo.bar' вы запускаете в том месте (методе) где решили, а ничего не возвращаете.

[jazzus]

Все так. Не знал, что редирект может быть объектом, который можно записать в переменную или запросить через this из другого метода и выполнить уже в нем. Я думал редирект это исключительно действие. В этом было непонимание. А почему this в VUE и Laravel одинаковые? Даже в данном случае - Ларавель запрашивает объект из метода, а Vue запускает метод. По-моему разница существенная

[Евгений Педя]

Ничего вы не поняли. Как не грустно.
Не нужно связывать this и редирект.
В обоих случаях this используется для обращения к текущему объекту для вызова его метода. И этим они одинаковы.

[jazzus]

Ок. То что this в VUE и Laravel

обращаются к текущему объекту для вызова метода

- в этом они одинаковые. Согласен. Тогда в чем они разные? Т.к. они по-любому по разному "обращаются к объекту для вызова метода, свойства или атрибута". В принципе это можно выяснить, сделав проверку (посмотреть какие данные получают VUE и ЛАравель при использовании this).

[jazzus]

Проверил. В Laravel вызывая метод через this получает объект ответа в исходный метод, а Vue при обращении к методу через this ничего не получает в исходный метод т.к. она может только запускать метод через this. Например:

thisTest(){
        this.test = this.returnTest();
      },

в Vue работать не будет только

this.returnTest();

[Mazino]

jazzus, Не стесняйся делать dump()/dd() всего до чего дотянешься.
Поможет во многом разобраться. К примеру, уверен на 95%, что dd($this); в твоем контроллере отвадило бы тебя писать сюда такой вопрос. Естественно, чтобы увидеть результат, нужно грузить в браузере страницу, которую обрабатывает исходный контроллер.