Added Zip Adapters (PclZip & ZipArchive)

Author: Progi1984

CHANGELOG.md

@@ -33,3 +33,8 @@
 
 ### Changes
 - XMLWriter : Refactoring for improving performances
+
+## 0.2.5
+
+### Features
+- Added Zip Adapter (PclZip & ZipArchive)

composer.json

@@ -15,7 +15,8 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0"
+        "php": ">=5.3.0",
+        "pclzip/pclzip": "^2.8"
     },
     "require-dev": {
         "phpunit/phpunit": "3.7.*",

src/Common/Adapter/Zip/PclZipAdapter.php

@@ -0,0 +1,58 @@
+<?php
+namespace PhpOffice\Common\Adapter\Zip;
+
+use PclZip;
+
+class PclZipAdapter implements ZipInterface
+{
+    /**
+     * @var PclZip
+     */
+    protected $oPclZip;
+
+    /**
+     * @var string
+     */
+    protected $tmpDir;
+
+    /**
+     * @param $filename
+     * @return $this
+     */
+    public function open($filename)
+    {
+        $this->oPclZip = new PclZip($filename);
+        $this->tmpDir = sys_get_temp_dir();
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function close()
+    {
+        return $this;
+    }
+
+    /**
+     * @param $localname
+     * @param $contents
+     * @return $this
+     * @throws \Exception
+     */
+    public function addFromString($localname, $contents)
+    {
+        $pathData = pathinfo($localname);
+
+        $hFile = fopen($this->tmpDir.'/'.$pathData['basename'], "wb");
+        fwrite($hFile, $contents);
+        fclose($hFile);
+
+        $res = $this->oPclZip->add($this->tmpDir.'/'.$pathData['basename'], PCLZIP_OPT_REMOVE_PATH, $this->tmpDir, PCLZIP_OPT_ADD_PATH, $pathData['dirname']);
+        if ($res == 0) {
+            throw new \Exception("Error zipping files : " . $this->oPclZip->errorInfo(true));
+        }
+        unlink($this->tmpDir.'/'.$pathData['basename']);
+        return $this;
+    }
+}

src/Common/Adapter/Zip/ZipArchiveAdapter.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace PhpOffice\Common\Adapter\Zip;
+
+use ZipArchive;
+
+class ZipArchiveAdapter implements ZipInterface
+{
+    /**
+     * @var ZipArchive
+     */
+    protected $oZipArchive;
+
+    /**
+     * @var string
+     */
+    protected $filename;
+
+    /**
+     * @param string $filename
+     * @throws \Exception Could not open $this->filename for writing.
+     * @return mixed
+     */
+    public function open($filename){
+        $this->filename = $filename;
+        $this->oZipArchive = new ZipArchive();
+
+        if ($this->oZipArchive->open($this->filename, ZipArchive::OVERWRITE) === true) {
+            return $this;
+        }
+        if ($this->oZipArchive->open($this->filename, ZipArchive::CREATE) === true) {
+            return $this;
+        }
+        throw new \Exception("Could not open $this->filename for writing.");
+    }
+
+    /**
+     * @return $this
+     * @throws \Exception Could not close zip file $this->filename.
+     */
+    public function close()
+    {
+        if ($this->oZipArchive->close() === false) {
+            throw new \Exception("Could not close zip file $this->filename.");
+        }
+        return $this;
+    }
+
+    /**
+     * @param $localname
+     * @param $contents
+     * @return bool
+     */
+    public function addFromString($localname, $contents)
+    {
+        return $this->oZipArchive->addFromString($localname, $contents);
+    }
+}

src/Common/Adapter/Zip/ZipInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace PhpOffice\Common\Adapter\Zip;
+
+
+interface ZipInterface
+{
+    public function open($filename);
+    public function close();
+    public function addFromString($localname, $contents);
+}

tests/Common/Tests/Adapter/Zip/PclZipAdapterTest.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Common\Tests\Adapter\Zip;
+
+use PhpOffice\Common\Adapter\Zip\PclZipAdapter;
+use PhpOffice\Common\Tests\TestHelperZip;
+
+class PclZipAdapterTest extends \PHPUnit_Framework_TestCase
+{
+    protected $zipTest;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        $pathResources = PHPOFFICE_COMMON_TESTS_BASE_DIR.DIRECTORY_SEPARATOR.'resources'.DIRECTORY_SEPARATOR.'files'.DIRECTORY_SEPARATOR;
+        $this->zipTest = tempnam($pathResources, 'PhpOfficeCommon');
+        copy($pathResources.'Sample_01_Simple.pptx', $this->zipTest);
+    }
+
+    public function tearDown()
+    {
+        parent::tearDown();
+
+        unlink($this->zipTest);
+    }
+
+    public function testOpen()
+    {
+        $object = new PclZipAdapter();
+        $this->assertInstanceOf('PhpOffice\\Common\\Adapter\\Zip\\ZipInterface', $object->open($this->zipTest));
+    }
+
+    public function testClose()
+    {
+        $object = new PclZipAdapter();
+        $object->open($this->zipTest);
+        $this->assertInstanceOf('PhpOffice\\Common\\Adapter\\Zip\\ZipInterface', $object->close());
+    }
+
+    public function testAddFromString()
+    {
+        $expectedPath = 'file.test';
+        $expectedContent = 'Content';
+
+        $object = new PclZipAdapter();
+        $object->open($this->zipTest);
+        $object->addFromString($expectedPath, $expectedContent);
+        $object->close();
+
+        $this->assertTrue(TestHelperZip::assertFileExists($this->zipTest, $expectedPath));
+        $this->assertTrue(TestHelperZip::assertFileContent($this->zipTest, $expectedPath, $expectedContent));
+    }
+}

tests/Common/Tests/Adapter/Zip/ZipArchiveAdapterTest.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Common\Tests\Adapter\Zip;
+
+use PhpOffice\Common\Adapter\Zip\ZipArchiveAdapter;
+use PhpOffice\Common\Tests\TestHelperZip;
+
+
+class ZipArchiveAdapterTest extends \PHPUnit_Framework_TestCase
+{
+    protected $zipTest;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        $pathResources = PHPOFFICE_COMMON_TESTS_BASE_DIR.DIRECTORY_SEPARATOR.'resources'.DIRECTORY_SEPARATOR.'files'.DIRECTORY_SEPARATOR;
+        $this->zipTest = tempnam($pathResources, 'PhpOfficeCommon');
+        copy($pathResources.'Sample_01_Simple.pptx', $this->zipTest);
+    }
+
+    public function tearDown()
+    {
+        parent::tearDown();
+
+        unlink($this->zipTest);
+    }
+
+    public function testOpen()
+    {
+        $object = new ZipArchiveAdapter();
+        $this->assertInstanceOf('PhpOffice\\Common\\Adapter\\Zip\\ZipInterface', $object->open($this->zipTest));
+    }
+
+    public function testClose()
+    {
+        $object = new ZipArchiveAdapter();
+        $object->open($this->zipTest);
+        $this->assertInstanceOf('PhpOffice\\Common\\Adapter\\Zip\\ZipInterface', $object->close());
+    }
+
+    public function testAddFromString()
+    {
+        $expectedPath = 'file.test';
+        $expectedContent = 'Content';
+
+        $object = new ZipArchiveAdapter();
+        $object->open($this->zipTest);
+        $object->addFromString($expectedPath, $expectedContent);
+        $object->close();
+
+        $this->assertTrue(TestHelperZip::assertFileExists($this->zipTest, $expectedPath));
+        $this->assertTrue(TestHelperZip::assertFileContent($this->zipTest, $expectedPath, $expectedContent));
+    }
+}