Add dependencies from class-like docblock annotations about deptrac HOT 3 CLOSED

Do you have some documentation reference to those frameworks? If we do this, ai would like to do it right, such that it does not break for some unforeseen circumstances.

from deptrac.

Sure - the framework I'm working with at the moment is some (very legacy) code in CakePHP 2 (https://book.cakephp.org/2/en/index.html).

In this framework various class types can access other class types through magic properties, for example $controller->model, or $model->otherModel. There are quite a few different potential links between class types like this, and working out which are available where is a little complex (it depends on class names, and also a few class property values). Models can also "inherit" methods from behavior classes, but when this happens the model is passed as the first parameter, so the method in the model is missing the first parameter of the behavior's method.

To allow us to perform useful static analysis and use IDE autocomplete etc. we've started manually adding these properties and methods as doc block @propertys and @methods, similar to the doc blocks produced by https://github.com/barryvdh/laravel-ide-helper. In Laravel however, as models, controllers, etc. exist in different namespaces, deptrac sees the dependencies because of the use ... lines at the top of the file. In CakePHP 2, there is no namespacing, so no use lines.

It would be great to be able to generically catch these docblock annotations in the way that IDEs do, so we can see the dependencies., It would then be up to us to separately maintain the correct docblock, or find/modify/create a tool to update it, which we do anyway for the benefit of IDEs, phpstan, etc.

from deptrac.

Oh, now I realized. It has been years since I've seen these. Sure that makes sense, we should add those, no problem.

from deptrac.