Skip to content
A reference of Zend Framework 3 components and classes
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data Added new components Mar 30, 2018
.gitignore Improved php-api-doc-maker.json Mar 10, 2018
README.md Update README.md Jan 28, 2019
composer.json Updated composer.json May 2, 2018
composer.lock Updated composer deps Apr 7, 2019
composer.phar Updated composer deps Apr 7, 2019
favicon.ico Improved php-api-doc-maker.json Mar 10, 2018
php-api-doc-maker.json Updated copyright date Apr 7, 2019

README.md

ZF3 API Reference

This project's ame is to provide a reference of Zend Framework 3 components and their PHP classes (API). The latest published version of the reference can be found on the ZF3 API Reference Website. This reference is integrated with my book, Using Zend Framework 3, so you can take a look at it, too.

Background

Some time ago I wanted to have a well-structured API reference for Zend Framework 3 in an HTML format to read it online. Unfortunatelly, I couldn't find one, so I decided to generate it myself. To do that, I've created a tool, php-api-doc-maker.

Generating Yourself

If you want to generate this API reference yourself (for example, to contribute), you need the php-api-doc-maker tool.

Before you install the tool, you need to have PHP 5.6 or later installed.

The tool needs the source code of ZF3 components to generate the class reference. Install ZF3 components with the following command:

php composer.phar update

Generate the reference in HTML format with the following command:

php php-api-doc-maker.php /path/to/api/reference/dir 

If everything is OK, you should find HTML files inside the /path/to/api/reference/dir/html subdirectory.

You can’t perform that action at this time.