Questions tagged [phpDocumentor] (46)

4
answers

How does the @var phpDoc when the interface is?

How does @var when specifying class I understand, but what about the interface?/** * Product model * * @var \carono\exchange1c\interfaces\ProductInterface */ public $productClass; UPD: The calling code/** * @return ProductInterface */ protected function getProductClass() { return $this->exModule->productClass; ...
Verner_White64 asked April 4th 20 at 12:32
0
answer

How to specify the relationship (dependencies) between components in PHP?

There are several folders with components, such as button, icon, image, text, gallery etc. Inside each folder is a php template, component, css, js, etc. Some components may use in your template, other components (for example, a button uses icon; or gallery uses the image and the button). Problem following - it is necessary...
arely_Marquardt asked April 4th 20 at 00:40
3
answers

How to comment PHP and JS code is there described somewhere in the standard?

The customer wants to develop well documented :) Tell me, are there any formal standards? For example, often meet in frameworks code something like:/** * Resolve the element''s value. * * @param mixed $resource * @param string|null $attribute * @return void */ Is somewhere specified in advance? Some specifications may ...
tavares_Corwin76 asked March 29th 20 at 23:35
2
answers

What do you mean inheritdoc tag in the comments generated by using gii in Yii2?

After generating code using Gii machine are comments of the type/** * @inheritdoc */ what does it mean?
Pasquale.Corkery asked March 29th 20 at 21:07
0
answer

How to document magic methods for autolookup in phpstorm?

Actually the subject is the following: there is a class which takes an unspecified number of kalbekov and calls them using magic, since that is not known beforehand which functions are registered, interested in the following: is it possible to document the specific object on the fly in order to use the autocompletion?
furman_Breitenberg asked March 29th 20 at 20:32
1
answer

As in phpstorm to automatically change the namespace in all phpdoc?

As with all phpdoc blocks to replace the full path in FQN?/** * @param \app\models\Test $test */ onuse app\models\Test; /** * @param Test $test */ Is there any ready-made functionality for this or a plugin?
Jeramie_Okune asked March 27th 20 at 13:08
2
answers

How to get rid of duplication in the description of the structure of the array?

Now we have to describe like this:/** * @var array $items = [ * 'left' => [ * 'id' => 1, * 'date_create' => '2019-07-23 11:47:35', * 'date_update' => '2019-07-23 11:47:35', * 'url' => '/sdsd/sdsdsd/', * 'active' => 1, * 'lang' => [ * 'id' => 1, * 'news_id' => 1, * 'lang_id' => 1, * ...
Palma.Leuschke71 asked March 25th 20 at 11:53
2
answers

How to use phpDoc to describe two variants of a method, overloaded using __call and __callStatic?

In the class there are two magic method __call and callStatic, which is overloaded conditional method read(). In the case of treatment by this method as static, it is passed the id of the entity for reading. In the case of treatment to him as to a method of a class instance, it is not transmitted, the id is taken from the i...
Nina86 asked March 19th 20 at 19:43
2
answers

What's wrong with phpdoc?

Good afternoon you have an array $bookList and the objects in it $book, when I label them as phpDoc @ var phpStorm does not swear , and when referred to as the @ array and @ ojbect appropriately displayed warning. What's the matter ?
mitchell_Waters asked March 19th 20 at 08:33
3
answers

Why you need a PHPDoc in php 7?

Please tell me why you need to specify the type of the method parameter and the type that the method returns in phpDoc, if the seventh version of php in the method, you can specify the parameter type and the type of wasuremono znaczenia? This is pointless duplication. Why do that?/** * Very important function * * @param s...
jarret84 asked March 17th 20 at 11:48