Documentation

Page last updated on April 20, 2018

One of the most common first question a developer or system integrator asks after getting access to the source code of the project or the API is: where do I find the documentation?  In this section, we have collected all the useful pointers, references, and tips on how to find all the documentation that you need.

CakePHP

First and most important, comes the CakePHP documentation.  Qobrix platform and all Qobrix applications are built on top of the CakePHP framework, so knowing and understanding how the framework works, which features it has and how to use them is critical to figuring out the rest of Qobrix.  CakePHP framework is well known for its excellent documentation.  Mainly, it comes in two parts:

  1. CakePHP Cookbook.  This is an online, frequently updated resource, which documents all of the CakePHP framework.  You can either read it from beginning to end, or navigate your way around the sections of particular interest to you.  We also try to reference this resource as much as we can in the rest of the Qobrix documentation, as well as its source code.
  2. CakePHP API Reference.  This resource provides the documentation for each and every class, method, constant, and variable in the CakePHP source code.  This is indispensable for developers building on top of the CakePHP framework.

Plugins, Components and Dependencies

Qobrix includes a variety of CakePHP plugins, third-party components and dependencies.  The easiest way to find what they are and get to the documentation is by using the Composer.  The two commands particularly useful for this are:

  1. ./bin/composer show , which shows a list of all installed dependencies, including the CakePHP plugins, with their name, version, and description.
  2. ./bin/composer info vendor/package , which shows detailed information about a particular package.  Just replace vendor/package with the package that you are interested in.

In the detailed information of the package, you’ll often find a variety of URLs to documentation, support process, etc.  If documentation URL is not part of the output, just follow the repository (source code) URL, that will take you to the project home.  More often than not, you’ll find either a README file there, or a docs/ folder.  Sometimes, you’ll have both.

Source Code

Our own source code is well documented as well.  You can read the documentation inline, within your favorite text editor on an IDE.  Or you can generate a static documentation set in a variety of formats (HTML, PDF, etc), using one of the many tools available.  We are using an approximation of the (abandoned) PSR-5 standard, which is supported by a number of tools, such as Doxygen, PHPDocumentor, Sami, and others.

API

For the details of the API implementation and documentation, please read the API section of the Developer Guides.