CVS update: php3/doc/functions
| From: | sas | Date: | Tue, 22 Dec 1998 19:32:25 +0000 |
| Subject: | CVS update: php3/doc/functions | ||
| Groups: | php.dev | ||
| Request: | Send a blank email to php-dev+get-3008@lists.php.net to get a copy of this message | ||
Date: Tuesday December 22, 1998 @ 14:32
Author: sas
Update of /repository/php3/doc/functions
In directory asf:/u/temp/cvs-serv28072
Modified Files:
strings.sgml
Log Message:
added documentation for get_meta_tags
note that this function doesn't fit anywhere.
Index: php3/doc/functions/strings.sgml
diff -c php3/doc/functions/strings.sgml:1.52 php3/doc/functions/strings.sgml:1.53
*** php3/doc/functions/strings.sgml:1.52 Sun Dec 20 10:43:58 1998
--- php3/doc/functions/strings.sgml Tue Dec 22 14:32:23 1998
***************
*** 286,291 ****
--- 286,328 ----
</refsect1>
</refentry>
+ <refentry id="function.get-meta-tags">
+ <refnamediv>
+ <refname>get_meta_tags</refname>
+ <refpurpose>Extracts all meta tag content attributes from a file and returns an
array</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcdef>array <function>get_meta_tags</function></funcdef>
+ <paramdef>string <parameter>filename</parameter></paramdef>
+ <paramdef>int
<parameter><optional>use_include_path</optional></parameter></paramdef>
+ </funcsynopsis>
+ <para>
+ Opens <parameter>filename</parameter> and parses it line by line
+ for <meta> tags of the form
+ <programlisting>
+ <meta name="author" content="name">
+ <meta name="tags" content="php3 documentation">
+ </head> <!-- parsing stops here -->
+ </programlisting></example>
+
+ (pay attention to line endings - PHP3 uses a native function to parse
+ the input, so a Mac file won't work on Unix).
+
+ <para>
+ The value of the name property becomes the key,
+ the value of the content property becomes the value of the returned array,
+ so you can easily use standard array functions to traverse it or access
+ single values. Special characters in the value of the name property are
+ substituted with '_', the rest is converted to lower case.
+
+ <para>
+ Setting <parameter>use_include_path</parameter> to 1 will result
+ in PHP3 trying to open the file along the standard include path.
+ </refsect1>
+ </refentry>
+
<refentry id="function.htmlspecialchars">
<refnamediv>
<refname>htmlspecialchars</refname>
--
PHP Development Mailing List http://www.php.net/
To unsubscribe send an empty message to php-dev-unsubscribe@lists.php.net
For help: php-dev-help@lists.php.net