From 929202873c95e3f43068c56822da144fd72b65a6 Mon Sep 17 00:00:00 2001
From: Mark Story <mark@freshbooks.com>
Date: Sun, 17 Mar 2013 17:05:05 -0400
Subject: [PATCH] Add Binary type.

Binary types will return PHP file handles for all binary data types.
Strings will also be converted into file handles. Saving binary data can
either be done with filehandles or strings.
---
 .../Datasource/Database/Type/BinaryType.php   | 76 ++++++++++++++++
 .../Database/Type/BinaryTypeTest.php          | 91 +++++++++++++++++++
 2 files changed, 167 insertions(+)
 create mode 100644 lib/Cake/Model/Datasource/Database/Type/BinaryType.php
 create mode 100644 lib/Cake/Test/TestCase/Model/Datasource/Database/Type/BinaryTypeTest.php

diff --git a/lib/Cake/Model/Datasource/Database/Type/BinaryType.php b/lib/Cake/Model/Datasource/Database/Type/BinaryType.php
new file mode 100644
index 00000000000..170991d8a95
--- /dev/null
+++ b/lib/Cake/Model/Datasource/Database/Type/BinaryType.php
@@ -0,0 +1,76 @@
+<?php
+/**
+ * PHP Version 5.4
+ *
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @since         CakePHP(tm) v 3.0.0
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+namespace Cake\Model\Datasource\Database\Type;
+
+use Cake\Error;
+use Cake\Model\Datasource\Database\Driver;
+use \PDO;
+
+/**
+ * Binary type converter.
+ *
+ * Use to convert binary data between PHP and the database types.
+ */
+class BinaryType extends \Cake\Model\Datasource\Database\Type {
+
+/**
+ * Convert binary data into the database format.
+ *
+ * Binary data is not altered before being inserted into the database.
+ * As PDO will handle reading file handles.
+ *
+ * @param string|resource $value The value to convert.
+ * @param Driver $driver The driver instance to convert with.
+ * @return string|resource
+ */
+	public function toDatabase($value, Driver $driver) {
+		return $value;
+	}
+
+/**
+ * Convert binary into resource handles
+ *
+ * @param null|string|resource $value The value to convert.
+ * @param Driver $driver The driver instance to convert with.
+ * @return resource
+ * @throws Cake\Error\Exception
+ */
+	public function toPHP($value, Driver $driver) {
+		if ($value === null) {
+			return null;
+		}
+		if (is_string($value)) {
+			return fopen('data:text/plain;base64,' . base64_encode($value), 'rb');
+		}
+		if (is_resource($value)) {
+			return $value;
+		}
+		throw new Error\Exception(__d('cake_dev', 'Unable to convert %s into binary.', gettype($value)));
+	}
+
+/**
+ * Get the correct PDO binding type for Binary data.
+ *
+ * @param mixed $value The value being bound.
+ * @param Driver $driver The driver.
+ * @return integer
+ */
+	public function toStatement($value, Driver $driver) {
+		return PDO::PARAM_LOB;
+	}
+
+}
diff --git a/lib/Cake/Test/TestCase/Model/Datasource/Database/Type/BinaryTypeTest.php b/lib/Cake/Test/TestCase/Model/Datasource/Database/Type/BinaryTypeTest.php
new file mode 100644
index 00000000000..9c420880343
--- /dev/null
+++ b/lib/Cake/Test/TestCase/Model/Datasource/Database/Type/BinaryTypeTest.php
@@ -0,0 +1,91 @@
+<?php
+/**
+ * PHP Version 5.4
+ *
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @since         CakePHP(tm) v 3.0.0
+ * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
+ */
+namespace Cake\Test\TestCase\Model\Datasource\Database\Type;
+
+use Cake\Model\Datasource\Database\Type;
+use Cake\Model\Datasource\Database\Type\BinaryType;
+use Cake\TestSuite\TestCase;
+use \PDO;
+
+/**
+ * Test for the Binary type.
+ */
+class BinaryTypeTest extends TestCase {
+
+/**
+ * Setup
+ *
+ * @return void
+ */
+	public function setUp() {
+		parent::setUp();
+		$this->type = Type::build('binary');
+		$this->driver = $this->getMock('Cake\Model\Datasource\Database\Driver');
+	}
+
+/**
+ * Test toPHP
+ *
+ * @return void
+ */
+	public function testToPHP() {
+		$this->assertNull($this->type->toPHP(null, $this->driver));
+
+		$result = $this->type->toPHP('some data', $this->driver);
+		$this->assertInternalType('resource', $result);
+
+		$fh = fopen(__FILE__, 'r');
+		$result = $this->type->toPHP($fh, $this->driver);
+		$this->assertSame($fh, $result);
+		fclose($fh);
+	}
+
+/**
+ * Test exceptions on invalid data.
+ *
+ * @expectedException \Cake\Error\Exception
+ * @expectedExceptionMessage Unable to convert array into binary.
+ */
+	public function testToPHPFailure() {
+		$this->type->toPHP([], $this->driver);
+	}
+
+/**
+ * Test converting to database format
+ *
+ * @return void
+ */
+	public function testToDatabase() {
+		$value = 'some data';
+		$result = $this->type->toDatabase($value, $this->driver);
+		$this->assertEquals($value, $result);
+
+		$fh = fopen(__FILE__, 'r');
+		$result = $this->type->toDatabase($fh, $this->driver);
+		$this->assertSame($fh, $result);
+	}
+
+/**
+ * Test that the PDO binding type is correct.
+ *
+ * @return void
+ */
+	public function testToStatement() {
+		$this->assertEquals(PDO::PARAM_LOB, $this->type->toStatement('', $this->driver));
+	}
+
+}