Introduction
Energine 2.13 is the full edition of Energine: a PHP framework in which a page is built from components, each component returns XML, and XSLT turns the page's XML into HTML. It brings the code of Energine 2.12 to PHP 8.4+ and MariaDB 10.11, repairs the modules and ships a starter project that installs from scratch.
Energine 2.13 is released as it is: it gets no new features, and its known risks are named. Development continues in Energine Simple.
What is inside
| Module | What it does | Read more |
|---|---|---|
share |
the section tree and pages, texts edited on the page, menus, the admin, files, languages, several sites in one install | Structure and content, Admin panel, Files and media, Languages and translations |
user |
sign-in, users, groups and rights | Users and permissions |
apps |
news, the feedback form, polls, selections, section branding, HTML inserts per page | News |
blog |
blogs of users | Blogs |
shop |
a catalogue, product pages, a cart, a wishlist and orders | Shop |
forms |
the form builder | Forms |
comments |
comments on news, blog posts and pages | Comments |
mail |
newsletters and mail templates | Mailing lists |
ads |
banner places and banners | Banners |
seo |
robots.txt and the Google sitemap |
URLs and search engines |
calendar |
the calendar of news and blogs | News |
How a page is built
- The web server sends every address that is not a file to
htdocs/index.php. - Energine finds the page by its address in the section tree of the current site and checks the visitor's rights on it.
- The page's layout and content templates — XML files — name its components; each component runs and returns its XML.
- The page's XML document goes through the site's XSLT stylesheets and becomes HTML.
Components, Page templates and XSLT views explain each step.
Requirements
PHP 8.4 or newer (tested on 8.5) with the extensions ctype, dom, fileinfo, gd, json, libxml, mbstring, PDO, pdo_mysql, SimpleXML, session and xsl; MariaDB 10.11 or newer — MySQL is not supported; nginx with PHP-FPM, or Apache 2.4 with mod_rewrite (not tested); composer. The steps are in Installation.
Interface languages
The admin and the site's interface come in Russian and Ukrainian; Russian is the default, and Ukrainian pages have the prefix /ua/. There is no English: a language is added in the language editor and its interface strings are translated in the translation editor — see Interface languages.
License
Energine is free software under the MIT license. Bundled third-party code keeps its own licenses: the TimThumb resizer (GPL-2.0), JSqueeze (Apache-2.0 or GPL-2.0), the CKEditor visual editor, CodeMirror, MooTools 1.5.2 and Font Awesome 4.3.0.
Next
- Installation — an empty site, or a site with demo content.
- Your first site — a section of your own with a component and an XSLT view.
- Migrating from 2.12 — what a 2.12 site has to change.