Specifications | Documentation

What will Osm Admin look like? What is missing right now? What effort is needed to close this gap? All these, and some other questions are covered in specifications.

Objects

Application data is made of objects. Use standard PHP class and attribute syntax to:

define the structure of application objects,
define how they are stored in the database,
specify computation logic.

Status. The text of this specification is a work in progress.

User Interface

Once you defined the structure of application objects, Osm Admin provides the default user interface that allows you to manage them in the admin area.

You can customize the user interface by defining custom views, and by changing property editing or filtering behavior.

Status. This specification is a work in progress.

Reflection

Osm Admin knows every tiny detail about your application objects and properties. And you can, too, using reflection.

Status. This specification is a work in progress.

Formulas

How To Write Specifications

In free form, explain the future usage of a given feature, and how Osm Admin will internally handle it.

Then, add Implementation Status / Efforts Required section.

In this section, specify what is not implemented yet. By convention, anything not listed in this section is already implemented and works as described, so be explicit.

Then, list implementation efforts required. Use task-like wording: "do this", "do that". Start each task in its own paragraph, and prefix it with bold R (stands for requirement):

**R**. Validate property definitions and applied attributes.

When implementing a specification, refine the task list by making each item doable in one working day. Then assign unique numbers:

**R01**. Only allow `int` and `string` property types.