0.1.6

- Remove user_error, use throw cases instead
- Remove use of ob_start/clean - documented instead

Author: Stan Hutcheon

README.md

@@ -43,7 +43,10 @@ $fullName = $file->name(); # full file name in zip, including path
 ```
 
 ###### get($file, $output = false):
-Returns, or outputs the file fetched from the remote ZIP
+Returns, or outputs the file fetched from the remote ZIP.
+
+**Note**: You should ensure no content is outputted before running ```->get($file, true)``` as this will cause the file download to contain invalid data.
+*Hint*: put ```ob_start()``` at the start of your script, then run ```ob_clean()``` before calling get.
 ```php
 <?php
 /*...*/
@@ -63,11 +66,14 @@ require 'vendor/autoload.php';
 
 use Stnvh\Partial\Zip as Partial;
 
+ob_start(); # will capture all output
+
 $p = new Partial('http://some.site.com/cats.zip', 'cat.png');
 
 # Get file object
 $file = $p->find();
 if($file) {
+    ob_clean(); # removes everything from current output to ensure file downloads correctly
     # Output to browser:
     $p->get($file, true);
 }

src/Stnvh/Partial/Data/PartialData.php

@@ -2,6 +2,10 @@
 
 namespace Stnvh\Partial\Data;
 
+use \RuntimeException as RuntimeException;
+use \InvalidArgumentException as InvalidArgumentException;
+use \BadMethodCallException as BadMethodCallException;
+
 /**
  * Class PartialData
  * @package Stnvh\Partial\Data
@@ -41,8 +45,7 @@ public function __call($name, $args) {
 	 */
 	public function get() {
 		if(!file_exists($this->tempName)) {
-			user_error('Temporary filename not set, did you call get() directly on the file object?', E_USER_ERROR);
-			exit;
+			throw new BadMethodCallException('Called before being fetched with Zip->get(). Don\'t call this directly!');
 		}
 
 		switch($this->method) {
@@ -58,8 +61,7 @@ public function get() {
 					$_method = 'bzdecompress';
 					break;
 				} else {
-					user_error('Unable to decompress, failed to load bz2 extension', E_USER_ERROR);
-					exit;
+					throw new RuntimeException('Unable to decompress, failed to load bz2 extension');
 				}
 			default:
 				$_method = false;
@@ -76,7 +78,7 @@ public function get() {
 	 * Removes the cached item from the disk
 	 * @return void
 	 */
-	public function purge() {
+	private function purge() {
 		if(file_exists($this->tempName)) {
 			@unlink($this->tempName);
 		}
@@ -99,8 +101,7 @@ public function isDir() {
 	public function format($raw, $map = false) {
 		$map = $map ?: $this->map;
 		if(!$map) {
-			user_error('No byte map specified', E_USER_ERROR);
-			exit;
+			throw new InvalidArgumentException('No byte map specified');
 		}
 
 		$i = 0;

src/Stnvh/Partial/Zip.php

@@ -4,6 +4,9 @@
 
 use Stnvh\Partial\Data;
 
+use \RuntimeException as RuntimeException;
+use \InvalidArgumentException as InvalidArgumentException;
+
 /**
  * Class Zip
  * @package Stnvh\Partial
@@ -64,8 +67,6 @@ private function receiveData($ch, $data) {
 	 * @return void
 	 */
 	public function __construct($url, $file = false) {
-		ob_start();
-
 		$this->info = new Data\ZipInfo();
 		$this->info->url = $url;
 		$this->info->file = $file;
@@ -87,13 +88,11 @@ public function init() {
 		));
 
 		if($request['http_code'] > 400) {
-			user_error(sprintf('Initial request failed, got HTTP status code: %d', $request['http_code']) , E_USER_ERROR);
-			exit;
+			throw new RuntimeException(sprintf('Initial request failed, got HTTP status code: %d', $request['http_code']));
 		}
 
 		if(!$request['headers']['Accept-Ranges']) {
-			user_error('Server does not support HTTP range requests', E_USER_ERROR);
-			exit;
+			throw new RuntimeException('Server does not support HTTP range requests');
 		}
 
 		$this->info->length = intval($request['download_content_length']);
@@ -118,8 +117,7 @@ public function init() {
 		if($_EOCD = strstr($this->info->centralDirectoryEnd, "\x50\x4b\x05\x06")) {
 			$this->info->centralDirectoryDesc = new Data\EOCD($_EOCD);
 		} else {
-			user_error('End of central directory not found', E_USER_ERROR);
-			exit;
+			throw new RuntimeException('End of central directory not found');
 		}
 
 		if($cdEnd = $this->info->centralDirectoryDesc) {
@@ -155,7 +153,7 @@ public function init() {
 			if($entry->isDir()) {
 				continue;
 			}
- 			
+
 			$this->info->centralDirectory[$entry->name] = $raw;
 			unset($_entries[$i]); # free mem as we loop
 		}
@@ -180,10 +178,9 @@ public function index() {
 	 */
 	public function find($fileName = false) {
 		$fileName = $fileName ?: $this->info->file;
-		
+
 		if(!$fileName) {
-			user_error('No filename specified to search', E_USER_ERROR);
-			exit;
+			throw new InvalidArgumentException('No filename specified to search');
 		}
 
 		foreach($this->info->centralDirectory as $name => $raw) {
@@ -203,8 +200,7 @@ public function find($fileName = false) {
 	 */
 	public function get(Data\CDFile $file, $output = false) {
 		if(!$file) {
-			user_error('No CDFile object specified', E_USER_ERROR);
-			exit;
+			throw new InvalidArgumentException('No CDFile object specified');
 		}
 
 		$this->tempName = $file->tempName;
@@ -236,7 +232,6 @@ public function get(Data\CDFile $file, $output = false) {
 		));
 
 		if($output) {
-			ob_clean(); # clean output
 			header(sprintf('Content-Disposition: attachment; filename="%s"', $file->filename));
 			header(sprintf('Content-Length: %d', $file->size));
 			header('Pragma: public');