Merge pull request #1 from degordian/master

mikehaertl · web-flow · commit 5154b8c2f804 · 2018-04-03T11:10:43.000+02:00
Replaced PHPExcel with PhpSpreadsheet
diff --git a/ExcelMessageController.php b/ExcelMessageController.php
@@ -1,15 +1,16 @@
 <?php
+
 namespace codemix\excelmessage;
 
 use Yii;
 use yii\console\Exception;
 use yii\console\Controller;
 use yii\helpers\Console;
 use yii\helpers\VarDumper;
-use \PHPExcel;
-use \PHPExcel_Worksheet;
-use \PHPExcel_IOFactory;
-use \PHPExcel_Cell_DataType;
+use \PhpOffice\PhpSpreadsheet\Spreadsheet;
+use \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
+use \PhpOffice\PhpSpreadsheet\IOFactory as PhpspreadsheetIOFactory;
+use \PhpOffice\PhpSpreadsheet\Cell\DataType as CellDataType;
 
 /**
  * Export new translations to Excel files from PHP message files and update PHP
@@ -60,7 +61,7 @@ class ExcelMessageController extends Controller
     public function options($actionID)
     {
         $options = ['color', 'languages', 'categories', 'ignoreLanguages', 'ignoreCategories'];
-        if ($actionID==='export') {
+        if ($actionID === 'export') {
             $options[] = 'lineHeight';
         }
         return $options;
@@ -101,8 +102,10 @@ public function actionExport($configFile, $excelDir, $type = 'new')
                 }
                 $this->stdout("Reading $file ... ", Console::FG_GREEN);
                 $existing = require($file);
-                if ($type==='new') {
-                    $existing = array_filter($existing, function ($v) { return $v===''; });
+                if ($type === 'new') {
+                    $existing = array_filter($existing, function ($v) {
+                        return $v === '';
+                    });
                 }
                 foreach ($existing as $source => $translation) {
                     if (!isset($messages[$language])) {
@@ -116,7 +119,7 @@ public function actionExport($configFile, $excelDir, $type = 'new')
                 $this->stdout("Done.\n", Console::FG_GREEN);
             }
         }
-        if (count($messages)!==0) {
+        if (count($messages) !== 0) {
             $this->writeToExcelFiles($messages, $excelDir);
         } else {
             $this->stdout("No new translations found\n", Console::FG_GREEN);
@@ -145,23 +148,23 @@ public function actionImport($configFile, $excelDir, $extension = 'xlsx')
     {
         $config = $this->checkArgs($configFile, $excelDir);
         $messages = [];
-        foreach (glob(rtrim($excelDir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.'*.'.$extension) as $file) {
+        foreach (glob(rtrim($excelDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . '*.' . $extension) as $file) {
             $language = pathinfo($file, PATHINFO_FILENAME);
             if (!$this->languageIncluded($language)) {
                 $this->stdout("Skipping language $language.\n", Console::FG_YELLOW);
                 continue;
             }
-            $excel = PHPExcel_IOFactory::load($file);
+            $excel = PhpspreadsheetIOFactory::load($file);
             foreach ($excel->getSheetNames() as $category) {
                 if (!$this->categoryIncluded($category)) {
                     $this->stdout("Skipping category $category.\n", Console::FG_YELLOW);
                     continue;
                 }
                 $sheet = $excel->getSheetByName($category);
                 $row = 2;
-                while (($source = $sheet->getCellByColumnAndRow(0,$row)->getValue())!==null) {
+                while (($source = $sheet->getCellByColumnAndRow(0, $row)->getValue()) !== null) {
                     $translation = (string)$sheet->getCellByColumnAndRow(1, $row)->getValue();
-                    if (trim($translation)!=='') {
+                    if (trim($translation) !== '') {
                         if (!isset($messages[$language])) {
                             $messages[$language] = [];
                         }
@@ -200,7 +203,7 @@ protected function checkArgs($configFile, $excelDir)
             'format' => 'php',
         ], require($configFile));
 
-        if (empty($config['format']) || $config['format']!=='php') {
+        if (empty($config['format']) || $config['format'] !== 'php') {
             throw new Exception('Format must be "php".');
         }
         if (!isset($config['messagePath'])) {
@@ -223,39 +226,39 @@ protected function checkArgs($configFile, $excelDir)
     protected function writeToExcelFiles($messages, $excelDir)
     {
         foreach ($messages as $language => $categories) {
-            $file = rtrim($excelDir, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$language.'.xlsx';
+            $file = rtrim($excelDir, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $language . '.xlsx';
             $this->stdout("Writing Excel file for $language to $file ... ", Console::FG_GREEN);
-            $excel = new PHPExcel();
+            $excel = new Spreadsheet();
             $index = 0;
             foreach ($categories as $category => $sources) {
-                $sheet = new PHPExcel_Worksheet($excel, $category);
+                $sheet = new Worksheet($excel, $category);
                 $excel->addSheet($sheet, $index++);
                 $sheet->getColumnDimension('A')->setWidth(60);
                 $sheet->getColumnDimension('B')->setWidth(60);
-                $sheet->setCellValue('A1', 'Source', PHPExcel_Cell_DataType::TYPE_STRING);
-                $sheet->setCellValue('B1', 'Translation', PHPExcel_Cell_DataType::TYPE_STRING);
+                $sheet->setCellValue('A1', 'Source', CellDataType::TYPE_STRING);
+                $sheet->setCellValue('B1', 'Translation', CellDataType::TYPE_STRING);
                 $sheet->getStyle('A1:B1')->applyFromArray([
                     'font' => [
                         'bold' => true,
                     ]
                 ]);
                 $row = 2;
                 foreach ($sources as $message => $translation) {
-                    $sheet->setCellValue('A'.$row, $message);
-                    $sheet->getStyle('A'.$row)->getAlignment()->setWrapText(true);
-                    if ($translation!=='') {
-                        $sheet->setCellValue('B'.$row, $translation);
-                        $sheet->getStyle('B'.$row)->getAlignment()->setWrapText(true);
+                    $sheet->setCellValue('A' . $row, $message);
+                    $sheet->getStyle('A' . $row)->getAlignment()->setWrapText(true);
+                    if ($translation !== '') {
+                        $sheet->setCellValue('B' . $row, $translation);
+                        $sheet->getStyle('B' . $row)->getAlignment()->setWrapText(true);
                     }
                     // This does not work with LibreOffice Calc, see:
                     // https://github.com/PHPOffice/PHPExcel/issues/588
-                    $sheet->getRowDimension($row)->setRowHeight($this->lineHeight===null ? -1 : $this->lineHeight);
+                    $sheet->getRowDimension($row)->setRowHeight($this->lineHeight === null ? -1 : $this->lineHeight);
                     $row++;
                 }
             }
             $excel->removeSheetByIndex($index);
             $excel->setActiveSheetIndex(0);
-            $writer = PHPExcel_IOFactory::createWriter($excel, "Excel2007");
+            $writer = PhpspreadsheetIOFactory::createWriter($excel, "Xlsx");
             $writer->save($file);
             $this->stdout("Done.\n", Console::FG_GREEN);
         }
@@ -273,7 +276,7 @@ protected function updateMessageFiles($messages, $config)
             $this->stdout("Updating translations for $language\n", Console::FG_GREEN);
             $dir = $config['messagePath'] . DIRECTORY_SEPARATOR . $language;
             foreach ($categories as $category => $translations) {
-                $file = $dir.DIRECTORY_SEPARATOR.$category.'.php';
+                $file = $dir . DIRECTORY_SEPARATOR . $category . '.php';
                 if (!file_exists($file)) {
                     $this->stdout("Category '$category' not found for language '$language' ($file) - Skipping", Console::FG_RED);
                 }
@@ -282,16 +285,18 @@ protected function updateMessageFiles($messages, $config)
                 foreach ($translations as $message => $translation) {
                     if (!array_key_exists($message, $existingMessages)) {
                         $this->stdout('Skipping (removed): ', Console::FG_YELLOW);
-                        $this->stdout($message."\n");
-                    } elseif ($existingMessages[$message]!=='') {
+                        $this->stdout($message . "\n");
+                    } elseif ($existingMessages[$message] !== '') {
                         $this->stdout('Skipping (exists): ', Console::FG_YELLOW);
-                        $this->stdout($message."\n");
+                        $this->stdout($message . "\n");
                     } else {
                         $existingMessages[$message] = $translation;
                     }
                 }
                 ksort($existingMessages);
-                $emptyMessages = array_filter($existingMessages, function ($v) { return $v===''; });
+                $emptyMessages = array_filter($existingMessages, function ($v) {
+                    return $v === '';
+                });
                 $translatedMessages = array_filter($existingMessages, 'strlen');
                 $array = VarDumper::export($emptyMessages + $translatedMessages);
 
@@ -330,8 +335,8 @@ protected function updateMessageFiles($messages, $config)
      */
     protected function languageIncluded($language)
     {
-        if ($this->languages===null) {
-            return $this->ignoreLanguages===null ? true : !in_array($language, explode(',', $this->ignoreLanguages));
+        if ($this->languages === null) {
+            return $this->ignoreLanguages === null ? true : !in_array($language, explode(',', $this->ignoreLanguages));
         } else {
             return in_array($language, explode(',', $this->languages));
         }
@@ -343,8 +348,8 @@ protected function languageIncluded($language)
      */
     protected function categoryIncluded($category)
     {
-        if ($this->categories===null) {
-            return $this->ignoreCategories===null ? true : !in_array($category, explode(',', $this->ignoreCategories));
+        if ($this->categories === null) {
+            return $this->ignoreCategories === null ? true : !in_array($category, explode(',', $this->ignoreCategories));
         } else {
             return in_array($category, explode(',', $this->categories));
         }
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ With this extension you can export messages from PHP message files to Excel,
 send them to your translators and read them back into your message files.
 
 > **Note:** To read and write to and from Excel file, we use the excellent
-> [PHPExcel](https://github.com/PHPOffice/PHPExcel) package.
+> [PhpSpreadsheet](https://github.com/PHPOffice/PhpSpreadsheet) package.
 
 
 ## Installation
@@ -75,7 +75,7 @@ This will add the new translations to your PHP message files. Yes it's
 really that simple.
 
 You can also pass a third parameter with the file extension, the default is `xlsx`
-as used by Excel2007 files. PHPExcel should also autodetect other Excel formats 
+as used by Excel 2007+ files. \PhpOffice\PhpSpreadsheet\Spreadsheet should also autodetect other Excel formats 
 
 > **Note:** The files must be provided in the same format as they where created by
 > the export:
diff --git a/composer.json b/composer.json
@@ -4,19 +4,17 @@
     "keywords": ["yii2", "i18n", "excel"],
     "type": "yii2-extension",
     "license": "MIT",
-    "authors": [
-        {
-            "name": "Michael Härtl",
-            "email": "haertl.mike@gmail.com"
-        }
-    ],
+    "authors": [{
+        "name": "Michael Härtl",
+        "email": "haertl.mike@gmail.com"
+    }],
     "require": {
-      "yiisoft/yii2": "*",
-      "phpoffice/phpexcel": "1.*"
+        "yiisoft/yii2": "*",
+        "phpoffice/phpspreadsheet": "^1.2"
     },
     "autoload": {
         "psr-4": {
             "codemix\\excelmessage\\": ""
         }
     }
-}
+}
