phpdoc @return과 지연로드

Question

자동 완성을위한 내 방법을 문서화하는 방법을 모르겠습니다.

내 모델 교육에는 SeekableIterator 및 Countable을 구현하는 Db_MysqlResult를 반환하는 getAnimators() 메소드가 있습니다. 내가 예를 들어, 그것을 반복 할 때 Db_MysqlResult 내 애니메이터 객체를 생성합니다 :

나는 @return 쓸 수

<?php 
foreach ($training->getAnimators() as $animator) { 
    // Autocompletion shows me next, seek, etc. not getName 
    echo $animator->getName(); 
} 
?> 

애니메이터 [] 내 getAnimators에서() 그것은 Db_MysqlResult를 반환하기 때문에 그것이 사실이 아닌 경우에도?

미리 도움을 주셔서 감사합니다.

Answer 1

당신은 그것의 방법을 자동으로 완성하도록 $ 애니메이터 변수를 찾고 있다면, 당신의 최선의 방법이에 @var 라인 힌트를 추가 할 수 있습니다 :

/** @var Animator $animator */ 
echo $animator-> 

일부의 IDE가 @var를 인식 할 수있는 능력을 가지고 line을 타입 힌트로 사용하여 자동 완성을 제공합니다.

그러나 $ training-> getAnimators()의 반환 값을 인식하고 foreach()에서 함께 묶이는 $ animator의 유형을 자동으로 인식하는 IDE는 알지 못합니다.