Discussion:
[22823] standard/trunk/documentation/manual/en/module_specs: [ZF-8966] Zend_Filter:
thomas
2010-08-09 16:07:46 UTC
Permalink
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[framework-svn][22823] standard/trunk/documentation/manual/en/module_specs: [ZF-8966] Zend_Filter:</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd>22823</dd>
<dt>Author</dt> <dd>thomas</dd>
<dt>Date</dt> <dd>2010-08-09 09:07:39 -0700 (Mon, 09 Aug 2010)</dd>
</dl>

<h3>Log Message</h3>
<pre>[ZF-8966] Zend_Filter:

- added section for Zend_Filter_StripTags</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterSetxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Set.xml</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterStripTagsxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-StripTags.xml</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="standardtrunkdocumentationmanualenmodule_specsZend_FilterSetxml"></a>
<div class="modfile"><h4>Modified: standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Set.xml (22822 => 22823)</h4>
<pre class="diff"><span>
<span class="info">--- standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Set.xml 2010-08-09 06:56:02 UTC (rev 22822)
+++ standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Set.xml 2010-08-09 16:07:39 UTC (rev 22823) </span><span class="lines">@@ -26,17 +26,7 @@ </span><span class="cx"> &lt;xi:include href=&quot;Zend_Filter-StringToUpper.xml&quot; /&gt; </span><span class="cx"> &lt;xi:include href=&quot;Zend_Filter-StringTrim.xml&quot; /&gt; </span><span class="cx"> &lt;xi:include href=&quot;Zend_Filter-StripNewLines.xml&quot; /&gt;
</span><del>-
- &lt;sect2 id=&quot;zend.filter.set.striptags&quot;&gt;
- &lt;title&gt;StripTags&lt;/title&gt;
-
- &lt;para&gt;
- This filter returns the input string, with all &lt;acronym&gt;HTML&lt;/acronym&gt; and
- &lt;acronym&gt;PHP&lt;/acronym&gt; tags stripped from it, except those that have been explicitly
- allowed. In addition to the ability to specify which tags are allowed, developers can
- specify which attributes are allowed across all allowed tags and for specific tags only.
- &lt;/para&gt;
- &lt;/sect2&gt; </del><ins>+ &lt;xi:include href=&quot;Zend_Filter-StripTags.xml&quot; /&gt; </ins><span class="cx"> &lt;/sect1&gt;
</span><span class="cx"> &lt;!--
</span><span class="cx"> vim:se ts=4 sw=4 et:
</span></span></pre></div>
<a id="standardtrunkdocumentationmanualenmodule_specsZend_FilterStripTagsxml"></a>
<div class="addfile"><h4>Added: standard/trunk/documentation/manual/en/module_specs/Zend_Filter-StripTags.xml (0 => 22823)</h4>
<pre class="diff"><span>
<span class="info">--- standard/trunk/documentation/manual/en/module_specs/Zend_Filter-StripTags.xml (rev 0)
+++ standard/trunk/documentation/manual/en/module_specs/Zend_Filter-StripTags.xml 2010-08-09 16:07:39 UTC (rev 22823) </span><span class="lines">@@ -0,0 +1,143 @@ </span><ins>+&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
+&lt;!-- Reviewed: no --&gt;
+&lt;sect2 id=&quot;zend.filter.set.striptags&quot;&gt;
+ &lt;title&gt;StripTags&lt;/title&gt;
+
+ &lt;para&gt;
+ This filter can strip &lt;acronym&gt;XML&lt;/acronym&gt; and &lt;acronym&gt;HTML&lt;/acronym&gt; tags from given
+ content.
+ &lt;/para&gt;
+
+ &lt;warning&gt;
+ &lt;title&gt;Zend_Filter_StripTags is potentially unsecure&lt;/title&gt;
+
+ &lt;para&gt;
+ Be warned that &lt;classname&gt;Zend_Filter_StripTags&lt;/classname&gt; should only be used to strip
+ all available tags.
+ &lt;/para&gt;
+
+ &lt;para&gt;
+ Using &lt;classname&gt;Zend_Filter_StripTags&lt;/classname&gt; to make your site
+ &lt;emphasis&gt;secure&lt;/emphasis&gt; by stripping some unwanted tags will lead to unsecure and
+ dangerous code.
+ &lt;/para&gt;
+
+ &lt;para&gt;
+ &lt;classname&gt;Zend_Filter_StripTags&lt;/classname&gt; must not be used to prevent
+ &lt;acronym&gt;XSS&lt;/acronym&gt; attacks. This filter is no replacement for using Tidy or
+ HtmlPurifier.
+ &lt;/para&gt;
+ &lt;/warning&gt;
+
+ &lt;sect3 id=&quot;zend.filter.set.striptags.options&quot;&gt;
+ &lt;title&gt;Supported options for Zend_Filter_StripTags&lt;/title&gt;
+
+ &lt;para&gt;
+ The following options are supported for &lt;classname&gt;Zend_Filter_StripTags&lt;/classname&gt;:
+ &lt;/para&gt;
+
+ &lt;itemizedlist&gt;
+ &lt;listitem&gt;
+ &lt;para&gt;
+ &lt;emphasis&gt;&lt;property&gt;allowAttribs&lt;/property&gt;&lt;/emphasis&gt;: This option sets the
+ attributes which are accepted. All other attributes are stripped from the given
+ content
+ &lt;/para&gt;
+ &lt;/listitem&gt;
+
+ &lt;listitem&gt;
+ &lt;para&gt;
+ &lt;emphasis&gt;&lt;property&gt;allowTags&lt;/property&gt;&lt;/emphasis&gt;: This option sets the tags
+ which are accepted. All other tags will be stripped from the given content
+ &lt;/para&gt;
+ &lt;/listitem&gt;
+ &lt;/itemizedlist&gt;
+ &lt;/sect3&gt;
+
+ &lt;sect3 id=&quot;zend.filter.set.striptags.basic&quot;&gt;
+ &lt;title&gt;Basic usage&lt;/title&gt;
+
+ &lt;para&gt;
+ See the following example for the default behaviour of this filter:
+ &lt;/para&gt;
+
+ &lt;programlisting language=&quot;php&quot;&gt;&lt;![CDATA[
+$filter = new Zend_Filter_StripTags();
+
+print $filter-&gt;filter('&lt;B&gt;My content&lt;/B&gt;');
+]]&gt;&lt;/programlisting&gt;
+
+ &lt;para&gt;
+ As result you will get the stripped content 'My content'.
+ &lt;/para&gt;
+
+ &lt;para&gt;
+ When the content contains broken or partitial tags then the complete following content
+ will be erased. See the following example:
+ &lt;/para&gt;
+
+ &lt;programlisting language=&quot;php&quot;&gt;&lt;![CDATA[
+$filter = new Zend_Filter_StripTags();
+
+print $filter-&gt;filter('This contains &lt;a href=&quot;http://example.com&quot;&gt;no ending tag');
+]]&gt;&lt;/programlisting&gt;
+
+ &lt;para&gt;
+ The above will return 'This contains' with the rest being stripped.
+ &lt;/para&gt;
+ &lt;/sect3&gt;
+
+ &lt;sect3 id=&quot;zend.filter.set.striptags.allowtags&quot;&gt;
+ &lt;title&gt;Allowing defined tags&lt;/title&gt;
+
+ &lt;para&gt;
+ &lt;classname&gt;Zend_Filter_StripTags&lt;/classname&gt; allows stripping of all but defined tags.
</ins><span class="lines">@@ Diff output truncated at 4096 characters. @@
</span></span></pre>
</div>
</div>

</body>
</html>

Loading...