따라서 PHPDoc @var에서는 멤버 변수 선언 위에 해당 유형을 암시하도록 지정할 수 있습니다 . 그런 다음 예를 들어 IDE. PHPEd는 어떤 유형의 객체를 사용하는지 알고 해당 변수에 대한 코드 통찰력을 제공 할 수 있습니다.

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

이것은 나중에 객체를 반복 할 때 적절한 힌트를 얻을 수 있도록 객체 배열과 동일하게해야 할 때까지 효과적입니다.

멤버 변수가 SomeObjs 의 배열임을 지정하기 위해 PHPDoc 태그를 선언하는 방법이 있습니까? 예를 들어 @var배열이 충분 @var array(SomeObj)하지 않고 유효하지 않은 것 같습니다.

사용하다:

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

인라인 변수를 타이핑 할 때

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

클래스 속성.

PHPDoc (및 Zend Studio 및 Netbeans와 같은 IDE)에 해당 옵션이없는 '09의 이전 답변 :

당신이 할 수있는 최선의 방법은

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

Zend Studio에서 많이합니다. 다른 편집자에 대해 모르지만 작동해야합니다.

JetBrains의 PhpStorm IDE에서 다음을 사용할 수 있습니다 /** @var SomeObj[] */.

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

하는 PHPDoc 문서는 이 방법을 권장합니다 :

단일 유형을 포함하도록 지정된 경우, 유형 정의는 독자에게 각 배열 요소의 유형을 알려줍니다. 그러면 주어진 배열의 요소로 하나의 유형 만 예상됩니다.

예: @return int[]

넷빈즈 힌트 :

User 클래스 배열에 $users[0]->대한 코드 완성을 얻습니다 $this->.

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

또한 클래스 멤버 목록에서 배열 유형을 볼 수 있습니다. $this->...

변수를 지정하는 것은 객체의 배열입니다 :

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

이것은 Netbeans 7.2에서 작동합니다 (사용하고 있습니다)

함께 작동 :

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

따라서 내부에서 선언을 사용할 foreach필요는 없습니다.

PSR-5 : PHPDoc 은 제네릭 스타일 표기법을 제안합니다.

통사론

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

컬렉션의 값은 다른 배열 일 수도 있고 다른 컬렉션 일 수도 있습니다.

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

예

<?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> */

참고 : IDE에서 코드 지원을 수행 할 것으로 예상되는 경우 IDE가 PHPDoc Generic 스타일 컬렉션 표기법을 지원하는지에 대한 또 다른 질문입니다.

이 질문에 대한 나의 대답으로부터 .

Robert C. Martin의 "Clean Code"에 요약 된대로 깨끗한 코드를 읽고 쓰는 것을 선호합니다. 그의 신조를 따를 때 개발자 (API 사용자)가 배열의 내부 구조를 알도록 요구해서는 안됩니다.

API 사용자는 다음과 같이 질문 할 수 있습니다. 1 차원 배열 만 있습니까? 다차원 배열의 모든 수준에서 개체가 퍼져 있습니까? 모든 객체에 액세스해야하는 중첩 루프 (foreach 등)는 몇 개입니까? 해당 배열에 어떤 유형의 객체가 "저장"됩니까?

개요를 살펴보면 객체를 포함하는 해당 배열을 1 차원 배열로 사용하려고합니다.

Nishi에서 설명한대로 다음을 사용할 수 있습니다.

/**
 * @return SomeObj[]
 */

그에 대한.

그러나 다시 한 번 명심하십시오-이것은 표준 docblock 표기법이 아닙니다. 이 표기법은 일부 IDE 제작자가 도입했습니다.

