我曾尝试对Magento进行逆向工程,我认为阅读每种方法都是一个好的开始(官方文档太浅了)。 Magento似乎没有预先生成的文档,这很公平,因为每种配置都彼此不同,因此以通用方式对其进行记录是没有意义的。代码库中有DocBlocks,我认为我可以使用PhpDoc为其生成文档。
Magento发行版是2.3.3,摘自其github页面:https://github.com/magento/magento2/archive/2.3.3.tar.gz
该环境位于Docker Ubuntu容器中,版本18.04.3 LTS。以下是Dockerfile中的重要信息:
RUN apt-get -y install php-bcmath \
php-curl \
php-gd \
php-intl \
php-soap \
php-zip \
php-mbstring \
#php-dom \
php-xml \
php-mysql \
composer
RUN mkdir /phpdoc \
&& wget -O /phpdoc.tar.gz https://github.com/phpDocumentor/phpDocumentor/archive/v3.0.0-alpha.4.tar.gz \
&& tar -xvpzf /phpdoc.tar.gz -C /phpdoc --strip-component=1 \
&& cd /phpdoc \
&& composer install
RUN echo "\nexport PATH=$PATH:/var/www/magento/bin:/phpdoc/bin\n" >> /root/.bashrc
首先运行是安装Magento的依赖项第二次运行是在/ phpdoc上安装phpdoc第三个RUN是使phpdoc命令成为全局命令
Php版本是7.3.12
我必须使用phpdoc版本3,因为php版本是7。我试图在PhpDoc版本2上运行完全相同的设置,但它不起作用。我到处寻找解决方案,共识是PhpDoc无法解析php 7,因此我必须使用版本3。
PhpDoc似乎安装得很好。它似乎也运行良好。我尝试在一个小文件夹上运行它(在/var/www/magento/app/code/Magento/Tax
,其中/var/www/magento
是文档根目录),以进行测试
shell输出:
root@78ace9205c9e:/var/www/magento/app/code/Magento# phpdoc -d Tax -t /var/www/docs
phpDocumentor vNo version set (parsed as 1.0.0)@
Parsing files
Applying transformations (can take a while)
17/17 [============================] 100%
All done!
root@78ace9205c9e:/var/www/magento/app/code/Magento#
这些文件也整洁地位于/ var / www / docs中,并且看起来很正常。这是目录清单:
root@78ace9205c9e:/var/www/docs# ls -la
total 472
drwxr-xr-x 11 root root 4096 Dec 10 16:20 .
drwxr-xr-x 1 root root 4096 Dec 10 17:05 ..
-rw-r--r-- 1 root root 229 Dec 10 19:09 .htaccess
drwxr-xr-x 2 root root 90112 Dec 10 18:56 classes
drwxr-xr-x 3 root root 4096 Dec 10 16:20 css
drwxr-xr-x 70 root root 94208 Dec 10 18:56 files
drwxr-xr-x 2 root root 4096 Dec 10 16:20 font
drwxr-xr-x 2 root root 4096 Dec 10 16:20 graphs
drwxr-xr-x 3 root root 4096 Dec 10 16:20 images
-rw-r--r-- 1 root root 202668 Dec 10 19:09 index.html
drwxr-xr-x 3 root root 4096 Dec 10 16:20 js
drwxr-xr-x 2 root root 49152 Dec 10 18:55 namespaces
drwxr-xr-x 2 root root 4096 Dec 10 16:20 reports
root@78ace9205c9e:/var/www/docs#
这是文件/var/www/docs/index.html的一部分:
root@78ace9205c9e:/var/www/docs# cat /var/www/docs/index.html | head -n 219 | tail -n 36
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-306007264"></a>
<a href="" style="margin-left: 30px; padding-left: 0">Block</a>
</div>
<div id="namespace-306007264" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-954821111"></a>
<a href="" style="margin-left: 30px; padding-left: 0">Adminhtml</a>
</div>
<div id="namespace-954821111" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-289993205"></a>
<a href="" style="margin-left: 30px; padding-left: 0">Frontend</a>
</div>
<div id="namespace-289993205" class="accordion-body collapse ">
<div class="accordion-inner">
<div class="accordion" style="margin-bottom: 0">
<div class="accordion-group">
<div class="accordion-heading">
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1022188315"></a>
<a href="" style="margin-left: 30px; padding-left: 0">Region</a>
</div>
<div id="namespace-1022188315" class="accordion-body collapse ">
<div class="accordion-inner">
root@78ace9205c9e:/var/www/docs#
如果您仔细注意,则链接的href为空。这基本上意味着文档几乎一文不值。这是直观的结果:
左侧的菜单看起来还不错,我可以探索树的结构。但是,当我单击1菜单项时,它只是返回到默认页面(这是预期的,因为href为空)。如果我直接转到名称空间的html文件(如/namespaces/Magento.Tax.html),则效果很好,如下所示:
一切似乎都工作正常,但神秘地链接却无法正常工作。任何帮助表示赞赏!
所以经过一段时间尝试其他php文档工具后,它们都无法正常工作。我猜这是因为php7太新了,几乎没有人使它工作。我的解决方案是只打开phpstorm中的每个文件,让它完成索引所有内容的艰苦工作,并将其用作临时文档。