O co chodzi z wiodącym podkreśleniem w metodach klas PHP?

Przeglądając różne biblioteki PHP, zauważyłem, że wiele osób decyduje się na poprzedzanie niektórych metod klasowych pojedynczym podkreśleniem, na przykład

public function _foo()

...zamiast...

public function foo()

Zdaję sobie sprawę, że ostatecznie sprowadza się to do osobistych preferencji, ale zastanawiałem się, czy ktoś ma jakiś wgląd w to, skąd pochodzi ten nawyk.

Wydaje mi się, że jest to prawdopodobnie przenoszone z PHP 4, zanim metody klasowe mogłyby zostać oznaczone jako chronione lub prywatne, w celu zasugerowania „nie wywołuj tej metody spoza klasy”. Jednak przyszło mi również do głowy, że może pochodzi skądś (język), którego nie znam lub że może kryć się za tym rozsądne uzasadnienie, którego znajomość przyniosłaby mi korzyści.

Wszelkie przemyślenia, spostrzeżenia i / lub opinie będą mile widziane.

Pochodzi ze złych, starych czasów Object Oriented PHP (PHP 4). Ta implementacja OO była dość zła i nie obejmowała rzeczy takich jak metody prywatne. Aby to zrekompensować, programiści PHP poprzedzili metody, które miały być prywatne, podkreśleniem. W niektórych starszych klasach zobaczysz, /**private*/ __foo() {jak nadać mu trochę wagi.

Nigdy nie słyszałem o programistach poprzedzających wszystkie swoje metody podkreśleniami, więc nie mogę zacząć wyjaśniać, co to powoduje.

Uważam, że obecnie najbardziej miarodajnym źródłem tego rodzaju konwencji PHP byłby PSR-2: Przewodnik po stylach kodowania, ponieważ Zend Framework jest częścią PSR :

Nazwy właściwości NIE POWINNY być poprzedzane pojedynczym podkreśleniem, aby wskazać widoczność chronioną lub prywatną.

Teraz, w 2013 roku, jest to „oficjalnie” zły styl według wytycznych kodowania PSR-2:

Nazwy właściwości NIE POWINNY być poprzedzane pojedynczym podkreśleniem w celu wskazania widoczności chronionej lub prywatnej "

Źródło: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md

Byłem zdecydowanie przeciwny dodawaniu przedrostków do metod prywatnych / chronionych podkreśleniem, ponieważ możesz użyć do tego słowa kluczowego private / protected, a IDE oznaczy je za Ciebie.

I nadal jestem, ale znalazłem jeden powód, dla którego może to być dobra praktyka. Wyobraź sobie, że masz sposób publiczny addFoo()i wewnątrz tej metodzie masz jakąś część zadania, która jest wspólna z innymi metodami addFooWhenBar(), addFooWhenBaz()... teraz, że najlepszą nazwą stosowaną metodą byłoby addFoo(), ale to jest już zajęta, więc trzeba wymyślić jakiś brzydka nazwa jak addFooInternal()lub addFooCommon()lub ... ale _addFoo()metoda prywatna wygląda na najlepszą.

Podkreślenia wiodące są zwykle używane w przypadku prywatnych nieruchomości i metod . Nie jest to technika, którą zwykle stosuję, ale pozostaje popularna wśród niektórych programistów.

Używam wiodącego podkreślenia w klasie PHP 5, którą piszę dla metod prywatnych. Jest to mała wizualna wskazówka dla programisty, że dany element klasy jest prywatny. Ten typ podpowiedzi nie jest tak przydatny, gdy używasz IDE, które rozróżnia członków publicznych i prywatnych. Podniosłem to z moich dni C #. Stare zwyczaje...

Uważam, że twoje pierwotne założenie było słuszne. Zauważyłem, że w niektórych językach powszechną praktyką jest dodawanie znaku podkreślenia do metod / elementów itp., Które mają pozostać prywatne w stosunku do „obiektu”. To tylko wizualny sposób na powiedzenie, chociaż możesz, nie powinieneś tego nazywać!

Szukałem tej samej odpowiedzi, przeprowadziłem kilka badań i właśnie odkryłem, że frameworki php sugerują różne style:

Code Igniter

Oficjalny podręcznik zawiera sekcję dotyczącą stylu kodowania, która zachęca do tej praktyki :

Metody i zmienne prywatne

Metody i zmienne, do których dostęp jest możliwy tylko wewnętrznie, takie jak funkcje narzędziowe i pomocnicze, których metody publiczne używają do abstrakcji kodu, powinny być poprzedzone podkreśleniem.

public function convert_text()

private function _convert_text()

Inne frameworki robią to samo, na przykład

Cakephp:

robi to samo :

Widoczność członków

Użyj prywatnych i chronionych słów kluczowych PHP5 dla metod i zmiennych. Ponadto niepubliczne nazwy metod lub zmiennych zaczynają się od pojedynczego podkreślenia (_). Przykład:

class A
{
    protected $_iAmAProtectedVariable;

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

    private $_iAmAPrivateVariable;

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

I również

GRUSZKA

robi to samo :

Członkowie klasy prywatnej są poprzedzeni pojedynczym podkreśleniem. Na przykład:

$_status    _sort()     _initTree()

Podczas

Drupal

styl kodu specjalnie ostrzega przed tym :

9. Chronione lub prywatne właściwości i metody nie powinny używać przedrostka podkreślenia.

Symfonia

z drugiej strony oświadcza :

Symfony przestrzega standardów określonych w dokumentach PSR-0, PSR-1, PSR-2 i PSR-4.

Znam to z Pythona, gdzie poprzedzanie zmiennych podkreśleniem powoduje, że kompilator tłumaczy pewną losową sekwencję liter i cyfr przed rzeczywistą nazwą zmiennej. Oznacza to, że każda próba uzyskania dostępu do zmiennej spoza klasy spowodowałaby błąd „zmienna niezdefiniowana”.

Nie wiem jednak, czy nadal jest to konwencja używana w Pythonie

W Drupalu (php CMS) podkreślenia mogą być używane do zapobiegania wywoływaniu hooków ( https://api.drupal.org/api/drupal/includes!module.inc/group/hooks/7 ).

Jeśli mam moduł o nazwie „my_module” i chcę nazwać funkcję my_module_insert, zostanie to „zaczepione” o funkcję hook_insert. Aby temu zapobiec, mogę zmienić nazwę mojej funkcji na _my_module_insert.

ps Sposób działania hooków w Drupalu umożliwia omyłkowe zaimplementowanie hooków, co jest bardzo złe.

Drupal i używanie podkreślenia:

Ogólnie rzecz biorąc, podkreślenie ma na celu proste zaznaczenie faktu, że funkcja byłaby prawdopodobnie wywoływana tylko przez powiązaną funkcję nadrzędną ...

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>';
}

Oczywiście tylko prosty przykład ...

Używanie podkreślenia tylko w celu zapamiętania, że ​​nie będziemy „modyfikować zmiennej” / „wywoływać funkcji” poza klasą.

Ponieważ deklarujemy zmienne const pisane dużymi literami, dzięki czemu widząc nazwę zmiennej można się domyślić, że jest to zmienna const. Podobnie jak zmienna, której nie chcemy modyfikować poza klasą, deklarujemy ją z podkreśleniem dla naszej własnej konwencji.

Nazywa się je „metodami magicznymi” .