Documentation: scripts/build.php

scripts/build.php - Build the reference store for this server

This script behaves as follows:

the script aborts if the user is not an associate
else if this is not a POST, a confirmation form is displayed
else the reference store is rebuilt, except in demo mode

The confirmation form allows for following parameters:

* Version information, that will be displayed within the Control Panel. For the core set of reference files the rule is to use the last digit of the current year as major version number, and the month index as minor version number. Letters 'a' and 'b' are appended for alpha and beta releases, respectively.

* Checkbox to disallow remote updates after the build. By default the checkbox is checked, meaning that any remote servers can update itself against the new reference store. If you uncheck this checkbox, the footprints file is not generated. This option is useful during integration phases, when the content of the reference store has to be checked before official release.

If the file demo.flag exists, the script assumes that this instance of YACS runs in demonstration mode and forbids the build.

The building process is made of several successive steps:

1. The footprints file is deleted to disable remote updates.

2. Reference scripts are copied to the reference store

This script is a reference file of this system.

Matching scripts are copied to the reference store. Files that where present in the reference repository before the build are preserved. This is the mechanism used to put any kind of files such as images, cascading style sheets, or even PHP scripts, in the reference store.

3. Documentation pages are deleted. This means that the table yacs_phpdoc is emptied. Files in the reference store are not impacted at this step.

4. Documentation pages are built based on phpDoc comments. All php scripts of the reference store are scanned. For each script having some phpDoc comment a new entry is created into the yacs_phpdoc table.

5. The footprints file is (re)created. This file contains a hash of all reference scripts of the reference store. It is downloaded by remote servers that are updated, to identify new or updated scripts. Note: When the script is asked to build a reference store for tests, the footprints file has a special name to avoid erroneous downloads rom remote servers.

6. An archive file is created. Finally all files of of the reference are put together into a single archive file simply named 'yacs.zip' and located at the yacs directory. At the end of the process the archive contains all files necessary to install a fresh server, including images, etc.

If you really want to restart a fresh built from start, please go to the control panel and select the purge command. This will actually remove reference scripts of the reference store. All other files, including non-reference scripts, will be preserved.

This script is a reference file of this system.

Licence: GNU Lesser General Public License

Auteurs:

Bernard Paques bernard.paques@bigfoot.com

Reste à faire:

produce a tgz archive as well