Jadi, di PHPDoc kita dapat menentukan di @varatas deklarasi variabel anggota untuk mengisyaratkan pada tipenya. Kemudian sebuah IDE, misalnya. PHPEd, akan tahu jenis objek apa yang bekerja dengannya dan akan dapat memberikan wawasan kode untuk variabel itu.

<?php
  class Test
  {
    /** @var SomeObj */
    private $someObjInstance;
  }
?>

Ini berfungsi dengan baik sampai saya perlu melakukan hal yang sama ke array objek untuk bisa mendapatkan petunjuk yang tepat ketika saya beralih melalui objek-objek itu nanti.

Jadi, apakah ada cara untuk mendeklarasikan tag PHPDoc untuk menentukan bahwa variabel anggota adalah array dari SomeObjs? @vararray tidak cukup, dan @var array(SomeObj)sepertinya tidak valid, misalnya.

Menggunakan:

/* @var $objs Test[] */
foreach ($objs as $obj) {
    // Typehinting will occur after typing $obj->
}

saat mengetikkan variabel sebaris, dan

class A {
    /** @var Test[] */
    private $items;
}

untuk properti kelas.

Jawaban sebelumnya dari '09 ketika PHPDoc (dan IDE seperti Zend Studio dan Netbeans) tidak memiliki opsi itu:

Yang terbaik yang bisa Anda lakukan adalah mengatakan,

foreach ($Objs as $Obj)
{
    /* @var $Obj Test */
    // You should be able to get hinting after the preceding line if you type $Obj->
}

Saya sering melakukan itu di Zend Studio. Tidak tahu tentang editor lain, tetapi itu harus berhasil.

Dalam IDE PhpStorm dari JetBrains, Anda dapat menggunakan /** @var SomeObj[] */, misalnya:

/**
 * @return SomeObj[]
 */
function getSomeObjects() {...}

The dokumentasi phpdoc merekomendasikan metode ini:

ditentukan mengandung satu jenis, definisi Jenis menginformasikan pembaca jenis setiap elemen array. Hanya satu Jenis yang diharapkan sebagai elemen untuk array yang diberikan.

Contoh: @return int[]

Petunjuk Netbeans:

Anda mendapatkan penyelesaian kode untuk $users[0]->dan untuk $this->berbagai kelas Pengguna.

/**
 * @var User[]
 */
var $users = array();

Anda juga dapat melihat jenis array dalam daftar anggota kelas ketika Anda selesai $this->...

Untuk menentukan variabel adalah array objek:

$needles = getAllNeedles();
/* @var $needles Needle[] */
$needles[1]->...                        //codehinting works

Ini bekerja di Netbeans 7.2 (Saya menggunakannya)

Bekerja juga dengan:

$needles = getAllNeedles();
/* @var $needles Needle[] */
foreach ($needles as $needle) {
    $needle->...                        //codehinting works
}

Oleh karena itu penggunaan deklarasi di dalam foreachtidak diperlukan.

PSR-5: PHPDoc mengusulkan bentuk notasi gaya Generics.

Sintaksis

Type[]
Type<Type>
Type<Type[, Type]...>
Type<Type[|Type]...>

Nilai dalam Koleksi MUNGKIN bahkan menjadi array lain dan bahkan Koleksi lain.

Type<Type<Type>>
Type<Type<Type[, Type]...>>
Type<Type<Type[|Type]...>>

Contohnya

<?php

$x = [new Name()];
/* @var $x Name[] */

$y = new Collection([new Name()]);
/* @var $y Collection<Name> */

$a = new Collection(); 
$a[] = new Model_User(); 
$a->resetChanges(); 
$a[0]->name = "George"; 
$a->echoChanges();
/* @var $a Collection<Model_User> */

Catatan: Jika Anda mengharapkan IDE untuk melakukan bantuan kode, maka itu adalah pertanyaan lain tentang apakah IDE mendukung notasi koleksi gaya generik PHPDoc.

Dari jawaban saya untuk pertanyaan ini .

