Excel Import & Export Feature

composer.json

@@ -15,7 +15,8 @@
         "php": "^5.5.9 || ^7.0",
         "illuminate/support": "5.1.* || 5.2.* || 5.3.*",
         "illuminate/console": "5.1.* || 5.2.* || 5.3.*",
-        "illuminate/filesystem": "5.1.* || 5.2.* || 5.3.*"
+        "illuminate/filesystem": "5.1.* || 5.2.* || 5.3.*",
+        "phpoffice/phpexcel": "^1.8"
     },
     "require-dev": {
         "phpunit/phpunit" : "^4.8 || ^5.0",

config/langman.php

@@ -12,4 +12,16 @@
      */
 
     'path' => realpath(base_path('resources/lang')),
+
+    /*
+     * --------------------------------------------------------------------------
+     * Path to the directory where Excel files should be exported
+     * --------------------------------------------------------------------------
+     *
+     * This option determines where to put the exported Excel files. This directory
+     * must be writable by server. By default storage/langman directory
+     * will be used.
+     */
+
+    'exports_path' => storage_path('langman-exports'),
 ];

src/Commands/ExportCommand.php

@@ -0,0 +1,211 @@
+<?php
+
+namespace Themsaid\Langman\Commands;
+
+use Illuminate\Console\Command;
+use Illuminate\Contracts\Filesystem\Filesystem;
+use Themsaid\Langman\Manager;
+
+class ExportCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'langman:export
+        {--P|path= : The location where the exported file should be saved (Default: storage/langman-exports).}
+        {--only= : Specify the file(s) you want to export to Excel}
+        {--exclude= : Specify the file(s) you do NOT want to export to Excel}';
+
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $description = 'Generates a Excel file from your language files';
+
+    /**
+     * The Languages manager instance.
+     *
+     * @var \Themsaid\LangMan\Manager
+     */
+    private $manager;
+
+    /**
+     * Array of files grouped by filename.
+     *
+     * @var array
+     */
+    protected $files;
+
+    /**
+     * ListCommand constructor.
+     *
+     * @param  \Themsaid\LangMan\Manager $manager
+     * @param  \Illuminate\Contracts\Filesystem\Filesystem
+     * @return void
+     */
+    public function __construct(Manager $manager)
+    {
+        parent::__construct();
+
+        $this->manager = $manager;
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return mixed
+     */
+    public function handle()
+    {
+        $path = $this->generateExcelFile($this->option('path'));
+
+        $this->info('Excel file successfully generated in ' . $path .'.');
+    }
+
+    /**
+     * Generates an Excel file from translations files and putting it in
+     * the given path.
+     *
+     * @param  string|null $path
+     * @return string
+     */
+    protected function generateExcelFile($path = null)
+    {
+        $filePath = $this->getFilePath($path);
+
+        $userSelectedFiles = $this->filterFilesForExport();
+
+        $this->writeContentsToFile($this->getHeaderContent(), $this->getBodyContent($userSelectedFiles), $filePath);
+
+        return $filePath;
+    }
+
+    /**
+     * Filter files based on user options
+     *
+     * @return array|string
+     */
+    protected function filterFilesForExport()
+    {
+        if (! is_null($this->option('only')) && ! is_null($this->option('exclude'))) {
+            $this->error('You cannot combine --only and --exclude options. Please use one of them.');
+            return;
+        }
+
+        $onlyFiles = [];
+
+        if (! is_null($this->option('only'))) {
+            $onlyFiles = array_keys($this->manager->files(explode(',', $this->option('only'))));
+        }
+
+        if (! is_null($this->option('exclude'))) {
+            $excludeFiles = explode(',', $this->option('exclude'));
+            $onlyFiles = array_diff(array_keys($this->manager->files()), $excludeFiles);
+        }
+
+        return $onlyFiles;
+    }
+
+    /**
+     * Creating a Excel file from the given content.
+     *
+     * @param  $header
+     * @param  $content
+     * @param  $filepath
+     * @return void
+     */
+    protected function writeContentsToFile($header, $content, $filepath)
+    {
+        array_unshift($content, $header);
+
+        $excelObj = new \PHPExcel();
+        $excelObj->getProperties()
+            ->setTitle('Laravel Langman Exported Language File')
+            ->setSubject('Laravel Langman Exported Language File')
+            ->setCreator('Laravel Langman');
+
+        $rowNumber = 1;
+        foreach ($content as $record) {
+            $excelObj->getActiveSheet()->fromArray($record, '', 'A'. $rowNumber);
+            $rowNumber++;
+        }
+
+        $writer = \PHPExcel_IOFactory::createWriter($excelObj, 'Excel2007');
+        $writer->save($filepath);
+    }
+
+    /**
+     * Get the file path for the CSV file.
+     *
+     * @param  $path
+     * @return string
+     */
+    protected function getFilePath($path)
+    {
+        $exportDir = is_null($path) ? config('langman.exports_path') : base_path($path);
+
+        if (! file_exists($exportDir)) {
+            mkdir($exportDir, 0755);
+        }
+
+        return $exportDir . '/' . $this->getDatePrefix() . '_langman.xlsx';
+    }
+
+    /*
+     * Get the date prefix for the Excel file.
+     *
+     * @return string
+     */
+    protected function getDatePrefix()
+    {
+        return date('Y_m_d_His');
+    }
+
+    /**
+     * Get the Excel header content.
+     *
+     * @return array
+     */
+    protected function getHeaderContent()
+    {
+        return array_merge(['Language File', 'Key'], $this->manager->languages());
+    }
+
+    /**
+     * Get the Excel body content from language files.
+     *
+     * @return array
+     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
+     */
+    protected function getBodyContent($files)
+    {
+        $langFiles = $this->manager->getFilesContentGroupedByFilenameAndKey($files);
+        $content = [];
+
+        foreach ($langFiles as $langFileName => $langProps) {
+            foreach ($langProps as $key => $translations) {
+                $row = [$langFileName, $key];
+
+                foreach ($this->manager->languages() as $language) {
+                    // If an UndefinedIndex Exception was thrown, it means that $key
+                    // does not have translation in the $language, so we will
+                    // handle it by just assigning it to an empty string
+                    try {
+                        // If a translation is just an array (empty), it means that it doesn't have
+                        // any translation so we will skip it by assigning it an empty string.
+                        $row[] = is_array($translations[$language]) ? '' : $translations[$language];
+                    } catch (\ErrorException $ex) {
+                        $row[] = '';
+                    }
+                }
+
+                $content[] = $row;
+            }
+        }
+
+        return $content;
+    }
+}