PHP Classes
elePHPant
Icontem

PHPDoc PDF Output Generator: Create PDF files from PHP sources with PHPDoc

Recommend this page to a friend!
  Info   View files Documentation   Screenshots Screenshots   View files View files (21)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2019-08-04 (4 months ago) RSS 2.0 feedNot yet rated by the usersTotal: 188 This week: 3All time: 8,362 This week: 119Up
Version License PHP version Categories
phpdoc2pdf 1.0.0Custom (specified...5PHP 5, Files and Folders, Project Man...
Description Author

This package can create PDF files from PHP sources with PHPDoc.

It can scan a given PHP source files or a directory with PHP project source files and extract comments in PHPDoc format that describe details of the the scanned PHP source code.

The package can generate a PDF document to present the documentation of the PHP project.

Innovation Award
PHP Programming Innovation award nominee
August 2019
Number 3
PHPDoc is a popular format for embedding information on PHP source code files to help documenting it.

This package can generate documentation of PHP source code in PDF format by extracting PHPDoc information that it may contain.


Manuel Lemos
  Performance   Level  
Name: Lluís Camino <contact>
Classes: 1 package by
Country: Spain Spain
Age: ???
All time rank: 4037107 in Spain Spain
Week rank: 127 Up6 in Spain Spain Up
Innovation award
Innovation award
Nominee: 1x

 

Details

phpDoc2pdf

Scrutinizer Code Quality Build Status

Create PDF formatted documentation for your PHP projects.

phpDoc2pdf uses the phpDocumentor/Reflection library to extract the classes, interfaces and traits from your project and generate a set of documentation similar to the one that phpDocumentor2 provides, but in PDF format.

You can see some examples on the docs folder.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

  1. Download the PHAR file directly from here.

Usage

Use the following command to generate the documentation:

php phpDoc2pdf.phar create <INPUT> <OUTPUT>

Replace `<INPUT>with the PHP file or directory that you want to document and<OUTPUT>` with the directory where the documentation will be saved.

Please note that the files you want to document have to be in UTF-8 format.

Built With

Contributing

All contributions are welcome, please see the To-do list below or suggest something. ?

To-do list

  • [x] Add tests
  • [x] Add markdown support
  • [x] Add templates system
  • [ ] Separate generated docs into different subdirectories
  • [x] Make installation and usage simpler
  • [ ] Include phpDocBlock types on method arguments
  • [ ] Add support for all type of file extensions.

License

This project is licensed under the MIT License - see the LICENSE file for details

Screenshots  
  • phpdoc2pdfexampleoutput.png
  Files folder image Files  
File Role Description
Files folder imagedocs (4 files)
Files folder imagesrc (2 directories)
Files folder imagetemplates (1 directory)
Files folder imagetests (2 files)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file composer.lock Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  docs  
File Role Description
  Accessible without login Plain text file Command.pdf Data Auxiliary data
  Accessible without login Plain text file CreateDocsCommand.pdf Data Auxiliary data
  Accessible without login Plain text file FilesTreatment.pdf Data Auxiliary data
  Accessible without login Plain text file PDFFile.pdf Data Auxiliary data

  Files folder image Files  /  src  
File Role Description
Files folder imageapplication (4 files)
Files folder imagecreate_documentation (1 file)

  Files folder image Files  /  src  /  application  
File Role Description
  Plain text file Command.php Class Class source
  Accessible without login Plain text file createDocs.php Example Example script
  Plain text file CreateDocsCommand.php Class Class source
  Plain text file FilesTreatment.php Class Class source

  Files folder image Files  /  src  /  create_documentation  
File Role Description
  Plain text file PDFFile.php Class Class source

  Files folder image Files  /  templates  
File Role Description
Files folder imagedefault (6 files)

  Files folder image Files  /  templates  /  default  
File Role Description
  Accessible without login Plain text file constants.php Example Example script
  Accessible without login Plain text file header.php Example Example script
  Accessible without login Plain text file methods.php Example Example script
  Accessible without login Plain text file properties.php Example Example script
  Accessible without login Plain text file styles.css Data Auxiliary data
  Accessible without login Plain text file summary.php Aux. Auxiliary script

  Files folder image Files  /  tests  
File Role Description
  Plain text file FilesTreatmentTest.php Class Class source
  Plain text file PDFFileTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 95%
Total:188
This week:3
All time:8,362
This week:119Up