Switched from internal exception to PHP Common Excpetions.

Updated readme.
Code cleanup.
Added php5-curl to the vargrant setup to fullfill the composer dependency requirements.

Author: Martin Brecht-Precht

README.md

@@ -34,44 +34,62 @@ require_once('path/to/vendor/autoload.php');
 ### Encoding data as QR code block data
 
 ```{php}
-use QrCodeSuite\QrEncode\QrEncoder;
+use CommonException\IoException;
+use QrCodeSuite\QrEncode;
 
 // Encode the data as QR code block data
-$encoder = new QrEncoder();
-$qrCodeData = $encoder
-	->setLevel(QrEncoder::QR_CODE_LEVEL_LOW)
-	->setTempDir('path/to/writable/directory')
-	->encodeQrCode('https://github.com/markenwerk/php-qr-code-suite');
+try {
+	$encoder = new QrEncode\QrEncoder();
+	$qrCodeData = $encoder
+		->setLevel(QrEncoder::QR_CODE_LEVEL_LOW)
+		->setTempDir('path/to/writable/directory')
+		->encodeQrCode('https://github.com/markenwerk/php-qr-code-suite');
+} catch(\InvalidArgumentException $exception) {
+	// QR code content contains invalid characters or is too large
+} catch(IoException\FolderWritableException $exception) {
+	// Temp dir is not writable
+} catch(QrEncode\Exception\QrEncoderException $exception) {
+	// QR encoder failed
+}
 ```
 
 ### Render encoded QR code block data as image
 
 ```{php}
+use CommonException\IoException;
 use QrCodeSuite\QrRender;
 use QrCodeSuite\QrRender\Color\RgbColor;
 use QrCodeSuite\QrRender\Color\CmykColor;
 
 // Render the encoded QR code block data as RGB PNG
 // Width and height should measure about 800 pixels
-$renderer = new QrRender\QrCodeRendererPng();
-$renderer
-	->setApproximateSize(800)
-	->setForegroundColor(new RgbColor(255, 0, 255))
-	->setBackgroundColor(new RgbColor(51, 51, 51))
-	->render($qrCodeData, 'path/to/qr-code.png');
+try {
+	$renderer = new QrRender\QrCodeRendererPng();
+	$renderer
+		->setApproximateSize(800)
+		->setForegroundColor(new RgbColor(255, 0, 255))
+		->setBackgroundColor(new RgbColor(51, 51, 51))
+		->render($qrCodeData, 'path/to/qr-code.png');
+} catch(IoException\FileWritableException $exception) {
+	// Output file not writable
+}
 
 // Get the effective width and height of the rendered image
 $imageWidth = $renderer->getWidth();
 $imageHeight = $renderer->getHeight();
 
 // Render the encoded QR code block data as CMYK TIFF
 // Width and height should measure about 800 pixels
-$renderer = new QrRender\QrCodeRendererTiff();
-$renderer
-	->setApproximateSize(800)
-	->setForegroundColor(new CmykColor(0, 100, 0, 0))
-	->setBackgroundColor(new CmykColor(0, 100, 100, 0))
-	->render($qrCodeData, 'path/to/qr-code.tif');
+try {
+	$renderer = new QrRender\QrCodeRendererTiff();
+	$renderer
+		->setApproximateSize(800)
+		->setForegroundColor(new CmykColor(0, 100, 0, 0))
+		->setBackgroundColor(new CmykColor(0, 100, 100, 0))
+		->render($qrCodeData, 'path/to/qr-code.tif');
+} catch(IoException\FileWritableException $exception) {
+	// Output file not writable
+}
 
 // Get the effective width and height of the rendered image
 $imageWidth = $renderer->getWidth();
@@ -80,14 +98,25 @@ $imageHeight = $renderer->getHeight();
 // Render the encoded QR code block data as CMYK vectorized EPS
 // EPS has no background color. It is just the blocks on blank cnavas.
 // EPS also has no approximate size. Scale the vectorized image as you like.
-$renderer = new QrRender\QrCodeRendererEps();
-$renderer
-	->setForegroundColor(new CmykColor(0, 100, 0, 0))
-	->render($qrCodeData, 'path/to/qr-code.eps');
+try {
+	$renderer = new QrRender\QrCodeRendererEps();
+	$renderer
+		->setForegroundColor(new CmykColor(0, 100, 0, 0))
+		->render($qrCodeData, 'path/to/qr-code.eps');
+} catch(IoException\FileWritableException $exception) {
+	// Output file not writable
+}
 ```
 
 ---
 