Saya lebih suka membaca dan menulis kode bersih - sebagaimana diuraikan dalam "Kode Bersih" oleh Robert C. Martin. Saat mengikuti kredo Anda, Anda tidak perlu meminta pengembang (sebagai pengguna API Anda) untuk mengetahui struktur (internal) array Anda.

Pengguna API dapat bertanya: Apakah itu array dengan satu dimensi saja? Apakah objek tersebar di semua tingkatan array multi dimensi? Berapa banyak loop bersarang (foreach, dll.) Yang saya perlukan untuk mengakses semua objek? Jenis objek apa yang "disimpan" dalam array itu?

Saat Anda menguraikan Anda ingin menggunakan array itu (yang berisi objek) sebagai array satu dimensi.

Seperti yang dijelaskan oleh Nishi, Anda dapat menggunakan:

/**
 * @return SomeObj[]
 */

untuk itu.

Tetapi sekali lagi: waspada - ini bukan notasi docblock standar. Notasi ini diperkenalkan oleh beberapa produsen IDE.

Oke, oke, sebagai pengembang Anda tahu bahwa "[]" terikat ke sebuah array di PHP. Tapi apa arti "sesuatu []" dalam konteks PHP normal? "[]" berarti: membuat elemen baru di dalam "sesuatu". Elemen baru bisa menjadi segalanya. Tetapi apa yang ingin Anda ungkapkan adalah: array objek dengan tipe yang sama dan tipe tepat. Seperti yang Anda lihat, produsen IDE memperkenalkan konteks baru. Konteks baru yang harus Anda pelajari. Konteks baru yang harus dipelajari oleh pengembang PHP lain (untuk memahami dokumen Anda). Gaya buruk (!).

Karena array Anda memiliki satu dimensi, Anda mungkin ingin memanggil "array objek" sebagai "daftar". Ketahuilah bahwa "daftar" memiliki arti yang sangat istimewa dalam bahasa pemrograman lain. Akan lebih baik jika menyebutnya "koleksi" misalnya.

Ingat: Anda menggunakan bahasa pemrograman yang memungkinkan Anda semua opsi OOP. Gunakan kelas sebagai ganti array dan buat kelas Anda dapat dilalui seperti array. Misalnya:

class orderCollection implements ArrayIterator

Atau jika Anda ingin menyimpan objek internal pada level yang berbeda dalam array multi dimensi / struktur objek:

class orderCollection implements RecursiveArrayIterator

Solusi ini menggantikan array Anda dengan objek tipe "orderCollection", tetapi sejauh ini tidak memungkinkan penyelesaian kode di dalam IDE Anda. Baik. Langkah berikutnya:

Menerapkan metode yang diperkenalkan oleh antarmuka dengan docblocks - khususnya:

/**
 * [...]
 * @return Order
 */
orderCollection::current()

/**
 * [...]
 * @return integer E.g. database identifier of the order
 */
orderCollection::key()

/**
 * [...]
 * @return Order
 */
orderCollection::offsetGet()

Jangan lupa untuk menggunakan petunjuk tipe untuk:

orderCollection::append(Order $order)
orderCollection::offsetSet(Order $order)

Solusi ini berhenti memperkenalkan banyak:

/** @var $key ... */
/** @var $value ... */

seluruh file kode Anda (misalnya dalam loop), seperti yang dikonfirmasi Zahymaka dengan jawabannya. Pengguna API Anda tidak dipaksa untuk memperkenalkan docblock itu, untuk memiliki penyelesaian kode. Untuk memiliki @return hanya pada satu tempat mengurangi redundansi (@var) semut mungkin. Taburkan "docBlocks with @var" akan membuat kode Anda lebih mudah dibaca.

Akhirnya kamu sudah selesai. Terlihat sulit untuk dicapai? Sepertinya mengambil palu untuk memecahkan kacang? Tidak benar-benar, karena Anda terbiasa dengan antarmuka itu dan dengan kode bersih. Ingat: kode sumber Anda ditulis sekali / banyak dibaca.

