Zzoss Installer Plugin Variables

These are the standard variables available for plugins:

$GLOBALS['ZI']['application_root']

$GLOBALS['ZI']['application_baseinstalldir']

Description: The absolute root path of the application.

Example: /htdocs/myapp-1.0/

$GLOBALS['ZI']['application_url']

Description: The base URL of the application.

Example: http://localhost/myapp-1.0/

$GLOBALS['ZI']['application_url_rel']

Description: The URL of the application relative to the web root.

Example: /myapp-1.0/

$GLOBALS['ZI']['application_demo']

Description: Boolean flag showing wheter the application was installed in demo mode or not. Can be:

true

false

$GLOBALS['ZI']['application_profile']

Description: Information about the installation type.

Possible value: 'full', 'minimum', 'custom'

$GLOBALS['ZI']['package_root']

$GLOBALS['ZI']['package_baseinstalldir']

Description: The absolute path to the installed package root should be stored. This path is composed of $GLOBALS['ZI']['application_baseinstalldir'] + <baseinstall dir from application.xml>

Example: /htdocs/myapp-1.0/mod/my_mod/

$GLOBALS['ZI']['package_src']

Description: Absolute path to the sources of the package.

Example: /tmp/zzoss_installer/distributions/mydistri-1.0/applications/myapp-1.0/packages/my_mod-1.0/

$GLOBALS['ZI']['package_url']

Description: The absolute url to the installed package root should be stored. This path is composed of <application url root> + <baseinstall dir from application.xml>

Example: http://myapp/mod/my_mod/

$GLOBALS['ZI']['package_url_rel']

Description: The relative url to the installed package root should be stored. This path is composed of <application url root rel> + <baseinstall dir from application.xml>

Example: myapp/mod/my_mod/

$GLOBALS['ZI']['package_build_dir']

Description: Path to the directory of the package where build files reside.

$GLOBALS['ZI']['package_action']

Description: Based on this variable, plugins can perform different routines for an action selected for a package. Possible values are:

install

update

remove

$GLOBALS['ZI']['package_name']

Description: Name of the package.

Example: my_mod

$GLOBALS['ZI']['package_summary']

Description: Summary of package.

Example: My own little module.

$GLOBALS['ZI']['package_version']

Description: Version of the package.

Example: 1.0

$GLOBALS['ZI']['file_baseinstalldir']

Description: The basinstall directory where the file gets installed to.

Example:

If you have a file defined in the package.xml like

<file role="php" baseinstalldir="test/" name="dir/file.php"/>

Then the file_baseinstalldir will be "test/".

$GLOBALS['ZI']['file_dest']

Description: Absolute path to the destination directory of the currently processed file. This parameter is only available to file role handler plugins.

Example: /htdocs/myapp-1.0/mod/my_mod/my_file.php

$GLOBALS['ZI']['file_src']

Description: Absolute path to the source of the currently processed file. This parameter is only available to file role handler plugins.

Example: /tmp/zzoss_installer/distributions/mydistri-1.0/applications/myapp-1.0/packages/my_mod-1.0/my_file.php

$GLOBALS['ZI']['build_dir']

$GLOBALS['ZI']['plugin_root']

$GLOBALS['ZI']['plugin_baseinstalldir']

Description: The absolute path to the location where the files reside that the plugin builds.

Example: /tmp/zzoss_installer/distributions/mydistri-1.0/applications/myapp-1.0/packages/my_build-1.0/dir/

$GLOBALS['ZI']['plugin_data_dir']

Description: Directory where plugins can store their data (lies within installer's data directory). A plugin should append a distinguished directory (e.g. adding the package name) to this path to avoid clashes with other plugins.

$GLOBALS['ZI']['build_params']

$GLOBALS['ZI']['plugin_params']

Description: Returns an associative array of the parameters defined in the <build> block of the XML package description file.

Example:

The <build> block as defined in a package.xml

<build dir="my_plugin/" plugin="my_plugin" rel="ge" version="1.0">
        <params>
                <my_value>a test</my_value>
        </params>
</build>

will result in an array of the form

$GLOBALS['ZI']['plugin_params']['my_value']

with the value

a test

$GLOBALS['ZI']['plugin_log']

Description: Log entries of the plugin which can be viewed after installation.

Example: $GLOBALS['ZI']['plugin_log'] .= 'My log entry.';

$GLOBALS['ZI']['gui_submitted']

Description: Tells, if form input has been submitted. Possible boolean values are:

true

false