Added doc blox and assert_private.

refs  jippi#148

Author: schkovich

manifests/extension.pp

@@ -23,6 +23,15 @@
 # [*source*]
 #   The path to the deb package to install
 #
+# [*sapis*]
+#   An array of PHP SAPIs for which extension should be installed. This
+#   parameters applies to PECL extensions only.
+#   @see http://php.net/manual/en/function.php-sapi-name.php
+#
+# [*priority*]
+#   Module loading priority. Default is 20. .
+#   @see http://www.brandonchecketts.com/archives/getting-ubuntu-14-04-php5enmod-to-understand-module-priority
+#
 # === Variables
 #
 # [*php_ensure*]
@@ -49,6 +58,14 @@
 #   source   => "/path/to/libgearman8_1.1.7-1_amd64.deb";
 # }
 #
+# php::extension { 'gearman':
+#   ensure   => "latest",
+#   package  => "gearman",
+#   provider => "pecl",
+#   sapis    => ['cli', 'fpm'],
+#   priority_=> 30
+# }
+#
 # === Authors
 #
 # Christian "Jippi" Winther <jippignu@gmail.com>

manifests/extension/disenable.pp

@@ -1,9 +1,43 @@
+# == Type: php::extension::disenable
+#
+# Enables a PHP extension installed using PECL
+#
+# === Parameters
+#
+# [*extension*]
+#   The name of extension to enable or disenable
+#
+# [*ensure*]
+#   The ensure of the package to install
+#   Could be "latest", "installed", pinned version or "absent"
+#
+# [*priority*]
+#   Integer indicateing loading order
+#
+# === Variables
+#
+# No variables
+#
+# === Examples
+#
+#  This is a private type and should not be used on its own.
+#
+# === Author
+#
+# Goran Miskovic <schkovich@gmail.com>
+#
+# === Copyright
+#
+# Copyright 2012-2016 Christian "Jippi" Winther, unless otherwise noted.
+#
 define php::extension::disenable (
   $extension,
   $ensure = 'present',
   $priority = 20,
 ) {
 
+  assert_private("This is a privete type and should not be used on its own.")
+
   $sapi = delete($title, $extension)
 
   Exec {

manifests/sapi.pp

@@ -1,8 +1,41 @@
+# == Type: php::sapi
+#
+# Enables a PHP extension installed using PECL
+#
+# === Parameters
+#
+# [*extension*]
+#   The name of extension to enable or disenable
+#
+# [*ensure*]
+#   The ensure of the package to install
+#   Could be "latest", "installed", pinned version or "absent"
+#
+# [*priority*]
+#   Integer indicateing loading order
+#
+# === Variables
+#
+# No variables
+#
+# === Examples
+#
+#  This is a private type and should not be used on its own.
+#
+# === Author
+#
+# Goran Miskovic <schkovich@gmail.com>
+#
+# === Copyright
+#
+# Copyright 2012-2016 Christian "Jippi" Winther, unless otherwise noted.
+#
 define php::sapi (
   $extension,
   $ensure,
   $priority,
 ) {
+  assert_private("This is a privete type and should not be used on its own.")
   include php::apache::params
   include php::fpm::params
   case $title {