Function __global->create_addon
Definitions
sources/addons2.php
- Create an addon to spec.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $file | string | No | No | required parameter | N/A | N/A | Filename to create in exports/addons directory (should end in .tar) |
| $files | array | No | No | required parameter | N/A | N/A | List of files to include |
| $addon_name | string | No | No | required parameter | N/A | N/A | Addon name |
| $incompatibilities | string | No | No | required parameter | N/A | N/A | Addon incompatibilities (comma-separated) |
| $dependencies | string | No | No | required parameter | N/A | N/A | Addon dependencies (comma-separated) |
| $author | string | No | No | required parameter | N/A | N/A | Addon author |
| $organisation | string | No | No | required parameter | N/A | N/A | Addon organisation |
| $version | string | No | No | required parameter | N/A | N/A | Addon version |
| $category | string | No | No | required parameter | N/A | N/A | Addon category |
| $copyright_attribution | string | No | No | required parameter | N/A | N/A | Addon copyright attribution |
| $licence | string | No | No | required parameter | N/A | N/A | Addon licence |
| $description | string | No | No | required parameter | N/A | N/A | Addon description |
| $min_cms_version | string | No | No | required parameter | N/A | N/A | Minimum required major.minor version of the website software to install this addon (blank: effectively 11.0) |
| $max_cms_version | string | No | No | required parameter | N/A | N/A | Maximum allowed major.minor version of the website software to install this addon (blank: no maximum) |
| $dir | PATH | No | No | exports/addons | N/A | N/A | Directory to save to |
| $mtimes | array | No | No | [] | N/A | N/A | A map of file mtimes to use |
| $file_base | ?PATH | No | No | Null | N/A | N/A | Alternate file base to get addon files from (null: main website file base) |
Preview
Code (PHP)
/**
* Create an addon to spec.
*
* @param string $file Filename to create in exports/addons directory (should end in .tar)
* @param array $files List of files to include
* @param string $addon_name Addon name
* @param string $incompatibilities Addon incompatibilities (comma-separated)
* @param string $dependencies Addon dependencies (comma-separated)
* @param string $author Addon author
* @param string $organisation Addon organisation
* @param string $version Addon version
* @param string $category Addon category
* @param string $copyright_attribution Addon copyright attribution
* @param string $licence Addon licence
* @param string $description Addon description
* @param string $min_cms_version Minimum required major.minor version of the website software to install this addon (blank: effectively 11.0)
* @param string $max_cms_version Maximum allowed major.minor version of the website software to install this addon (blank: no maximum)
* @param PATH $dir Directory to save to
* @param array $mtimes A map of file mtimes to use
* @param ?PATH $file_base Alternate file base to get addon files from (null: main website file base)
*/
function create_addon(string $file, array $files, string $addon_name, string $incompatibilities, string $dependencies, string $author, string $organisation, string $version, string $category, string $copyright_attribution, string $licence, string $description, string $min_cms_version, string $max_cms_version, string $dir = 'exports/addons', array $mtimes = [], ?string $file_base = null)
* Create an addon to spec.
*
* @param string $file Filename to create in exports/addons directory (should end in .tar)
* @param array $files List of files to include
* @param string $addon_name Addon name
* @param string $incompatibilities Addon incompatibilities (comma-separated)
* @param string $dependencies Addon dependencies (comma-separated)
* @param string $author Addon author
* @param string $organisation Addon organisation
* @param string $version Addon version
* @param string $category Addon category
* @param string $copyright_attribution Addon copyright attribution
* @param string $licence Addon licence
* @param string $description Addon description
* @param string $min_cms_version Minimum required major.minor version of the website software to install this addon (blank: effectively 11.0)
* @param string $max_cms_version Maximum allowed major.minor version of the website software to install this addon (blank: no maximum)
* @param PATH $dir Directory to save to
* @param array $mtimes A map of file mtimes to use
* @param ?PATH $file_base Alternate file base to get addon files from (null: main website file base)
*/
function create_addon(string $file, array $files, string $addon_name, string $incompatibilities, string $dependencies, string $author, string $organisation, string $version, string $category, string $copyright_attribution, string $licence, string $description, string $min_cms_version, string $max_cms_version, string $dir = 'exports/addons', array $mtimes = [], ?string $file_base = null)
