Przeglądaj źródła

ZF-8959 #comment modificaions to chapter for Zend_Filter_BaseName per documentation standards.

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22245 44c647ce-9c0f-0410-b52a-842ac1e357ba
wilmoore 15 lat temu
rodzic
commit
87f23c1d17

+ 26 - 1
documentation/manual/en/module_specs/Zend_Filter-BaseName.xml

@@ -4,9 +4,25 @@
     <title>BaseName</title>
 
     <para>
-        Given a string containing a path to a file, this filter will return the base name of the file.
+        <classname>Zend_Filter_BaseName</classname> allows you to validate if a given value contains
+        a string containing a path to a file and it will return the base name of the file.
     </para>
 
+    <sect3 id="zend.filter.set.basename.options">
+        <title>Supported options for Zend_Filter_BaseName</title>
+
+        <para>
+            There are no additional options for <classname>Zend_Filter_BaseName</classname>:
+        </para>
+    </sect3>
+
+    <sect3 id="zend.filter.set.basename.basic">
+        <title>Basic usage</title>
+
+        <para>
+            A basic example of usage is below:
+        </para>
+
     <programlisting language="php"><![CDATA[
 $filter = new Zend_Filter_BaseName();
 
@@ -14,11 +30,20 @@ print $filter->filter('/vol/tmp/filename');
 // returns "filename"
 ]]></programlisting>
 
+        <para>
+            This will return 'filename'.
+        </para>
+
     <programlisting language="php"><![CDATA[
 $filter = new Zend_Filter_BaseName();
 
 print $filter->filter('/vol/tmp/filename.txt');
 // returns "filename.txt"
 ]]></programlisting>
+    
+        <para>
+            This will return 'filename.txt'.
+        </para>
 
+    </sect3>
 </sect2>