MAGNIMEX-14: Downloading Sample File

- changed sample files location
- fixed PhpDoc

Author: Siarhei Andreyeu

app/code/Magento/ImportExport/Controller/Adminhtml/Import/Download.php

@@ -0,0 +1,76 @@
+<?php
+/**
+ * Copyright © 2015 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\ImportExport\Controller\Adminhtml\Import;
+
+use Magento\ImportExport\Controller\Adminhtml\Import as ImportController;
+use Magento\Framework\App\Filesystem\DirectoryList;
+
+class Download extends ImportController
+{
+    const SAMPLE_FILES_DIRECTORY = 'Magento/ImportExport/Files/Sample/';
+
+    /**
+     * @var \Magento\Framework\Controller\Result\RawFactory
+     */
+    protected $resultRawFactory;
+
+    /** @var \Magento\Framework\Filesystem\Directory\WriteInterface */
+    protected $fileDirectory;
+
+    /**
+     * @param \Magento\Backend\App\Action\Context $context
+     * @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory
+     * @param \Magento\Framework\Controller\Result\RawFactory $resultRawFactory
+     */
+    public function __construct(
+        \Magento\Backend\App\Action\Context $context,
+        \Magento\Framework\App\Response\Http\FileFactory $fileFactory,
+        \Magento\Framework\Controller\Result\RawFactory $resultRawFactory,
+        \Magento\Framework\Filesystem $filesystem
+    ) {
+        parent::__construct(
+            $context
+        );
+        $this->fileFactory = $fileFactory;
+        $this->resultRawFactory = $resultRawFactory;
+        $this->fileDirectory = $filesystem->getDirectoryWrite(DirectoryList::MODULES);
+    }
+
+    /**
+     * Download sample file action
+     *
+     * @return void|\Magento\Backend\App\Action
+     */
+    public function execute()
+    {
+        $fileName = $this->getRequest()->getParam('filename') . '.csv';
+        $filePath = self::SAMPLE_FILES_DIRECTORY . $fileName;
+
+        if (!$this->fileDirectory->isFile($filePath)) {
+            /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
+            $this->messageManager->addError(__('There is no sample file for this entity.'));
+            $resultRedirect = $this->resultRedirectFactory->create();
+            $resultRedirect->setPath('*/import');
+            return $resultRedirect;
+        }
+
+        $fileSize = isset($this->fileDirectory->stat($filePath)['size'])
+            ? $this->fileDirectory->stat($filePath)['size'] : null;
+
+        $this->fileFactory->create(
+            $fileName,
+            null,
+            DirectoryList::VAR_DIR,
+            'application/octet-stream',
+            $fileSize
+        );
+
+        /** @var \Magento\Framework\Controller\Result\Raw $resultRaw */
+        $resultRaw = $this->resultRawFactory->create();
+        $resultRaw->setContents($this->fileDirectory->readFile($filePath));
+        return $resultRaw;
+    }
+}

pub/advanced_pricing.csv renamed to app/code/Magento/ImportExport/Files/Sample/advanced_pricing.csv

@@ -677,7 +677,7 @@ public function isRowAllowedToImport(array $rowData, $rowNumber)
         return $this->validateRow($rowData, $rowNumber) && !isset($this->_skippedRows[$rowNumber]);
     }
 
-    /*
+    /**
     * Is import need to log in history.
     *
     * @return bool

pub/catalog_product.csv renamed to app/code/Magento/ImportExport/Files/Sample/catalog_product.csv

@@ -35,7 +35,7 @@ require(['jquery', 'prototype'], function(jQuery){
          * Base url
          * @type {string}
          */
-        sampleFilesBaseUrl: '<?php echo $block->getBaseUrl() ?>' + 'pub/',
+        sampleFilesBaseUrl: '<?php echo $block->getUrl('*/*/download/', ['filename' => 'entity-name']) ?>',
 
         /**
          * Reset selected index
@@ -105,7 +105,7 @@ require(['jquery', 'prototype'], function(jQuery){
         showSampleFile: function(entityId) {
             var sampleFileSpan = jQuery('#sample-file-span');
             if (entityId) {
-                var sampleFileLink = this.sampleFilesBaseUrl + entityId + '.csv';
+                var sampleFileLink = this.sampleFilesBaseUrl.replace('entity-name', entityId);
                 jQuery('#sample-file-link').attr('href', sampleFileLink);
                 if (sampleFileSpan.is(':hidden')) {
                     sampleFileSpan.show();