Defined Type: php::extension::config

Defined in:
manifests/extension/config.pp

Overview

Configure a PHP extension package

Parameters

ensure

The ensure of the package to install Could be “latest”, “installed” or a pinned version

provider

The provider used to install the package Could be “pecl”, “apt”, “dpkg” or any other OS package provider If set to “none”, no package will be installed

so_name

The DSO name of the package (e.g. opcache for zendopcache)

ini_prefix

An optional filename prefix for the settings file of the extension

php_api_version

This parameter is used to build the full path to the extension directory for zend_extension in PHP < 5.5 (e.g. 20100525)

header_packages

System packages dependencies to install for extensions (e.g. for memcached libmemcached-dev on Debian)

compiler_packages

System packages dependencies to install for compiling extensions (e.g. build-essential on Debian)

zend

Boolean parameter, whether to load extension as zend_extension. Defaults to false.

settings

Nested hash of global config parameters for php.ini

settings_prefix

Boolean/String parameter, whether to prefix all setting keys with the extension name or specified name. Defaults to false.

sapi

String parameter, whether to specify ALL sapi or a specific sapi. Defaults to ALL.

Parameters:

  • ensure (String) (defaults to: 'installed')
  • provider (Optional[Php::Provider]) (defaults to: undef)
  • so_name (Optional[String]) (defaults to: downcase($name))
  • ini_prefix (Optional[String]) (defaults to: undef)
  • php_api_version (Optional[String]) (defaults to: undef)
  • zend (Boolean) (defaults to: false)
  • settings (Hash) (defaults to: {})
  • settings_prefix (Variant[Boolean, String]) (defaults to: false)
  • sapi (Php::Sapi) (defaults to: 'ALL') 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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
 
# File 'manifests/extension/config.pp', line 47

define php::extension::config (
  String                   $ensure          = 'installed',
  Optional[Php::Provider]  $provider        = undef,
  Optional[String]         $so_name         = downcase($name),
  Optional[String]         $ini_prefix      = undef,
  Optional[String]         $php_api_version = undef,
  Boolean                  $zend            = false,
  Hash                     $settings        = {},
  Variant[Boolean, String] $settings_prefix = false,
  Php::Sapi                $sapi            = 'ALL',
) {
  if ! defined(Class['php']) {
    warning('php::extension::config is private')
  }

  if $zend == true {
    $extension_key = 'zend_extension'
    $module_path = $php_api_version? {
      undef   => undef,
      default => "/usr/lib/php5/${php_api_version}/",
    }
  } else {
    $extension_key = 'extension'
    $module_path = undef
  }

  $ini_name = downcase($so_name)

  # Ensure "<extension>." prefix is present in setting keys if requested
  $full_settings = $settings_prefix ? {
    true   => ensure_prefix($settings, "${so_name}."),
    false  => $settings,
    String => ensure_prefix($settings, "${settings_prefix}."),
  }

  if $provider != 'pear' {
    $final_settings = deep_merge({ "${extension_key}" => "${module_path}${so_name}.so" }, $full_settings)
  } else {
    $final_settings = $full_settings
  }

  if $facts['os']['name'] == 'Ubuntu' and $zend != true and $name == 'mysql' {
    # Do not manage the .ini file if it's mysql.  PHP 7.0+ do not have
    # mysql.so.  If mysql.ini exists and version is 7.0+, then remove it.
    $real_ensure = 'absent'
  } else {
    $real_ensure = $ensure
  }

  $config_root_ini = pick_default($php::config_root_ini, $php::params::config_root_ini)
  if $real_ensure != 'absent' {
    php::config { $title:
      file   => "${config_root_ini}/${ini_prefix}${ini_name}.ini",
      config => $final_settings,
    }

    # Ubuntu/Debian systems use the mods-available folder. We need to enable
    # settings files ourselves with php5enmod command.
    $ext_tool_enable   = pick_default($php::ext_tool_enable, $php::params::ext_tool_enable)
    $ext_tool_query    = pick_default($php::ext_tool_query, $php::params::ext_tool_query)
    $ext_tool_enabled  = pick_default($php::ext_tool_enabled, $php::params::ext_tool_enabled)

    if $facts['os']['family'] == 'Debian' and $ext_tool_enabled {
      $cmd = "${ext_tool_enable} -s ${sapi} ${so_name}"
      $execname = "ext_tool_enable_${so_name}"

      $_sapi = $sapi ? {
        'ALL' => 'cli',
        default => $sapi,
      }
      if $final_settings[$extension_key] {
        exec { $execname:
          command => $cmd,
          onlyif  => "${ext_tool_query} -s ${_sapi} -m ${so_name} | /bin/grep 'No module matches ${so_name}'",
          require => ::Php::Config[$title],
        }

        if $php::fpm {
          Package[$php::fpm::package] ~> Exec[$execname]
        }
      }
    }
  } else {
    file { "${config_root_ini}/${ini_prefix}${ini_name}.ini":
      ensure => 'absent',
    }
  }
}