The installer scripts of cjw_multisite #

cjw_multisite builds its site with two PHP files in settings/ of the package: cjw-multi-site-installer.php (the class cjwMultiSiteInstaller, 5,939 lines) and cjw-starter-install.php (the starter content functions, 827 lines), with post-install-fix.php (593 lines) as a helper. This page follows an install through them in order. It is for developers who change the installer or write one like it; administrators reading a setup log find here what each step's notice means.

The file's header says where it comes from: "Generated from the 7x MultiSite installer (sevenx_multisite, sevenx-multi-site-installer.php) for the starter site of the cjw_themes_jumper extension". Most steps are therefore the same as in The multisite installer script; this page dwells on what is different.

Contents #

1. When the setup calls what
2. The settings the installer starts from
3. Before the packages: preInstall()
4. INI settings, roles and preferences
5. After the packages: the post-install steps
6. The starter content steps
7. Reading the log
8. Related pages

When the setup calls what #

The create sites step of the setup (kernel/setup/steps/ezstep_create_sites.php) loads the settings files of the site package and calls the functions they define, in this order:

The kernel's eZSiteInstaller::executeSteps() runs the post-install steps one after the other and stops the chain at the first step that reports an error, so the installer puts robust repairs early and cosmetic steps last.

The settings the installer starts from #

initSettings() reads the parameters of the setup and fixes these values:

Before the packages: preInstall() #

1. Records the highest node id and object id of the base data (cjwBaseMaxNodeID, cjwBaseMaxObjectID), so the later node fix can tell base data from package content.
2. Adds the attributes tags (ezkeyword) and publish_date (ezdatetime) to the class folder, named in the site's primary language.
3. Sets [FileSettings] VarDir=var/site for the run and prepends the settings/ folder of every extension in the list (activateSiteExtensionSettings()), so datatypes such as those of enhancedselection2 and eztags are known while classes and objects are imported.
4. Links the starter content's images and files from extension/cjw_themes_jumper/share/ into the content package (cjwLinkStarterFilesFromExtension()).
5. Registers the datatypes ezsrrating, ezgmaplocation, ngenhancedlink and eztags for the run.
6. Adds the two-step sign-in field to the user class when sevenx_authentication_2fa is available.
7. Drops and recreates the tables of every extension schema (dropExtensionTables(), insertDBFile()): the named ones (ezstarrating, ezgmaplocation, eztags, explayouts, enhancedselection2, cjw_newsletter, syndication) plus every other listed extension with a share/db_schema.dba or sql/<engine>/schema.sql, and the admin access extensions. Tables only: no db_data.dba is loaded (declaredExtensionSchemas() passes false for every entry).
8. Repairs the language columns of eztags rows from the base data when eng-GB exists.

INI settings, roles and preferences #

The osm_proxy/tiles policy is specific to this package: the maps of the starter design load their tiles through the osm_proxy module of cjw_themes_jumper.

After the packages: the post-install steps #

The steps of initSteps(), in order, grouped:

The starter content steps #

cjwInstallStarterContent( $siteaccesses ) runs as the administrator (user 14) and calls, in order:

Each part logs its result; a failed part is named in one error line, and the install carries on. All content caches are cleared at the end.

Reading the log #

Notices to look for in the debug output of the install:

Base data before the content package: nodes up to ..., objects up to ...; content package cjw_multisite_democontent
Starter content files from the extension: <n> linked, <n> copied, <n> missing
Class additions of the starter content: <n> added, <n> present
Starter layouts: <n> rows in 10 tables, rules for <the user siteaccesses>
Starter paths: <n> renamed, <n> differences left

Related pages #

• cjw_multisite
• The demo content package
• Siteaccesses and languages
• The multisite installer script of sevenx_multisite
• Install scripts in a site package
• Changing the installer script
• Site packages: start here
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.