+## Exception handling
+
+PHP Google Geocoder provides different exceptions provided by the PHP Common Exceptions project for proper handling.  
+You can find more information about [PHP Common Exceptions at Github](https://github.com/markenwerk/php-common-exceptions).
+
+---
+
 ## Contribution
 
 Contributing to our projects is always very appreciated.  

composer.json

@@ -30,7 +30,8 @@
   "require": {
     "php": ">=5.3",
     "ext-gd": "*",
-    "ext-imagick": "*"
+    "ext-imagick": "*",
+    "markenwerk/common-exceptions": "~2.0"
   },
   "require-dev": {
     "phpunit/phpunit": "~4.8",

src/QrEncode/QrEncoder.php

@@ -2,6 +2,7 @@
 
 namespace QrCodeSuite\QrEncode;
 
+use CommonException\IoException;
 use QrCodeSuite\QrEncode\Exception\QrEncoderException;
 use QrCodeSuite\QrEncode\QrCode\QrCode;
 use QrCodeSuite\QrEncode\QrCode\QrCodePointRow;
@@ -79,16 +80,24 @@ public function setLevel($level)
 	/**
 	 * @param string $contents
 	 * @return QrCode
+	 * @throws IoException\FolderWritableException
 	 * @throws QrEncoderException
 	 */
 	public function encodeQrCode($contents)
 	{
 		$chars = str_split($contents);
 		foreach ($chars as $char) {
 			if (0 == ord($char)) {
-				throw new QrEncoderException('Encoding null character failed');
+				throw new \InvalidArgumentException('QR code contents contains a not allowed null character.');
 			}
 		}
+		// Validate temp dir
+		if (!is_dir($this->tempDir)) {
+			throw new IoException\FolderWritableException('Temp dir not exists');
+		}
+		if (!is_writable($this->tempDir)) {
+			throw new IoException\FolderWritableException('Temp dir not writable');
+		}
 		// Build temp name
 		$pngPath = rtrim($this->tempDir, '/') . '/qr_' . time() . rand(1000, 9999) . '.png';
 		// Build command
@@ -114,12 +123,13 @@ public function encodeQrCode($contents)
 			$err = stream_get_contents($pipes[2]);
 			fclose($pipes[2]);
 			proc_close($process);
-			if ($this->startsWith($err, "Failed to encode the input data")) {
-				throw new QrEncoderException('Too much content');
+			if ($this->startsWith($err, 'Failed to encode the input data')) {
+				throw new \InvalidArgumentException('Too much content');
 			}
 		} else {
 			throw new QrEncoderException('QR encoder internal error');
 		}
+
 		$image = @imagecreatefrompng($pngPath);
 		if ($image === false) {
 			throw new QrEncoderException('GD lib internal error');

src/QrRender/Exception/IoException.php

@@ -2,9 +2,9 @@
 
 namespace QrCodeSuite\QrRender;
 
+use CommonException\IoException;
 use QrCodeSuite\QrEncode\QrCode\QrCode;
 use QrCodeSuite\QrRender\Color\CmykColor;
-use QrCodeSuite\QrRender\Exception\IoException;
 use QrCodeSuite\QrRender\PathFinder\PathPoint;
 use QrCodeSuite\QrRender\PathFinder\QrCodePathFinder;
 
@@ -50,12 +50,12 @@ public function setForegroundColor(CmykColor $foregroundColor)
 	/**
 	 * @param QrCode $qrCode
 	 * @param string $filename
-	 * @throws IoException
+	 * @throws IoException\FileWritableException
 	 */
 	public function render(QrCode $qrCode, $filename)
 	{
 		if (!is_dir(dirname($filename)) || !is_writable(dirname($filename))) {
-			throw new IoException('QR code path not writable.');
+			throw new IoException\FileWritableException('QR code path not writable.');
 		}
 
 		$pathFinder = new QrCodePathFinder();
@@ -99,7 +99,7 @@ public function render(QrCode $qrCode, $filename)
 
 		$bytes = @file_put_contents($filename, implode("\n", $epsSource));
 		if ($bytes === false) {
-			throw new IoException('QR code output file not writable.');
+			throw new IoException\FileWritableException('QR code output file not writable.');
 		}
 	}
 

src/QrRender/QrCodeRendererEps.php

@@ -2,9 +2,9 @@
 
 namespace QrCodeSuite\QrRender;
 
+use CommonException\IoException;
 use QrCodeSuite\QrEncode\QrCode\QrCode;
 use QrCodeSuite\QrRender\Color\RgbColor;
-use QrCodeSuite\QrRender\Exception\IoException;
 
 /**
  * Class QrCodeRendererPng
@@ -126,12 +126,12 @@ public function getHeight()
 	/**
 	 * @param QrCode $qrCode
 	 * @param string $filename
-	 * @throws IoException
+	 * @throws IoException\FileWritableException
 	 */
 	public function render(QrCode $qrCode, $filename)
 	{
 		if (!is_dir(dirname($filename)) || !is_writable(dirname($filename))) {
-			throw new IoException('QR code path not writable.');
+			throw new IoException\FileWritableException('QR code path not writable.');
 		}
 
 		// Get basic info
@@ -177,7 +177,7 @@ public function render(QrCode $qrCode, $filename)
 		$canvas->destroy();
 
 		if ($writeSuccess !== true) {
-			throw new IoException('QR code output file not writable.');
+			throw new IoException\FileWritableException('QR code output file not writable.');
 		}
 	}
 

src/QrRender/QrCodeRendererPng.php

@@ -2,9 +2,9 @@
 
 namespace QrCodeSuite\QrRender;
 
+use CommonException\IoException;
 use QrCodeSuite\QrEncode\QrCode\QrCode;
 use QrCodeSuite\QrRender\Color\CmykColor;
-use QrCodeSuite\QrRender\Exception\IoException;
 
 /**
  * Class QrCodeRendererTiff
@@ -124,12 +124,12 @@ public function getHeight()
 	/**
 	 * @param QrCode $qrCode
 	 * @param string $filename
-	 * @throws IoException
+	 * @throws IoException\FileWritableException
 	 */
 	public function render(QrCode $qrCode, $filename)
 	{
 		if (!is_dir(dirname($filename)) || !is_writable(dirname($filename))) {
-			throw new IoException('QR code path not writable.');
+			throw new IoException\FileWritableException('QR code path not writable.');
 		}
 
 		// Get basic info
@@ -180,7 +180,7 @@ public function render(QrCode $qrCode, $filename)
 		$block->destroy();
 
 		if ($writeSuccess !== true) {
-			throw new IoException('QR code output file not writable');
+			throw new IoException\FileWritableException('QR code output file not writable');
 		}
 	}
 

src/QrRender/QrCodeRendererTiff.php

@@ -10,6 +10,7 @@ apt-get install -y apache2
 apt-get install -y php5
 apt-get install -y libapache2-mod-php5
 apt-get install -y php5-cli
+apt-get install -y php5-curl
 apt-get install -y php5-gd
 apt-get install -y php5-imagick
 apt-get install -y qrencode