EventDispatchableWorkflow::finish() - Code Metrics - mathielen/import-engine - Measure and Improve Code Quality continuously with Scrutinizer

EventDispatchableWorkflow::finish() A
last analyzed 2021-02-08 13:43 UTC

↳ Parent: EventDispatchableWorkflow

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	5
cts	5
cp	1
rs	9.9332
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	2

<?php

namespace Mathielen\DataImport;

use Ddeboer\DataImport\Result;
use Ddeboer\DataImport\Workflow as OriginalWorkflow;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Mathielen\DataImport\Event\ImportProcessEvent;
use Mathielen\DataImport\Event\ImportItemEvent;
use Ddeboer\DataImport\Exception\ExceptionInterface;

class EventDispatchableWorkflow extends OriginalWorkflow
{
    /**
     * @var EventDispatcherInterface
     */
    private $eventDispatcher;

    public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
    {
        $this->eventDispatcher = $eventDispatcher;
    }

    public function process()
    {
        //if no eventdispatcher has been set, use original functionality
        if (!$this->eventDispatcher) {
            return parent::process();
        }

        $count = 0;
        $exceptions = array();
        $startTime = new \DateTime();
        $importProcessEvent = new ImportProcessEvent();

        //Prepare
        $this->prepare($importProcessEvent);

        // Read all items
        foreach ($this->reader as $item) {
            //only create event once for every item-event for performance reasons
            $event = $importProcessEvent->newItemEvent($item);

            try {
                $this->processRead($item, $event);

                // Apply filters before conversion
                if (!$this->processFilter($item, $event)) {
                    continue;
                }

                // Convert item
                if (!$convertedItem = $this->processConvert($item, $event)) {
                    continue;
                }

                // Apply filters after conversion
                if (!$this->processConvertFilter($convertedItem, $event)) {
                    continue;
                }

                $this->processWrite($convertedItem, $item, $event);
            } catch (ExceptionInterface $e) {
                if ($this->skipItemOnFailure) {
                    $exceptions[] = $e;
                    $this->logger->error($e->getMessage());
                } else {
                    throw $e;
                }
            }

            ++$count;
        }

        //Finish
        $this->finish($importProcessEvent);

        return new Result($this->name, $startTime, new \DateTime(), $count, $exceptions);
    }

