README

Installation

You can install this plugin into your CakePHP application using composer.

Run

composer require itco/LdapiHelper

When using the LdapiHelper, do not explicitly require the LDAPI package too.

Documentation is automatically built and hosted by ReadTheDocs: https://ldapihelper.readthedocs.io/

This documentation is built through Doxygen and Sphinx (Python package), with the Breathe extension. Build it like:

cd docs
make html

Run pip install -r docs/requirements.txt to get the required packages.
The build output can be found in docs/_build/html.

An easier way to build documentation is using phpDocumentor. Generated PHPDoc documentation can be found here: https://itco.bitbucket.io/ldapihelper/index.html (note: this is not build automatically and can be out-of-date).

Generate documentation with:

phpdoc -d ./src -t ./phpdoc_build

Use -d to set the input and -t to set the output.

See CHANGELOG.md for an overview.