Qual è il problema con un carattere di sottolineatura principale nei metodi di classe PHP?

Osservando varie librerie PHP ho notato che molte persone scelgono di aggiungere un prefisso ad alcuni metodi di classe con un singolo trattino basso, come

public function _foo()

...invece di...

public function foo()

Mi rendo conto che alla fine questo dipende dalle preferenze personali, ma mi chiedevo se qualcuno avesse avuto un'idea di da dove provenga questa abitudine.

Il mio pensiero è che probabilmente è stato riportato da PHP 4, prima che i metodi di classe potessero essere contrassegnati come protetti o privati, come un modo per implicare "non chiamare questo metodo al di fuori della classe". Tuttavia, mi è anche venuto in mente che forse ha origine da qualche parte (una lingua) che non conosco o che potrebbe esserci un buon ragionamento dietro cui trarrebbe beneficio dalla conoscenza.

Eventuali pensieri, intuizioni e / o opinioni sarebbero apprezzati.

È dai brutti tempi di Object Oriented PHP (PHP 4). L'implementazione di OO era piuttosto negativa e non includeva cose come i metodi privati. Per compensare, gli sviluppatori PHP hanno preceduto i metodi che dovevano essere privati ​​con un carattere di sottolineatura. In alcune classi precedenti vedrai/**private*/ __foo() { di dargli un peso extra.

Non ho mai sentito parlare di sviluppatori che precedono tutti i loro metodi con caratteri di sottolineatura, quindi non posso iniziare a spiegare quali sono le cause.

Credo che la fonte più autorevole per questo tipo di convenzioni per PHP in questo momento sia la PSR-2: Coding Style Guide perché Zend Framework fa parte di PSR :

I nomi delle proprietà NON DOVREBBERO essere preceduti da un singolo trattino basso per indicare la visibilità protetta o privata.

Ora, nel 2013, questo è uno stile "ufficialmente" cattivo secondo le linee guida di codifica PSR-2:

I nomi delle proprietà NON DOVREBBERO essere preceduti da un singolo trattino basso per indicare la visibilità protetta o privata »

Fonte: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md

Ero fortemente contrario al prefisso dei metodi privati ​​/ protetti con il trattino basso poiché puoi usare la parola chiave privata / protetta per questo e IDE lo segnerà per te.

E lo sono ancora, ma ho trovato una ragione per cui può essere una buona pratica. Immagina di avere un metodo pubblico addFoo()e all'interno di quel metodo hai una parte del compito che è comune con altri metodi addFooWhenBar(), addFooWhenBaz()... Ora, il nome migliore per quel metodo comune sarebbe addFoo(), ma è già stato preso, quindi devi trovare un po ' brutto nome come addFooInternal()o addFooCommon()o ... ma il _addFoo()metodo privato sembra il migliore.

I caratteri di sottolineatura principali vengono generalmente utilizzati per proprietà e metodi privati . Non è una tecnica che di solito utilizzo, ma rimane popolare tra alcuni programmatori.

Uso un carattere di sottolineatura principale nella classe PHP 5 che scrivo per metodi privati. È un piccolo segnale visivo allo sviluppatore che un determinato membro della classe è privato. Questo tipo di suggerimento non è utile quando si utilizza un IDE che distingue i membri pubblici e privati ​​per te. L'ho raccolto dai miei giorni C #. Vecchie abitudini ...

Credo che la tua ipotesi originale fosse corretta, ho trovato che per alcune lingue è una prassi comune anteporre un carattere di sottolineatura a metodi / membri ecc. Che devono essere mantenuti privati ​​dell '"oggetto". Solo un modo visivo per dire, anche se puoi, non dovresti chiamarlo così!

Stavo cercando la stessa risposta, ho fatto qualche ricerca e ho appena scoperto che i framework php suggeriscono stili diversi:

Accenditore di codice

Il manuale ufficiale ha una sezione di stile di codifica che incoraggia questa pratica :

Metodi e variabili privati

I metodi e le variabili a cui si accede solo internamente, come le funzioni di utilità e di supporto utilizzate dai metodi pubblici per l'astrazione del codice, devono essere preceduti da un trattino basso.

public function convert_text()

private function _convert_text()

Altri framework fanno lo stesso, come

CakePHP:

fa lo stesso :

Visibilità dei membri

Usa le parole chiave private e protette di PHP5 per metodi e variabili. Inoltre, i nomi di metodi o variabili non pubblici iniziano con un singolo trattino basso (_). Esempio:

class A
{
    protected $_iAmAProtectedVariable;

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

    private $_iAmAPrivateVariable;

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

E anche

PERA

fa lo stesso :

I membri della classe privata sono preceduti da un singolo trattino basso. Per esempio:

$_status    _sort()     _initTree()

Mentre

Drupal

lo stile di codice mette specificamente in guardia contro questo :

9. Le proprietà e i metodi protetti o privati ​​non devono utilizzare un prefisso di sottolineatura.

Sinfonia

d'altra parte, dichiara :

Symfony segue gli standard definiti nei documenti PSR-0, PSR-1, PSR-2 e PSR-4.

Lo so da Python, dove il prefisso delle variabili con un trattino basso fa sì che il compilatore traduca una sequenza casuale di lettere e numeri davanti al nome della variabile attuale. Ciò significa che qualsiasi tentativo di accedere alla variabile dall'esterno della classe comporterebbe un errore "variabile non definita".

Non so se questa è ancora la convenzione da usare in Python

In Drupal (un php CMS) i caratteri di sottolineatura possono essere utilizzati per impedire la chiamata di hook ( https://api.drupal.org/api/drupal/includes!module.inc/group/hooks/7 ).

Se ho un modulo chiamato "my_module" e voglio nominare una funzione my_module_insert, si "aggancerebbe" alla funzione hook_insert. Per evitare ciò, posso rinominare la mia funzione in _my_module_insert.

ps Il modo in cui funzionano gli hook in Drupal è possibile implementare un hook per errore, il che è molto male.

Drupal e usando il trattino basso:

In generale, il carattere di sottolineatura è semplicemente quello di contrassegnare il fatto che una funzione sarebbe probabilmente chiamata solo da una funzione genitore correlata ...

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

Certo, solo un semplice esempio ...

Usando la sottolineatura solo per ricordare che non "modificheremo la variabile" / "chiameremo la funzione" al di fuori della classe.

Mentre dichiariamo variabili const in tutte le maiuscole in modo che mentre si vede il nome della variabile possa indovinare che si tratta di una variabile const. Simile alla variabile che non vogliamo modificare al di fuori della classe, la dichiariamo con trattino basso per la nostra convenzione.

Sono chiamati "metodi magici" .