Merge pull request #6 from robotusers/spreadsheet

Support phpoffice/phpspreadsheet

Author: robertpustulka

README.md

@@ -7,7 +7,10 @@
 [![codecov](https://codecov.io/gh/robotusers/cakephp-excel/branch/master/graph/badge.svg)](https://codecov.io/gh/robotusers/cakephp-excel)
 
 CakePHP Excel plugin allows for spreadsheet files manipulation with the power of CakePHP ORM.
-This plugin is build using [PHPExcel](https://github.com/PHPOffice/PHPExcel) library and can work with multiple types of spreadsheet files (excel, csv etc).
+This plugin is build using [PHPSpreadsheet](https://github.com/PHPOffice/PHPSpreadsheet) library and can work with multiple types of spreadsheet files (excel, csv etc).
+
+**NOTE:**
+CakePHP Excel plugin versions 0.4.0 and lower used now abandoned [PHPExcel](https://github.com/PHPOffice/PHPExcel) library.
 
 ## Installation
 
@@ -22,11 +25,11 @@ Excel plugin lets you manipulate spreadsheet files multiple ways. The simplest u
 
 For example we are loading an excel file that contains some record data.
 
-|   | A             | B                  | C    |
-|:--|:------------: |:------------------:| :---:|
-| 1 | Led Zeppelin	| Led Zeppelin II    | 1969 |
-| 2 | Deep Purple   | Machine Head       | 1972 |
-| 3 | Pink Floyd    | Wish You Were Here | 1975 |
+|   | A             | B                     | C    |
+|:--|:------------: |:---------------------:| :---:|
+| 1 | Led Zeppelin  | Led Zeppelin II       | 1969 |
+| 2 | Deep Purple   | Machine Head          | 1972 |
+| 3 | Pink Floyd    | Wish You Were Here    | 1975 |
 
 ```php
 use Robotusers/Excel/Registry;
@@ -100,10 +103,10 @@ $row = $table->newEntity([
 $table->save($row);
 ```
 
-Now the new record is saved, but excel file has not been updated yet. You have to call `writeExcel()` method:
+Now the new record is saved, but excel file has not been updated yet. You have to call `writeSpreadsheet()` method:
 
 ```php
-$table->writeExcel();
+$table->writeSpreadsheet();
 ```
 
 You may also want to read or write only some of the rows and columns.
@@ -176,18 +179,18 @@ If you want to load data into your table you have to set a worksheet instance.
 use Cake\Filesystem\File;
 
 $file = new File('path/to/file.xls');
-$excel = $table->getManager()->getExcel($file); // PHPExcel instance
-$worksheet = $excel->getActiveSheet(); // PHPExcel_Worksheet instance
+$spreadsheet = $table->getManager()->getSpreadsheet($file); // \PhpOffice\PhpSpreadsheet\Spreadsheet instance
+$worksheet = $spreadsheet->getActiveSheet(); // \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet instance
 
-$table->setWorksheet($worksheet)->readExcel();
+$table->setWorksheet($worksheet)->readSpreadsheet();
 ```
 
 Now your table is populated with excel data.
 
 If you want to write your data back to excel file you have to set a file.
 
 ```php
-$table->setFile($file)->writeExcel();
+$table->setFile($file)->writeSpreadsheet();
 ```
 
 ## Working with different tables
@@ -201,8 +204,8 @@ $table = TableRegistry::get('SomeTable');
 $manager = new Manager();
 
 $file = new File('file.xlsx');
-$excel = $manager->getExcel($file);
-$worksheet = $excel->getActiveSheet();
+$spreadsheet = $manager->getSpreadsheet($file);
+$worksheet = $spreadsheet->getActiveSheet();
 
 $manager->read($worksheet, $table, [
     'columnMap' => [
@@ -223,5 +226,5 @@ $manager->write($table, $worksheet, [
     ]
 ]);
 //to actually save the file you have to call save()
-$writer = $manager->save($excel, $file);
+$writer = $manager->save($spreadsheet, $file);
 ```

composer.json

@@ -1,29 +1,29 @@
 {
-	"name": "robotusers/cakephp-excel",
-	"description": "Robotusers CakePHP Excel plugin",
-	"homepage": "https://github.com/robotusers/cakephp-excel",
-	"type": "cakephp-plugin",
-	"license": "MIT",
-	"require": {
-		"php": ">=5.5",
-		"cakephp/filesystem": "^3.4",
-		"cakephp/orm": "^3.4",
-		"phpoffice/phpexcel": "^1.8"
-	},
-	"require-dev": {
-		"cakephp/cakephp": "~3.4.0",
-		"cakephp/cakephp-codesniffer": "*",
-		"phpunit/phpunit": "^5.6|^6"
-	},
-	"autoload": {
-		"psr-4": {
-			"Robotusers\\Excel\\": "src"
-		}
-	},
-	"autoload-dev": {
-		"psr-4": {
-			"Cake\\Test\\": "vendor/cakephp/cakephp/tests",
-			"Robotusers\\Excel\\Test\\": "tests"
-		}
-	}
+    "name": "robotusers/cakephp-excel",
+    "description": "Robotusers CakePHP Excel plugin",
+    "homepage": "https://github.com/robotusers/cakephp-excel",
+    "type": "cakephp-plugin",
+    "license": "MIT",
+    "require": {
+        "php": ">=5.5",
+        "cakephp/filesystem": "^3.4",
+        "cakephp/orm": "^3.4",
+        "phpoffice/phpspreadsheet": "^1.1"
+    },
+    "require-dev": {
+        "cakephp/cakephp": "~3.4.0",
+        "cakephp/cakephp-codesniffer": "*",
+        "phpunit/phpunit": "^5.6|^6"
+    },
+    "autoload": {
+        "psr-4": {
+            "Robotusers\\Excel\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Cake\\Test\\": "vendor/cakephp/cakephp/tests",
+            "Robotusers\\Excel\\Test\\": "tests"
+        }
+    }
 }

config/bootstrap.php

@@ -1,5 +1,5 @@
 <?php
-/* 
+/*
  * The MIT License
  *
  * Copyright 2017 RobotUsers
@@ -32,7 +32,7 @@
 $name = Registry::CONNECTON_NAME;
 $hasConnectionConfig = ConnectionManager::config($name);
 if (!$hasConnectionConfig && !in_array('sqlite', PDO::getAvailableDrivers())) {
-    $msg = 'Excel not enabled. You need to either install pdo_sqlite, or define the "%s" connection name.';
+    $msg = 'Spreadsheet not enabled. You need to either install pdo_sqlite, or define the "%s" connection name.';
     Log::warning(sprintf($msg, $name));
     return;
 }
@@ -45,4 +45,4 @@
         'cacheMetadata' => true,
         'quoteIdentifiers' => true,
     ]);
-}
+}

src/Database/Factory.php

@@ -29,10 +29,10 @@
 use Cake\Database\Schema\TableSchema;
 use Cake\Utility\Inflector;
 use Cake\Utility\Text;
-use PHPExcel_Cell;
-use PHPExcel_Cell_DataType;
-use PHPExcel_Worksheet;
-use PHPExcel_Worksheet_Row;
+use PhpOffice\PhpSpreadsheet\Cell\Cell;
+use PhpOffice\PhpSpreadsheet\Cell\DataType;
+use PhpOffice\PhpSpreadsheet\Worksheet\Row;
+use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
 
 /**
  * Description of Factory
@@ -47,7 +47,7 @@ class Factory
      * @var array
      */
     protected $dataTypeMap = [
-        PHPExcel_Cell_DataType::TYPE_NULL => false
+        DataType::TYPE_NULL => false
     ];
 
     /**
@@ -64,11 +64,11 @@ class Factory
 
     /**
      *
-     * @param PHPExcel_Worksheet $worksheet
+     * @param Worksheet $worksheet
      * @param array $options
      * @return TableSchema
      */
-    public function createSchema(PHPExcel_Worksheet $worksheet, array $options = [])
+    public function createSchema(Worksheet $worksheet, array $options = [])
     {
         $options += [
             'tableName' => $this->getTableName($worksheet),
@@ -96,10 +96,10 @@ public function createSchema(PHPExcel_Worksheet $worksheet, array $options = [])
                 'columns' => [$primaryKey]
             ]);
 
-        $row = new PHPExcel_Worksheet_Row($worksheet, $options['startRow']);
+        $row = new Row($worksheet, $options['startRow']);
         $cells = $row->getCellIterator($options['startColumn'], $options['endColumn']);
         foreach ($cells as $cell) {
-            /* @var $cell PHPExcel_Cell */
+            /* @var $cell Cell */
 
             $type = $this->discoverType($cell, $options);
 
@@ -117,11 +117,11 @@ public function createSchema(PHPExcel_Worksheet $worksheet, array $options = [])
 
     /**
      *
-     * @param PHPExcel_Cell $cell
+     * @param Cell $cell
      * @param array $options
-     * @return array|string|false
+     * @return array|string|bool
      */
-    protected function discoverType(PHPExcel_Cell $cell, array $options)
+    protected function discoverType(Cell $cell, array $options)
     {
         $format = $cell->getStyle()->getNumberFormat()->getFormatCode();
         $dataType = $cell->getDataType();
@@ -159,16 +159,17 @@ public function createTable(Connection $connection, TableSchema $schema)
 
     /**
      *
-     * @param PHPExcel_Worksheet $worksheet
+     * @param Worksheet $worksheet
      * @return string
      */
-    public function getTableName(PHPExcel_Worksheet $worksheet)
+    public function getTableName(Worksheet $worksheet)
     {
         $excel = $worksheet->getParent();
         $title = $excel->getID() . ' ' . $worksheet->getTitle();
 
         $slug = Text::slug($title, [
-            'replacement' => '_'
+            'replacement' => '_',
+            'preserve' => '.',
         ]);
         $camelized = Inflector::camelize($slug);
         $name = Inflector::tableize($camelized);
@@ -197,7 +198,7 @@ public function getNumberFormatMap()
     /**
      *
      * @param string $type
-     * @param string|array|false $column
+     * @param string|array|bool $column
      * @return $this
      */
     public function setDataType($type, $column)
@@ -210,7 +211,7 @@ public function setDataType($type, $column)
     /**
      *
      * @param string $format
-     * @param string|array|false $column
+     * @param string|array|bool $column
      * @return $this
      */
     public function setNumberFormat($format, $column)