Please note: CPAINT nor this website is under active development. |
Backend API
Class Summary
The backend of CPAINT - the server-side part - consists of a single file named cpaint2.inc.X whereas X represents the file extension of your desired programming language. Currently versions for PHP and ASP are available.
We believe that portability is the major concern for web applications, so we'll see that we get CPAINT ported to other languages as well. Currently we're working on perl and .NET ports.
Whatever language you chose, the backend will always work identical. It will always consist of the same classes with a bunch of methods each for you to access. All methods will be named identically in all languages and will accept the same arguments.
In this section of the documentation we'll introduce to you the various methods available in the backend
classes of CPAINT. However we'll only introduce the publicly available methods. The others are
irrelevant for your daily work.
If you need to change or improve CPAINT itself, you'll find JavaDoc-like documentation for all
classes, methods and properties in the backend files.
cpaint
The cpaint backend class serves two purposes.
First, it interprets the parameters sent to your application via the CPAINT frontend
and calls the right function of your own application.
Second, it must be used by your application functions to generate the response for the frontend.
cpaint_node
The cpaint_node class represents a container for the response or a part of the response that will be sent back to the frontend.
cpaint_transformer
The cpaint_transformer class is
being called by the cpaint class transparently.
It provides the methods to transform the set of cpaint_node objects
into a valid response of the desired type.