Midgard API Reference
The Midgard API reference is organized around the design of the database storage backend. For every entity, like a topic or an article, an MgdSchema type exists. The record type definition of an entity is a direct reflection of the database table that holds instances, records, of those entities. The records are not manipulated directly, but through functions that work with objects. The parameters of those objects often map directly to the fields of the record type they relate to. Sometimes relevant information from different record types is merged into one object.
Object-oriented Midgard
New Midgard API provides the following systems:
- MgdSchema object API
- Methods of Midgard Objects
- Midgard Query Builder
- Midgard PHP superglobals
- Midgard global PHP functions
- Midgard replication API
- Midgard for Java Content Repository
MidCOM component API
Midgard's Component Framework for PHP provides its own API for component and site developers:
- MidCOM component development
- Stable MidCOM API (in PhpDoc format)
- Developer Snapshot MidCOM API (in PhpDoc format)
- MidCOM template global variables
Javascript API
Midgard uses Javascript to provide a nicer Ajax (programming) user interface and some advanced functionalities.
- Prototype - the core Javascript library bundled with MidCOM
- protoGrowl - User interface notification library
- protoToolbar - Toolbar rendering library
Classic Midgard API
This section describes the types and functions of the Midgard 1.x series
For every entity this reference holds a section with a Record Type Definition, an Object Definition and an explanation of the available functions that are related to that particular record type. A separate section is dedicated to functions that do not relate to a specific record type.
If the return type of a function is object, the available parameters and methods from that object can be found by examining the related Object Definition.