diff --git a/reference/id3/functions/id3-get-frame-long-name.xml b/reference/id3/functions/id3-get-frame-long-name.xml
index 141074f114..38f11df91d 100644
--- a/reference/id3/functions/id3-get-frame-long-name.xml
+++ b/reference/id3/functions/id3-get-frame-long-name.xml
@@ -1,12 +1,12 @@
-
+
id3_get_frame_long_name
Get the long name of an ID3v2 frame
-
- Description
+
+ &reftitle.description;
stringid3_get_frame_long_name
stringframeId
@@ -15,9 +15,30 @@
id3_get_frame_long_name returns the long name for an
ID3v2 frame.
+
+
+ &reftitle.parameters;
-
+
+
+ frameId
+
+
+ An ID3v2 frame
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns the frame long name or &false; on errors.
+
+
+
+ &reftitle.examples;
<function>id3_get_frame_long_name</function> example
@@ -29,9 +50,7 @@ echo $longName;
?>
]]>
-
- This will output:
-
+ &example.outputs;
+
+
+ &reftitle.seealso;
- See also id3_get_frame_short_name.
+
+ id3_get_frame_short_name
+
diff --git a/reference/id3/functions/id3-get-frame-short-name.xml b/reference/id3/functions/id3-get-frame-short-name.xml
index aeee0635f6..39e96c883d 100644
--- a/reference/id3/functions/id3-get-frame-short-name.xml
+++ b/reference/id3/functions/id3-get-frame-short-name.xml
@@ -1,12 +1,12 @@
-
+
id3_get_frame_short_name
Get the short name of an ID3v2 frame
-
- Description
+
+ &reftitle.description;
stringid3_get_frame_short_name
stringframeId
@@ -15,9 +15,34 @@
id3_get_frame_short_name returns the short name for an
ID3v2 frame.
+
+
+ &reftitle.parameters;
-
+
+
+ frameId
+
+
+ An ID3v2 frame
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns the frame short name or &false; on errors.
+
+
+ The values returned by id3_get_short_name are used in the
+ array returned by id3_get_tag.
+
+
+
+ &reftitle.examples;
<function>id3_get_frame_short_name</function> example
@@ -29,9 +54,7 @@ echo $shortName;
?>
]]>
-
- This will output:
-
+ &example.outputs;
+
+
+ &reftitle.seealso;
- The values returned by id3_get_short_name are used in the
- array returned by id3_get_tag.
-
-
- See also id3_get_frame_long_name.
+
+ id3_get_frame_long_name
+
diff --git a/reference/id3/functions/id3-get-genre-id.xml b/reference/id3/functions/id3-get-genre-id.xml
index 6a2f09c5b7..139e2b347a 100644
--- a/reference/id3/functions/id3-get-genre-id.xml
+++ b/reference/id3/functions/id3-get-genre-id.xml
@@ -1,25 +1,43 @@
-
+
id3_get_genre_id
Get the id for a genre
-
- Description
+
+ &reftitle.description;
intid3_get_genre_id
stringgenre
- id3_get_genre_id returns the id for a genre. If the
- specified genre is not available in the genre list, id3_get_genre_id
- will return &false;
+ id3_get_genre_id returns the id for a genre.
+
+
+ &reftitle.parameters;
- In an ID3 tag, the genre is stored using a integer ranging from 0 to
- 147.
+
+
+ genre
+
+
+ An integer ranging from 0 to 147
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ The genre id or &false; on errors.
+
+
+
+ &reftitle.examples;
<function>id3_get_genre_id</function> example
@@ -31,9 +49,7 @@ echo $id;
?>
]]>
-
- This will output:
-
+ &example.outputs;
+
+
+ &reftitle.seealso;
- See also id3_get_genre_list and id3_get_genre_name.
+
+ id3_get_genre_name
+ id3_get_genre_list
+
diff --git a/reference/id3/functions/id3-get-genre-list.xml b/reference/id3/functions/id3-get-genre-list.xml
index 438673e9ad..307eb8e259 100644
--- a/reference/id3/functions/id3-get-genre-list.xml
+++ b/reference/id3/functions/id3-get-genre-list.xml
@@ -1,12 +1,12 @@
-
+
id3_get_genre_list
Get all possible genre values
-
- Description
+
+ &reftitle.description;
arrayid3_get_genre_list
@@ -21,6 +21,16 @@
they may choose one. When updating the ID3 tag you will always have to
specify the genre as an integer ranging from 0 to 147.
+
+
+ &reftitle.returnvalues;
+
+ Returns an array containing all possible genres that may be stored in an
+ ID3 tag.
+
+
+
+ &reftitle.examples;
<function>id3_get_genre_list</function> example
@@ -32,9 +42,7 @@ print_r($genres);
?>
]]>
-
- This will output:
-
+ &example.outputs;
+
+
+ &reftitle.seealso;
- See also id3_get_genre_name and id3_get_genre_id.
+
+ id3_get_genre_name
+ id3_get_genre_id
+
diff --git a/reference/id3/functions/id3-get-genre-name.xml b/reference/id3/functions/id3-get-genre-name.xml
index 4537632b64..131e06985d 100644
--- a/reference/id3/functions/id3-get-genre-name.xml
+++ b/reference/id3/functions/id3-get-genre-name.xml
@@ -1,12 +1,12 @@
-
+
id3_get_genre_name
Get the name for a genre id
-
- Description
+
+ &reftitle.description;
stringid3_get_genre_name
intgenre_id
@@ -14,10 +14,30 @@
id3_get_genre_name returns the name for a genre id.
+
+
+ &reftitle.parameters;
- In an ID3 tag, the genre is stored using a integer ranging from 0 to
- 147.
+
+
+ genre_id
+
+
+ An integer ranging from 0 to 147
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns the name as a string.
+
+
+
+ &reftitle.examples;
<function>id3_get_genre_name</function> example
@@ -29,9 +49,7 @@ echo $genre;
?>
]]>
-
- This will output:
-
+ &example.outputs;
+
+
+ &reftitle.seealso;
- See also id3_get_genre_list and id3_get_genre_id.
+
+ id3_get_genre_list
+ id3_get_genre_id
+
diff --git a/reference/id3/functions/id3-get-tag.xml b/reference/id3/functions/id3-get-tag.xml
index 0dcfc3f797..14299473b4 100644
--- a/reference/id3/functions/id3-get-tag.xml
+++ b/reference/id3/functions/id3-get-tag.xml
@@ -1,12 +1,12 @@
-
+
id3_get_tag
Get all information stored in an ID3 tag
-
- Description
+
+ &reftitle.description;
arrayid3_get_tag
stringfilename
@@ -16,14 +16,56 @@
id3_get_tag is used to get all information stored
in the id3 tag of the specified file.
-
- Instead of a filename you may also pass a valid stream resource.
-
+
+
+ &reftitle.parameters;
- The optional version parameter allows you to
- specify the version of the tag as MP3 files may contain both, version 1.x and
- version 2.x tags.
+
+
+ filename
+
+
+ The path to the MP3 file
+
+
+ Instead of a filename you may also pass a valid stream resource
+
+
+
+
+ version
+
+
+ Allows you to specify the version of the tag as MP3 files may contain
+ both, version 1.x and version 2.x tags
+
+
+ Since version 0.2 id3_get_tag also supports ID3
+ tags of version 2.2, 2.3 and 2.4. To extract information from these
+ tags, pass one of the constants ID3_V2_2, ID3_V2_3 or ID3_V2_4 as the
+ second parameter.
+ ID3 v2.x tags can contain a lot more information about the MP3 file
+ than ID3 v1.x tags.
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns an associative array with various keys like:
+ title, artist, ..
+
+
+ The key genre will contain an integer between 0 and
+ 147. You may use id3_get_genre_name to convert it to
+ a human readable string.
+
+
+
+ &reftitle.examples;
<function>id3_get_tag</function> example
@@ -35,9 +77,7 @@ print_r($tag);
?>
]]>
-
- This will output something like:
-
+ &example.outputs.similar;
-
-
- The key genre will contain an integer between 0 and 147. You may
- use id3_get_genre_name to convert it to a human readable string.
-
-
- Since version 0.2 id3_get_tag also supports ID3 tags of version 2.2, 2.3 and 2.4.
- To extract information from these tags, pass one of the constants ID3_V2_2, ID3_V2_3 or ID3_V2_4 as the
- second parameter.
-
-
<function>id3_get_tag</function> example
@@ -72,9 +101,7 @@ print_r($tag);
?>
]]>
-
- This will output something like:
-
+ &example.outputs.similar;
+
+
+ &reftitle.seealso;
- ID3 v2.x tags can contain a lot more information about the MP3 file than ID3 v1.x tags.
-
-
- See also id3_set_tag,
- id3_remove_tag and id3_get_version.
+
+ id3_set_tag
+ id3_remove_tag
+ id3_get_version
+
diff --git a/reference/id3/functions/id3-get-version.xml b/reference/id3/functions/id3-get-version.xml
index a0f7217c6f..2453449f6b 100644
--- a/reference/id3/functions/id3-get-version.xml
+++ b/reference/id3/functions/id3-get-version.xml
@@ -1,25 +1,55 @@
-
+
id3_get_version
Get version of an ID3 tag
-
- Description
+
+ &reftitle.description;
intid3_get_version
stringfilename
- id3_get_version retrieves the version(s) of the ID3 tag(s) in
- the MP3 file. As a tag can contain ID3 v1.x and v2.x tags, the return value of this
- function should be bitwise compared with the predefined constants ID3_V1_0,
- ID3_V1_1 and ID3_V2.
+ id3_get_version retrieves the version(s) of the
+ ID3 tag(s) in the MP3 file.
-
- Instead of a filename you may also pass a valid stream resource.
-
+
+ If a file contains an ID3 v1.1 tag, it always contains
+ a 1.0 tag, as version 1.1 is just an extension of 1.0.
+
+
+
+ &reftitle.parameters;
+
+
+
+ filename
+
+
+ The path to the MP3 file
+
+
+ Instead of a filename you may also pass a valid stream resource
+
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ Returns the version number of the ID3 tag of the file.
+ As a tag can contain ID3 v1.x and v2.x tags, the return value of this
+ function should be bitwise compared with the predefined constants
+ ID3_V1_0, ID3_V1_1 and
+ ID3_V2.
+
+
+
+ &reftitle.examples;
<function>id3_get_version</function> example
@@ -39,9 +69,7 @@ if ($version & ID3_V2) {
?>
]]>
-
- This will output something like:
-
+ &example.outputs.similar;
+
+
+ &reftitle.seealso;
- If a file contains an ID3 v1.1 tag, it always contains
- a 1.0 tag, as version 1.1 is just an extension of 1.0.
-
-
- See also id3_get_tag, id3_set_tag and
- id3_remove_tag.
+
+ id3_set_tag
+ id3_get_tag
+ id3_remove_tag
+
diff --git a/reference/id3/functions/id3-remove-tag.xml b/reference/id3/functions/id3-remove-tag.xml
index 6ef5f5c486..caeeb2d892 100644
--- a/reference/id3/functions/id3-remove-tag.xml
+++ b/reference/id3/functions/id3-remove-tag.xml
@@ -1,12 +1,12 @@
-
+
id3_remove_tag
Remove an existing ID3 tag
-
- Description
+
+ &reftitle.description;
boolid3_remove_tag
stringfilename
@@ -14,17 +14,44 @@
id3_remove_tag is used to remove the information stored
- of an ID3 tag. If no tag has been present, it will return &false; and leave the file
- as it was.
+ of an ID3 tag.
-
- Instead of a filename you may also pass a valid stream resource.
-
+
+
+ &reftitle.parameters;
- The optional version parameter allows you to
- specify the version of the tag as MP3 files may contain both, version 1.x and
- version 2.x tags.
+
+
+ filename
+
+
+ The path to the MP3 file
+
+
+ Instead of a filename you may also pass a valid stream resource
+
+
+
+
+ version
+
+
+ Allows you to specify the version of the tag as MP3 files may contain
+ both, version 1.x and version 2.x tags.
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.success;
+
+
+
+ &reftitle.examples;
<function>id3_remove_tag</function> example
@@ -48,17 +75,25 @@ Tag succesfully removed
+
+
+ &reftitle.notes;
- Currently id3_remove_tag only supports
- version 1.0 and 1.1. If you choose to remove a 1.0 tag and the file
- contains a 1.1 tag, this tag will be removed, as v1.1 is only an
- extension of 1.0.
+ Currently id3_remove_tag only supports version 1.0
+ and 1.1. If you choose to remove a 1.0 tag and the file contains a 1.1
+ tag, this tag will be removed, as v1.1 is only an extension of 1.0.
+
+
+ &reftitle.seealso;
- See also id3_get_tag,
- id3_set_tag and id3_get_version.
+
+ id3_set_tag
+ id3_get_tag
+ id3_get_version
+
diff --git a/reference/id3/functions/id3-set-tag.xml b/reference/id3/functions/id3-set-tag.xml
index 32a286874b..cae1e9f3ea 100644
--- a/reference/id3/functions/id3-set-tag.xml
+++ b/reference/id3/functions/id3-set-tag.xml
@@ -1,12 +1,12 @@
-
+
id3_set_tag
Update information stored in an ID3 tag
-
- Description
+
+ &reftitle.description;
boolid3_set_tag
stringfilename
@@ -17,14 +17,104 @@
id3_set_tag is used to change the information stored
of an ID3 tag. If no tag has been present, it will be added to the file.
-
- Instead of a filename you may also pass a valid stream resource.
-
+
+
+ &reftitle.parameters;
- The optional version parameter allows you to
- specify the version of the tag as MP3 files may contain both, version 1.x and
- version 2.x tags.
+
+
+ filename
+
+
+ The path to the MP3 file
+
+
+ Instead of a filename you may also pass a valid stream resource
+
+
+
+
+ tag
+
+
+ An associative array of tag keys and values
+
+
+ The following keys may be used in the associative array:
+
+
+
+ Keys in the associative array
+
+
+
+ key
+ possible value
+ available in version
+
+
+
+
+ title
+ string with maximum of 30 characters
+ v1.0, v1.1
+
+
+ artist
+ string with maximum of 30 characters
+ v1.0, v1.1
+
+
+ album
+ string with maximum of 30 characters
+ v1.0, v1.1
+
+
+ year
+ 4 digits
+ v1.0, v1.1
+
+
+ genre
+ integer value between 0 and 147
+ v1.0, v1.1
+
+
+ comment
+ string with maximum of 30 characters (28 in v1.1)
+ v1.0, v1.1
+
+
+ track
+ integer between 0 and 255
+ v1.1
+
+
+
+
+
+
+
+
+ version
+
+
+ Allows you to specify the version of the tag as MP3 files may contain
+ both, version 1.x and version 2.x tags
+
+
+
+
+
+
+ &reftitle.returnvalues;
+
+ &return.success;
+
+
+
+ &reftitle.examples;
<function>id3_set_tag</function> example
@@ -53,69 +143,24 @@ Tag succesfully updated
+
+
+ &reftitle.notes;
- Currently id3_set_tag only supports
- version 1.0 and 1.1.
+ Currently id3_remove_tag only supports version 1.0
+ and 1.1.
+
+
+ &reftitle.seealso;
- The following keys may be used in the associative array:
-
-
-
- Keys in the associative array
-
-
-
- key
- possible value
- available in version
-
-
-
-
- title
- string with maximum of 30 characters
- v1.0, v1.1
-
-
- artist
- string with maximum of 30 characters
- v1.0, v1.1
-
-
- album
- string with maximum of 30 characters
- v1.0, v1.1
-
-
- year
- 4 digits
- v1.0, v1.1
-
-
- genre
- integer value between 0 and 147
- v1.0, v1.1
-
-
- comment
- string with maximum of 30 characters (28 in v1.1)
- v1.0, v1.1
-
-
- track
- integer between 0 and 255
- v1.1
-
-
-
-
-
-
- See also id3_get_tag,
- id3_remove_tag and id3_get_version.
+
+ id3_remove_tag
+ id3_get_tag
+ id3_get_version
+