Jika penyelesaian kode IDE Anda tidak berfungsi dengan pendekatan ini, beralihlah ke pendekatan yang lebih baik (mis. IntelliJ IDEA, PhpStorm, Netbeans) atau ajukan permintaan fitur pada pelacak masalah produsen IDE Anda.

Terima kasih kepada Christian Weiss (dari Jerman) karena menjadi pelatih saya dan karena mengajari saya hal-hal hebat. PS: Temui saya dan dia di XING.

Gunakan array[type]di Zend Studio.

Di Zend Studio, array[MyClass]atau array[int]atau bahkan array[array[MyClass]]bekerja dengan baik.

Di NetBeans 7.0 (mungkin lebih rendah juga) Anda bisa mendeklarasikan tipe pengembalian "array with Text objects" sama seperti @return Textdan petunjuk kode akan berfungsi:

Sunting: memperbarui contoh dengan saran @Bob Fanger

/**
 * get all Tests
 *
 * @return Test|Array $tests
 */
public function getAllTexts(){
    return array(new Test(), new Test());
}

dan gunakan saja:

$tests =  $controller->getAllTests();
//$tests->         //codehinting works!
//$tests[0]->      //codehinting works!

foreach($tests as $text){
    //$test->      //codehinting works!
}

Itu tidak sempurna tetapi lebih baik daripada hanya membiarkannya hanya "dicampur", yang tidak membawa nilai.

CONS adalah Anda diizinkan untuk menginjak array sebagai Obyek Teks yang akan melempar kesalahan.

Seperti yang disebutkan DanielaWaranie dalam jawabannya - ada cara untuk menentukan jenis $ item ketika Anda mengulangi lebih dari $ item dalam $ collectionObject: Tambahkan @return MyEntitiesClassNameke current()dan sisa dari Iteratordan ArrayAccess-metode yang mengembalikan nilai.

Ledakan! Tidak perlu di /** @var SomeObj[] $collectionObj */atas foreach, dan berfungsi baik dengan objek koleksi, tidak perlu mengembalikan koleksi dengan metode khusus yang dijelaskan sebagai @return SomeObj[].

Saya kira tidak semua IDE mendukungnya tetapi berfungsi dengan baik di PhpStorm, yang membuat saya lebih bahagia.

Contoh:

class MyCollection implements Countable, Iterator, ArrayAccess {

    /**
     * @return User
     */
    public function current() {
        return $this->items[$this->cursor];
    }

    //... implement rest of the required `interface` methods and your custom
}

Apa yang berguna saya akan menambahkan memposting jawaban ini

Dalam kasus saya current()dan sisa interface-metode yang diterapkan di Abstractkelas -koleksi dan saya tidak tahu apa jenis entitas yang akhirnya akan disimpan dalam koleksi.

Jadi di sini adalah triknya: Jangan tentukan tipe return di kelas abstrak, alih-alih gunakan instuksi PhpDoc @methoddalam deskripsi kelas koleksi tertentu.

Contoh:

class User {

    function printLogin() {
        echo $this->login;
    }

}

abstract class MyCollection implements Countable, Iterator, ArrayAccess {

    protected $items = [];

    public function current() {
        return $this->items[$this->cursor];
    }

    //... implement rest of the required `interface` methods and your custom
    //... abstract methods which will be shared among child-classes
}

/**
 * @method User current()
 * ...rest of methods (for ArrayAccess) if needed
 */
class UserCollection extends MyCollection {

    function add(User $user) {
        $this->items[] = $user;
    }

    // User collection specific methods...

}

Sekarang, penggunaan kelas:

$collection = new UserCollection();
$collection->add(new User(1));
$collection->add(new User(2));
$collection->add(new User(3));

foreach ($collection as $user) {
    // IDE should `recognize` method `printLogin()` here!
    $user->printLogin();
}

Sekali lagi: Saya kira tidak semua IDE mendukungnya, tetapi PhpStorm mendukungnya. Coba milikmu, kirim komentar hasilnya!

