Яка угода з провідним підкресленням методів класу PHP?

Переглядаючи різні бібліотеки PHP, я помітив, що багато людей обирають префікс деяких методів класу за допомогою одного підкреслення, наприклад

public function _foo()

...замість...

public function foo()

Я усвідомлюю, що в кінцевому рахунку це зводиться до особистих переваг, але мені було цікаво, чи хтось розуміє, звідки ця звичка походить.

Думаю, що це, ймовірно, переноситься з PHP 4, перш ніж методи класу можуть бути позначені як захищені або приватні, як спосіб натякнути на "не викликати цей метод поза класом". Однак мені також спало на думку, що, можливо, воно походить десь (мова), з якою я не знайомий, або що за цим можуть бути обґрунтовані міркування, які я б з користю знав.

Будь-які думки, уявлення та / або думки були б вдячні.

Це з старих поганих часів об'єктно-орієнтованого PHP (PHP 4). Така реалізація ОО була досить поганою, і вона не включала речі, як приватні методи. Щоб отримати компенсацію, розробники PHP наперед встановили методи, які мали бути приватними із підкресленням. У деяких старших класах ви побачите, /**private*/ __foo() {щоб надати цьому додаткову вагу.

Я ніколи не чув, щоб розробники домагалися всіх своїх методів підкресленнями, тому не можу почати пояснювати, що це викликає.

Я вважаю, що найавторитетнішим джерелом подібних конвенцій для PHP зараз було б PSR-2: Посібник зі стилів кодування, оскільки Zend Framework є частиною PSR :

Імена властивостей НЕ БУДЬ вказуватись окремим підкресленням для вказівки захищеної або приватної видимості.

Тепер, у 2013 році, це "офіційно" поганий стиль за принципом кодування PSR-2:

Назви властивостей НЕ БУДЬ вказуватися одним підкресленням, щоб вказувати на захищену або приватну видимість "

Джерело: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md

Я був категорично проти префіксації приватних / захищених методів підкресленням, оскільки ви можете використовувати приватне / захищене ключове слово для цього, і IDE позначатиме це для вас.

І я все ще є, але я знайшов одну причину, чому це може бути хорошою практикою. Уявіть, що у вас є публічний методaddFoo() і всередині цього методу у вас є частина завдань, яка є спільною для інших методів addFooWhenBar(), addFooWhenBaz()... Тепер найкраща назва цього звичайного методу була б addFoo(), але вона вже прийнята, тому ви повинні придумати деякі потворне ім’я, як addFooInternal()або addFooCommon()чи ..., але _addFoo()приватний метод виглядає найкращим.

Провідні підкреслення зазвичай використовуються для приватних властивостей та методів . Це не техніка, яку я зазвичай використовую, але все ще залишається популярною серед деяких програмістів.

Я використовую провідне підкреслення в класі PHP 5, який я пишу для приватних методів. Це невелика візуальна підказка для розробника про те, що конкретний член класу є приватним. Цей тип натяку не настільки корисний при використанні IDE, що відрізняє публічних та приватних членів для вас. Я взяв його з моїх C # днів. Старі звички ...

Я вважаю, що ваше первісне припущення було правильним, я вважаю, що для деяких мов звичайною практикою є приставки підкреслення до методів / членів тощо, які повинні бути приватними для "об'єкта". Просто візуальний спосіб сказати, хоча ви можете, ви не повинні це називати!

Я шукав ту саму відповідь, я робив деякі дослідження, і я тільки що виявив, що фреймворки PHP пропонують різні стилі:

Код запалювача

В офіційному посібнику є розділ стилю кодування, який заохочує цю практику :

Приватні методи та змінні

Методи та змінні, до яких можна отримати доступ лише внутрішньо, такі як корисні та допоміжні функції, які використовуються вашими загальнодоступними методами для абстрагування коду, мають бути встановлені підкресленням.

public function convert_text()

private function _convert_text()

Інші рамки роблять те саме, як

Cakephp:

робить те ж саме :

Видимість учасника

Використовуйте приватні та захищені ключові слова PHP5 для методів та змінних. Крім того, непублічні методи або назви змінних починаються з одного підкреслення (_). Приклад:

class A
{
    protected $_iAmAProtectedVariable;

    protected function _iAmAProtectedMethod()
    {
       /* ... */
    }

    private $_iAmAPrivateVariable;

    private function _iAmAPrivateMethod()
    {
        /* ... */
    }
}

І також

МІСЦЕ

робить те ж саме :

Для членів приватного класу передує один підкреслення. Наприклад:

$_status    _sort()     _initTree()

Поки

Друпал

стиль коду спеціально застерігає від цього :

9. Захищені або приватні властивості та методи не повинні використовувати префікс підкреслення.

Симфонія

з іншого боку, заявляє :

Symfony відповідає стандартам, визначеним у документах PSR-0, PSR-1, PSR-2 та PSR-4.

Я знаю це з python, де префіксація ваших змінних підкресленням змушує компілятор перекладати якусь випадкову послідовність букв і цифр перед фактичним іменем змінної. Це означає, що будь-яка спроба отримати доступ до змінної за межами класу призведе до помилки "невизначена змінна".

Я не знаю, чи все-таки це умова використовувати в python

У Drupal (php CMS) підкреслення можна використовувати для запобігання виклику гачків ( https://api.drupal.org/api/drupal/includes!module.inc/group/hooks/7 ).

Якщо у мене є модуль під назвою "my_module" і я хочу назвати функцію my_module_insert, він би "зачепився" на функцію mock_insert. Щоб запобігти тому, що я можу перейменувати свою функцію на _my_module_insert.

ps Спосіб роботи гачків у Drupal можна реалізувати гачок помилково, що дуже погано.

Drupal та за допомогою підкреслення:

Загалом підкреслення полягає в тому, щоб просто відзначити той факт, що функцію, ймовірно, може викликати лише пов'язана батьківська функція ...

function mymodule_tool($sting="page title"){
    $out ='';
    //do stuff 
    $out  .= _mymodule_tool_decor($sting);
    return $out;
}

function _mymodule_tool_decor($sting){
    return '<h1>'.$string.'</h1>';
}

Звичайно, просто простий приклад ...

Використання підкреслення лише для пам’яті, що ми не будемо «змінювати змінну» / «викликати функцію» поза класом.

Оскільки ми оголошуємо змінні const у всіх великих літерах, так що, переглядаючи ім'я змінної, можна здогадатися, що це змінна const. Подібну змінну, яку ми не хочемо змінювати поза класом, ми оголошуємо її підкресленням для власної конвенції.

Їх називають "магічними методами" .