From 5583fc213e026c2cabc19de112e5244d8416eb07 Mon Sep 17 00:00:00 2001
From: Stephan Schmidt <schst@php.net>
Date: Thu, 16 Dec 2004 17:33:14 +0000
Subject: [PATCH] added new functions for ID3 v2.x frames

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@174906 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../id3/functions/id3-get-frame-long-name.xml | 67 +++++++++++++++++++
 .../functions/id3-get-frame-short-name.xml    | 67 +++++++++++++++++++
 2 files changed, 134 insertions(+)
 create mode 100644 reference/id3/functions/id3-get-frame-long-name.xml
 create mode 100644 reference/id3/functions/id3-get-frame-short-name.xml

diff --git a/reference/id3/functions/id3-get-frame-long-name.xml b/reference/id3/functions/id3-get-frame-long-name.xml
new file mode 100644
index 0000000000..6048dfe349
--- /dev/null
+++ b/reference/id3/functions/id3-get-frame-long-name.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.id3-get-frame-long-name">
+   <refnamediv>
+    <refname>id3_get_frame_long_name</refname>
+    <refpurpose>Get the long name of an ID3v2 frame</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>string</type><methodname>id3_get_frame_long_name</methodname>
+      <methodparam><type>string</type><parameter>frameId</parameter></methodparam>
+     </methodsynopsis>
+    <para>
+     <function>id3_get_frame_long_name</function> returns the long name for an
+     ID3v2 frame.
+    </para>
+    <para>
+     
+    </para>
+    <para>
+     <example>
+      <title><function>id3_get_frame_long_name</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+$longName = id3_get_frame_long_name("TOLY");
+echo $longName;
+?>
+]]>
+      </programlisting>
+      <para>
+       This will output:
+      </para>
+      <screen>
+<![CDATA[
+Original lyricist(s)/text writer(s)
+]]>
+      </screen>
+     </example>
+    </para>
+    <para>
+     See also <function>id3_get_frame_short_name</function>.
+    </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:"../../../../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
+-->
diff --git a/reference/id3/functions/id3-get-frame-short-name.xml b/reference/id3/functions/id3-get-frame-short-name.xml
new file mode 100644
index 0000000000..d037b2788b
--- /dev/null
+++ b/reference/id3/functions/id3-get-frame-short-name.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.id3-get-frame-short-name">
+   <refnamediv>
+    <refname>id3_get_frame_short_name</refname>
+    <refpurpose>Get the short name of an ID3v2 frame</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>string</type><methodname>id3_get_frame_short_name</methodname>
+      <methodparam><type>string</type><parameter>frameId</parameter></methodparam>
+     </methodsynopsis>
+    <para>
+     <function>id3_get_frame_short_name</function> returns the short name for an
+     ID3v2 frame.
+    </para>
+    <para>
+     
+    </para>
+    <para>
+     <example>
+      <title><function>id3_get_frame_short_name</function> example</title>
+      <programlisting role="php">
+<![CDATA[
+<?php
+$shortName = id3_get_frame_short_name("TOLY");
+echo $shortName;
+?>
+]]>
+      </programlisting>
+      <para>
+       This will output:
+      </para>
+      <screen>
+<![CDATA[
+originalLyricist
+]]>
+      </screen>
+     </example>
+    </para>
+    <para>
+     See also <function>id3_get_frame_long_name</function>.
+    </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:"../../../../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
+-->