Merge pull request #12 from benlipp/to-array

added toArray function for Caption

README.md

@@ -19,9 +19,20 @@ Import the `Parser` class: `use Benlipp\SrtParser\Parser;`
 Use it:
 ````
 $parser = new Parser();
+
 $parser->loadFile('/path/to/srtfile.srt');
+
 $captions = $parser->parse();
 ````
+or
+````
+$parser = new Parser();
+
+$parser->loadString($formatted_caption_input);
+
+$captions = $parser->parse();
+````
+
 `parse()` returns an array of captions. Use them like so:
 
 ````
@@ -31,6 +42,25 @@ foreach($captions as $caption){
     echo "Text: " . $caption->text;
 }
 ````
+A caption can be returned as an array instead of an object, if you prefer. The array is `snake_case` for compatibility with Laravel's attributes.
+````
+foreach($captions as $caption){
+    $caption = $caption->toArray();
+    echo "Start Time: " . $caption['start_time'];
+    echo "End Time: " . $caption['end_time'];
+    echo "Text: " . $caption['text'];
+}
+````
+For Laravel usage with a model:
+````
+$url = "https://youtu.be/dQw4w9WgXcQ";
+$video = new Video($url);
+foreach ($captions as $caption) {
+    $data = new VideoMetadata($caption->toArray());
+    $video->videoMetadata()->save($data);
+}
+````
+
 You can also chain the `parse()` method:
 ````
 $parser = new Parser();

src/SrtParser/Caption.php

@@ -28,4 +28,17 @@ public function setText($text)
 
         return $this;
     }
+
+    /**
+     * Returns an array with snake_case formatted keys for Laravel
+     * @return array
+     */
+    public function toArray()
+    {
+        return [
+            'start_time' => $this->startTime,
+            'end_time' => $this->endTime,
+            'text' => $this->text
+        ];
+    }
 }

tests/CaptionTest.php

@@ -32,4 +32,25 @@ public function testFormatting()
         $this->assertEquals($text, $caption->text);
     }
 
+    public function testToArray()
+    {
+        $startTime = "00:00:00,000";
+        $endTime = "00:00:05,000";
+        $text = "Caption";
+
+        $expectedStart = Time::get($startTime);
+        $expectedEnd = Time::get($endTime);
+
+        $caption = new Caption($startTime, $endTime, $text);
+        $captionArray = $caption->toArray();
+        $this->assertTrue(is_array($captionArray));
+
+        $expectedArray = [
+            'start_time' => $expectedStart,
+            'end_time' => $expectedEnd,
+            'text' => $text
+        ];
+        $this->assertEquals($captionArray, $expectedArray);
+    }
+
 }