New Framework Support


Adding completely new framework to Skipper is task demanding on both knowledge of the framework in question and Skipper import/export process. If you help us with the framework side, we can implement the support for your favourite framework quite easily.

If you want to cooperate with us on support of the new framework, contact us, we will help you with details and we can provide you with special free testing license framework development period. When the framework is implemented, we can continue our cooperation and we will be glad to provide you and your team free licenses.

Following article will summarize all the information we will need to implement a support for the new framework.

Basic information

Skipper currently supports ORM frameworks based on PHP that use definition files in XML, YAML or PHP annotations format, or that use stand alone schema definition files. Expanding support for other languages (Ruby, Perl or Python) and formats is fully possible.

If your Framework fits the description above, or you believe it is similar enough, collect the information described further in the article and send it to us.

If the schemas are defined in different way, e.g. directly in the PHP code, let us know how the definitions are used and if they are using some unique format that makes them stand appart from the rest of the code.

Import and export support

Depending on the structure and complexity of the framework we can prepare support option for export only or full support of import/export of the definitions. For example if your framework writes definitions directly in the code, Skipper can export the definitions easily, but implementing import from the code may not be possible at all. Contact us and we will gladly discuss the possibilities with you.

Sample workflow

Let us know the best practices how Skipper should support your framework. Which file should be modified, what naming convention should be kept etc. This example will be the most helpfull for us if you can compare your framework functionality to framework that is already supported by Skipper (eg Doctrine 2).

Here is an example of workflow description for Doctrine ODM driver. It is very similar to Doctrine 2, therefore the workflow can be very short.

Schema files structure

Next we will need to have overview of the schema file structur. This is best done with examples of definitions for each element and relation used by you framework (entity, table, index, association etc).

Examples should contain both the minimal syntax and an example with options that can be specified for the element in question. Please also include links to the documentation regardign each element and/or other sources that will enable us to confirm the information and look for more details.

Most straightforward way to do this is prepare a copy of schema definitions summary and fill it with information about your framework.

Another inspiration what to include in the mapping table can be seen at ORM Cheatsheet with the examples for each element.

Schema file examples

In this part we will need examples of the complete schema definition files or complete applications with definitions. You can copy the contents of definition files, or provide links to tutorials or github repositories with example projets or testing files.

Contacts

You can send us the document with all the information to support@skipper18.com.

We will go through the document, and contact you with additional questions if required.