Questions tagged [phpDocumentor] (46)

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

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

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

After generating code using Gii machine are comments of the type/** * @inheritdoc */ what does it mean?

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?

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?

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

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

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 ?

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