From: Michael M Slusarz <slusarz@curecanti.org>
Date: Tue, 26 Jan 2010 22:38:54 +0000 (-0700)
Subject: Parameter documentation
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=ce64aa00d9d1e9f5b7183af9bdde35adbe38f4b4;p=horde.git

Parameter documentation
---

diff --git a/framework/Text_Filter/lib/Horde/Text/Filter/Xss.php b/framework/Text_Filter/lib/Horde/Text/Filter/Xss.php
index 7822f37db..ff7d95780 100644
--- a/framework/Text_Filter/lib/Horde/Text/Filter/Xss.php
+++ b/framework/Text_Filter/lib/Horde/Text/Filter/Xss.php
@@ -6,6 +6,20 @@
  * people *KNOW* HTML is a security hole, clean up what we can, and leave it
  * at that.
  *
+ * Filter parameters:
+ * ------------------
+ * <pre>
+ * 'body_only' - (boolean) Only scan within the HTML body tags?
+ *               DEFAULT: true
+ * 'replace' - (string) The string to replace filtered tags with.
+ *             DEFAULT: 'XSSCleaned'
+ * 'strip_styles' - (boolean) Strip style tags?
+ *                  DEFAULT: true
+ * 'strip_style_attributes' - (boolean) Strip style attributes in all HTML
+ *                            tags?
+ *                            DEFAULT: true
+ * </pre>
+ *
  * Copyright 2004-2010 The Horde Project (http://www.horde.org/)
  *
  * See the enclosed file COPYING for license information (LGPL). If you