From 702b92067333a3dd4f1e401e4208b0a65f5d5921 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20=C3=85kre=20Solberg?= <andreas.solberg@uninett.no>
Date: Thu, 8 Jan 2009 15:30:23 +0000
Subject: [PATCH] Updating inline documentation on core proccessing filters
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@1098 44740490-163a-0410-bde0-09ae8108e29a
---
modules/core/lib/Auth/Process/AttributeAdd.php | 6 +++---
modules/core/lib/Auth/Process/AttributeLimit.php | 2 +-
modules/core/lib/Auth/Process/AttributeMap.php | 6 +++---
modules/core/lib/Auth/Process/GenerateGroups.php | 6 +++---
modules/core/lib/Auth/Process/TargetedID.php | 8 ++++----
5 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/modules/core/lib/Auth/Process/AttributeAdd.php b/modules/core/lib/Auth/Process/AttributeAdd.php
index 5d31acae0..ab98be857 100644
--- a/modules/core/lib/Auth/Process/AttributeAdd.php
+++ b/modules/core/lib/Auth/Process/AttributeAdd.php
@@ -8,21 +8,21 @@
* Example - add attribute, single value:
* <code>
* 'authproc' => array(
- * array('core:AttributeAdd', 'source' => 'myidp'),
+ * 50 => array('class' => 'core:AttributeAdd', 'source' => 'myidp'),
* ),
* </code>
*
* Examle - add attribute, multiple values:
* <code>
* 'authproc' => array(
- * array('core:AttributeAdd', 'groups' => array('users', 'members')),
+ * 50 => array('class' => 'core:AttributeAdd', 'groups' => array('users', 'members')),
* ),
* </code>
*
* Examle - replace attribute, single value:
* <code>
* 'authproc' => array(
- * array('core:AttributeAdd', '%replace', 'uid' => array('guest')),
+ * 50 => array('class' => 'core:AttributeAdd', '%replace', 'uid' => array('guest')),
* ),
* </code>
*
diff --git a/modules/core/lib/Auth/Process/AttributeLimit.php b/modules/core/lib/Auth/Process/AttributeLimit.php
index d96df12c3..23313b1fd 100644
--- a/modules/core/lib/Auth/Process/AttributeLimit.php
+++ b/modules/core/lib/Auth/Process/AttributeLimit.php
@@ -6,7 +6,7 @@
* Example - remove all attributes except 'cn' and 'mail':
* <code>
* 'authproc' => array(
- * array('core:AttributeLimit', 'cn', 'mail'),
+ * 50 => array('class' => 'core:AttributeLimit', 'cn', 'mail'),
* ),
* </code>
*
diff --git a/modules/core/lib/Auth/Process/AttributeMap.php b/modules/core/lib/Auth/Process/AttributeMap.php
index 9631b0b9e..5209f8430 100644
--- a/modules/core/lib/Auth/Process/AttributeMap.php
+++ b/modules/core/lib/Auth/Process/AttributeMap.php
@@ -6,14 +6,14 @@
* Example 1 - apply map stored in attributemap/defaultmap.php:
* <code>
* 'authproc' => array(
- * array('core:AttributeMap', 'defaultmaps'),
+ * 50 => array('class' => 'core:AttributeMap', 'defaultmaps'),
* ),
* </code>
*
* Example 2 - rename attributes 'mail' and 'uid' to 'email' and 'user':
* <code>
* 'authproc' => array(
- * array('core:AttributeMap', 'mail' => 'email', 'uid' => 'user'),
+ * 50 => array('class' => 'core:AttributeMap', 'mail' => 'email', 'uid' => 'user'),
* ),
* </code>
*
@@ -89,7 +89,7 @@ class sspmod_core_Auth_Process_AttributeMap extends SimpleSAML_Auth_ProcessingFi
* @param array &$request The current request
*/
public function process(&$request) {
- assert('is_array($request');
+ assert('is_array($request)');
assert('array_key_exists("Attributes", $request)');
$attributes =& $request['Attributes'];
diff --git a/modules/core/lib/Auth/Process/GenerateGroups.php b/modules/core/lib/Auth/Process/GenerateGroups.php
index 6e8c2e35a..b773be3f7 100644
--- a/modules/core/lib/Auth/Process/GenerateGroups.php
+++ b/modules/core/lib/Auth/Process/GenerateGroups.php
@@ -27,15 +27,15 @@
* Example - generate from default set of attributes:
* <code>
* 'authproc' => array(
- * array('core:GenerateGroups'),
+ * 50 => 'core:GenerateGroups',
* ),
* </code>
*
* Example - generate from only the eduPersonAffilitation attribute:
* <code>
* 'authproc' => array(
- * array('core:GenerateGroups', 'eduPersonAffiliation'),
- * ),
+ * 50 => array('class' => 'core:GenerateGroups', 'eduPersonAffiliation'),
+ * ),
* </code>
*
* @author Olav Morken, UNINETT AS.
diff --git a/modules/core/lib/Auth/Process/TargetedID.php b/modules/core/lib/Auth/Process/TargetedID.php
index 3044f71df..b8f8a0b33 100644
--- a/modules/core/lib/Auth/Process/TargetedID.php
+++ b/modules/core/lib/Auth/Process/TargetedID.php
@@ -14,15 +14,15 @@
* Example - generate from user ID:
* <code>
* 'authproc' => array(
- * array('core:TargetedID'),
- * ),
+ * 50 => 'core:TargetedID',
+ * )
* </code>
*
* Example - generate from mail-attribute:
* <code>
* 'authproc' => array(
- * array('core:TargetedID' , 'attribute' => 'mail'),
- * ),
+ * 50 => array('class' => 'core:TargetedID' , 'attribute' => 'mail'),
+ * ),
* </code>
*
* @author Olav Morken, UNINETT AS.
--
GitLab