좋아, 개발자로서 "[]"가 PHP의 배열에 묶여 있다는 것을 알고있다. 그러나 일반적인 PHP 컨텍스트에서 "something []"은 무엇을 의미합니까? "[]"는 "something"내에 새 요소를 만듭니다. 새로운 요소는 모든 것이 될 수 있습니다. 그러나 당신이 표현하고자하는 것은 같은 유형과 정확한 유형의 객체 배열입니다. 보시다시피, IDE 제작자는 새로운 컨텍스트를 소개합니다. 배워야 할 새로운 맥락. 다른 PHP 개발자들이 (문서 블록을 이해하기 위해) 배워야 할 새로운 맥락. 나쁜 스타일 (!).

배열은 하나의 차원을 가지기 때문에 "객체 배열"을 "목록"이라고 부를 수 있습니다. "목록"은 다른 프로그래밍 언어에서 매우 특별한 의미를 갖습니다. 예를 들어 "컬렉션"이라고 부르는 것이 좋습니다.

기억하십시오 : OOP의 모든 옵션을 가능하게하는 프로그래밍 언어를 사용합니다. 배열 대신 클래스를 사용하고 클래스처럼 배열을 순회 가능하게 만듭니다. 예 :

class orderCollection implements ArrayIterator

또는 다차원 배열 / 개체 구조 내에서 다른 수준의 내부 개체를 저장하려는 경우 :

class orderCollection implements RecursiveArrayIterator

이 솔루션은 배열을 "orderCollection"유형의 객체로 대체하지만 IDE 내에서 코드 완성을 활성화하지는 않습니다. 괜찮아. 다음 단계:

docblock과의 인터페이스에 의해 도입되는 메소드를 구현합니다.

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

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

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

다음에 유형 힌트를 사용하는 것을 잊지 마십시오.

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

이 솔루션은 다음과 같은 많은 도입을 중단합니다.

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

Zahymaka가 자신의 답변으로 확인한 것처럼 코드 파일 전체 (예 : 루프 내). API 사용자는 해당 docblock을 도입하여 코드를 완성하지 않아도됩니다. @return을 한 곳에서만 설정하면 중복 (@var)이 가능한 한 감소됩니다. "docBlocks with @var"을 뿌리면 코드를 읽을 수 없게됩니다.

마지막으로 당신은 끝났습니다. 힘들게 보입니까? 너트를 깨기 위해 망치를 타는 것처럼 보입니까? 그 인터페이스와 깨끗한 코드에 익숙하기 때문에 실제로는 아닙니다. 기억하십시오 : 소스 코드는 한 번 작성되고 많은 것을 읽습니다.

IDE의 코드 완성이이 방법으로 작동하지 않으면 더 나은 방법으로 전환하거나 (예 : IntelliJ IDEA, PhpStorm, Netbeans) IDE 제작자의 이슈 트래커에 기능 요청을 제출하십시오.

트레이너이자 훌륭한 자료를 가르쳐 주신 Christian Weiss (독일 출신)에게 감사합니다. 추신 : XING에서 나와 나와 만나십시오.

array[type]Zend Studio에서 사용하십시오 .

Zend Studio에서 array[MyClass]또는 array[int]심지어 array[array[MyClass]]잘 작동합니다.

NetBeans 7.0에서 (더 낮을 수도 있음) 리턴 유형 "array with Text objects"를 선언 @return Text하고 코드 힌트가 작동합니다.

편집 : @ Bob Fanger 제안으로 예제를 업데이트했습니다 .

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

그리고 그냥 사용하십시오 :

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

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

완벽하지는 않지만 단지 "혼합 된"상태로 두는 것이 낫습니다.

단점은 배열을 텍스트 객체로 밟아 오류를 발생시킬 수 있다는 것입니다.

DanielaWaranie 그녀의 대답에 언급 한 바와 같이 - 당신이 $ collectionObject에 $ 항목을 통해 반복 할 때 $ 항목의 유형을 지정하는 방법이있다 : 추가 @return MyEntitiesClassName로 current()와의 휴식 Iterator과 ArrayAccess-methods하는 반환 값.

팔! 에서 필요 /** @var SomeObj[] $collectionObj */이상 foreach하고 잘 컬렉션 개체와 함께 작동하지, 특정 방법으로 반환 컬렉션에 필요로 설명하지@return SomeObj[] .

