Welcome to the Zend Framework 2 documentation

End-of-Life occurred 31 March 2018

This repository mirrored Zend Framework through the 2.4 series; however, 2.4 reached its end of life on 31 March 2018.

At this time, this repository has been archived, and is read-only.

Current documentation is bundled directly in each component, and published at https://docs.zendframework.com

RELEASE INFORMATION

This documentation is based on Zend Framework 2 (master branch)

VIEW THE DOCUMENTATION ONLINE

We used the readthedocs.org project to render online the development version of the documentation of Zend Framework 2.

You can read the development online documentation in http://zf2.readthedocs.org.

You can read the last stable documentation in http://framework.zend.com/manual/current/en/index.html.

BUILDING DOCUMENTATION

Building the documentation requires Sphinx. Further requirements are Pygments, docutils and markupsafe, installable with pip install.

Descend into the docs/ directory, and run make with one of the following targets:

• epub - build epub (ebook) documentation (requires Calibre to build cross-platform epub versions)
• help - build Windows help files
• html - build HTML documentation
• info - build Unix info pages
• latexpdf - build PDF documentation (requires a working latex toolchain)
• man - build Unix manpages
• text - build ANSI text manual files

Examples:

make html

You can cleanup by running make clean.

CONTRIBUTING

If you wish to contribute to the documentation of Zend Framework 2, please read the CONTRIBUTING.md file.

If you don't know where to begin, or where you can best help, please review the TODO.md file.

LICENSE

The files in this archive are released under the Zend Framework license. You can find a copy of this license in LICENSE.txt.

ACKNOWLEDGEMENTS

The Zend Framework team would like to thank all the contributors to the Zend Framework Documentation project, our corporate sponsor, and you, the Zend Framework user. Please visit us sometime soon at http://framework.zend.com.