get-meta-tags.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6ecb3d252204d4f7077eb5221209b4eab0216c18 Maintainer: sammywg Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 6ecb3d252204d4f7077eb5221209b4eab0216c18 Reviewer: samesch -->
<refentry xml:id="function.get-meta-tags" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>get_meta_tags</refname>
  <refpurpose>
   Liest alle content-Attribute der Meta-Tags einer Datei aus und gibt ein
   Array zurück
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>get_meta_tags</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Öffnet <parameter>filename</parameter> und untersucht die Datei Zeile für
   Zeile auf das Vorkommen von &lt;meta&gt;-Tags. Das Parsen wird bei
   <literal>&lt;/head&gt;</literal> beendet.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       Der Pfad zur HTML-Datei im Stringformat. Die Datei kann lokal oder als
       ein <acronym>URL</acronym> vorliegen.
      </para>
      <para>
       <example>
        <title>Was <function>get_meta_tags</function> parst</title>
        <programlisting role="html">
<![CDATA[
<meta name="author" content="name">
<meta name="keywords" content="php documentation">
<meta name="DESCRIPTION" content="a php manual">
<meta name="geo.position" content="49.33;-86.59">
</head> <!-- das Parsen endet hier -->
]]>
        </programlisting>
       </example>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>use_include_path</parameter></term>
     <listitem>
      <para>
       Ist <parameter>use_include_path</parameter> auf &true; gesetzt,
       versucht PHP die Datei unter Verwendung der Standard-Include-Pfade aus
       der INI-Direktive <link linkend="ini.include-path">include_path</link>
       zu finden. Diese Angabe wird nur für lokale Dateien, nicht jedoch für
       URLs verwendet.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt ein Array mit allen geparsten Meta-Tags zurück.
  </para>
  <para>
   Dabei werden die Werte der name-Attribute zu den Schlüsseln des
   zurückgegebenen Arrays und die Werte der content-Attribute zu deren
   Werten, sodass einfach die Standard-Arrayfunktionen verwendet werden
   können, um das gesamte Array zu durchlaufen oder auf einzelne Werte davon
   zuzugreifen. Sonderzeichen im Wert des name-Attributs werden mit '_'
   ersetzt, alle anderen Zeichen werden in Kleinbuchstaben konvertiert. Haben
   zwei Meta-Tags den gleichen Namen, wird nur der letzte zurückgegeben.
  </para>
  <para>
   Gibt im Fall eines Fehlers &false; zurück.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Was <function>get_meta_tags</function> zurückgibt</title>
    <programlisting role="php">
<![CDATA[
<?php
// Angenommen die genannten Tags stuenden auf www.example.com
$tags = get_meta_tags('http://www.example.com/');

// Beachten Sie, dass alle Keys kleingeschrieben werden
// und dass . im Schluessel durch _ ersetzt wird.
echo $tags['author'];       // name
echo $tags['keywords'];     // php documentation
echo $tags['description'];  // a php manual
echo $tags['geo_position']; // 49.33;-86.59
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Nur Meta-Tags mit name-Attributen werden geparst. Anführungszeichen sind
    nicht erforderlich.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>htmlentities</function></member>
    <member><function>urlencode</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->