2017-07-11 8 views
1

で使用される変数を宣言します。自動的に私はこのような多くの変数がテンプレートに渡されますが(もタイプヒンティングのPhpStormで働く)docコメントで宣言されていないいくつかの古い小枝テンプレート、リファクタリングしてい小枝テンプレート

{# @var user AppBundle\Entity\User #} 
{# @var message string #} 
<p>Hello {{ user.fullName }}!</p> 
<p>{{ message }}</p> 

テンプレートで使用されている変数からこれらのドキュメントコメントを事前に生成できるツールがありますか?理想的にはPhpStormプラグインとして使用できますか?

変数を見落としていないことを確認するために、変数名をタイプなしで抽出するだけで十分です(これはTwig構文から推測しにくい)。

それはテンプレートで作成した変数を宣言しない場合は、このようにまた、それは、素晴らしいものになります。

{# @var users AppBundle\Entity\User[] #} 
{# "user" variable is not documented as it is not passed into the template from outside #} 
{% for user in users %} 
<p>Hello {{ user.fullName }}!</p> 
{% endfor %} 

このようなコメントがタイプヒンティングのため、だけでなく、どうあるべきかを確認する開発者のためだけでなく、便利ですテンプレートをリファクタリング/再利用するときにテンプレートに渡すことができます。

ありがとうございます。

+0

あなたの最初のコードブロックがユーザーオブジェクトのPhpStormオートコンプリートを与えると言っていますか?鉱山はそれをしないので尋ねる、私はそれを愛するだろう。 –

+0

はい、私のために働きます(最新のPhpStormとSymfonyプラグイン)。この構文(phpdocとの比較では常にvarName/typeの逆順、常にFQCN)を正確に実行してみてください。しかし、たとえそれが抽出されなかったとしても、依然として多くの有用性があります。 – amik

答えて

0

残念ながら、IDEまたは使用可能なプラグインがユースケースのために提案できるものは何もありません。

+0

回答ありがとうございますが、私はまだ肯定的なものが来ることを願っています:) – amik

+1

これはありません。もし存在しない場合は、PhpStormバグトラッカーで機能リクエストを送信してください。http://youtrack.jetbrains.com/issues/ WI#newissue = yes –

+2

良いアイデアですが、これはSymfonyプラグインの機能になりそうです - https://github.com/Haehnchen/idea-php-symfony2-plugin/issues/974に投稿しました – amik

関連する問題