Что именно делает этот код?

Question

[goshaLoonny]

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

protected function subEntities(): array
    {
        return [
            'from'                              => User::class,
            'sender_chat'                       => Chat::class,
            'chat'                              => Chat::class,
            'forward_from'                      => User::class,
            'forward_from_chat'                 => Chat::class,
            'reply_to_message'                  => ReplyToMessage::class,
            'via_bot'                           => User::class,
            'entities'                          => [MessageEntity::class],
            'caption_entities'                  => [MessageEntity::class],
            'audio'                             => Audio::class,
            'document'                          => Document::class,
            'animation'                         => Animation::class,
            'game'                              => Game::class,
            'photo'                             => [PhotoSize::class],
            'sticker'                           => Sticker::class,
            'video'                             => Video::class,
            'voice'                             => Voice::class,
            'video_note'                        => VideoNote::class,
            'contact'                           => Contact::class,
            'location'                          => Location::class,
            'venue'                             => Venue::class,
            'poll'                              => Poll::class,
            'dice'                              => Dice::class,
            'new_chat_members'                  => [User::class],
            'left_chat_member'                  => User::class,
            'new_chat_photo'                    => [PhotoSize::class],
            'message_auto_delete_timer_changed' => MessageAutoDeleteTimerChanged::class,
            'pinned_message'                    => __CLASS__,
            'invoice'                           => Invoice::class,
            'successful_payment'                => SuccessfulPayment::class,
            'passport_data'                     => PassportData::class,
            'proximity_alert_triggered'         => ProximityAlertTriggered::class,
            'voice_chat_scheduled'              => VoiceChatScheduled::class,           // deprecated
            'voice_chat_started'                => VoiceChatStarted::class,             // deprecated
            'voice_chat_ended'                  => VoiceChatEnded::class,               // deprecated
            'voice_chat_participants_invited'   => VoiceChatParticipantsInvited::class, // deprecated
            'video_chat_scheduled'              => VideoChatScheduled::class,
            'video_chat_started'                => VideoChatStarted::class,
            'video_chat_ended'                  => VideoChatEnded::class,
            'video_chat_participants_invited'   => VideoChatParticipantsInvited::class,
            'web_app_data'                      => WebAppData::class,
            'reply_markup'                      => InlineKeyboard::class,
        ];
    }

оригинал: https://github.com/php-telegram-bot/core/blob/deve...

Answer 1

[Ипатьев]

Вся магия происходит здесь
Обычный магический метод __call(), который вызывается, когда происходит обращение к несуществующему методу.

По факту это такой магический геттер на стероидах.
Отрезает от имени метода первые три буквы и ищет свойство с получившимся именем.
Свойства добавляются в класс в конструкторе через массив.

Если свойство не найдено, ищет в массиве имя класса, объект которого надо создать и вернуть.
Для этого зачем-то меняет регистр с camelCase на snake_case и ищет элемент массива с таким именем по вышеприведённой карте классов. То есть getForwardFrom превращается в forward_from, и по этому индексу возвращается имя класса. почему нельзя было сразу написать в том же регистре - загадка

В целом - отборнейший говнокод.

Comments

[goshaLoonny]

то есть сами методы явно не указаны, а в PHPDoc указаны методы которые не вызовут ошибку в ответ со стороны API? я верно понял?

p.s. сорри за копипаст коммента с предыдущего ответа

[Ипатьев]

Ну примерно так
Только я не вижу, чтобы он вызывал ошибку. Тупо возвращает null, если ничего не нашёл.

[Ипатьев]

Так что скорее просто список доступных методов.
И это двойной идиотизм - мы поленились написать нормальные методы, заменив их магией - но при этом всё равно пишем их в докблок.

[DevMan]

Ипатьев, в докблоках описывают для IDE: автокомплит и не задрачивает "метод не существует".
если пишешь в блокноте, можно смело выпиливать.

[goshaLoonny]

Ипатьев, большое спасибо)

[Ипатьев]

DevMan, мне неважно для кого они описаны
Важно что кто-то сидел, пыхтел, выписывал каждый метод аж два раза - сначала в докблоке, а потом в массиве.
Сделать нормальные методы было бы и проще, и итог получился бы не таким говнокодистым.

[DevMan]

Ипатьев, еще раз: докблок и массив решают совершенно разные задачи.
а если протереть глаза, то можно увидеть что в массиве методов вообще нет.

[Ипатьев]

DevMan, задача одна и та же. Называется геттер. Геттер - это метод. Можно написать явно, а можно наворотить магии. Которая всё равно сведётся к вызову магического метода. Из-за того что кто-то поленился написать нормально, пришлось городить докблок в дополнение к массиву.

[DevMan]

Ипатьев, ты прикалываешься или на серьезных сусалах заливаешь дичь потому что не знаешь?

еще раз: этот докблок нужен ТОЛЬКО для IDE и/или для генерации документации, к выполнению кода он НЕ имеет НИКАКОГО отношения.
его можно вообще удалить, если не нужны ништяки в IDE/генерация документации.

[Ипатьев]

DevMan, кроме "IDE" кодом иногда ещё пользуется программист. Редко конечно, раз в год по настроению. Кропает что-то у себя ручкой в блокнотике. И вот этому программисту желательно знать, а какие вообще методы поддерживает класс, которым он пользуется. Варианта для этого есть два: либо прописать методы нормально, либо писать такую цидулю на пять экранов.

Старайтесь поменьше кидаться на людей, если вы что-то не поняли. И не приписывать им свои собственные фантазии про "выполнение кода".

[DevMan]

Ипатьев, черт, чот меня переклинило: ты писал одно, я прочитал другое.
сорян.

Answer 2

[Антон Шаманов]

перед тем как что-то писать, освой хотя бы основы, в данном случае магические методы

Пожалуйста объясните что делает этот код.

массив возвращает, соотнеси его с phpdoc методами и станет понятнее

И откуда там взялись методы указанные в PHPDoc

отсюда https://github.com/php-telegram-bot/core/blob/6a61...

Comments

[goshaLoonny]

то есть сами методы явно не указаны, а в PHPDoc указаны методы которые не вызовут ошибку в ответ со стороны API? я верно понял?

[Антон Шаманов]

goshaLoonny, верно, в phpdoc они указываются для использования в autocomplete ide вроде phpstorm

Answer 3

[DevMan]

скорее всего "привязывает" команды/события к php–классам.

Comments

[goshaLoonny]

что значит привязывает?

[DevMan]

goshaLoonny, сопоставляет: какая команда телеги каким php–классом обрабатывается.

[goshaLoonny]

DevMan, я не понимаю все равно. Структура массива такая же как и ответ со стороны API Telegram. И я не пойму что он сопоставляет. И что конкретно делает ::class

[goshaLoonny]

DevMan, вот приходит ответ от API и этот ответ накидывает на эти данные методы из указанных классов?
Если вы тыкните меня в доки php про это я буду очень благодарен

[Ипатьев]

goshaLoonny, я же написал в своем ответе, что непонятно-то?
Ищет имя класса, объект которого надо создать при вызове того или иного метода, перечисленного в докблоке.

При чем здесь ответ от API вообще?

[DevMan]

goshaLoonny, не понимаешь потому что не учил.
https://www.php.net/manual/ru/language.oop5.basic....

[goshaLoonny]

Ипатьев, при том что я запутался) Сорри за тупость

[goshaLoonny]

DevMan, спасибо огромное)