    private function prepare(ImportProcessEvent $importProcessEvent)
    {
        //Prepare writers
        foreach ($this->writers as $writer) {
            $writer->prepare();
        }

        //Send global event
        $this->eventDispatcher->dispatch(ImportProcessEvent::AFTER_PREPARE, $importProcessEvent);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    private function finish(ImportProcessEvent $importProcessEvent)
    {
        // Finish writers
        foreach ($this->writers as $writer) {
            $writer->finish();
        }

        //Send global event
        $this->eventDispatcher->dispatch(ImportProcessEvent::AFTER_FINISH, $importProcessEvent);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    protected function processRead(array $item, ImportItemEvent $event)
    {
        $this->eventDispatcher->dispatch(ImportItemEvent::AFTER_READ, $event);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    protected function processFilter(array $item, ImportItemEvent $event)

    {
        $filterResult = $this->filterItem($item, $this->filters);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        $this->eventDispatcher->dispatch(ImportItemEvent::AFTER_FILTER, $event->setCurrentResult($filterResult));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $filterResult;
    }

    protected function processConvert(array $item, ImportItemEvent $event)
    {
        $convertedItem = $this->convertItem($item);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->eventDispatcher->dispatch(ImportItemEvent::AFTER_FILTER, $event->setCurrentResult($convertedItem));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $convertedItem;
    }

    protected function processConvertFilter(array $item, ImportItemEvent $event)

    {
        $filterResult = $this->filterItem($item, $this->afterConversionFilters);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

        $this->eventDispatcher->dispatch(ImportItemEvent::AFTER_CONVERSIONFILTER, $event->setCurrentResult($filterResult));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $filterResult;
    }

    protected function processWrite(array $convertedItem, array $item, ImportItemEvent $event)
    {
        foreach ($this->writers as $writer) {
            $writer->writeItem($convertedItem, $item);
        }

        $this->eventDispatcher->dispatch(ImportItemEvent::AFTER_WRITE, $event);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
}


1			<?php
2
3			namespace Mathielen\DataImport;
4
5			use Ddeboer\DataImport\Result;
6			use Ddeboer\DataImport\Workflow as OriginalWorkflow;
7			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
8			use Mathielen\DataImport\Event\ImportProcessEvent;
9			use Mathielen\DataImport\Event\ImportItemEvent;
10			use Ddeboer\DataImport\Exception\ExceptionInterface;
11
12			class EventDispatchableWorkflow extends OriginalWorkflow
13			{
14			/**
15			* @var EventDispatcherInterface
16			*/
17			private $eventDispatcher;
18
19	14		public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
20			{
21	14		$this->eventDispatcher = $eventDispatcher;
22	14		}
23
24	14		public function process()
25			{
26			//if no eventdispatcher has been set, use original functionality
27	14		if (!$this->eventDispatcher) {
28			return parent::process();
29			}
30
31	14		$count = 0;
32	14		$exceptions = array();
33	14		$startTime = new \DateTime();
34	14		$importProcessEvent = new ImportProcessEvent();
35
36			//Prepare
37	14		$this->prepare($importProcessEvent);
38
39			// Read all items
40	14		foreach ($this->reader as $item) {
41			//only create event once for every item-event for performance reasons
42	14		$event = $importProcessEvent->newItemEvent($item);
43
44			try {
45	14		$this->processRead($item, $event);
46
47			// Apply filters before conversion
48	14		if (!$this->processFilter($item, $event)) {
49	2		continue;
50			}
51
52			// Convert item
53	13		if (!$convertedItem = $this->processConvert($item, $event)) {
54			continue;
55			}
56
57			// Apply filters after conversion
58	13		if (!$this->processConvertFilter($convertedItem, $event)) {
59			continue;
60			}
61
62	13		$this->processWrite($convertedItem, $item, $event);
63			} catch (ExceptionInterface $e) {
64			if ($this->skipItemOnFailure) {
65			$exceptions[] = $e;
66			$this->logger->error($e->getMessage());
67			} else {
68			throw $e;
69			}
70			}
71
72	13		++$count;
73			}
74
75			//Finish
76	14		$this->finish($importProcessEvent);
77
78	14		return new Result($this->name, $startTime, new \DateTime(), $count, $exceptions);
79			}
80
81	14		private function prepare(ImportProcessEvent $importProcessEvent)
82			{
83			//Prepare writers
84	14		foreach ($this->writers as $writer) {
85	12		$writer->prepare();
86			}
87
88			//Send global event
89	14		$this->eventDispatcher->dispatch(ImportProcessEvent::AFTER_PREPARE, $importProcessEvent);
			0 ignored issues – show Documentation introduced 2020-11-09 10:22 UTC by Report Bug Copy Issue Report `$importProcessEvent` is of type `object<Mathielen\DataImp...ent\ImportProcessEvent>`, but the function expects a `null\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
90	14		}
91
92	14		private function finish(ImportProcessEvent $importProcessEvent)
93			{
94			// Finish writers
95	14		foreach ($this->writers as $writer) {
96	12		$writer->finish();
97			}
98
99			//Send global event
100	14		$this->eventDispatcher->dispatch(ImportProcessEvent::AFTER_FINISH, $importProcessEvent);
			0 ignored issues – show Documentation introduced 2020-11-09 10:22 UTC by Report Bug Copy Issue Report `$importProcessEvent` is of type `object<Mathielen\DataImp...ent\ImportProcessEvent>`, but the function expects a `null\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
101	14		}
102
103	14		protected function processRead(array $item, ImportItemEvent $event)
104			{
105	14		$this->eventDispatcher->dispatch(ImportItemEvent::AFTER_READ, $event);
			0 ignored issues – show Documentation introduced 2020-11-09 10:22 UTC by Report Bug Copy Issue Report `$event` is of type `object<Mathielen\DataImp...\Event\ImportItemEvent>`, but the function expects a `null\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
106	14		}
107
108	14	View Code Duplication	protected function processFilter(array $item, ImportItemEvent $event)
			0 ignored issues – show Duplication introduced 2017-11-25 00:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
109			{
110	14		$filterResult = $this->filterItem($item, $this->filters);
			0 ignored issues – show Bug introduced 2015-12-08 09:18 UTC by Report Bug Copy Issue Report It seems like `$this->filters` can also be of type `array<integer,object<Dde...ilter\FilterInterface>>`; however, `Ddeboer\DataImport\Workflow::filterItem()` does only seem to accept `object<SplPriorityQueue>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
111
112	14		$this->eventDispatcher->dispatch(ImportItemEvent::AFTER_FILTER, $event->setCurrentResult($filterResult));
			0 ignored issues – show Documentation introduced 2020-11-09 10:22 UTC by Report Bug Copy Issue Report `$event->setCurrentResult($filterResult)` is of type `object<Mathielen\DataImp...\Event\ImportItemEvent>`, but the function expects a `null\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
113
114	14		return $filterResult;
115			}
116
117	13		protected function processConvert(array $item, ImportItemEvent $event)
118			{
119	13		$convertedItem = $this->convertItem($item);
			0 ignored issues – show Documentation introduced 2015-12-08 09:18 UTC by Report Bug Copy Issue Report `$item` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
120
121	13		$this->eventDispatcher->dispatch(ImportItemEvent::AFTER_FILTER, $event->setCurrentResult($convertedItem));
			0 ignored issues – show Documentation introduced 2020-11-09 10:22 UTC by Report Bug Copy Issue Report `$event->setCurrentResult($convertedItem)` is of type `object<Mathielen\DataImp...\Event\ImportItemEvent>`, but the function expects a `null\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
122
123	13		return $convertedItem;
124			}
125
126	13	View Code Duplication	protected function processConvertFilter(array $item, ImportItemEvent $event)
			0 ignored issues – show Duplication introduced 2017-11-25 00:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
127			{
128	13		$filterResult = $this->filterItem($item, $this->afterConversionFilters);
			0 ignored issues – show Bug introduced 2015-12-08 09:18 UTC by Report Bug Copy Issue Report It seems like `$this->afterConversionFilters` can also be of type `array<integer,object<Dde...ilter\FilterInterface>>`; however, `Ddeboer\DataImport\Workflow::filterItem()` does only seem to accept `object<SplPriorityQueue>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
129
130	13		$this->eventDispatcher->dispatch(ImportItemEvent::AFTER_CONVERSIONFILTER, $event->setCurrentResult($filterResult));
			0 ignored issues – show Documentation introduced 2020-11-09 10:22 UTC by Report Bug Copy Issue Report `$event->setCurrentResult($filterResult)` is of type `object<Mathielen\DataImp...\Event\ImportItemEvent>`, but the function expects a `null\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
131
132	13		return $filterResult;
133			}
134
135	13		protected function processWrite(array $convertedItem, array $item, ImportItemEvent $event)
136			{
137	13		foreach ($this->writers as $writer) {
138	12		$writer->writeItem($convertedItem, $item);
139			}
140
141	13		$this->eventDispatcher->dispatch(ImportItemEvent::AFTER_WRITE, $event);
			0 ignored issues – show Documentation introduced 2020-11-09 10:22 UTC by Report Bug Copy Issue Report `$event` is of type `object<Mathielen\DataImp...\Event\ImportItemEvent>`, but the function expects a `null\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
142	13		}
143			}
144

mathielen / import-engine

EventDispatchableWorkflow::finish() A last analyzed 2021-02-08 13:43 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

EventDispatchableWorkflow::finish() A
last analyzed 2021-02-08 13:43 UTC