From 066cd3da8966e6789eb4504f89c147ff4c3ff0c7 Mon Sep 17 00:00:00 2001
From: Tyler Antonio <contact@tanton.io>
Date: Wed, 8 Apr 2015 10:03:15 -0600
Subject: [PATCH] Updated metadata.sources comments to include information
 about the PDO metadata store

---
 config-templates/config.php | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/config-templates/config.php b/config-templates/config.php
index 3104e4672..418504084 100644
--- a/config-templates/config.php
+++ b/config-templates/config.php
@@ -571,6 +571,15 @@ $config = array(
      * - 'cachelength': Maximum time metadata cah be cached, in seconds. Default to 24
      *                  hours (86400 seconds). Optional.
      *
+     * PDO metadata handler:
+     * This metadata handler looks up for the metadata of an entity stored in a database.
+     * The PDO metadata handler defines the following options:
+     * - 'type': This is always 'pdo'.
+     * - 'dsn': The database connection string. Mandatory.
+     * - 'username': Database username
+     * - 'cachedir': Database password
+     * - 'usePersistentConnection': Enable/Disable persistent database connection. Default is false.
+     *
      *
      * Examples:
      *
@@ -593,6 +602,11 @@ $config = array(
      *     array('type' => 'mdx', server => 'http://mdx.server.com:8080', 'cachedir' => '/var/simplesamlphp/mdx-cache', 'cachelength' => 86400)
      *     ),
      *
+     * This example defines an pdo source.
+     * 'metadata.sources' => array(
+     *     array('type' => 'pdo', server => 'mysql:host=localhost;dbname=saml', 'username' => 'simplesamlphp', 'password' => 'SuperSecretPassword')
+     *     ),
+     *
      * Default:
      * 'metadata.sources' => array(
      *     array('type' => 'flatfile')
-- 
GitLab