Commit 0f755ee6 authored by Chhengleap Soem's avatar Chhengleap Soem
Browse files

Merge branch 'KIME-4583' into 'master'

Refactoring and Documentation



See merge request !14
parents ce2edd20 9af7082e
Loading
Loading
Loading
Loading
+1 −1
Changes for Classes/WE/SpreadsheetImport/Annotations/Mapping.php: 1 added line, 1 removed line.
Original line number Original line Diff line number Diff line
@@ -12,7 +12,7 @@ namespace WE\SpreadsheetImport\Annotations;
 *                                                                        */
 *                                                                        */


/**
/**
 * Defines the column mapping for a property
 * Annotation to define the column mapping for a property
 *
 *
 * @Annotation
 * @Annotation
 * @Target({"PROPERTY"})
 * @Target({"PROPERTY"})
+8 −8
Changes for Classes/WE/SpreadsheetImport/Command/SpreadsheetImportCommandController.php: 8 added lines, 8 removed lines.
Original line number Original line Diff line number Diff line
@@ -46,12 +46,12 @@ class SpreadsheetImportCommandController extends CommandController {
	protected $settings;
	protected $settings;


	/**
	/**
	 * Import one pending queued spreadsheet into Domain data, and it will import the next one if it is done
	 * Import next queued spreadsheets into domain objects asynchronously.
	 */
	 */
	public function importCommand() {
	public function importCommand() {
		$currentImportingCount = $this->spreadsheetImportRepository->countByImportingStatus(SpreadsheetImport::IMPORTING_STATUS_IN_PROGRESS);
		$currentImportingCount = $this->spreadsheetImportRepository->countByImportingStatus(SpreadsheetImport::IMPORTING_STATUS_IN_PROGRESS);
		if ($currentImportingCount > 0) {
		if ($currentImportingCount > 0) {
			$this->outputFormatted('There is a progressing importing spreadsheet.');
			$this->outputFormatted('Previous spreadsheet import is still in progress.');
			$this->quit();
			$this->quit();
		}
		}
		/** @var SpreadsheetImport $spreadsheetImport */
		/** @var SpreadsheetImport $spreadsheetImport */
@@ -67,25 +67,25 @@ class SpreadsheetImportCommandController extends CommandController {
			try {
			try {
				$this->spreadsheetImportService->import();
				$this->spreadsheetImportService->import();
				$spreadsheetImport->setImportingStatus(SpreadsheetImport::IMPORTING_STATUS_COMPLETED);
				$spreadsheetImport->setImportingStatus(SpreadsheetImport::IMPORTING_STATUS_COMPLETED);
				$this->outputFormatted('Spreadsheet has been imported. (totalInserted: %d, totalUpdated: %d, totalDeleted: %d, totalSkipped: %d)',
				$this->outputFormatted('Spreadsheet has been imported. %d inserted, %d updated, %d deleted, %d skipped',
					array($spreadsheetImport->getTotalInserted(), $spreadsheetImport->getTotalUpdated(), $spreadsheetImport->getTotalDeleted(), $spreadsheetImport->getTotalSkipped()));
					array($spreadsheetImport->getTotalInserted(), $spreadsheetImport->getTotalUpdated(), $spreadsheetImport->getTotalDeleted(), $spreadsheetImport->getTotalSkipped()));
			} catch (Exception $e) {
			} catch (Exception $e) {
				$spreadsheetImport->setImportingStatus(SpreadsheetImport::IMPORTING_STATUS_FAILED);
				$spreadsheetImport->setImportingStatus(SpreadsheetImport::IMPORTING_STATUS_FAILED);
				$this->outputFormatted('Spreadsheet imported failed.');
				$this->outputFormatted('Spreadsheet import failed.');
			}
			}
			$this->spreadsheetImportRepository->update($spreadsheetImport);
			$this->spreadsheetImportRepository->update($spreadsheetImport);
		} else {
		} else {
			$this->outputFormatted('There is no spreadsheet importing in queue.');
			$this->outputFormatted('No spreadsheet import in queue.');
		}
		}
	}
	}


	/**
	/**
	 * Cleanup previous spreadsheet imports by specific time (defined by settings)
	 * Cleanup previous spreadsheet imports. Threashold defined in settings.
	 */
	 */
	public function cleanupCommand() {
	public function cleanupCommand() {
		$cleanupImportFromPreviousDay = $this->settings['cleanupImportFromPreviousDay'];
		$cleanupImportsThreasholdDays = intval($this->settings['cleanupImportsThreasholdDays']);
		$cleanupFromDate = new \DateTime();
		$cleanupFromDate = new \DateTime();
		$cleanupFromDate->sub(new \DateInterval('P' . $cleanupImportFromPreviousDay . 'D'));
		$cleanupFromDate->sub(new \DateInterval('P' . $cleanupImportsThreasholdDays . 'D'));
		$oldSpreadsheetImports = $this->spreadsheetImportRepository->findPreviousImportsBySpecificDate($cleanupFromDate);
		$oldSpreadsheetImports = $this->spreadsheetImportRepository->findPreviousImportsBySpecificDate($cleanupFromDate);
		if ($oldSpreadsheetImports->count() > 0) {
		if ($oldSpreadsheetImports->count() > 0) {
			/** @var SpreadsheetImport $oldSpreadsheetImport */
			/** @var SpreadsheetImport $oldSpreadsheetImport */
+187 −0
Changes for Classes/WE/SpreadsheetImport/Controller/SpreadsheetImportController.php: 187 added lines, 0 removed lines.
Original line number Original line Diff line number Diff line
<?php
namespace WE\SpreadsheetImport\Controller;

/*                                                                        *
 * This script belongs to the Flow package "SpreadsheetImport".           *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 * of the License, or (at your option) any later version.                 *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

use TYPO3\Flow\Annotations as Flow;
use TYPO3\Flow\Mvc\Controller\ActionController;
use WE\SpreadsheetImport\Domain\Model\SpreadsheetImport;

/**
 * Controller for default import. This controller might be overwritten for the import of different domains.
 */
class SpreadsheetImportController extends ActionController {

	/**
	 * @var string
	 */
	protected $context = 'default';

	/**
	 * @Flow\Inject
	 * @var \WE\SpreadsheetImport\Domain\Repository\SpreadsheetImportRepository
	 */
	protected $spreadsheetImportRepository;

	/**
	 * @Flow\Inject
	 * @var \WE\SpreadsheetImport\SpreadsheetImportService
	 */
	protected $spreadsheetImportService;

	/**
	 * @Flow\Inject
	 * @var \WE\SpreadsheetImport\FrontendMappingService
	 */
	protected $frontendMappingService;

	/**
	 * Initialize create action
	 */
	protected function initializeCreateAction() {
		$this->arguments['newSpreadsheetImport']->getPropertyMappingConfiguration()->forProperty('scheduleDate')
			->setTypeConverterOption('TYPO3\Flow\Property\TypeConverter\DateTimeConverter', \TYPO3\Flow\Property\TypeConverter\DateTimeConverter::CONFIGURATION_DATE_FORMAT, 'd.m.Y');
	}

	/**
	 * New action with context set statically
	 */
	public function newAction() {
		$arguments = $this->frontendMappingService->getContextArgumentsForRequest($this->context, $this->request);
		$spreadsheetImports = $this->spreadsheetImportRepository->findByContextAndArguments($this->context, $arguments);
		$this->view->assign('spreadsheetImports', $spreadsheetImports);
		$this->view->assign('arguments', serialize($arguments));
		$this->view->assign('context', $this->context);
	}

	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $newSpreadsheetImport
	 */
	public function createAction(SpreadsheetImport $newSpreadsheetImport) {
		$formArguments = $this->request->getArguments();
		$this->setScheduleDateTime($newSpreadsheetImport, $formArguments['scheduleTime']);
		$this->setImportAction($newSpreadsheetImport, (int)$formArguments['action']);
		$this->spreadsheetImportService->init($newSpreadsheetImport);
		$mappingProperties = $this->spreadsheetImportService->getAnnotationMappingProperties();
		$mappings = $this->frontendMappingService->getSpreadsheetImportMapping($mappingProperties);
		$newSpreadsheetImport->setMapping($mappings);
		$this->spreadsheetImportRepository->add($newSpreadsheetImport);
		$this->redirect('mapping', NULL, NULL, array('spreadsheetImport' => $newSpreadsheetImport));
	}

	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 */
	public function mappingAction(SpreadsheetImport $spreadsheetImport) {
		$this->spreadsheetImportService->init($spreadsheetImport);
		$spreadsheetColumns = $this->spreadsheetImportService->getSpreadsheetColumns();
		$this->view->assign('spreadsheetColumns', $spreadsheetColumns);
		$this->view->assign('domainMappingProperties', $spreadsheetImport->getMapping());
		$this->view->assign('spreadsheetImport', $spreadsheetImport);
	}

	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 */
	public function mapAction(SpreadsheetImport $spreadsheetImport) {
		if ($spreadsheetImport->getImportingStatus() === SpreadsheetImport::IMPORTING_STATUS_DRAFT) {
			$this->spreadsheetImportService->init($spreadsheetImport);
			$mappingProperties = $this->spreadsheetImportService->getAnnotationMappingProperties();
			$requestArguments = $this->request->getArguments();
			$mappings = $this->frontendMappingService->getSpreadsheetImportMapping($mappingProperties, $requestArguments);
			$spreadsheetImport->setMapping($mappings);
			$this->spreadsheetImportRepository->update($spreadsheetImport);
		}
		$this->redirect('preview', NULL, NULL, array('spreadsheetImport' => $spreadsheetImport));
	}

	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 * @param int $record
	 */
	public function previewAction(SpreadsheetImport $spreadsheetImport, $record = 1) {
		$this->spreadsheetImportService->init($spreadsheetImport);
		$preview = $this->frontendMappingService->getMappingPreview($spreadsheetImport, $record);
		$total = $this->spreadsheetImportService->getTotalRecords();
		$this->view->assign('preview', $preview['preview']);
		$this->view->assign('record', $record);
		$this->view->assign('previous', $record - 1);
		$this->view->assign('next', $record + 1);
		$this->view->assign('total', $total);
		$this->view->assign('hasErrors', $preview['hasErrors']);
		$this->view->assign('spreadsheetImport', $spreadsheetImport);
	}

	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 */
	public function confirmAction(SpreadsheetImport $spreadsheetImport) {
		$arguments = $spreadsheetImport->getArguments();
		if ($spreadsheetImport->getImportingStatus() === SpreadsheetImport::IMPORTING_STATUS_DRAFT) {
			$spreadsheetImport->setImportingStatus(SpreadsheetImport::IMPORTING_STATUS_IN_QUEUE);
			$this->spreadsheetImportRepository->update($spreadsheetImport);
		}
		$this->redirect('new', NULL, NULL, $arguments);
	}

	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 */
	public function cancelAction(SpreadsheetImport $spreadsheetImport) {
		$arguments = $spreadsheetImport->getArguments();
		if ($spreadsheetImport->getImportingStatus() === SpreadsheetImport::IMPORTING_STATUS_DRAFT) {
			$this->spreadsheetImportRepository->remove($spreadsheetImport);
			$this->persistenceManager->persistAll();
		}
		$this->redirect('new', NULL, NULL, $arguments);
	}

	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 */
	public function deleteAction(SpreadsheetImport $spreadsheetImport) {
		$arguments = $spreadsheetImport->getArguments();
		if ($spreadsheetImport->getImportingStatus() <= SpreadsheetImport::IMPORTING_STATUS_IN_QUEUE) {
			$this->spreadsheetImportRepository->remove($spreadsheetImport);
		}
		$this->redirect('new', NULL, NULL, $arguments);
	}

	/**
	 * @param SpreadsheetImport $spreadsheetImport
	 * @param                   $time
	 */
	private function setScheduleDateTime(SpreadsheetImport $spreadsheetImport, $time) {
		$date = $spreadsheetImport->getScheduleDate();
		$times = explode(':', $time);
		$hour = isset($times[0]) ? $times[0] : 0;
		$minute = isset($times[1]) ? $times[1] : 0;
		$date->setTime($hour, $minute);
		$spreadsheetImport->setScheduleDate($date);
	}

	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 * @param int $action
	 */
	private function setImportAction(SpreadsheetImport $spreadsheetImport, $action = 1) {
		if ($action >= 1) {
			$spreadsheetImport->setInserting(TRUE);
		}
		if ($action >= 2) {
			$spreadsheetImport->setUpdating(TRUE);
		}
		if ($action >= 3) {
			$spreadsheetImport->setDeleting(TRUE);
		}
	}

}
+3 −20
Changes for Classes/WE/SpreadsheetImport/Exception/Exception.php: 3 added lines, 20 removed lines.
Original line number Original line Diff line number Diff line
<?php
<?php
namespace WE\SpreadsheetImport\Domain\Model;
namespace WE\SpreadsheetImport\Exception;


/*                                                                        *
/*                                                                        *
 * This script belongs to the Flow package "SpreadsheetImport".           *
 * This script belongs to the Flow package "SpreadsheetImport".           *
@@ -11,25 +11,8 @@ namespace WE\SpreadsheetImport\Domain\Model;
 * The TYPO3 project - inspiring people to share!                         *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */
 *                                                                        */


interface SpreadsheetImportTargetInterface {

	/**
	 * @param boolean $updated
	 *
	 * @return void
	 */
	public function setUpdated($updated);

/**
/**
	 * @param \DateTime $lastUpdated
 * Generic SpreadsheetImport Exception
	 *
	 * @return void
 */
 */
	public function isUpdated($lastUpdated);
class Exception extends \TYPO3\Flow\Exception  {

	/**
	 * @return array
	 */
	public static function getAdditionalProperties();

}
}
+12 −2
Changes for Classes/WE/SpreadsheetImport/FrontendMappingService.php: 12 added lines, 2 removed lines.
Original line number Original line Diff line number Diff line
@@ -15,6 +15,7 @@ use TYPO3\Flow\Annotations as Flow;
use TYPO3\Flow\Mvc\ActionRequest;
use TYPO3\Flow\Mvc\ActionRequest;
use WE\SpreadsheetImport\Annotations\Mapping;
use WE\SpreadsheetImport\Annotations\Mapping;
use WE\SpreadsheetImport\Domain\Model\SpreadsheetImport;
use WE\SpreadsheetImport\Domain\Model\SpreadsheetImport;
use WE\SpreadsheetImport\Exception\Exception;


/**
/**
 * Service class of basic FE mapping functionality for simple usage on separate implementations.
 * Service class of basic FE mapping functionality for simple usage on separate implementations.
@@ -57,10 +58,14 @@ class FrontendMappingService {
	 * @param string $context
	 * @param string $context
	 * @param \TYPO3\Flow\Mvc\ActionRequest $request
	 * @param \TYPO3\Flow\Mvc\ActionRequest $request
	 *
	 *
	 * @throws \WE\SpreadsheetImport\Exception\Exception
	 * @return array
	 * @return array
	 */
	 */
	public function getContextArgumentsForRequest($context, ActionRequest $request) {
	public function getContextArgumentsForRequest($context, ActionRequest $request) {
		$arguments = array();
		$arguments = array();
		if (! isset($this->settings[$context]) || ! isset($this->settings[$context]['arguments'])) {
			throw new Exception('Context with arguments needs to be configured in the Settings', 1478069710);
		}
		$contextArguments = $this->settings[$context]['arguments'];
		$contextArguments = $this->settings[$context]['arguments'];
		if (is_array($contextArguments)) {
		if (is_array($contextArguments)) {
			foreach ($contextArguments as $contextArgument) {
			foreach ($contextArguments as $contextArgument) {
@@ -101,13 +106,18 @@ class FrontendMappingService {


	/**
	/**
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 * @param \WE\SpreadsheetImport\Domain\Model\SpreadsheetImport $spreadsheetImport
	 * @param $record
	 * @param int $record
	 *
	 *
	 * @throws \WE\SpreadsheetImport\Exception\Exception
	 * @return array
	 * @return array
	 */
	 */
	public function getMappingPreview(SpreadsheetImport $spreadsheetImport, $record) {
	public function getMappingPreview(SpreadsheetImport $spreadsheetImport, $record) {
		$mapping = $spreadsheetImport->getMapping();
		$mapping = $spreadsheetImport->getMapping();
		$domain = $this->settings[$spreadsheetImport->getContext()]['domain'];
		$context = $spreadsheetImport->getContext();
		if (! isset($this->settings[$context]) || ! isset($this->settings[$context]['arguments'])) {
			throw new Exception('Context with arguments needs to be configured in the Settings', 1478069743);
		}
		$domain = $this->settings[$context]['domain'];
		$record = max($record, 1);
		$record = max($record, 1);
		$previewObject = $this->spreadsheetImportService->getObjectByRow($record);
		$previewObject = $this->spreadsheetImportService->getObjectByRow($record);
		$preview = array();
		$preview = array();
Loading