Discussion:
[22821] standard/trunk/documentation/manual/en/module_specs: [ZF-8965] Zend_Filter:
thomas
2010-08-08 21:16:05 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][22821] standard/trunk/documentation/manual/en/module_specs: [ZF-8965] 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>22821</dd>
<dt>Author</dt> <dd>thomas</dd>
<dt>Date</dt> <dd>2010-08-08 14:16:01 -0700 (Sun, 08 Aug 2010)</dd>
</dl>

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

- added section for Zend_Filter_StripNewLines
- reworked filter description for available settings</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterBooleanxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Boolean.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterCallbackxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Callback.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterCompressxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Compress.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterEncryptionxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Encryption.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterLocalizedToNormalizedxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-LocalizedToNormalized.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterNullxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Null.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterPregReplacexml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-PregReplace.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterRealPathxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-RealPath.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterSetxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Set.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterStringToLowerxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-StringToLower.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterStringToUpperxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-StringToUpper.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterStringTrimxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-StringTrim.xml</a></li>
</ul>

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

<h3>Removed Paths</h3>
<ul>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterDecryptionxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Decryption.xml</a></li>
<li><a href="#standardtrunkdocumentationmanualenmodule_specsZend_FilterNormalizedToLocalizedxml">standard/trunk/documentation/manual/en/module_specs/Zend_Filter-NormalizedToLocalized.xml</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="standardtrunkdocumentationmanualenmodule_specsZend_FilterBooleanxml"></a>
<div class="modfile"><h4>Modified: standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Boolean.xml (22820 => 22821)</h4>
<pre class="diff"><span>
<span class="info">--- standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Boolean.xml 2010-08-08 19:32:56 UTC (rev 22820)
+++ standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Boolean.xml 2010-08-08 21:16:01 UTC (rev 22821) </span><span class="lines">@@ -8,6 +8,39 @@ </span><span class="cx"> useful when working with databases or when processing form values. </span><span class="cx"> &lt;/para&gt; </span><span class="cx"> </span><ins>+ &lt;sect3 id=&quot;zend.filter.set.boolean.options&quot;&gt;
+ &lt;title&gt;Supported options for Zend_Filter_Boolean&lt;/title&gt;
+
+ &lt;para&gt;
+ The following options are supported for &lt;classname&gt;Zend_Filter_Boolean&lt;/classname&gt;:
+ &lt;/para&gt;
+
+ &lt;itemizedlist&gt;
+ &lt;listitem&gt;
+ &lt;para&gt;
+ &lt;emphasis&gt;&lt;property&gt;casting&lt;/property&gt;&lt;/emphasis&gt;: When this option is set to
+ &lt;constant&gt;TRUE&lt;/constant&gt; then any given input will be casted to boolean. This
+ option defaults to &lt;constant&gt;TRUE&lt;/constant&gt;.
+ &lt;/para&gt;
+ &lt;/listitem&gt;
+
+ &lt;listitem&gt;
+ &lt;para&gt;
+ &lt;emphasis&gt;&lt;property&gt;locale&lt;/property&gt;&lt;/emphasis&gt;: This option sets the locale
+ which will be used to detect localized input.
+ &lt;/para&gt;
+ &lt;/listitem&gt;
+
+ &lt;listitem&gt;
+ &lt;para&gt;
+ &lt;emphasis&gt;&lt;property&gt;type&lt;/property&gt;&lt;/emphasis&gt;: The &lt;property&gt;type&lt;/property&gt;
+ option sets the boolean type which should be used. Read the following for
+ details.
+ &lt;/para&gt;
+ &lt;/listitem&gt;
+ &lt;/itemizedlist&gt;
+ &lt;/sect3&gt;
+ </ins><span class="cx"> &lt;sect3 id=&quot;zend.filter.set.boolean.default&quot;&gt; </span><span class="cx"> &lt;title&gt;Default behaviour for Zend_Filter_Boolean&lt;/title&gt;
</span><span class="cx">
</span></span></pre></div>
<a id="standardtrunkdocumentationmanualenmodule_specsZend_FilterCallbackxml"></a>
<div class="modfile"><h4>Modified: standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Callback.xml (22820 => 22821)</h4>
<pre class="diff"><span>
<span class="info">--- standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Callback.xml 2010-08-08 19:32:56 UTC (rev 22820)
+++ standard/trunk/documentation/manual/en/module_specs/Zend_Filter-Callback.xml 2010-08-08 21:16:01 UTC (rev 22821) </span><span class="lines">@@ -9,23 +9,52 @@ </span><span class="cx"> have a method which does the job. </span><span class="cx"> &lt;/para&gt; </span><span class="cx"> </span><del>- &lt;para&gt;
- Let's expect we want to create a filter which reverses a string.
- &lt;/para&gt; </del><ins>+ &lt;sect3 id=&quot;zend.filter.set.callback.options&quot;&gt;
+ &lt;title&gt;Supported options for Zend_Filter_Callback&lt;/title&gt; </ins><span class="cx"> </span><del>- &lt;programlisting language=&quot;php&quot;&gt;&lt;![CDATA[ </del><ins>+ &lt;para&gt;
+ The following options are supported for &lt;classname&gt;Zend_Filter_Callback&lt;/classname&gt;:
+ &lt;/para&gt;
+
+ &lt;itemizedlist&gt;
+ &lt;listitem&gt;
+ &lt;para&gt;
+ &lt;emphasis&gt;&lt;property&gt;callback&lt;/property&gt;&lt;/emphasis&gt;: This sets the callback
+ which should be used.
+ &lt;/para&gt;
+ &lt;/listitem&gt;
+
+ &lt;listitem&gt;
+ &lt;para&gt;
+ &lt;emphasis&gt;&lt;property&gt;options&lt;/property&gt;&lt;/emphasis&gt;: This property sets the
+ options which are used when the callback is processed.
+ &lt;/para&gt;
+ &lt;/listitem&gt;
+ &lt;/itemizedlist&gt;
+ &lt;/sect3&gt;
+
+ &lt;sect3 id=&quot;zend.filter.set.callback.basic&quot;&gt;
+ &lt;title&gt;Basic usage&lt;/title&gt;
+
+ &lt;para&gt;
+ The usage of this filter is quite simple. Let's expect we want to create a filter which
+ reverses a string.
+ &lt;/para&gt;
+
+ &lt;programlisting language=&quot;php&quot;&gt;&lt;![CDATA[ </ins><span class="cx"> $filter = new Zend_Filter_Callback('strrev'); </span><span class="cx"> </span><span class="cx"> print $filter-&gt;filter('Hello!'); </span><span class="cx"> // returns &quot;!olleH&quot; </span><span class="cx"> ]]&gt;&lt;/programlisting&gt; </span><span class="cx"> </span><del>- &lt;para&gt;
- As you can see it's really simple to use a callback to define a own filter. It is also
- possible to use a method, which is defined within a class, by giving an array as callback.
- &lt;/para&gt; </del><ins>+ &lt;para&gt;
+ As you can see it's really simple to use a callback to define a own filter. It is also
+ possible to use a method, which is defined within a class, by giving an array as
+ callback.
+ &lt;/para&gt; </ins><span class="cx"> </span><del>- &lt;programlisting language=&quot;php&quot;&gt;&lt;![CDATA[ </del><ins>+ &lt;programlisting language=&quot;php&quot;&gt;&lt;![CDATA[ </ins><span class="cx"> // Our classdefinition </span><span class="cx"> class MyClass </span><span class="cx"> { </span><span class="lines">@@ -37,18 +66,31 @@ </span><span class="cx"> print $filter-&gt;filter('Hello!'); </span><span class="cx"> ]]&gt;&lt;/programlisting&gt; </span><span class="cx"> </span><del>- &lt;para&gt;
- To get the actual set callback use &lt;methodname&gt;getCallback()&lt;/methodname&gt; and to set
- another callback use &lt;methodname&gt;setCallback()&lt;/methodname&gt;.
- &lt;/para&gt; </del><ins>+ &lt;para&gt;
+ To get the actual set callback use &lt;methodname&gt;getCallback()&lt;/methodname&gt; and to set
</ins><span class="lines">@@ Diff output truncated at 4096 characters. @@
</span></span></pre>
</div>
</div>

</body>
</html>

Loading...