{"id":950,"date":"2018-07-31T13:36:46","date_gmt":"2018-07-31T13:36:46","guid":{"rendered":"https:\/\/codingfix.com\/?p=950"},"modified":"2024-09-02T15:58:22","modified_gmt":"2024-09-02T15:58:22","slug":"installing-phpdocumentor-issues-solved","status":"publish","type":"post","link":"https:\/\/codingfix.com\/installing-phpdocumentor-issues-solved\/","title":{"rendered":"Installing phpDocumentor issues solved!"},"content":{"rendered":"\n

Installing phpDocumentor should be easy. At least, I read here and there in the Internet, besides of course in the official website<\/a>,  that you have many options to install it, one easier of the previous one!<\/p>\n\n\n\n

So I was absolutely confident that in a bunch of minutes I’d have been able to run phpDocumentor and create the documentation for my new Php class.<\/p>\n\n\n\n

Do you know? I was wrong. This is what happened.<\/p>\n\n\n\n

phpDocumentor.phar<\/h2>\n\n\n\n

The first thing I tried it has been to use the .phar file. I know the first way they suggest is to use PEAR, but I have had a positive experience about using .phar files just a day before: I wanted to have php-cs-fixer setup and running in Atom and after several attempts I ended up using php-cs-fixer.phar file. So, when ti came the moment to install phpDocumentor I told myself: “why should I have to struggle with the command line, dependencies issues and the rest when I can just download a single, wonderful file and put in my php directory?” Done! Once I had phpDocumentor.phar installed, I have opened the command prompt directly in my class folder and typed<\/p>\n\n\n\n

phpdoc -d \".\" -t \".\/docs\"<\/pre>\n\n\n\n
BUUUZZZZ!!!<\/p>\n\n\n\n
\n
Could not open input file: “phpDocumentor.phar”<\/p>\n<\/blockquote>\n\n\n\n
Installing phpDocumentor with Composer<\/h2>\n\n\n\n
Wooops, what’s this? Started googling a bit, but with no success, so I sadly abandoned the .phar file and I went on with Composer. worst than before!<\/p>\n\n\n\n
\n
phpdoc is not recognized as an internal or external command<\/p>\n<\/blockquote>\n\n\n\n
To Google or not to Google? No, I don’t want to waste time to understand why something is told to work doesn’t work (not talking about Composer itself, which is a great tool I use in several occasions, just talking about installing phpDocumentor via Composer). Filed attempt.<\/p>\n\n\n\n
Installing phpDocumentor with PEAR<\/h2>\n\n\n\n
I always had good experience installing php extensions through PEAR so I thought it would have worked even installing phpDocumentor. I typed the following command and I eagerly awaited the response:<\/p>\n\n\n\n
pear channel-discover pear.phpdoc.org\npear install phpdoc\/phpDocumentor<\/pre>\n\n\n\n
Wow, everything seemed to go fine! Once the process has finished, I have done another attempt to create my documentation typing the usual command:<\/p>\n\n\n\n
phpdoc -d \".\" -t \".\/docs\"<\/pre>\n\n\n\n
Aaarrghhh!!! The command prompt window has been filled with a lot of warnings and errors related to Smarty templates!<\/p>\n\n\n\n
The solution<\/h2>\n\n\n\n
I will spare you the details. I just say that thirty\/forty minutes of googling gave me the solution: downloading the version 2.9.0 directly from Github. I went to https:\/\/github.com\/phpDocumentor\/phpDocumentor2\/releases\/tag\/v2.9.0<\/a> and clicked to the compressed file with the name phpDocumentor-2.9.0.tgz<\/a> to download it and… Don’t ask me why, maybe that day I was terribly unlucky, but the download was terribly slow, it stopped several times and once it has been completed, the archive was corrupted!<\/p>\n\n\n\n
The true solution!<\/h2>\n\n\n\n
Fortunately I have found another website which allows to download that file: https:\/\/fossies.org\/linux\/www\/phpDocumentor-2.9.0.tgz\/<\/a>. Finally, I’ve got the file. I put it in a temporary folder, opened the command prompt and simply typed:<\/p>\n\n\n\n
pear install phpDocumentor-2.9.0.tgz<\/pre>\n\n\n\n
A small adjustement to the file phpdoc.bat is still missing. Go in your php folder (In my Windows 10 partition I have installed xampp, so my php is located in C:\\xampp\\php folder) and open phpdoc.bat with a text editor. It should look like this:<\/p>\n\n\n\n
BAT (Batchfile)<\/span><\/path><\/path><\/svg><\/span>
@<\/span>echo<\/span> <\/span>off<\/span><\/span>\nif<\/span> <\/span>"<\/span>%PHPBIN%<\/span>"<\/span> == <\/span>""<\/span> <\/span>set<\/span> <\/span>PHPBIN<\/span>=php.exe<\/span><\/span>\nif<\/span> not <\/span>exist<\/span> <\/span>"<\/span>%PHPBIN%<\/span>"<\/span> <\/span>if<\/span> <\/span>"<\/span>%PHP_PEAR_PHP_BIN%<\/span>"<\/span> neq <\/span>""<\/span> <\/span>goto<\/span> USE_PEAR_PATH<\/span><\/span>\nGOTO<\/span> RUN<\/span><\/span>\n:<\/span>USE_PEAR_PATH<\/span><\/span>\nset<\/span> <\/span>PHPBIN<\/span>=<\/span>%PHP_PEAR_PHP_BIN%<\/span><\/span>\n:<\/span>RUN<\/span><\/span>\n"<\/span>%PHPBIN%<\/span>"<\/span> <\/span>"<\/span>%PHP_PEAR_BIN_DIR%<\/span>\\phpdoc"<\/span> <\/span>%*<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Just change the last line replacing “%PHP_PEAR_BIN_DIR%\\phpdoc”<\/span>  with the plain full path to your phpdoc file. In my case, the resulting phpdoc.bat file looks liek this:<\/p>\n\n\n\n
BAT (Batchfile)<\/span><\/path><\/path><\/svg><\/span>
@<\/span>echo<\/span> <\/span>off<\/span><\/span>\nif<\/span> <\/span>"<\/span>%PHPBIN%<\/span>"<\/span> == <\/span>""<\/span> <\/span>set<\/span> <\/span>PHPBIN<\/span>=php.exe<\/span><\/span>\nif<\/span> not <\/span>exist<\/span> <\/span>"<\/span>%PHPBIN%<\/span>"<\/span> <\/span>if<\/span> <\/span>"<\/span>%PHP_PEAR_PHP_BIN%<\/span>"<\/span> neq <\/span>""<\/span> <\/span>goto<\/span> USE_PEAR_PATH<\/span><\/span>\nGOTO<\/span> RUN<\/span><\/span>\n:<\/span>USE_PEAR_PATH<\/span><\/span>\nset<\/span> <\/span>PHPBIN<\/span>=<\/span>%PHP_PEAR_PHP_BIN%<\/span><\/span>\n:<\/span>RUN<\/span><\/span>\n"<\/span>%PHPBIN%<\/span>"<\/span> <\/span>"C:\\xampp\\php\\phpdoc"<\/span> <\/span>%*<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
That’s all, now it works! And I’ve got my full documentation with my favourite template:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
phpdoc<\/span> <\/span>-d<\/span> <\/span>"."<\/span> <\/span>-t<\/span> <\/span>".\/docs"<\/span> <\/span>--template=<\/span>"responsive-twig"<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
If you have found useful this article, please share it through your social networks. If you want to leave me a comment, I’ll be happy to hear from you!<\/p>\n","protected":false},"excerpt":{"rendered":"
Installing phpDocumentor should be easy. At least, I read here and there in the Internet, besides of course in the official website,  that you have many options to install it, one easier of the previous one! So I was absolutely confident that in a bunch of minutes I’d have been able to run phpDocumentor and […]<\/p>\n","protected":false},"author":3,"featured_media":953,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_gspb_post_css":"","footnotes":""},"categories":[34],"tags":[],"post_folder":[142],"class_list":["post-950","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-other-stuff"],"_links":{"self":[{"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/posts\/950","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/comments?post=950"}],"version-history":[{"count":0,"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/posts\/950\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/media\/953"}],"wp:attachment":[{"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/media?parent=950"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/categories?post=950"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/tags?post=950"},{"taxonomy":"post_folder","embeddable":true,"href":"https:\/\/codingfix.com\/wp-json\/wp\/v2\/post_folder?post=950"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}