Saya tahu saya terlambat ke pesta, tapi saya sudah mengerjakan masalah ini baru-baru ini. Saya harap seseorang melihat ini karena jawaban yang diterima, meskipun benar, bukan cara terbaik Anda bisa melakukan ini. Setidaknya tidak di PHPStorm, saya belum menguji NetBeans.

Cara terbaik melibatkan perluasan kelas ArrayIterator daripada menggunakan tipe array asli. Ini memungkinkan Anda untuk mengetikkan petunjuk di tingkat kelas daripada di tingkat contoh, yang berarti Anda hanya perlu PHPDoc sekali, tidak di seluruh kode Anda (yang tidak hanya berantakan dan melanggar KERING, tetapi juga bisa bermasalah ketika datang ke refactoring - PHPStorm memiliki kebiasaan melewatkan PHPDoc saat refactoring)

Lihat kode di bawah ini:

class MyObj
{
    private $val;
    public function __construct($val) { $this->val = $val; }
    public function getter() { return $this->val; }
}

/**
 * @method MyObj current()
 */
class MyObjCollection extends ArrayIterator
{
    public function __construct(Array $array = [])
    {
        foreach($array as $object)
        {
            if(!is_a($object, MyObj::class))
            {
                throw new Exception('Invalid object passed to ' . __METHOD__ . ', expected type ' . MyObj::class);
            }
        }
        parent::__construct($array);
    }

    public function echoContents()
    {
        foreach($this as $key => $myObj)
        {
            echo $key . ': ' . $myObj->getter() . '<br>';
        }
    }
}

$myObjCollection = new MyObjCollection([
    new MyObj(1),
    new MyObj('foo'),
    new MyObj('blah'),
    new MyObj(23),
    new MyObj(array())
]);

$myObjCollection->echoContents();

Kuncinya di sini adalah PHPDoc @method MyObj current()mengesampingkan jenis kembali yang diwarisi dari ArrayIterator (yaitu mixed). Dimasukkannya PHPDoc ini berarti bahwa ketika kita beralih menggunakan properti kelas foreach($this as $myObj), kita kemudian mendapatkan penyelesaian kode ketika merujuk ke variabel$myObj->...

Bagi saya, ini adalah cara paling rapi untuk mencapai ini (setidaknya sampai PHP memperkenalkan Typed Array, jika mereka melakukannya), seperti yang kita nyatakan tipe iterator di kelas iterable, bukan pada contoh kelas yang tersebar di seluruh kode.

Saya belum menunjukkan di sini solusi lengkap untuk memperluas ArrayIterator, jadi jika Anda menggunakan teknik ini, Anda mungkin juga ingin:

• Sertakan PHPDoc tingkat kelas lainnya sesuai kebutuhan, untuk metode seperti offsetGet($index)dannext()
• Pindahkan cek kewarasan is_a($object, MyObj::class)dari konstruktor ke metode pribadi
• Sebut pemeriksaan kewarasan ini (sekarang pribadi) dari penggantian metode seperti offsetSet($index, $newval)danappend($value)

Masalahnya adalah bahwa @varhanya dapat menunjukkan tipe tunggal - Tidak mengandung formula yang kompleks. Jika Anda memiliki sintaks untuk "array Foo", mengapa berhenti di situ dan tidak menambahkan sintaks untuk "array array, yang berisi 2 Foo dan tiga Bar"? Saya mengerti bahwa daftar elemen mungkin lebih umum dari itu, tetapi ini merupakan lereng yang licin.

Secara pribadi, saya pernah beberapa kali @var Foo[]menandakan "array Foo", tetapi tidak didukung oleh IDE.

<?php foreach($this->models as /** @var Model_Object_WheelModel */ $model): ?>
    <?php
    // Type hinting now works:
    $model->getImage();
    ?>
<?php endforeach; ?>

Saya telah menemukan sesuatu yang berfungsi, itu bisa menyelamatkan nyawa!

private $userList = array();
$userList = User::fetchAll(); // now $userList is an array of User objects
foreach ($userList as $user) {
   $user instanceof User;
   echo $user->getName();
}