v3.0.01

- Add `getContents()` to AudioCover
- Old method `getContent()` is deprecated

Author: ewilan-riviere

README.md

@@ -30,17 +30,6 @@ Audio files can use different formats, this package aims to provide a simple way
 
 -   Add support for more formats with [external packages](https://askubuntu.com/questions/226773/how-to-read-mp3-tags-in-shell)
 
-| Program  |  Version   |  Time / s  |
-| :------: | :--------: | :--------: |
-| exiftool |   10.25    | 49.5 ± 0.5 |
-|  lltag   |   0.14.5   |  41 ± 1.0  |
-| ffprobe  | 3.1.3-1+b3 |  33 ± 0.5  |
-|  eyeD3   |   0.6.18   |  24 ± 0.5  |
-| id3info  |   3.8.3    | 4.2 ± 0.1  |
-|  id3v2   |   0.1.12   | 2.9 ± 0.1  |
-| id3tool  |    1.2a    | 1.7 ± 0.1  |
-| mp3info  |   0.8.5a   | 1.4 ± 0.1  |
-
 ## Installation
 
 You can install the package via composer:
@@ -324,7 +313,7 @@ use Kiwilan\Audio\Audio;
 
 $audio = Audio::get('path/to/audio.mp3');
 
-$audio->getCover()->getContent(); // `?string` raw file
+$audio->getCover()->getContents(); // `?string` raw file
 $audio->getCover()->getMimeType(); // `?string` (image/jpeg, image/png, ...)
 $audio->getCover()->getWidth(); // `?int` in pixels
 $audio->getCover()->getHeight(); // `?int` in pixels

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "kiwilan/php-audio",
     "description": "PHP package to parse and update audio files metadata, with `JamesHeinrich/getID3`.",
-    "version": "3.0.0",
+    "version": "3.0.01",
     "keywords": [
         "audio",
         "php",

src/Audio.php

@@ -427,7 +427,7 @@ private function parse(): self
         $this->audio = AudioMetadata::make($this);
         $this->cover = AudioCover::make($reader->getComments());
 
-        if ($this->cover?->getContent()) {
+        if ($this->cover?->getContents()) {
             $this->hasCover = true;
         }
 

src/Models/AudioCover.php

@@ -4,7 +4,7 @@
 
 class AudioCover
 {
-    protected ?string $content = null;
+    protected ?string $contents = null;
 
     protected ?string $mimeType = null;
 
@@ -20,17 +20,25 @@ public static function make(?Id3Comments $comments): ?self
 
         $self = new self();
 
-        $self->content = $comments->picture()->data();
+        $self->contents = $comments->picture()->data();
         $self->mimeType = $comments->picture()->image_mime();
         $self->width = $comments->picture()->image_width();
         $self->height = $comments->picture()->image_height();
 
         return $self;
     }
 
+    /**
+     * @deprecated Use `getContents()` instead.
+     */
     public function getContent(): ?string
     {
-        return $this->content;
+        return $this->contents;
+    }
+
+    public function getContents(): ?string
+    {
+        return $this->contents;
     }
 
     public function getMimeType(): ?string

tests/AudioTest.php

@@ -71,6 +71,7 @@
     if ($audio->hasCover()) {
         expect($cover)->toBeInstanceOf(AudioCover::class);
         expect($cover->getContent())->toBeString();
+        expect($cover->getContents())->toBeString();
         expect($cover->getMimeType())->toBeString();
         if ($cover->getWidth()) {
             expect($cover->getWidth())->toBeInt();
@@ -80,7 +81,7 @@
         }
 
         $path = "tests/output/cover-{$ext}.jpg";
-        file_put_contents($path, $cover->getContent());
+        file_put_contents($path, $cover->getContents());
         expect(file_exists($path))->toBeTrue();
         expect($path)->toBeReadableFile();
     } else {

tests/Mp3Test.php

@@ -45,13 +45,13 @@
     $cover = $audio->getCover();
 
     expect($cover)->toBeInstanceOf(AudioCover::class);
-    expect($cover->getContent())->toBeString();
+    expect($cover->getContents())->toBeString();
     expect($cover->getMimeType())->toBe('image/jpeg');
     expect($cover->getWidth())->toBe(640);
     expect($cover->getHeight())->toBe(640);
 
     $path = 'tests/output/cover.jpg';
-    file_put_contents($path, $cover->getContent());
+    file_put_contents($path, $cover->getContents());
     expect(file_exists($path))->toBeTrue();
     expect($path)->toBeReadableFile();
 });

tests/WriterTest.php

@@ -106,7 +106,7 @@
     expect($audio->getTitle())->toBe($random);
 
     $content = file_get_contents(FOLDER);
-    expect($audio->getCover()->getContent())->toBe($content);
+    expect($audio->getCover()->getContents())->toBe($content);
 })->with([MP3_WRITER]);
 
 it('can update use tags with tag formats', function (string $path) {