Puppet Class: php

Inherits:
::php::params
Defined in:
manifests/init.pp

Overview

Base class with global configuration parameters that pulls in all enabled components.

Parameters

ensure

Specify which version of PHP packages to install, defaults to ‘present’. Please note that ‘absent’ to remove packages is not supported!

manage_repos

Include repository (dotdeb, ppa, etc.) to install recent PHP from

fpm

Install and configure php-fpm

fpm_service_enable

Enable/disable FPM service

fpm_service_ensure

Ensure FPM service is either ‘running’ or ‘stopped’

fpm_service_name

This is the name of the php-fpm service. It defaults to reasonable OS defaults but can be different in case of using php7.0/other OS/custom fpm service

fpm_service_provider

This is the name of the service provider, in case there is a non OS default service provider used to start FPM. Defaults to ‘undef’, pick system defaults.

dev

Install php header files, needed to install pecl modules

composer

Install and auto-update composer

pear

Install PEAR

phpunit

Install phpunit

extensions

Install PHP extensions, this is overwritten by hiera hash ‘php::extensions`

package_prefix

This is the prefix for constructing names of php packages. This defaults to a sensible default depending on your operating system, like ‘php-’ or ‘php5-’.

config_root_ini

This is the path to the config .ini files of the extensions. This defaults to a sensible default depending on your operating system, like ‘/etc/php5/mods-available’ or ‘/etc/php5/conf.d’.

ext_tool_enable

Absolute path to php tool for enabling extensions in debian/ubuntu systems. This defaults to ‘/usr/sbin/php5enmod’.

ext_tool_query

Absolute path to php tool for querying information about extensions in debian/ubuntu systems. This defaults to ‘/usr/sbin/php5query’.

ext_tool_enabled

Enable or disable the use of php tools on debian based systems debian/ubuntu systems. This defaults to ‘true’.

log_owner

The php-fpm log owner

log_group

The group owning php-fpm logs

embedded

Enable embedded SAPI

pear_ensure

The package ensure of PHP pear to install and run pear auto_discover

settings

Parameters:

  • ensure (Any) (defaults to: $::php::params::ensure)
  • manage_repos (Any) (defaults to: $::php::params::manage_repos)
  • fpm (Any) (defaults to: true)
  • fpm_service_enable (Any) (defaults to: $::php::params::fpm_service_enable)
  • fpm_service_ensure (Any) (defaults to: $::php::params::fpm_service_ensure)
  • fpm_service_name (Any) (defaults to: $::php::params::fpm_service_name)
  • fpm_service_provider (Any) (defaults to: undef)
  • embedded (Any) (defaults to: false)
  • dev (Any) (defaults to: true)
  • composer (Any) (defaults to: true)
  • pear (Any) (defaults to: true)
  • pear_ensure (Any) (defaults to: $::php::params::pear_ensure)
  • phpunit (Any) (defaults to: false)
  • extensions (Any) (defaults to: {})
  • settings (Any) (defaults to: {})
  • package_prefix (Any) (defaults to: $::php::params::package_prefix)
  • config_root_ini (Any) (defaults to: $::php::params::config_root_ini)
  • ext_tool_enable (Any) (defaults to: $::php::params::ext_tool_enable)
  • ext_tool_query (Any) (defaults to: $::php::params::ext_tool_query)
  • ext_tool_enabled (Any) (defaults to: $::php::params::ext_tool_enabled)
  • log_owner (Any) (defaults to: $::php::params::fpm_user)
  • log_group (Any) (defaults to: $::php::params::fpm_group) 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'manifests/init.pp', line 82

class php (
  $ensure               = $::php::params::ensure,
  $manage_repos         = $::php::params::manage_repos,
  $fpm                  = true,
  $fpm_service_enable   = $::php::params::fpm_service_enable,
  $fpm_service_ensure   = $::php::params::fpm_service_ensure,
  $fpm_service_name     = $::php::params::fpm_service_name,
  $fpm_service_provider = undef,
  $embedded             = false,
  $dev                  = true,
  $composer             = true,
  $pear                 = true,
  $pear_ensure          = $::php::params::pear_ensure,
  $phpunit              = false,
  $extensions           = {},
  $settings             = {},
  $package_prefix       = $::php::params::package_prefix,
  $config_root_ini      = $::php::params::config_root_ini,
  $ext_tool_enable      = $::php::params::ext_tool_enable,
  $ext_tool_query       = $::php::params::ext_tool_query,
  $ext_tool_enabled     = $::php::params::ext_tool_enabled,
  $log_owner            = $::php::params::fpm_user,
  $log_group            = $::php::params::fpm_group,
) inherits ::php::params {

  validate_string($ensure)
  validate_bool($manage_repos)
  validate_bool($fpm)
  validate_bool($embedded)
  validate_bool($dev)
  validate_bool($composer)
  validate_bool($pear)
  validate_bool($ext_tool_enabled)
  validate_string($pear_ensure)
  validate_bool($phpunit)
  validate_hash($extensions)
  validate_hash($settings)
  validate_string($log_owner)
  validate_string($log_group)

  if $config_root_ini != undef {
    validate_absolute_path($config_root_ini)
  }
  if $ext_tool_enable != undef {
    validate_absolute_path($ext_tool_enable)
  }
  if $ext_tool_query != undef {
    validate_absolute_path($ext_tool_query)
  }

  # Deep merge global php settings
  $real_settings = deep_merge($settings, hiera_hash('php::settings', {}))

  # Deep merge global php extensions
  $real_extensions = deep_merge($extensions, hiera_hash('php::extensions', {}))

  if $manage_repos {
    class { '::php::repo': } ->
    Anchor['php::begin']
  }

  anchor { 'php::begin': } ->
    class { '::php::packages': } ->
    class { '::php::cli':
      settings => $real_settings,
    } ->
  anchor { 'php::end': }

  # Configure global PHP settings in php.ini
  if $::osfamily != 'Debian' {
    Class['php::packages'] ->
    class {'::php::global':
      settings => $real_settings,
    } ->
    Anchor['php::end']
  }

  if $fpm {
    Anchor['php::begin'] ->
      class { '::php::fpm':
        service_enable   => $fpm_service_enable,
        service_ensure   => $fpm_service_ensure,
        service_name     => $fpm_service_name,
        service_provider => $fpm_service_provider,
        settings         => $real_settings,
        log_owner        => $log_owner,
        log_group        => $log_group,
      } ->
    Anchor['php::end']
  }
  if $embedded {
    if $::osfamily == 'RedHat' and $fpm {
      # Both fpm and embeded SAPIs are using same php.ini
      fail('Enabling both cli and embedded sapis is not currently supported')
    }

    Anchor['php::begin'] ->
      class { '::php::embedded':
        settings => $real_settings,
      } ->
    Anchor['php::end']
  }
  if $dev {
    Anchor['php::begin'] ->
      class { '::php::dev': } ->
    Anchor['php::end']
  }
  if $composer {
    Anchor['php::begin'] ->
      class { '::php::composer': } ->
    Anchor['php::end']
  }
  if $pear {
    Anchor['php::begin'] ->
      class { '::php::pear':
        ensure => $pear_ensure,
      } ->
    Anchor['php::end']
  }
  if $phpunit {
    Anchor['php::begin'] ->
      class { '::php::phpunit': } ->
    Anchor['php::end']
  }

  create_resources('::php::extension', $real_extensions, {
    require => Class['::php::cli'],
    before  => Anchor['php::end']
  })

  # On FreeBSD purge the system-wide extensions.ini. It is going
  # to be replaced with per-module configuration files.
  if $::osfamily == 'FreeBSD' {
    # Purge the system-wide extensions.ini
    file { '/usr/local/etc/php/extensions.ini':
      ensure  => absent,
      require => Class['::php::packages'],
    }
  }
}