모든 IDE가 지원하지는 않지만 PhpStorm에서는 완벽하게 작동하므로 더 행복합니다.

예:

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
}

이 답변을 게시하면 어떤 유용한 정보를 얻을 수 있었습니까

내 경우에는 current()나머지 interface방법이 구현됩니다.Abstract -collection 클래스 되며 결국 어떤 종류의 엔티티가 컬렉션에 저장되는지 알 수 없습니다.

그래서 여기 트릭이 있습니다 : 추상 클래스에서 반환 유형을 지정하지 말고 대신 PhpDoc 인스트럭션을 사용하십시오 @method 특정 컬렉션 클래스의 설명에서 .

예:

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...

}

이제 클래스 사용법 :

$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();
}

다시 한번 : 모든 IDE가이를 지원하지는 않지만 PhpStorm은 지원합니다. 당신을 시도하고 결과를 의견에 게시하십시오!

나는 파티에 늦었다는 것을 알고 있지만 최근 에이 문제를 연구하고 있습니다. 수락 된 답변은 정확하지만 정확 하지 않기 때문에 누군가 이것을 볼 수 있기를 바랍니다. 당신이 할 수있는 최선의 방법입니다. 적어도 PHPStorm에는 없지만 NetBeans는 테스트하지 않았습니다.

가장 좋은 방법은 기본 배열 유형을 사용하지 않고 ArrayIterator 클래스를 확장하는 것입니다. 이를 통해 인스턴스 수준이 아닌 클래스 수준에서 힌트를 입력 할 수 있습니다. 즉, 코드 전체가 아닌 PHPDoc에 한 번만 필요합니다 (지저분하고 DRY를 위반 할뿐만 아니라 문제가 발생할 수 있음) 리팩토링-PHPStorm은 리팩토링시 PHPDoc을 놓치는 습관이 있습니다)

아래 코드를 참조하십시오 :

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();

여기서 핵심은 PHPDoc이 @method MyObj current()ArrayIterator에서 상속 된 반환 유형 ()을 재정의하는 것입니다 mixed. 이 PHPDoc의 포함은 다음을 사용하여 클래스 속성을 반복 할 때foreach($this as $myObj) 할 때 변수를 참조 할 때 코드 완성을 얻음을 의미합니다.$myObj->...

나에게 이것은 코드 전체에 흩어져있는 클래스의 인스턴스가 아닌 반복 가능한 클래스에서 반복자 유형을 선언하기 때문에 이것을 달성하는 가장 쉬운 방법입니다 (적어도 PHP는 유형 배열을 도입 할 때까지).

여기서는 ArrayIterator 확장을위한 완벽한 솔루션을 보여주지 않았으므로이 기술을 사용하면 다음을 수행 할 수도 있습니다.

• 다음과 같은 방법에 대한 필요에 따라 다른 클래스 수준의하는 PHPDoc, 포함 offsetGet($index)및next()
• 온 전성 검사 is_a($object, MyObj::class)를 생성자에서 개인 메서드로 이동
• 같은 방법 오버라이드 (override)에서이 (지금 개인) 전성 검사 전화 offsetSet($index, $newval)와append($value)

문제는 @var단일 유형을 나타낼 수 있다는 것 입니다. 복잡한 수식을 포함하지 않습니다. "Farray of Foo"에 대한 구문이있는 경우, 여기서 중지하고 "2 Foo와 3 개의 Bar를 포함하는 배열의 배열"에 대한 구문을 추가하지 않는 이유는 무엇입니까? 요소 목록이 그보다 일반적 일 수는 있지만 미끄러운 경사입니다.

개인적으로, 나는 @var Foo[]"Foo 's 배열"을 나타내는 데 몇 번이나 사용 했지만 IDE에서는 지원하지 않습니다.

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

작동하는 것을 찾았습니다. 생명을 구할 수 있습니다!

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