From 5cd551f4ff04fc59cc9380efd8fffcab952633fa Mon Sep 17 00:00:00 2001 From: Tim Meusel Date: Fri, 27 Jan 2023 13:13:40 +0100 Subject: [PATCH] update REFERENCE.md --- REFERENCE.md | 1200 +++++++++++++++++++++++++------------------------- 1 file changed, 594 insertions(+), 606 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index c2c06124..0bd229cc 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -7,37 +7,37 @@ ### Classes * [`php`](#php): Base class with global configuration parameters that pulls in all enabled components. === Parameters [*ensure*] Specify which version of -* [`php::apache_config`](#phpapache_config): Install and configure php apache settings === Parameters [*inifile*] The path to the ini php-apache ini file [*settings*] Hash with ne -* [`php::cli`](#phpcli): Install and configure php CLI === Parameters [*inifile*] The path to the ini php5-cli ini file [*settings*] Hash with nested hash of k -* [`php::composer`](#phpcomposer): Install composer package manager === Parameters [*source*] Holds URL to the Composer source file [*path*] Holds path to the Composer e -* [`php::composer::auto_update`](#phpcomposerauto_update): Install composer package manager === Parameters [*max_age*] Defines number of days after which Composer should be updated [*source*] H -* [`php::dev`](#phpdev): Install the development package with headers for PHP === Parameters [*ensure*] The PHP ensure of PHP dev to install [*package*] The pa -* [`php::embedded`](#phpembedded): Install and configure php embedded SAPI === Parameters [*inifile*] The path to the ini php5-embeded ini file [*settings*] Hash with ne -* [`php::fpm`](#phpfpm): Install and configure mod_php for fpm === Parameters [*user*] The user that php-fpm should run as [*group*] The group that php-fpm sho -* [`php::fpm::config`](#phpfpmconfig): Configure php-fpm service === Parameters [*config_file*] The path to the fpm config file [*user*] The user that runs php-fpm [*group* -* [`php::fpm::service`](#phpfpmservice): Manage fpm service === Parameters [*service_name*] name of the php-fpm service [*ensure*] 'ensure' value for the service [*enable*] -* [`php::global`](#phpglobal) -* [`php::globals`](#phpglobals) -* [`php::packages`](#phppackages): Install common PHP packages === Parameters [*ensure*] Specify which version of PHP packages to install [*names*] List of the names of -* [`php::params`](#phpparams): PHP params class -* [`php::pear`](#phppear): Install PEAR package manager === Parameters [*ensure*] The package ensure of PHP pear to install and run pear auto_discover [*package*] -* [`php::phpunit`](#phpphpunit): Install phpunit, PHP testing framework === Parameters [*source*] Holds URL to the phpunit source file [*path*] Holds path to the phpun -* [`php::phpunit::auto_update`](#phpphpunitauto_update): Install phpunit package manager === Parameters [*max_age*] Defines number of days after which phpunit should be updated [*source*] Hol -* [`php::repo`](#phprepo): Configure package repository -* [`php::repo::debian`](#phprepodebian): Configure debian apt repo === Parameters [*location*] Location of the apt repository [*repos*] Apt repository names [*include_src*] -* [`php::repo::redhat`](#phpreporedhat) -* [`php::repo::suse`](#phpreposuse): Configure suse repo === Parameters [*reponame*] Name of the Zypper repository [*baseurl*] Base URL of the Zypper repository -* [`php::repo::ubuntu`](#phprepoubuntu): Configure ubuntu ppa === Parameters [*version*] PHP version to manage (e.g. 5.6) +* [`php::apache_config`](#php--apache_config): Install and configure php apache settings === Parameters [*inifile*] The path to the ini php-apache ini file [*settings*] Hash with ne +* [`php::cli`](#php--cli): Install and configure php CLI === Parameters [*inifile*] The path to the ini php5-cli ini file [*settings*] Hash with nested hash of k +* [`php::composer`](#php--composer): Install composer package manager === Parameters [*source*] Holds URL to the Composer source file [*path*] Holds path to the Composer e +* [`php::composer::auto_update`](#php--composer--auto_update): Install composer package manager === Parameters [*max_age*] Defines number of days after which Composer should be updated [*source*] H +* [`php::dev`](#php--dev): Install the development package with headers for PHP === Parameters [*ensure*] The PHP ensure of PHP dev to install [*package*] The pa +* [`php::embedded`](#php--embedded): Install and configure php embedded SAPI === Parameters [*inifile*] The path to the ini php5-embeded ini file [*settings*] Hash with ne +* [`php::fpm`](#php--fpm): Install and configure mod_php for fpm === Parameters [*user*] The user that php-fpm should run as [*group*] The group that php-fpm sho +* [`php::fpm::config`](#php--fpm--config): Configure php-fpm service === Parameters [*config_file*] The path to the fpm config file [*user*] The user that runs php-fpm [*group* +* [`php::fpm::service`](#php--fpm--service): Manage fpm service === Parameters [*service_name*] name of the php-fpm service [*ensure*] 'ensure' value for the service [*enable*] +* [`php::global`](#php--global) +* [`php::globals`](#php--globals) +* [`php::packages`](#php--packages): Install common PHP packages === Parameters [*ensure*] Specify which version of PHP packages to install [*names*] List of the names of +* [`php::params`](#php--params): PHP params class +* [`php::pear`](#php--pear): Install PEAR package manager === Parameters [*ensure*] The package ensure of PHP pear to install and run pear auto_discover [*package*] +* [`php::phpunit`](#php--phpunit): Install phpunit, PHP testing framework === Parameters [*source*] Holds URL to the phpunit source file [*path*] Holds path to the phpun +* [`php::phpunit::auto_update`](#php--phpunit--auto_update): Install phpunit package manager === Parameters [*max_age*] Defines number of days after which phpunit should be updated [*source*] Hol +* [`php::repo`](#php--repo): Configure package repository +* [`php::repo::debian`](#php--repo--debian): Configure debian apt repo === Parameters [*location*] Location of the apt repository [*repos*] Apt repository names [*include_src*] +* [`php::repo::redhat`](#php--repo--redhat) +* [`php::repo::suse`](#php--repo--suse): Configure suse repo === Parameters [*reponame*] Name of the Zypper repository [*baseurl*] Base URL of the Zypper repository +* [`php::repo::ubuntu`](#php--repo--ubuntu): Configure ubuntu ppa === Parameters [*version*] PHP version to manage (e.g. 5.6) ### Defined types -* [`php::apache_vhost`](#phpapache_vhost): Configures an apache vhost for php === Parameters [*vhost*] The vhost address [*docroot*] The vhost docroot [*port*] The vhost port -* [`php::config`](#phpconfig): Configure php.ini settings for a PHP SAPI === Parameters [*file*] The path to ini file [*config*] Nested hash of key => value to apply -* [`php::config::setting`](#phpconfigsetting): Configure php.ini settings === Parameters [*key*] The key of the value, like `ini_setting` [*file*] The path to ini file [*value*] -* [`php::extension`](#phpextension): Install a PHP extension package === Parameters [*ensure*] The ensure of the package to install Could be "present", "absent", "latest", -* [`php::extension::config`](#phpextensionconfig): Configure a PHP extension package === Parameters [*ensure*] The ensure of the package to install Could be "latest", "installed" or a pi -* [`php::extension::install`](#phpextensioninstall): Install a PHP extension package === Parameters [*ensure*] The ensure of the package to install Could be "latest", "installed" or a pinn -* [`php::fpm::pool`](#phpfpmpool): Configure fpm pools === Parameters See the official php-fpm documentation for parameters that are not documented here: http://php.net/manua +* [`php::apache_vhost`](#php--apache_vhost): Configures an apache vhost for php === Parameters [*vhost*] The vhost address [*docroot*] The vhost docroot [*port*] The vhost port +* [`php::config`](#php--config): Configure php.ini settings for a PHP SAPI === Parameters [*file*] The path to ini file [*config*] Nested hash of key => value to apply +* [`php::config::setting`](#php--config--setting): Configure php.ini settings === Parameters [*key*] The key of the value, like `ini_setting` [*file*] The path to ini file [*value*] +* [`php::extension`](#php--extension): Install a PHP extension package === Parameters [*ensure*] The ensure of the package to install Could be "present", "absent", "latest", +* [`php::extension::config`](#php--extension--config): Configure a PHP extension package === Parameters [*ensure*] The ensure of the package to install Could be "latest", "installed" or a pi +* [`php::extension::install`](#php--extension--install): Install a PHP extension package === Parameters [*ensure*] The ensure of the package to install Could be "latest", "installed" or a pinn +* [`php::fpm::pool`](#php--fpm--pool): Configure fpm pools === Parameters See the official php-fpm documentation for parameters that are not documented here: http://php.net/manua ### Functions @@ -46,11 +46,11 @@ ### Data types -* [`Php::ComposerChannel`](#phpcomposerchannel) -* [`Php::Duration`](#phpduration): A duration in seconds are with an unit -* [`Php::InstallOptions`](#phpinstalloptions) -* [`Php::Provider`](#phpprovider) -* [`Php::Sapi`](#phpsapi) +* [`Php::ComposerChannel`](#Php--ComposerChannel) +* [`Php::Duration`](#Php--Duration): A duration in seconds are with an unit +* [`Php::InstallOptions`](#Php--InstallOptions) +* [`Php::Provider`](#Php--Provider) +* [`Php::Sapi`](#Php--Sapi) ## Classes @@ -195,43 +195,43 @@ enabled components. The following parameters are available in the `php` class: -* [`ensure`](#ensure) -* [`manage_repos`](#manage_repos) -* [`fpm`](#fpm) -* [`fpm_service_enable`](#fpm_service_enable) -* [`fpm_service_ensure`](#fpm_service_ensure) -* [`fpm_service_name`](#fpm_service_name) -* [`fpm_service_provider`](#fpm_service_provider) -* [`fpm_pools`](#fpm_pools) -* [`fpm_global_pool_settings`](#fpm_global_pool_settings) -* [`fpm_inifile`](#fpm_inifile) -* [`fpm_package`](#fpm_package) -* [`fpm_user`](#fpm_user) -* [`fpm_group`](#fpm_group) -* [`embedded`](#embedded) -* [`dev`](#dev) -* [`composer`](#composer) -* [`pear`](#pear) -* [`pear_ensure`](#pear_ensure) -* [`phpunit`](#phpunit) -* [`apache_config`](#apache_config) -* [`proxy_type`](#proxy_type) -* [`proxy_server`](#proxy_server) -* [`extensions`](#extensions) -* [`settings`](#settings) -* [`cli_settings`](#cli_settings) -* [`package_prefix`](#package_prefix) -* [`config_root_ini`](#config_root_ini) -* [`config_root_inifile`](#config_root_inifile) -* [`ext_tool_enable`](#ext_tool_enable) -* [`ext_tool_query`](#ext_tool_query) -* [`ext_tool_enabled`](#ext_tool_enabled) -* [`log_owner`](#log_owner) -* [`log_group`](#log_group) -* [`pool_purge`](#pool_purge) -* [`reload_fpm_on_config_changes`](#reload_fpm_on_config_changes) - -##### `ensure` +* [`ensure`](#-php--ensure) +* [`manage_repos`](#-php--manage_repos) +* [`fpm`](#-php--fpm) +* [`fpm_service_enable`](#-php--fpm_service_enable) +* [`fpm_service_ensure`](#-php--fpm_service_ensure) +* [`fpm_service_name`](#-php--fpm_service_name) +* [`fpm_service_provider`](#-php--fpm_service_provider) +* [`fpm_pools`](#-php--fpm_pools) +* [`fpm_global_pool_settings`](#-php--fpm_global_pool_settings) +* [`fpm_inifile`](#-php--fpm_inifile) +* [`fpm_package`](#-php--fpm_package) +* [`fpm_user`](#-php--fpm_user) +* [`fpm_group`](#-php--fpm_group) +* [`embedded`](#-php--embedded) +* [`dev`](#-php--dev) +* [`composer`](#-php--composer) +* [`pear`](#-php--pear) +* [`pear_ensure`](#-php--pear_ensure) +* [`phpunit`](#-php--phpunit) +* [`apache_config`](#-php--apache_config) +* [`proxy_type`](#-php--proxy_type) +* [`proxy_server`](#-php--proxy_server) +* [`extensions`](#-php--extensions) +* [`settings`](#-php--settings) +* [`cli_settings`](#-php--cli_settings) +* [`package_prefix`](#-php--package_prefix) +* [`config_root_ini`](#-php--config_root_ini) +* [`config_root_inifile`](#-php--config_root_inifile) +* [`ext_tool_enable`](#-php--ext_tool_enable) +* [`ext_tool_query`](#-php--ext_tool_query) +* [`ext_tool_enabled`](#-php--ext_tool_enabled) +* [`log_owner`](#-php--log_owner) +* [`log_group`](#-php--log_group) +* [`pool_purge`](#-php--pool_purge) +* [`reload_fpm_on_config_changes`](#-php--reload_fpm_on_config_changes) + +##### `ensure` Data type: `String` @@ -239,7 +239,7 @@ Data type: `String` Default value: `$php::params::ensure` -##### `manage_repos` +##### `manage_repos` Data type: `Boolean` @@ -247,15 +247,15 @@ Data type: `Boolean` Default value: `$php::params::manage_repos` -##### `fpm` +##### `fpm` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `fpm_service_enable` +##### `fpm_service_enable` Data type: `Boolean` @@ -263,7 +263,7 @@ Data type: `Boolean` Default value: `$php::params::fpm_service_enable` -##### `fpm_service_ensure` +##### `fpm_service_ensure` Data type: `Enum['running', 'stopped']` @@ -271,7 +271,7 @@ Data type: `Enum['running', 'stopped']` Default value: `$php::params::fpm_service_ensure` -##### `fpm_service_name` +##### `fpm_service_name` Data type: `String[1]` @@ -279,15 +279,15 @@ Data type: `String[1]` Default value: `$php::params::fpm_service_name` -##### `fpm_service_provider` +##### `fpm_service_provider` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `fpm_pools` +##### `fpm_pools` Data type: `Hash` @@ -295,7 +295,7 @@ Data type: `Hash` Default value: `$php::params::fpm_pools` -##### `fpm_global_pool_settings` +##### `fpm_global_pool_settings` Data type: `Hash` @@ -303,7 +303,7 @@ Data type: `Hash` Default value: `{}` -##### `fpm_inifile` +##### `fpm_inifile` Data type: `Stdlib::Absolutepath` @@ -311,15 +311,15 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::fpm_inifile` -##### `fpm_package` +##### `fpm_package` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `fpm_user` +##### `fpm_user` Data type: `String[1]` @@ -327,7 +327,7 @@ Data type: `String[1]` Default value: `$php::params::fpm_user` -##### `fpm_group` +##### `fpm_group` Data type: `String[1]` @@ -335,31 +335,31 @@ Data type: `String[1]` Default value: `$php::params::fpm_group` -##### `embedded` +##### `embedded` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `dev` +##### `dev` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `composer` +##### `composer` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `pear` +##### `pear` Data type: `Boolean` @@ -367,7 +367,7 @@ Data type: `Boolean` Default value: `$php::params::pear` -##### `pear_ensure` +##### `pear_ensure` Data type: `String` @@ -375,39 +375,39 @@ Data type: `String` Default value: `$php::params::pear_ensure` -##### `phpunit` +##### `phpunit` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `apache_config` +##### `apache_config` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `proxy_type` +##### `proxy_type` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `proxy_server` +##### `proxy_server` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `extensions` +##### `extensions` Data type: `Hash` @@ -415,7 +415,7 @@ Data type: `Hash` Default value: `{}` -##### `settings` +##### `settings` Data type: `Hash` @@ -423,7 +423,7 @@ Data type: `Hash` Default value: `{}` -##### `cli_settings` +##### `cli_settings` Data type: `Hash` @@ -431,7 +431,7 @@ Data type: `Hash` Default value: `{}` -##### `package_prefix` +##### `package_prefix` Data type: `Optional[String[1]]` @@ -439,7 +439,7 @@ Data type: `Optional[String[1]]` Default value: `$php::params::package_prefix` -##### `config_root_ini` +##### `config_root_ini` Data type: `Stdlib::Absolutepath` @@ -447,7 +447,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::config_root_ini` -##### `config_root_inifile` +##### `config_root_inifile` Data type: `Stdlib::Absolutepath` @@ -455,7 +455,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::config_root_inifile` -##### `ext_tool_enable` +##### `ext_tool_enable` Data type: `Optional[Stdlib::Absolutepath]` @@ -463,7 +463,7 @@ Data type: `Optional[Stdlib::Absolutepath]` Default value: `$php::params::ext_tool_enable` -##### `ext_tool_query` +##### `ext_tool_query` Data type: `Optional[Stdlib::Absolutepath]` @@ -471,7 +471,7 @@ Data type: `Optional[Stdlib::Absolutepath]` Default value: `$php::params::ext_tool_query` -##### `ext_tool_enabled` +##### `ext_tool_enabled` Data type: `Boolean` @@ -479,7 +479,7 @@ Data type: `Boolean` Default value: `$php::params::ext_tool_enabled` -##### `log_owner` +##### `log_owner` Data type: `String` @@ -487,7 +487,7 @@ Data type: `String` Default value: `$php::params::fpm_user` -##### `log_group` +##### `log_group` Data type: `String` @@ -495,7 +495,7 @@ Data type: `String` Default value: `$php::params::fpm_group` -##### `pool_purge` +##### `pool_purge` Data type: `Boolean` @@ -503,15 +503,15 @@ Data type: `Boolean` Default value: `$php::params::pool_purge` -##### `reload_fpm_on_config_changes` +##### `reload_fpm_on_config_changes` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -### `php::apache_config` +### `php::apache_config` Install and configure php apache settings @@ -527,10 +527,10 @@ Install and configure php apache settings The following parameters are available in the `php::apache_config` class: -* [`inifile`](#inifile) -* [`settings`](#settings) +* [`inifile`](#-php--apache_config--inifile) +* [`settings`](#-php--apache_config--settings) -##### `inifile` +##### `inifile` Data type: `Stdlib::Absolutepath` @@ -538,7 +538,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::apache_inifile` -##### `settings` +##### `settings` Data type: `Hash` @@ -546,7 +546,7 @@ Data type: `Hash` Default value: `{}` -### `php::cli` +### `php::cli` Install and configure php CLI @@ -562,10 +562,10 @@ Install and configure php CLI The following parameters are available in the `php::cli` class: -* [`inifile`](#inifile) -* [`settings`](#settings) +* [`inifile`](#-php--cli--inifile) +* [`settings`](#-php--cli--settings) -##### `inifile` +##### `inifile` Data type: `Stdlib::Absolutepath` @@ -573,7 +573,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::cli_inifile` -##### `settings` +##### `settings` Data type: `Hash` @@ -581,7 +581,7 @@ Data type: `Hash` Default value: `{}` -### `php::composer` +### `php::composer` Install composer package manager @@ -615,16 +615,16 @@ Install composer package manager The following parameters are available in the `php::composer` class: -* [`source`](#source) -* [`path`](#path) -* [`proxy_type`](#proxy_type) -* [`proxy_server`](#proxy_server) -* [`channel`](#channel) -* [`auto_update`](#auto_update) -* [`max_age`](#max_age) -* [`root_group`](#root_group) +* [`source`](#-php--composer--source) +* [`path`](#-php--composer--path) +* [`proxy_type`](#-php--composer--proxy_type) +* [`proxy_server`](#-php--composer--proxy_server) +* [`channel`](#-php--composer--channel) +* [`auto_update`](#-php--composer--auto_update) +* [`max_age`](#-php--composer--max_age) +* [`root_group`](#-php--composer--root_group) -##### `source` +##### `source` Data type: `String` @@ -632,7 +632,7 @@ Data type: `String` Default value: `$php::params::composer_source` -##### `path` +##### `path` Data type: `Stdlib::Absolutepath` @@ -640,23 +640,23 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::composer_path` -##### `proxy_type` +##### `proxy_type` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `proxy_server` +##### `proxy_server` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `channel` +##### `channel` Data type: `Php::ComposerChannel` @@ -664,15 +664,15 @@ Data type: `Php::ComposerChannel` Default value: `'stable'` -##### `auto_update` +##### `auto_update` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `max_age` +##### `max_age` Data type: `Integer` @@ -680,7 +680,7 @@ Data type: `Integer` Default value: `$php::params::composer_max_age` -##### `root_group` +##### `root_group` Data type: `Variant[Integer, String]` @@ -688,7 +688,7 @@ Data type: `Variant[Integer, String]` Default value: `$php::params::root_group` -### `php::composer::auto_update` +### `php::composer::auto_update` Install composer package manager @@ -724,32 +724,32 @@ Install composer package manager The following parameters are available in the `php::composer::auto_update` class: -* [`max_age`](#max_age) -* [`source`](#source) -* [`path`](#path) -* [`channel`](#channel) -* [`proxy_type`](#proxy_type) -* [`proxy_server`](#proxy_server) +* [`max_age`](#-php--composer--auto_update--max_age) +* [`source`](#-php--composer--auto_update--source) +* [`path`](#-php--composer--auto_update--path) +* [`channel`](#-php--composer--auto_update--channel) +* [`proxy_type`](#-php--composer--auto_update--proxy_type) +* [`proxy_server`](#-php--composer--auto_update--proxy_server) -##### `max_age` +##### `max_age` Data type: `Integer[1]` -##### `source` +##### `source` Data type: `String[1]` -##### `path` +##### `path` Data type: `Stdlib::Absolutepath` -##### `channel` +##### `channel` Data type: `Php::ComposerChannel` @@ -757,23 +757,23 @@ Data type: `Php::ComposerChannel` Default value: `'stable'` -##### `proxy_type` +##### `proxy_type` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `proxy_server` +##### `proxy_server` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -### `php::dev` +### `php::dev` Install the development package with headers for PHP @@ -789,11 +789,11 @@ Install the development package with headers for PHP The following parameters are available in the `php::dev` class: -* [`ensure`](#ensure) -* [`package`](#package) -* [`manage_repos`](#manage_repos) +* [`ensure`](#-php--dev--ensure) +* [`package`](#-php--dev--package) +* [`manage_repos`](#-php--dev--manage_repos) -##### `ensure` +##### `ensure` Data type: `String` @@ -801,7 +801,7 @@ Data type: `String` Default value: `$php::ensure` -##### `package` +##### `package` Data type: `String` @@ -809,7 +809,7 @@ Data type: `String` Default value: `"${php::package_prefix}${php::params::dev_package_suffix}"` -##### `manage_repos` +##### `manage_repos` Data type: `Boolean` @@ -817,7 +817,7 @@ Data type: `Boolean` Default value: `$php::manage_repos` -### `php::embedded` +### `php::embedded` Install and configure php embedded SAPI @@ -839,12 +839,12 @@ Install and configure php embedded SAPI The following parameters are available in the `php::embedded` class: -* [`ensure`](#ensure) -* [`package`](#package) -* [`inifile`](#inifile) -* [`settings`](#settings) +* [`ensure`](#-php--embedded--ensure) +* [`package`](#-php--embedded--package) +* [`inifile`](#-php--embedded--inifile) +* [`settings`](#-php--embedded--settings) -##### `ensure` +##### `ensure` Data type: `String` @@ -852,7 +852,7 @@ Data type: `String` Default value: `$php::ensure` -##### `package` +##### `package` Data type: `String` @@ -860,7 +860,7 @@ Data type: `String` Default value: `"${php::package_prefix}${php::params::embedded_package_suffix}"` -##### `inifile` +##### `inifile` Data type: `Stdlib::Absolutepath` @@ -868,7 +868,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::embedded_inifile` -##### `settings` +##### `settings` Data type: `Hash` @@ -876,7 +876,7 @@ Data type: `Hash` Default value: `{}` -### `php::fpm` +### `php::fpm` Install and configure mod_php for fpm @@ -943,24 +943,24 @@ Install and configure mod_php for fpm The following parameters are available in the `php::fpm` class: -* [`ensure`](#ensure) -* [`user`](#user) -* [`group`](#group) -* [`service_ensure`](#service_ensure) -* [`service_enable`](#service_enable) -* [`service_name`](#service_name) -* [`service_provider`](#service_provider) -* [`package`](#package) -* [`inifile`](#inifile) -* [`settings`](#settings) -* [`global_pool_settings`](#global_pool_settings) -* [`pools`](#pools) -* [`log_owner`](#log_owner) -* [`log_group`](#log_group) -* [`pool_purge`](#pool_purge) -* [`reload_fpm_on_config_changes`](#reload_fpm_on_config_changes) - -##### `ensure` +* [`ensure`](#-php--fpm--ensure) +* [`user`](#-php--fpm--user) +* [`group`](#-php--fpm--group) +* [`service_ensure`](#-php--fpm--service_ensure) +* [`service_enable`](#-php--fpm--service_enable) +* [`service_name`](#-php--fpm--service_name) +* [`service_provider`](#-php--fpm--service_provider) +* [`package`](#-php--fpm--package) +* [`inifile`](#-php--fpm--inifile) +* [`settings`](#-php--fpm--settings) +* [`global_pool_settings`](#-php--fpm--global_pool_settings) +* [`pools`](#-php--fpm--pools) +* [`log_owner`](#-php--fpm--log_owner) +* [`log_group`](#-php--fpm--log_group) +* [`pool_purge`](#-php--fpm--pool_purge) +* [`reload_fpm_on_config_changes`](#-php--fpm--reload_fpm_on_config_changes) + +##### `ensure` Data type: `Optional[String]` @@ -968,7 +968,7 @@ Data type: `Optional[String]` Default value: `$php::ensure` -##### `user` +##### `user` Data type: `String[1]` @@ -976,7 +976,7 @@ Data type: `String[1]` Default value: `$php::fpm_user` -##### `group` +##### `group` Data type: `String[1]` @@ -984,7 +984,7 @@ Data type: `String[1]` Default value: `$php::fpm_group` -##### `service_ensure` +##### `service_ensure` Data type: `Enum['running', 'stopped']` @@ -992,7 +992,7 @@ Data type: `Enum['running', 'stopped']` Default value: `$php::fpm_service_ensure` -##### `service_enable` +##### `service_enable` Data type: `Boolean` @@ -1000,7 +1000,7 @@ Data type: `Boolean` Default value: `$php::fpm_service_enable` -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -1008,7 +1008,7 @@ Data type: `String[1]` Default value: `$php::fpm_service_name` -##### `service_provider` +##### `service_provider` Data type: `Optional[String[1]]` @@ -1016,7 +1016,7 @@ Data type: `Optional[String[1]]` Default value: `$php::fpm_service_provider` -##### `package` +##### `package` Data type: `String` @@ -1024,7 +1024,7 @@ Data type: `String` Default value: `$php::real_fpm_package` -##### `inifile` +##### `inifile` Data type: `Stdlib::Absolutepath` @@ -1032,7 +1032,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::fpm_inifile` -##### `settings` +##### `settings` Data type: `Hash` @@ -1040,7 +1040,7 @@ Data type: `Hash` Default value: `$php::real_settings` -##### `global_pool_settings` +##### `global_pool_settings` Data type: `Hash` @@ -1048,7 +1048,7 @@ Data type: `Hash` Default value: `$php::real_fpm_global_pool_settings` -##### `pools` +##### `pools` Data type: `Hash` @@ -1056,7 +1056,7 @@ Data type: `Hash` Default value: `$php::real_fpm_pools` -##### `log_owner` +##### `log_owner` Data type: `String[1]` @@ -1064,7 +1064,7 @@ Data type: `String[1]` Default value: `$php::log_owner` -##### `log_group` +##### `log_group` Data type: `String[1]` @@ -1072,7 +1072,7 @@ Data type: `String[1]` Default value: `$php::log_group` -##### `pool_purge` +##### `pool_purge` Data type: `Boolean` @@ -1080,7 +1080,7 @@ Data type: `Boolean` Default value: `$php::pool_purge` -##### `reload_fpm_on_config_changes` +##### `reload_fpm_on_config_changes` Data type: `Boolean` @@ -1088,7 +1088,7 @@ Data type: `Boolean` Default value: `$php::reload_fpm_on_config_changes` -### `php::fpm::config` +### `php::fpm::config` Configure php-fpm service @@ -1166,30 +1166,30 @@ Configure php-fpm service The following parameters are available in the `php::fpm::config` class: -* [`config_file`](#config_file) -* [`user`](#user) -* [`group`](#group) -* [`inifile`](#inifile) -* [`pid_file`](#pid_file) -* [`settings`](#settings) -* [`pool_base_dir`](#pool_base_dir) -* [`pool_purge`](#pool_purge) -* [`error_log`](#error_log) -* [`log_level`](#log_level) -* [`emergency_restart_threshold`](#emergency_restart_threshold) -* [`emergency_restart_interval`](#emergency_restart_interval) -* [`process_control_timeout`](#process_control_timeout) -* [`process_max`](#process_max) -* [`rlimit_files`](#rlimit_files) -* [`systemd_interval`](#systemd_interval) -* [`log_owner`](#log_owner) -* [`log_group`](#log_group) -* [`log_dir_mode`](#log_dir_mode) -* [`root_group`](#root_group) -* [`syslog_facility`](#syslog_facility) -* [`syslog_ident`](#syslog_ident) - -##### `config_file` +* [`config_file`](#-php--fpm--config--config_file) +* [`user`](#-php--fpm--config--user) +* [`group`](#-php--fpm--config--group) +* [`inifile`](#-php--fpm--config--inifile) +* [`pid_file`](#-php--fpm--config--pid_file) +* [`settings`](#-php--fpm--config--settings) +* [`pool_base_dir`](#-php--fpm--config--pool_base_dir) +* [`pool_purge`](#-php--fpm--config--pool_purge) +* [`error_log`](#-php--fpm--config--error_log) +* [`log_level`](#-php--fpm--config--log_level) +* [`emergency_restart_threshold`](#-php--fpm--config--emergency_restart_threshold) +* [`emergency_restart_interval`](#-php--fpm--config--emergency_restart_interval) +* [`process_control_timeout`](#-php--fpm--config--process_control_timeout) +* [`process_max`](#-php--fpm--config--process_max) +* [`rlimit_files`](#-php--fpm--config--rlimit_files) +* [`systemd_interval`](#-php--fpm--config--systemd_interval) +* [`log_owner`](#-php--fpm--config--log_owner) +* [`log_group`](#-php--fpm--config--log_group) +* [`log_dir_mode`](#-php--fpm--config--log_dir_mode) +* [`root_group`](#-php--fpm--config--root_group) +* [`syslog_facility`](#-php--fpm--config--syslog_facility) +* [`syslog_ident`](#-php--fpm--config--syslog_ident) + +##### `config_file` Data type: `Stdlib::Absolutepath` @@ -1197,7 +1197,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::fpm_config_file` -##### `user` +##### `user` Data type: `String` @@ -1205,7 +1205,7 @@ Data type: `String` Default value: `$php::params::fpm_user` -##### `group` +##### `group` Data type: `String` @@ -1213,7 +1213,7 @@ Data type: `String` Default value: `$php::params::fpm_group` -##### `inifile` +##### `inifile` Data type: `String` @@ -1221,7 +1221,7 @@ Data type: `String` Default value: `$php::params::fpm_inifile` -##### `pid_file` +##### `pid_file` Data type: `Stdlib::Absolutepath` @@ -1229,7 +1229,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::fpm_pid_file` -##### `settings` +##### `settings` Data type: `Hash` @@ -1237,7 +1237,7 @@ Data type: `Hash` Default value: `{}` -##### `pool_base_dir` +##### `pool_base_dir` Data type: `Stdlib::Absolutepath` @@ -1245,15 +1245,15 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::fpm_pool_dir` -##### `pool_purge` +##### `pool_purge` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `error_log` +##### `error_log` Data type: `String` @@ -1261,7 +1261,7 @@ Data type: `String` Default value: `$php::params::fpm_error_log` -##### `log_level` +##### `log_level` Data type: `String` @@ -1269,7 +1269,7 @@ Data type: `String` Default value: `'notice'` -##### `emergency_restart_threshold` +##### `emergency_restart_threshold` Data type: `Integer` @@ -1277,7 +1277,7 @@ Data type: `Integer` Default value: `0` -##### `emergency_restart_interval` +##### `emergency_restart_interval` Data type: `Php::Duration` @@ -1285,7 +1285,7 @@ Data type: `Php::Duration` Default value: `0` -##### `process_control_timeout` +##### `process_control_timeout` Data type: `Php::Duration` @@ -1293,7 +1293,7 @@ Data type: `Php::Duration` Default value: `0` -##### `process_max` +##### `process_max` Data type: `Integer` @@ -1301,23 +1301,23 @@ Data type: `Integer` Default value: `0` -##### `rlimit_files` +##### `rlimit_files` Data type: `Optional[Integer[1]]` -Default value: ``undef`` +Default value: `undef` -##### `systemd_interval` +##### `systemd_interval` Data type: `Optional[Php::Duration]` -Default value: ``undef`` +Default value: `undef` -##### `log_owner` +##### `log_owner` Data type: `String` @@ -1325,7 +1325,7 @@ Data type: `String` Default value: `$php::params::fpm_user` -##### `log_group` +##### `log_group` Data type: `String` @@ -1333,7 +1333,7 @@ Data type: `String` Default value: `$php::params::fpm_group` -##### `log_dir_mode` +##### `log_dir_mode` Data type: `Pattern[/^\d+$/]` @@ -1341,7 +1341,7 @@ Data type: `Pattern[/^\d+$/]` Default value: `'0770'` -##### `root_group` +##### `root_group` Data type: `String[1]` @@ -1349,7 +1349,7 @@ Data type: `String[1]` Default value: `$php::params::root_group` -##### `syslog_facility` +##### `syslog_facility` Data type: `String` @@ -1357,7 +1357,7 @@ Data type: `String` Default value: `'daemon'` -##### `syslog_ident` +##### `syslog_ident` Data type: `String` @@ -1365,7 +1365,7 @@ Data type: `String` Default value: `'php-fpm'` -### `php::fpm::service` +### `php::fpm::service` Manage fpm service @@ -1393,13 +1393,13 @@ Manage fpm service The following parameters are available in the `php::fpm::service` class: -* [`service_name`](#service_name) -* [`ensure`](#ensure) -* [`enable`](#enable) -* [`provider`](#provider) -* [`reload_fpm_on_config_changes`](#reload_fpm_on_config_changes) +* [`service_name`](#-php--fpm--service--service_name) +* [`ensure`](#-php--fpm--service--ensure) +* [`enable`](#-php--fpm--service--enable) +* [`provider`](#-php--fpm--service--provider) +* [`reload_fpm_on_config_changes`](#-php--fpm--service--reload_fpm_on_config_changes) -##### `service_name` +##### `service_name` Data type: `String[1]` @@ -1407,7 +1407,7 @@ Data type: `String[1]` Default value: `$php::fpm::service_name` -##### `ensure` +##### `ensure` Data type: `Enum['running', 'stopped']` @@ -1415,7 +1415,7 @@ Data type: `Enum['running', 'stopped']` Default value: `$php::fpm::service_ensure` -##### `enable` +##### `enable` Data type: `Boolean` @@ -1423,7 +1423,7 @@ Data type: `Boolean` Default value: `$php::fpm::service_enable` -##### `provider` +##### `provider` Data type: `Optional[String[1]]` @@ -1431,7 +1431,7 @@ Data type: `Optional[String[1]]` Default value: `$php::fpm::service_provider` -##### `reload_fpm_on_config_changes` +##### `reload_fpm_on_config_changes` Data type: `Boolean` @@ -1439,7 +1439,7 @@ Data type: `Boolean` Default value: `$php::fpm::reload_fpm_on_config_changes` -### `php::global` +### `php::global` The php::global class. @@ -1447,10 +1447,10 @@ The php::global class. The following parameters are available in the `php::global` class: -* [`inifile`](#inifile) -* [`settings`](#settings) +* [`inifile`](#-php--global--inifile) +* [`settings`](#-php--global--settings) -##### `inifile` +##### `inifile` Data type: `Stdlib::Absolutepath` @@ -1458,7 +1458,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::config_root_inifile` -##### `settings` +##### `settings` Data type: `Hash` @@ -1466,7 +1466,7 @@ Data type: `Hash` Default value: `{}` -### `php::globals` +### `php::globals` The php::globals class. @@ -1474,44 +1474,44 @@ The php::globals class. The following parameters are available in the `php::globals` class: -* [`php_version`](#php_version) -* [`config_root`](#config_root) -* [`fpm_pid_file`](#fpm_pid_file) -* [`rhscl_mode`](#rhscl_mode) +* [`php_version`](#-php--globals--php_version) +* [`config_root`](#-php--globals--config_root) +* [`fpm_pid_file`](#-php--globals--fpm_pid_file) +* [`rhscl_mode`](#-php--globals--rhscl_mode) -##### `php_version` +##### `php_version` Data type: `Optional[Pattern[/^(rh-)?(php)?[578](\.)?[0-9]/]]` -Default value: ``undef`` +Default value: `undef` -##### `config_root` +##### `config_root` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `fpm_pid_file` +##### `fpm_pid_file` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `rhscl_mode` +##### `rhscl_mode` Data type: `Optional[Enum['rhscl', 'remi']]` -Default value: ``undef`` +Default value: `undef` -### `php::packages` +### `php::packages` Install common PHP packages @@ -1531,12 +1531,12 @@ Install common PHP packages The following parameters are available in the `php::packages` class: -* [`ensure`](#ensure) -* [`manage_repos`](#manage_repos) -* [`names_to_prefix`](#names_to_prefix) -* [`names`](#names) +* [`ensure`](#-php--packages--ensure) +* [`manage_repos`](#-php--packages--manage_repos) +* [`names_to_prefix`](#-php--packages--names_to_prefix) +* [`names`](#-php--packages--names) -##### `ensure` +##### `ensure` Data type: `String` @@ -1544,7 +1544,7 @@ Data type: `String` Default value: `$php::ensure` -##### `manage_repos` +##### `manage_repos` Data type: `Boolean` @@ -1552,7 +1552,7 @@ Data type: `Boolean` Default value: `$php::manage_repos` -##### `names_to_prefix` +##### `names_to_prefix` Data type: `Array` @@ -1560,7 +1560,7 @@ Data type: `Array` Default value: `prefix($php::params::common_package_suffixes, $php::package_prefix)` -##### `names` +##### `names` Data type: `Array` @@ -1568,11 +1568,11 @@ Data type: `Array` Default value: `$php::params::common_package_names` -### `php::params` +### `php::params` PHP params class -### `php::pear` +### `php::pear` Install PEAR package manager @@ -1588,11 +1588,11 @@ Install PEAR package manager The following parameters are available in the `php::pear` class: -* [`ensure`](#ensure) -* [`package`](#package) -* [`manage_repos`](#manage_repos) +* [`ensure`](#-php--pear--ensure) +* [`package`](#-php--pear--package) +* [`manage_repos`](#-php--pear--manage_repos) -##### `ensure` +##### `ensure` Data type: `String` @@ -1600,15 +1600,15 @@ Data type: `String` Default value: `$php::pear_ensure` -##### `package` +##### `package` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `manage_repos` +##### `manage_repos` Data type: `Boolean` @@ -1616,7 +1616,7 @@ Data type: `Boolean` Default value: `$php::manage_repos` -### `php::phpunit` +### `php::phpunit` Install phpunit, PHP testing framework @@ -1638,13 +1638,13 @@ Install phpunit, PHP testing framework The following parameters are available in the `php::phpunit` class: -* [`source`](#source) -* [`path`](#path) -* [`root_group`](#root_group) -* [`auto_update`](#auto_update) -* [`max_age`](#max_age) +* [`source`](#-php--phpunit--source) +* [`path`](#-php--phpunit--path) +* [`root_group`](#-php--phpunit--root_group) +* [`auto_update`](#-php--phpunit--auto_update) +* [`max_age`](#-php--phpunit--max_age) -##### `source` +##### `source` Data type: `String` @@ -1652,7 +1652,7 @@ Data type: `String` Default value: `$php::params::phpunit_source` -##### `path` +##### `path` Data type: `Stdlib::Absolutepath` @@ -1660,7 +1660,7 @@ Data type: `Stdlib::Absolutepath` Default value: `$php::params::phpunit_path` -##### `root_group` +##### `root_group` Data type: `String[1]` @@ -1668,15 +1668,15 @@ Data type: `String[1]` Default value: `$php::params::root_group` -##### `auto_update` +##### `auto_update` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `max_age` +##### `max_age` Data type: `Integer` @@ -1684,7 +1684,7 @@ Data type: `Integer` Default value: `$php::params::phpunit_max_age` -### `php::phpunit::auto_update` +### `php::phpunit::auto_update` Install phpunit package manager @@ -1703,33 +1703,33 @@ Install phpunit package manager The following parameters are available in the `php::phpunit::auto_update` class: -* [`max_age`](#max_age) -* [`source`](#source) -* [`path`](#path) +* [`max_age`](#-php--phpunit--auto_update--max_age) +* [`source`](#-php--phpunit--auto_update--source) +* [`path`](#-php--phpunit--auto_update--path) -##### `max_age` +##### `max_age` Data type: `Integer[1]` -##### `source` +##### `source` Data type: `String[1]` -##### `path` +##### `path` Data type: `Stdlib::Absolutepath` -### `php::repo` +### `php::repo` Configure package repository -### `php::repo::debian` +### `php::repo::debian` Configure debian apt repo @@ -1757,14 +1757,14 @@ Configure debian apt repo The following parameters are available in the `php::repo::debian` class: -* [`location`](#location) -* [`repos`](#repos) -* [`include_src`](#include_src) -* [`key`](#key) -* [`dotdeb`](#dotdeb) -* [`sury`](#sury) +* [`location`](#-php--repo--debian--location) +* [`repos`](#-php--repo--debian--repos) +* [`include_src`](#-php--repo--debian--include_src) +* [`key`](#-php--repo--debian--key) +* [`dotdeb`](#-php--repo--debian--dotdeb) +* [`sury`](#-php--repo--debian--sury) -##### `location` +##### `location` Data type: `String[1]` @@ -1772,7 +1772,7 @@ Data type: `String[1]` Default value: `'https://packages.dotdeb.org'` -##### `repos` +##### `repos` Data type: `String[1]` @@ -1780,42 +1780,46 @@ Data type: `String[1]` Default value: `'all'` -##### `include_src` +##### `include_src` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `key` +##### `key` Data type: `Hash` -Default value: `{ +Default value: + +```puppet +{ 'id' => '6572BBEF1B5FF28B28B706837E3F070089DF5277', 'source' => 'http://www.dotdeb.org/dotdeb.gpg', - }` + } +``` -##### `dotdeb` +##### `dotdeb` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `sury` +##### `sury` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -### `php::repo::redhat` +### `php::repo::redhat` The php::repo::redhat class. @@ -1823,9 +1827,9 @@ The php::repo::redhat class. The following parameters are available in the `php::repo::redhat` class: -* [`yum_repo`](#yum_repo) +* [`yum_repo`](#-php--repo--redhat--yum_repo) -##### `yum_repo` +##### `yum_repo` Data type: `String[1]` @@ -1833,7 +1837,7 @@ Data type: `String[1]` Default value: `'remi_php56'` -### `php::repo::suse` +### `php::repo::suse` Configure suse repo @@ -1849,10 +1853,10 @@ Configure suse repo The following parameters are available in the `php::repo::suse` class: -* [`reponame`](#reponame) -* [`baseurl`](#baseurl) +* [`reponame`](#-php--repo--suse--reponame) +* [`baseurl`](#-php--repo--suse--baseurl) -##### `reponame` +##### `reponame` Data type: `String[1]` @@ -1860,7 +1864,7 @@ Data type: `String[1]` Default value: `'mayflower-php56'` -##### `baseurl` +##### `baseurl` Data type: `String[1]` @@ -1868,7 +1872,7 @@ Data type: `String[1]` Default value: `'http://download.opensuse.org/repositories/home:/mayflower:/php5.6_based/SLE_11_SP3/'` -### `php::repo::ubuntu` +### `php::repo::ubuntu` Configure ubuntu ppa @@ -1881,9 +1885,9 @@ Configure ubuntu ppa The following parameters are available in the `php::repo::ubuntu` class: -* [`version`](#version) +* [`version`](#-php--repo--ubuntu--version) -##### `version` +##### `version` Data type: `Pattern[/^\d\.\d/]` @@ -1893,7 +1897,7 @@ Default value: `'5.6'` ## Defined types -### `php::apache_vhost` +### `php::apache_vhost` Configures an apache vhost for php @@ -1918,13 +1922,13 @@ Configures an apache vhost for php The following parameters are available in the `php::apache_vhost` defined type: -* [`vhost`](#vhost) -* [`docroot`](#docroot) -* [`port`](#port) -* [`default_vhost`](#default_vhost) -* [`fastcgi_socket`](#fastcgi_socket) +* [`vhost`](#-php--apache_vhost--vhost) +* [`docroot`](#-php--apache_vhost--docroot) +* [`port`](#-php--apache_vhost--port) +* [`default_vhost`](#-php--apache_vhost--default_vhost) +* [`fastcgi_socket`](#-php--apache_vhost--fastcgi_socket) -##### `vhost` +##### `vhost` Data type: `String[1]` @@ -1932,7 +1936,7 @@ Data type: `String[1]` Default value: `'example.com'` -##### `docroot` +##### `docroot` Data type: `Stdlib::Absolutepath` @@ -1940,7 +1944,7 @@ Data type: `Stdlib::Absolutepath` Default value: `'/var/www'` -##### `port` +##### `port` Data type: `Integer[1]` @@ -1948,15 +1952,15 @@ Data type: `Integer[1]` Default value: `80` -##### `default_vhost` +##### `default_vhost` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `fastcgi_socket` +##### `fastcgi_socket` Data type: `String[1]` @@ -1964,7 +1968,7 @@ Data type: `String[1]` Default value: `'fcgi://127.0.0.1:9000/$1'` -### `php::config` +### `php::config` Configure php.ini settings for a PHP SAPI @@ -1989,22 +1993,22 @@ Configure php.ini settings for a PHP SAPI The following parameters are available in the `php::config` defined type: -* [`file`](#file) -* [`config`](#config) +* [`file`](#-php--config--file) +* [`config`](#-php--config--config) -##### `file` +##### `file` Data type: `Stdlib::Absolutepath` -##### `config` +##### `config` Data type: `Hash` -### `php::config::setting` +### `php::config::setting` Configure php.ini settings @@ -2030,31 +2034,31 @@ Configure php.ini settings The following parameters are available in the `php::config::setting` defined type: -* [`key`](#key) -* [`file`](#file) -* [`value`](#value) +* [`key`](#-php--config--setting--key) +* [`file`](#-php--config--setting--file) +* [`value`](#-php--config--setting--value) -##### `key` +##### `key` Data type: `String[1]` -##### `file` +##### `file` Data type: `Stdlib::Absolutepath` -##### `value` +##### `value` Data type: `Optional[Variant[Integer, String]]` -Default value: ``undef`` +Default value: `undef` -### `php::extension` +### `php::extension` Install a PHP extension package @@ -2132,25 +2136,25 @@ Install a PHP extension package The following parameters are available in the `php::extension` defined type: -* [`ensure`](#ensure) -* [`provider`](#provider) -* [`source`](#source) -* [`so_name`](#so_name) -* [`ini_prefix`](#ini_prefix) -* [`php_api_version`](#php_api_version) -* [`package_prefix`](#package_prefix) -* [`package_name`](#package_name) -* [`zend`](#zend) -* [`settings`](#settings) -* [`multifile_settings`](#multifile_settings) -* [`sapi`](#sapi) -* [`settings_prefix`](#settings_prefix) -* [`responsefile`](#responsefile) -* [`header_packages`](#header_packages) -* [`compiler_packages`](#compiler_packages) -* [`install_options`](#install_options) - -##### `ensure` +* [`ensure`](#-php--extension--ensure) +* [`provider`](#-php--extension--provider) +* [`source`](#-php--extension--source) +* [`so_name`](#-php--extension--so_name) +* [`ini_prefix`](#-php--extension--ini_prefix) +* [`php_api_version`](#-php--extension--php_api_version) +* [`package_prefix`](#-php--extension--package_prefix) +* [`package_name`](#-php--extension--package_name) +* [`zend`](#-php--extension--zend) +* [`settings`](#-php--extension--settings) +* [`multifile_settings`](#-php--extension--multifile_settings) +* [`sapi`](#-php--extension--sapi) +* [`settings_prefix`](#-php--extension--settings_prefix) +* [`responsefile`](#-php--extension--responsefile) +* [`header_packages`](#-php--extension--header_packages) +* [`compiler_packages`](#-php--extension--compiler_packages) +* [`install_options`](#-php--extension--install_options) + +##### `ensure` Data type: `String` @@ -2158,47 +2162,47 @@ Data type: `String` Default value: `$php::ensure` -##### `provider` +##### `provider` Data type: `Optional[Php::Provider]` -Default value: ``undef`` +Default value: `undef` -##### `source` +##### `source` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `so_name` +##### `so_name` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `ini_prefix` +##### `ini_prefix` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `php_api_version` +##### `php_api_version` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `package_prefix` +##### `package_prefix` Data type: `String` @@ -2206,23 +2210,23 @@ Data type: `String` Default value: `$php::package_prefix` -##### `package_name` +##### `package_name` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `zend` +##### `zend` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `settings` +##### `settings` Data type: `Variant[Hash, Hash[String, Hash]]` @@ -2230,15 +2234,15 @@ Data type: `Variant[Hash, Hash[String, Hash]]` Default value: `{}` -##### `multifile_settings` +##### `multifile_settings` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `sapi` +##### `sapi` Data type: `Php::Sapi` @@ -2246,23 +2250,23 @@ Data type: `Php::Sapi` Default value: `'ALL'` -##### `settings_prefix` +##### `settings_prefix` Data type: `Variant[Boolean, String]` -Default value: ``false`` +Default value: `false` -##### `responsefile` +##### `responsefile` Data type: `Optional[Stdlib::AbsolutePath]` -Default value: ``undef`` +Default value: `undef` -##### `header_packages` +##### `header_packages` Data type: `Variant[String, Array[String]]` @@ -2270,7 +2274,7 @@ Data type: `Variant[String, Array[String]]` Default value: `[]` -##### `compiler_packages` +##### `compiler_packages` Data type: `Variant[String, Array[String]]` @@ -2278,15 +2282,15 @@ Data type: `Variant[String, Array[String]]` Default value: `$php::params::compiler_packages` -##### `install_options` +##### `install_options` Data type: `Php::InstallOptions` -Default value: ``undef`` +Default value: `undef` -### `php::extension::config` +### `php::extension::config` Configure a PHP extension package @@ -2338,17 +2342,17 @@ Configure a PHP extension package The following parameters are available in the `php::extension::config` defined type: -* [`ensure`](#ensure) -* [`provider`](#provider) -* [`so_name`](#so_name) -* [`ini_prefix`](#ini_prefix) -* [`php_api_version`](#php_api_version) -* [`zend`](#zend) -* [`settings`](#settings) -* [`settings_prefix`](#settings_prefix) -* [`sapi`](#sapi) +* [`ensure`](#-php--extension--config--ensure) +* [`provider`](#-php--extension--config--provider) +* [`so_name`](#-php--extension--config--so_name) +* [`ini_prefix`](#-php--extension--config--ini_prefix) +* [`php_api_version`](#-php--extension--config--php_api_version) +* [`zend`](#-php--extension--config--zend) +* [`settings`](#-php--extension--config--settings) +* [`settings_prefix`](#-php--extension--config--settings_prefix) +* [`sapi`](#-php--extension--config--sapi) -##### `ensure` +##### `ensure` Data type: `String` @@ -2356,15 +2360,15 @@ Data type: `String` Default value: `'installed'` -##### `provider` +##### `provider` Data type: `Optional[Php::Provider]` -Default value: ``undef`` +Default value: `undef` -##### `so_name` +##### `so_name` Data type: `Optional[String]` @@ -2372,31 +2376,31 @@ Data type: `Optional[String]` Default value: `downcase($name)` -##### `ini_prefix` +##### `ini_prefix` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `php_api_version` +##### `php_api_version` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `zend` +##### `zend` Data type: `Boolean` -Default value: ``false`` +Default value: `false` -##### `settings` +##### `settings` Data type: `Hash` @@ -2404,15 +2408,15 @@ Data type: `Hash` Default value: `{}` -##### `settings_prefix` +##### `settings_prefix` Data type: `Variant[Boolean, String]` -Default value: ``false`` +Default value: `false` -##### `sapi` +##### `sapi` Data type: `Php::Sapi` @@ -2420,7 +2424,7 @@ Data type: `Php::Sapi` Default value: `'ALL'` -### `php::extension::install` +### `php::extension::install` Install a PHP extension package @@ -2465,17 +2469,17 @@ Install a PHP extension package The following parameters are available in the `php::extension::install` defined type: -* [`ensure`](#ensure) -* [`provider`](#provider) -* [`source`](#source) -* [`package_prefix`](#package_prefix) -* [`package_name`](#package_name) -* [`responsefile`](#responsefile) -* [`header_packages`](#header_packages) -* [`compiler_packages`](#compiler_packages) -* [`install_options`](#install_options) +* [`ensure`](#-php--extension--install--ensure) +* [`provider`](#-php--extension--install--provider) +* [`source`](#-php--extension--install--source) +* [`package_prefix`](#-php--extension--install--package_prefix) +* [`package_name`](#-php--extension--install--package_name) +* [`responsefile`](#-php--extension--install--responsefile) +* [`header_packages`](#-php--extension--install--header_packages) +* [`compiler_packages`](#-php--extension--install--compiler_packages) +* [`install_options`](#-php--extension--install--install_options) -##### `ensure` +##### `ensure` Data type: `String` @@ -2483,23 +2487,23 @@ Data type: `String` Default value: `'installed'` -##### `provider` +##### `provider` Data type: `Optional[Php::Provider]` -Default value: ``undef`` +Default value: `undef` -##### `source` +##### `source` Data type: `Optional[String]` -Default value: ``undef`` +Default value: `undef` -##### `package_prefix` +##### `package_prefix` Data type: `String` @@ -2507,23 +2511,23 @@ Data type: `String` Default value: `$php::package_prefix` -##### `package_name` +##### `package_name` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `responsefile` +##### `responsefile` Data type: `Optional[Stdlib::AbsolutePath]` -Default value: ``undef`` +Default value: `undef` -##### `header_packages` +##### `header_packages` Data type: `Variant[String, Array[String]]` @@ -2531,7 +2535,7 @@ Data type: `Variant[String, Array[String]]` Default value: `[]` -##### `compiler_packages` +##### `compiler_packages` Data type: `Variant[String, Array[String]]` @@ -2539,15 +2543,15 @@ Data type: `Variant[String, Array[String]]` Default value: `$php::params::compiler_packages` -##### `install_options` +##### `install_options` Data type: `Php::InstallOptions` -Default value: ``undef`` +Default value: `undef` -### `php::fpm::pool` +### `php::fpm::pool` Configure fpm pools @@ -2675,52 +2679,52 @@ documented here: http://php.net/manual/en/install.fpm.configuration.php. The following parameters are available in the `php::fpm::pool` defined type: -* [`ensure`](#ensure) -* [`listen`](#listen) -* [`listen_backlog`](#listen_backlog) -* [`listen_allowed_clients`](#listen_allowed_clients) -* [`listen_owner`](#listen_owner) -* [`listen_group`](#listen_group) -* [`listen_mode`](#listen_mode) -* [`user`](#user) -* [`group`](#group) -* [`apparmor_hat`](#apparmor_hat) -* [`pm`](#pm) -* [`pm_max_children`](#pm_max_children) -* [`pm_start_servers`](#pm_start_servers) -* [`pm_min_spare_servers`](#pm_min_spare_servers) -* [`pm_max_spare_servers`](#pm_max_spare_servers) -* [`pm_max_requests`](#pm_max_requests) -* [`pm_process_idle_timeout`](#pm_process_idle_timeout) -* [`pm_status_path`](#pm_status_path) -* [`ping_path`](#ping_path) -* [`ping_response`](#ping_response) -* [`access_log`](#access_log) -* [`access_log_format`](#access_log_format) -* [`request_terminate_timeout`](#request_terminate_timeout) -* [`request_slowlog_timeout`](#request_slowlog_timeout) -* [`security_limit_extensions`](#security_limit_extensions) -* [`slowlog`](#slowlog) -* [`template`](#template) -* [`rlimit_files`](#rlimit_files) -* [`rlimit_core`](#rlimit_core) -* [`chroot`](#chroot) -* [`chdir`](#chdir) -* [`catch_workers_output`](#catch_workers_output) -* [`include`](#include) -* [`env`](#env) -* [`env_value`](#env_value) -* [`clear_env`](#clear_env) -* [`options`](#options) -* [`php_value`](#php_value) -* [`php_flag`](#php_flag) -* [`php_admin_value`](#php_admin_value) -* [`php_admin_flag`](#php_admin_flag) -* [`php_directives`](#php_directives) -* [`root_group`](#root_group) -* [`base_dir`](#base_dir) - -##### `ensure` +* [`ensure`](#-php--fpm--pool--ensure) +* [`listen`](#-php--fpm--pool--listen) +* [`listen_backlog`](#-php--fpm--pool--listen_backlog) +* [`listen_allowed_clients`](#-php--fpm--pool--listen_allowed_clients) +* [`listen_owner`](#-php--fpm--pool--listen_owner) +* [`listen_group`](#-php--fpm--pool--listen_group) +* [`listen_mode`](#-php--fpm--pool--listen_mode) +* [`user`](#-php--fpm--pool--user) +* [`group`](#-php--fpm--pool--group) +* [`apparmor_hat`](#-php--fpm--pool--apparmor_hat) +* [`pm`](#-php--fpm--pool--pm) +* [`pm_max_children`](#-php--fpm--pool--pm_max_children) +* [`pm_start_servers`](#-php--fpm--pool--pm_start_servers) +* [`pm_min_spare_servers`](#-php--fpm--pool--pm_min_spare_servers) +* [`pm_max_spare_servers`](#-php--fpm--pool--pm_max_spare_servers) +* [`pm_max_requests`](#-php--fpm--pool--pm_max_requests) +* [`pm_process_idle_timeout`](#-php--fpm--pool--pm_process_idle_timeout) +* [`pm_status_path`](#-php--fpm--pool--pm_status_path) +* [`ping_path`](#-php--fpm--pool--ping_path) +* [`ping_response`](#-php--fpm--pool--ping_response) +* [`access_log`](#-php--fpm--pool--access_log) +* [`access_log_format`](#-php--fpm--pool--access_log_format) +* [`request_terminate_timeout`](#-php--fpm--pool--request_terminate_timeout) +* [`request_slowlog_timeout`](#-php--fpm--pool--request_slowlog_timeout) +* [`security_limit_extensions`](#-php--fpm--pool--security_limit_extensions) +* [`slowlog`](#-php--fpm--pool--slowlog) +* [`template`](#-php--fpm--pool--template) +* [`rlimit_files`](#-php--fpm--pool--rlimit_files) +* [`rlimit_core`](#-php--fpm--pool--rlimit_core) +* [`chroot`](#-php--fpm--pool--chroot) +* [`chdir`](#-php--fpm--pool--chdir) +* [`catch_workers_output`](#-php--fpm--pool--catch_workers_output) +* [`include`](#-php--fpm--pool--include) +* [`env`](#-php--fpm--pool--env) +* [`env_value`](#-php--fpm--pool--env_value) +* [`clear_env`](#-php--fpm--pool--clear_env) +* [`options`](#-php--fpm--pool--options) +* [`php_value`](#-php--fpm--pool--php_value) +* [`php_flag`](#-php--fpm--pool--php_flag) +* [`php_admin_value`](#-php--fpm--pool--php_admin_value) +* [`php_admin_flag`](#-php--fpm--pool--php_admin_flag) +* [`php_directives`](#-php--fpm--pool--php_directives) +* [`root_group`](#-php--fpm--pool--root_group) +* [`base_dir`](#-php--fpm--pool--base_dir) + +##### `ensure` Data type: `Enum['present', 'absent']` @@ -2728,7 +2732,7 @@ Data type: `Enum['present', 'absent']` Default value: `'present'` -##### `listen` +##### `listen` Data type: `String[1]` @@ -2736,47 +2740,47 @@ Data type: `String[1]` Default value: `'127.0.0.1:9000'` -##### `listen_backlog` +##### `listen_backlog` Data type: `Integer[-1]` -Default value: `-` +Default value: `-1` -##### `listen_allowed_clients` +##### `listen_allowed_clients` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `listen_owner` +##### `listen_owner` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `listen_group` +##### `listen_group` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `listen_mode` +##### `listen_mode` Data type: `Optional[Stdlib::Filemode]` -Default value: ``undef`` +Default value: `undef` -##### `user` +##### `user` Data type: `String[1]` @@ -2784,7 +2788,7 @@ Data type: `String[1]` Default value: `$php::fpm::config::user` -##### `group` +##### `group` Data type: `String[1]` @@ -2792,15 +2796,15 @@ Data type: `String[1]` Default value: `$php::fpm::config::group` -##### `apparmor_hat` +##### `apparmor_hat` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `pm` +##### `pm` Data type: `String[1]` @@ -2808,7 +2812,7 @@ Data type: `String[1]` Default value: `'dynamic'` -##### `pm_max_children` +##### `pm_max_children` Data type: `Integer[1]` @@ -2816,7 +2820,7 @@ Data type: `Integer[1]` Default value: `50` -##### `pm_start_servers` +##### `pm_start_servers` Data type: `Integer[0]` @@ -2824,7 +2828,7 @@ Data type: `Integer[0]` Default value: `5` -##### `pm_min_spare_servers` +##### `pm_min_spare_servers` Data type: `Integer[0]` @@ -2832,7 +2836,7 @@ Data type: `Integer[0]` Default value: `5` -##### `pm_max_spare_servers` +##### `pm_max_spare_servers` Data type: `Integer[0]` @@ -2840,7 +2844,7 @@ Data type: `Integer[0]` Default value: `35` -##### `pm_max_requests` +##### `pm_max_requests` Data type: `Integer[0]` @@ -2848,7 +2852,7 @@ Data type: `Integer[0]` Default value: `0` -##### `pm_process_idle_timeout` +##### `pm_process_idle_timeout` Data type: `Php::Duration` @@ -2856,23 +2860,23 @@ Data type: `Php::Duration` Default value: `'10s'` -##### `pm_status_path` +##### `pm_status_path` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `ping_path` +##### `ping_path` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `ping_response` +##### `ping_response` Data type: `String[1]` @@ -2880,15 +2884,15 @@ Data type: `String[1]` Default value: `'pong'` -##### `access_log` +##### `access_log` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `access_log_format` +##### `access_log_format` Data type: `String[1]` @@ -2896,7 +2900,7 @@ Data type: `String[1]` Default value: `'"%R - %u %t \"%m %r\" %s"'` -##### `request_terminate_timeout` +##### `request_terminate_timeout` Data type: `Php::Duration` @@ -2904,7 +2908,7 @@ Data type: `Php::Duration` Default value: `0` -##### `request_slowlog_timeout` +##### `request_slowlog_timeout` Data type: `Php::Duration` @@ -2912,7 +2916,7 @@ Data type: `Php::Duration` Default value: `0` -##### `security_limit_extensions` +##### `security_limit_extensions` Data type: `Array[String[1]]` @@ -2920,7 +2924,7 @@ Data type: `Array[String[1]]` Default value: `[]` -##### `slowlog` +##### `slowlog` Data type: `Stdlib::Absolutepath` @@ -2928,7 +2932,7 @@ Data type: `Stdlib::Absolutepath` Default value: `"/var/log/php-fpm/${name}-slow.log"` -##### `template` +##### `template` Data type: `String[1]` @@ -2936,39 +2940,39 @@ Data type: `String[1]` Default value: `'php/fpm/pool.conf.erb'` -##### `rlimit_files` +##### `rlimit_files` Data type: `Optional[Integer]` -Default value: ``undef`` +Default value: `undef` -##### `rlimit_core` +##### `rlimit_core` Data type: `Optional[Integer]` -Default value: ``undef`` +Default value: `undef` -##### `chroot` +##### `chroot` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `chdir` +##### `chdir` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` -##### `catch_workers_output` +##### `catch_workers_output` Data type: `Enum['yes', 'no']` @@ -2976,15 +2980,15 @@ Data type: `Enum['yes', 'no']` Default value: `'no'` -##### `include` +##### `include` Data type: `Optional[String[1]]` -Default value: ``undef`` +Default value: `undef` -##### `env` +##### `env` Data type: `Array[String[1]]` @@ -2992,7 +2996,7 @@ Data type: `Array[String[1]]` Default value: `[]` -##### `env_value` +##### `env_value` Data type: `Hash` @@ -3000,15 +3004,15 @@ Data type: `Hash` Default value: `{}` -##### `clear_env` +##### `clear_env` Data type: `Boolean` -Default value: ``true`` +Default value: `true` -##### `options` +##### `options` Data type: `Hash` @@ -3016,7 +3020,7 @@ Data type: `Hash` Default value: `{}` -##### `php_value` +##### `php_value` Data type: `Hash` @@ -3024,7 +3028,7 @@ Data type: `Hash` Default value: `{}` -##### `php_flag` +##### `php_flag` Data type: `Hash` @@ -3032,7 +3036,7 @@ Data type: `Hash` Default value: `{}` -##### `php_admin_value` +##### `php_admin_value` Data type: `Hash` @@ -3040,7 +3044,7 @@ Data type: `Hash` Default value: `{}` -##### `php_admin_flag` +##### `php_admin_flag` Data type: `Hash` @@ -3048,7 +3052,7 @@ Data type: `Hash` Default value: `{}` -##### `php_directives` +##### `php_directives` Data type: `Array[String[1]]` @@ -3056,7 +3060,7 @@ Data type: `Array[String[1]]` Default value: `[]` -##### `root_group` +##### `root_group` Data type: `String[1]` @@ -3064,13 +3068,13 @@ Data type: `String[1]` Default value: `$php::params::root_group` -##### `base_dir` +##### `base_dir` Data type: `Optional[Stdlib::Absolutepath]` -Default value: ``undef`` +Default value: `undef` ## Functions @@ -3174,27 +3178,19 @@ Returns: `Any` ## Data types -### `Php::ComposerChannel` +### `Php::ComposerChannel` The Php::ComposerChannel data type. -Alias of - -```puppet -Enum['stable', 'preview', 'snapshot', '1', '2'] -``` +Alias of `Enum['stable', 'preview', 'snapshot', '1', '2']` -### `Php::Duration` +### `Php::Duration` A duration in seconds are with an unit -Alias of - -```puppet -Variant[Integer[0], Pattern[/^\d+[smhd]?$/]] -``` +Alias of `Variant[Integer[0], Pattern[/^\d+[smhd]?$/]]` -### `Php::InstallOptions` +### `Php::InstallOptions` The Php::InstallOptions data type. @@ -3209,23 +3205,15 @@ Optional[Array[ ]] ``` -### `Php::Provider` +### `Php::Provider` The Php::Provider data type. -Alias of - -```puppet -Enum['none', 'pecl', 'pear', 'dpkg', 'apt', 'yum', 'rpm', 'dnf', 'up2date', 'zypper', 'rug', 'freebsd', 'pkgng', 'ports', 'portupgrade'] -``` +Alias of `Enum['none', 'pecl', 'pear', 'dpkg', 'apt', 'yum', 'rpm', 'dnf', 'up2date', 'zypper', 'rug', 'freebsd', 'pkgng', 'ports', 'portupgrade']` -### `Php::Sapi` +### `Php::Sapi` The Php::Sapi data type. -Alias of - -```puppet -Enum['ALL', 'cli', 'fpm', 'apache2'] -``` +Alias of `Enum['ALL', 'cli', 'fpm', 'apache2']`