core/lib/Thelia/ImportExport/Import/AbstractImport.php line 56

  1. <?php
  3. /*
  4.  * This file is part of the Thelia package.
  5.  * http://www.thelia.net
  6.  *
  7.  * (c) OpenStudio <info@thelia.net>
  8.  *
  9.  * For the full copyright and license information, please view the LICENSE
  10.  * file that was distributed with this source code.
  11.  */
  13. namespace Thelia\ImportExport\Import;
  15. use Symfony\Component\HttpFoundation\File\File;
  16. use Thelia\Core\Translation\Translator;
  17. use Thelia\Model\Lang;
  19. /**
  20.  * Class AbstractImport.
  21.  *
  22.  * @author Jérôme Billiras <jbilliras@openstudio.fr>
  23.  */
  24. abstract class AbstractImport implements \Iterator
  25. {
  26.     /**
  27.      * @var array
  28.      */
  29.     private $data;
  31.     /**
  32.      * @var \Symfony\Component\HttpFoundation\File\File
  33.      */
  34.     protected $file;
  36.     /**
  37.      * @var \Thelia\Model\Lang A language model
  38.      */
  39.     protected $language;
  41.     /**
  42.      * @var array Mandatory columns
  43.      */
  44.     protected $mandatoryColumns = [];
  46.     /**
  47.      * @var int Imported row count
  48.      */
  49.     protected $importedRows = 0;
  51.     public function current()
  52.     {
  53.         return current($this->data);
  54.     }
  56.     public function key()
  57.     {
  58.         return key($this->data);
  59.     }
  61.     public function next(): void
  62.     {
  63.         next($this->data);
  64.     }
  66.     public function rewind(): void
  67.     {
  68.         reset($this->data);
  69.     }
  71.     public function valid(): bool
  72.     {
  73.         return key($this->data) !== null;
  74.     }
  76.     /**
  77.      * Get data.
  78.      *
  79.      * @return array Parsed data
  80.      */
  81.     public function getData()
  82.     {
  83.         return $this->data;
  84.     }
  86.     /**
  87.      * Set data.
  88.      *
  89.      * @param array $data Parsed data
  90.      *
  91.      * @return $this Return $this, allow chaining
  92.      */
  93.     public function setData(array $data)
  94.     {
  95.         $this->data = $data;
  97.         return $this;
  98.     }
  100.     /**
  101.      * Get file.
  102.      *
  103.      * @return \Symfony\Component\HttpFoundation\File\File
  104.      */
  105.     public function getFile()
  106.     {
  107.         return $this->file;
  108.     }
  110.     /**
  111.      * Set file.
  112.      *
  113.      * @return $this Return $this, allow chaining
  114.      */
  115.     public function setFile(File $file)
  116.     {
  117.         $this->file = $file;
  119.         return $this;
  120.     }
  122.     /**
  123.      * Get language.
  124.      *
  125.      * @return \Thelia\Model\Lang A language model
  126.      */
  127.     public function getLang()
  128.     {
  129.         return $this->language;
  130.     }
  132.     /**
  133.      * Set language.
  134.      *
  135.      * @param \Thelia\Model\Lang|null $language A language model
  136.      *
  137.      * @return $this Return $this, allow chaining
  138.      */
  139.     public function setLang(Lang $language = null)
  140.     {
  141.         $this->language = $language;
  143.         return $this;
  144.     }
  146.     /**
  147.      * Check mandatory columns.
  148.      *
  149.      * @param array $data Data
  150.      *
  151.      * @return bool Data contains mandatory columns or not
  152.      */
  153.     public function checkMandatoryColumns(array $data): void
  154.     {
  155.         $diff = array_diff($this->mandatoryColumns, array_keys($data));
  157.         if (\count($diff) > 0) {
  158.             throw new \UnexpectedValueException(
  159.                 Translator::getInstance()->trans(
  160.                     'The following columns are missing: %columns',
  161.                     [
  162.                         '%columns' => implode(', ', $diff),
  163.                     ]
  164.                 )
  165.             );
  166.         }
  167.     }
  169.     /**
  170.      * Get imported rows.
  171.      *
  172.      * @return int Imported rows count
  173.      */
  174.     public function getImportedRows()
  175.     {
  176.         return $this->importedRows;
  177.     }
  179.     /**
  180.      * Set imported rows.
  181.      *
  182.      * @param int $importedRows Imported rows count
  183.      *
  184.      * @return $this Return $this, allow chaining
  185.      */
  186.     public function setImportedRows($importedRows)
  187.     {
  188.         $this->importedRows = $importedRows;
  190.         return $this;
  191.     }
  193.     /**
  194.      * Import data.
  195.      *
  196.      * @param array $data Data to import
  197.      *
  198.      * @return string|null String with error, null otherwise
  199.      */
  200.     abstract public function importData(array $data);
  201. }