Apa masalahnya dengan garis bawah terkemuka dalam metode kelas PHP?

Sambil melihat-lihat berbagai pustaka PHP, saya perhatikan bahwa banyak orang memilih untuk mengawali beberapa metode kelas dengan satu garis bawah, seperti

public function _foo()

...dari pada...

public function foo()

Saya menyadari bahwa pada akhirnya ini tergantung pada preferensi pribadi, tetapi saya bertanya-tanya apakah ada yang tahu dari mana kebiasaan ini berasal.

Pikir saya adalah bahwa itu mungkin dibawa dari PHP 4, sebelum metode kelas dapat ditandai sebagai dilindungi atau pribadi, sebagai cara menyiratkan "jangan panggil metode ini dari luar kelas". Namun, terlintas dalam benak saya bahwa mungkin itu berasal dari suatu tempat (suatu bahasa) yang tidak saya kenal atau mungkin ada alasan yang baik di baliknya bahwa saya akan mendapat manfaat dari mengetahuinya.

Setiap pemikiran, wawasan, dan / atau opini akan dihargai.

Ini dari masa lalu yang buruk dari Object Oriented PHP (PHP 4). Implementasi OO itu sangat buruk, dan tidak termasuk hal-hal seperti metode pribadi. Untuk mengimbangi, pengembang PHP memilih metode yang dimaksudkan untuk menjadi pribadi dengan garis bawah. Di beberapa kelas yang lebih tua, Anda akan melihat/**private*/ __foo() { memberikan bobot tambahan.

Saya belum pernah mendengar tentang pengembang yang memasang semua metode mereka dengan garis bawah, jadi saya tidak bisa mulai menjelaskan apa penyebabnya.

Saya percaya sumber paling otoritatif untuk konvensi semacam ini untuk PHP saat ini adalah PSR-2: Panduan Gaya Pengkodean karena Zend Framework adalah bagian dari PSR :

Nama properti TIDAK HARUS diawali dengan garis bawah tunggal untuk menunjukkan visibilitas yang dilindungi atau pribadi.

Sekarang, pada 2013, ini adalah gaya buruk "resmi" oleh pedoman pengkodean PSR-2:

Nama properti TIDAK HARUS diawali dengan garis bawah tunggal untuk menunjukkan visibilitas pribadi atau terlindungi

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

Saya sangat menentang awalan metode privat / terproteksi dengan garis bawah karena Anda dapat menggunakan kata kunci privat / terlindungi untuk itu dan IDE akan menandainya untuk Anda.

Dan saya masih, tetapi, saya menemukan satu alasan mengapa itu bisa menjadi praktik yang baik. Bayangkan Anda memiliki metode publik addFoo()dan di dalam metode itu Anda memiliki beberapa bagian tugas yang sama dengan metode lain addFooWhenBar(), addFooWhenBaz()... Sekarang, nama terbaik untuk metode umum itu adalah addFoo(), tetapi sudah diambil, jadi Anda harus membuat beberapa nama jelek seperti addFooInternal()atau addFooCommon()atau ... tetapi _addFoo()metode pribadi sepertinya yang terbaik.

Garis bawah utama biasanya digunakan untuk properti dan metode pribadi . Bukan teknik yang biasa saya pakai, tetapi tetap populer di kalangan beberapa programmer.

Saya menggunakan garis bawah terkemuka di kelas PHP 5 yang saya tulis untuk metode pribadi. Ini adalah isyarat visual kecil bagi pengembang bahwa anggota kelas tertentu bersifat pribadi. Jenis petunjuk ini tidak berguna ketika menggunakan IDE yang membedakan anggota publik dan pribadi untuk Anda. Saya mengambilnya dari hari C # saya. Kebiasaan lama ...

Saya percaya asumsi awal Anda benar, saya telah menemukan itu menjadi praktik umum untuk beberapa bahasa untuk awalan garis bawah untuk metode / anggota dll yang dimaksudkan untuk dirahasiakan dengan "objek". Hanya cara visual untuk mengatakan meskipun Anda bisa, Anda tidak harus memanggil ini!

Saya mencari jawaban yang sama, saya melakukan riset, dan saya baru saja menemukan bahwa kerangka kerja php menyarankan gaya yang berbeda:

Penyala kode

Manual resmi memiliki bagian gaya pengkodean yang mendorong praktik ini :

Metode dan Variabel Pribadi

Metode dan variabel yang hanya diakses secara internal, seperti fungsi utilitas dan pembantu yang digunakan metode publik Anda untuk abstraksi kode, harus diawali dengan garis bawah.

public function convert_text()

private function _convert_text()

Kerangka kerja lain melakukan hal yang sama, seperti

Cakephp:

melakukan hal yang sama :

Visibilitas Anggota

Gunakan kata kunci pribadi dan dilindungi PHP5 untuk metode dan variabel. Selain itu, metode non-publik atau nama variabel mulai dengan garis bawah tunggal (_). Contoh:

class A
{
    protected $_iAmAProtectedVariable;

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

    private $_iAmAPrivateVariable;

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

Dan juga

PIR

melakukan hal yang sama :

Anggota kelas pribadi didahului oleh satu garis bawah tunggal. Sebagai contoh:

$_status    _sort()     _initTree()

Sementara

Drupal

gaya kode secara khusus memperingatkan ini :

9. Properti dan metode yang dilindungi atau pribadi tidak boleh menggunakan awalan garis bawah.

Simfoni

di sisi lain, nyatakan :

Symfony mengikuti standar yang ditentukan dalam dokumen PSR-0, PSR-1, PSR-2 dan PSR-4.

Saya tahu itu dari python, di mana awalan variabel Anda dengan garis bawah menyebabkan kompiler menerjemahkan beberapa urutan acak huruf dan angka di depan nama variabel yang sebenarnya. Ini berarti bahwa setiap upaya untuk mengakses variabel dari luar kelas akan menghasilkan kesalahan "variabel tidak terdefinisi".

Saya tidak tahu apakah ini masih merupakan konvensi untuk digunakan dalam python

Dalam Drupal (a php CMS) garis bawah dapat digunakan untuk mencegah agar kait tidak dipanggil ( https://api.drupal.org/api/drupal/includes!module.inc/group/hooks/7 ).

Jika saya memiliki modul yang disebut "my_module" dan ingin memberi nama fungsi my_module_insert itu akan "kait" pada fungsi hook_insert. Untuk mencegahnya, saya dapat mengubah nama fungsi saya menjadi _my_module_insert.

ps Cara kait bekerja di Drupal dimungkinkan untuk menerapkan hook secara tidak sengaja, yang sangat buruk.

Drupal, dan gunakan garis bawah:

Secara umum garis bawah adalah untuk menandai fakta bahwa suatu fungsi mungkin hanya akan dipanggil oleh fungsi induk terkait ...

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

Tentu saja, hanya sebuah contoh sederhana ...

Menggunakan garis bawah hanya untuk tujuan mengingat bahwa kita tidak akan 'memodifikasi variabel' / 'memanggil fungsi' di luar kelas.

Seperti kita mendeklarasikan variabel const di semua huruf besar sehingga sambil melihat nama variabel dapat menebak bahwa itu adalah variabel const. Serupa dengan variabel yang tidak ingin kami modifikasi di luar kelas, kami mendeklarasikannya dengan garis bawah untuk konvensi kami sendiri.

Mereka disebut "metode ajaib" .