phpDoc for object's properties

Question

I've got file template.php, that is included in CBitrixComponentTemplate's method. CBitrixComponentTemplate has property $this->__component, that is dynamicly filled with object EtmOrderAdd. EtmOrderAdd has property objValidator.

Now, when I am writing the file template.php, I need all these properties to be understood by phpDoc. Here's the picture, illustrating my idea :

enter image description here

How should I write it?

@property only works when used in PHPDoc for THAT class -- it will not work the way you are trying to use it. Since I'm not familiar with Bitrix at all, my only suggestion right now would be to introduce intermediate variable and use it instead (and for such case ordinary @var will work) — LazyOne
– LazyOne, Commented Oct 1, 2014 at 14:51

nook_ru · Accepted Answer · 2015-01-21 11:42:56Z

3

Bitrix has almost no phpDoc for internal methods and functions. Also it has a plenty of legacy code, that won't show correctly with PhpStorm's code completion.

However, there are several things you can try to improve the situation:

Add bxApiDocs files as an External Library to PhpStorm.
This will add autocomplete for the internal bitrix methods
It seems like you've defined custom component class since $template->__component usually contains CBitrixComponent object that doesn't have objValidator property. So you need to add @property inside your class.php file of your component.

answered Jan 21, 2015 at 11:42

nook_ru

313 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

phpDoc for object's properties

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related