CronJob::exportDynamicStreams() - Code Metrics - Inspection of "[WIP] CON-4687" - shopware/SwagConnect - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#358)

by Simon

created 2017-08-17 07:59 UTC

CronJob::exportDynamicStreams() B

↳ Parent: CronJob

Complexity

Conditions	7
Paths	35

Size

Total Lines	65
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	65
rs	7.1439
c	0
b	0
f	0
cc	7
eloc	36
nc	35
nop	1

How to fix Long Method

<?php
/**
 * (c) shopware AG <[email protected]>
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ShopwarePlugins\Connect\Subscribers;

use Enlight\Event\SubscriberInterface;
use Shopware\Connect\SDK;
use Shopware\CustomModels\Connect\Attribute;
use Shopware\Models\ProductStream\ProductStream;
use ShopwarePlugins\Connect\Components\Config;
use ShopwarePlugins\Connect\Components\ErrorHandler;
use ShopwarePlugins\Connect\Components\Helper;
use ShopwarePlugins\Connect\Components\ImageImport;
use ShopwarePlugins\Connect\Components\Logger;
use ShopwarePlugins\Connect\Components\ConnectExport;
use ShopwarePlugins\Connect\Components\ProductStream\ProductStreamService;

class CronJob implements SubscriberInterface
{
    /**
     * @var \ShopwarePlugins\Connect\Components\Config
     */
    private $configComponent;

    /**
     * @var SDK
     */
    protected $sdk;

    /**
     * @var ProductStreamService
     */
    protected $streamService;

    /**
     * @var ConnectExport
     */
    protected $connectExport;

    /**
     * @var Helper
     */
    private $helper;

    /**
     * @param SDK $sdk
     * @param ConnectExport $connectExport
     * @param Config $configComponent
     */
    public function __construct(
        SDK $sdk,
        ConnectExport $connectExport,
        Config $configComponent,
        Helper $helper
    ) {
        $this->connectExport = $connectExport;
        $this->sdk = $sdk;
        $this->configComponent = $configComponent;
        $this->helper = $helper;
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [
            'Shopware_CronJob_ShopwareConnectImportImages' => 'importImages',
            'Shopware_CronJob_ShopwareConnectUpdateProducts' => 'updateProducts',
            'Shopware_CronJob_ConnectExportDynamicStreams' => 'exportDynamicStreams',
        ];
    }

    /**
     * @return ImageImport
     */
    public function getImageImport()
    {
        return new ImageImport(
            Shopware()->Models(),
            $this->helper,
            Shopware()->Container()->get('thumbnail_manager'),
            new Logger(Shopware()->Db())
        );
    }

    /**
     * Import images of new products
     *
     * @param \Shopware_Components_Cron_CronJob $job
     * @return bool
     */
    public function importImages(\Shopware_Components_Cron_CronJob $job)
    {
        $limit = $this->configComponent->getConfig('articleImagesLimitImport', 10);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $this->getImageImport()->import($limit);

        return true;
    }

    /**
     * Collect all own products and send them
     * to Connect system.
     *
     * Used to update products with many variants.
     *
     * @param \Shopware_Components_Cron_CronJob $job
     * @return bool
     */
    public function updateProducts(\Shopware_Components_Cron_CronJob $job)
    {
        $sourceIds = Shopware()->Db()->fetchCol(
            'SELECT source_id FROM s_plugin_connect_items WHERE shop_id IS NULL AND cron_update = 1 LIMIT 100'
        );

        if (empty($sourceIds)) {
            return true;
        }

        $this->connectExport->export($sourceIds);

        $quotedSourceIds = Shopware()->Db()->quote($sourceIds);
        Shopware()->Db()->query("
            UPDATE s_plugin_connect_items
            SET cron_update = false
            WHERE source_id IN ($quotedSourceIds)"
        )->execute();

        return true;
    }

    /**
     * @param \Shopware_Components_Cron_CronJob $job
     */
    public function exportDynamicStreams(\Shopware_Components_Cron_CronJob $job)
    {
        /** @var ProductStreamService $streamService */
        $streamService = $this->getStreamService();
        $streams = $streamService->getAllExportedStreams(ProductStreamService::DYNAMIC_STREAM);

        /** @var ProductStream $stream */
        foreach ($streams as $stream) {
            $streamId = $stream->getId();
            $productSearchResult = $streamService->getProductFromConditionStream($stream);
            $orderNumbers = array_keys($productSearchResult->getProducts());

            //no products found
            if (!$orderNumbers) {

                //removes all products from this stream
                $streamService->markProductsToBeRemovedFromStream($streamId);
            } else {
                $articleIds = $this->helper->getArticleIdsByNumber($orderNumbers);

                $streamService->markProductsToBeRemovedFromStream($streamId);
                $streamService->createStreamRelation($streamId, $articleIds);
            }

            try {
                $streamsAssignments = $streamService->prepareStreamsAssignments($streamId, false);

                //article ids must be taken from streamsAssignments
                $exportArticleIds = $streamsAssignments->getArticleIds();

                $removeArticleIds = $streamsAssignments->getArticleIdsWithoutStreams();

                if (!empty($removeArticleIds)) {
                    $this->removeArticlesFromStream($removeArticleIds);

                    //filter the $exportArticleIds
                    $exportArticleIds = array_diff($exportArticleIds, $removeArticleIds);
                }

                $sourceIds = $this->helper->getArticleSourceIds($exportArticleIds);

                $errorMessages = $this->connectExport->export($sourceIds, $streamsAssignments);
                $streamService->changeStatus($streamId, ProductStreamService::STATUS_EXPORT);
            } catch (\RuntimeException $e) {
                $streamService->changeStatus($streamId, ProductStreamService::STATUS_ERROR);
                $streamService->log($streamId, $e->getMessage());
                continue;
            }

            if ($errorMessages) {

                $streamService->changeStatus($streamId, ProductStreamService::STATUS_ERROR);

                $errorMessagesText = '';
                $displayedErrorTypes = [
                    ErrorHandler::TYPE_DEFAULT_ERROR,
                    ErrorHandler::TYPE_PRICE_ERROR
                ];

                foreach ($displayedErrorTypes as $displayedErrorType) {
                    $errorMessagesText .= implode('\n', $errorMessages[$displayedErrorType]);
                }

                $streamService->log($streamId, $errorMessagesText);
            }
        }
    }

    /**
     * If article is not taking part of any shopware stream it will be removed
     * @param array $articleIds
     */
    private function removeArticlesFromStream(array $articleIds)
    {
        $sourceIds = $this->helper->getArticleSourceIds($articleIds);
        $items = $this->connectExport->fetchConnectItems($sourceIds, false);

        foreach ($items as $item) {
            $this->sdk->recordDelete($item['sourceId']);
        }

        $this->getStreamService()->removeMarkedStreamRelations();
        $this->connectExport->updateConnectItemsStatus($sourceIds, Attribute::STATUS_DELETE);
    }

    /**
     * @return ProductStreamService $streamService
     */
    private function getStreamService()
    {
        if (!$this->streamService) {
            $this->streamService = Shopware()->Container()->get('swagconnect.product_stream_service');
        }

        return $this->streamService;
    }
}


1			<?php
2			/**
3			* (c) shopware AG <[email protected]>
4			* For the full copyright and license information, please view the LICENSE
5			* file that was distributed with this source code.
6			*/
7
8			namespace ShopwarePlugins\Connect\Subscribers;
9
10			use Enlight\Event\SubscriberInterface;
11			use Shopware\Connect\SDK;
12			use Shopware\CustomModels\Connect\Attribute;
13			use Shopware\Models\ProductStream\ProductStream;
14			use ShopwarePlugins\Connect\Components\Config;
15			use ShopwarePlugins\Connect\Components\ErrorHandler;
16			use ShopwarePlugins\Connect\Components\Helper;
17			use ShopwarePlugins\Connect\Components\ImageImport;
18			use ShopwarePlugins\Connect\Components\Logger;
19			use ShopwarePlugins\Connect\Components\ConnectExport;
20			use ShopwarePlugins\Connect\Components\ProductStream\ProductStreamService;
21
22			class CronJob implements SubscriberInterface
23			{
24			/**
25			* @var \ShopwarePlugins\Connect\Components\Config
26			*/
27			private $configComponent;
28
29			/**
30			* @var SDK
31			*/
32			protected $sdk;
33
34			/**
35			* @var ProductStreamService
36			*/
37			protected $streamService;
38
39			/**
40			* @var ConnectExport
41			*/
42			protected $connectExport;
43
44			/**
45			* @var Helper
46			*/
47			private $helper;
48
49			/**
50			* @param SDK $sdk
51			* @param ConnectExport $connectExport
52			* @param Config $configComponent
53			*/
54			public function __construct(
55			SDK $sdk,
56			ConnectExport $connectExport,
57			Config $configComponent,
58			Helper $helper
59			) {
60			$this->connectExport = $connectExport;
61			$this->sdk = $sdk;
62			$this->configComponent = $configComponent;
63			$this->helper = $helper;
64			}
65
66			/**
67			* {@inheritdoc}
68			*/
69			public static function getSubscribedEvents()
70			{
71			return [
72			'Shopware_CronJob_ShopwareConnectImportImages' => 'importImages',
73			'Shopware_CronJob_ShopwareConnectUpdateProducts' => 'updateProducts',
74			'Shopware_CronJob_ConnectExportDynamicStreams' => 'exportDynamicStreams',
75			];
76			}
77
78			/**
79			* @return ImageImport
80			*/
81			public function getImageImport()
82			{
83			return new ImageImport(
84			Shopware()->Models(),
85			$this->helper,
86			Shopware()->Container()->get('thumbnail_manager'),
87			new Logger(Shopware()->Db())
88			);
89			}
90
91			/**
92			* Import images of new products
93			*
94			* @param \Shopware_Components_Cron_CronJob $job
95			* @return bool
96			*/
97			public function importImages(\Shopware_Components_Cron_CronJob $job)
98			{
99			$limit = $this->configComponent->getConfig('articleImagesLimitImport', 10);
			0 ignored issues – show Bug introduced 2017-08-17 08:04 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$limit` is correct as `$this->configComponent->...ImagesLimitImport', 10)` (which targets `ShopwarePlugins\Connect\...nts\Config::getConfig()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
100			$this->getImageImport()->import($limit);
101
102			return true;
103			}
104
105			/**
106			* Collect all own products and send them
107			* to Connect system.
108			*
109			* Used to update products with many variants.
110			*
111			* @param \Shopware_Components_Cron_CronJob $job
112			* @return bool
113			*/
114			public function updateProducts(\Shopware_Components_Cron_CronJob $job)
115			{
116			$sourceIds = Shopware()->Db()->fetchCol(
117			'SELECT source_id FROM s_plugin_connect_items WHERE shop_id IS NULL AND cron_update = 1 LIMIT 100'
118			);
119
120			if (empty($sourceIds)) {
121			return true;
122			}
123
124			$this->connectExport->export($sourceIds);
125
126			$quotedSourceIds = Shopware()->Db()->quote($sourceIds);
127			Shopware()->Db()->query("
128			UPDATE s_plugin_connect_items
129			SET cron_update = false
130			WHERE source_id IN ($quotedSourceIds)"
131			)->execute();
132
133			return true;
134			}
135
136			/**
137			* @param \Shopware_Components_Cron_CronJob $job
138			*/
139			public function exportDynamicStreams(\Shopware_Components_Cron_CronJob $job)
140			{
141			/** @var ProductStreamService $streamService */
142			$streamService = $this->getStreamService();
143			$streams = $streamService->getAllExportedStreams(ProductStreamService::DYNAMIC_STREAM);
144
145			/** @var ProductStream $stream */
146			foreach ($streams as $stream) {
147			$streamId = $stream->getId();
148			$productSearchResult = $streamService->getProductFromConditionStream($stream);
149			$orderNumbers = array_keys($productSearchResult->getProducts());
150
151			//no products found
152			if (!$orderNumbers) {
			0 ignored issues – show Bug Best Practice introduced 2017-06-21 11:52 UTC by Report Bug Copy Issue Report The expression `$orderNumbers` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
153			//removes all products from this stream
154			$streamService->markProductsToBeRemovedFromStream($streamId);
155			} else {
156			$articleIds = $this->helper->getArticleIdsByNumber($orderNumbers);
157
158			$streamService->markProductsToBeRemovedFromStream($streamId);
159			$streamService->createStreamRelation($streamId, $articleIds);
160			}
161
162			try {
163			$streamsAssignments = $streamService->prepareStreamsAssignments($streamId, false);
164
165			//article ids must be taken from streamsAssignments
166			$exportArticleIds = $streamsAssignments->getArticleIds();
167
168			$removeArticleIds = $streamsAssignments->getArticleIdsWithoutStreams();
169
170			if (!empty($removeArticleIds)) {
171			$this->removeArticlesFromStream($removeArticleIds);
172
173			//filter the $exportArticleIds
174			$exportArticleIds = array_diff($exportArticleIds, $removeArticleIds);
175			}
176
177			$sourceIds = $this->helper->getArticleSourceIds($exportArticleIds);
178
179			$errorMessages = $this->connectExport->export($sourceIds, $streamsAssignments);
180			$streamService->changeStatus($streamId, ProductStreamService::STATUS_EXPORT);
181			} catch (\RuntimeException $e) {
182			$streamService->changeStatus($streamId, ProductStreamService::STATUS_ERROR);
183			$streamService->log($streamId, $e->getMessage());
184			continue;
185			}
186
187			if ($errorMessages) {
			0 ignored issues – show Bug Best Practice introduced 2017-06-21 11:52 UTC by Report Bug Copy Issue Report The expression `$errorMessages` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
188			$streamService->changeStatus($streamId, ProductStreamService::STATUS_ERROR);
189
190			$errorMessagesText = '';
191			$displayedErrorTypes = [
192			ErrorHandler::TYPE_DEFAULT_ERROR,
193			ErrorHandler::TYPE_PRICE_ERROR
194			];
195
196			foreach ($displayedErrorTypes as $displayedErrorType) {
197			$errorMessagesText .= implode('\n', $errorMessages[$displayedErrorType]);
198			}
199
200			$streamService->log($streamId, $errorMessagesText);
201			}
202			}
203			}
204
205			/**
206			* If article is not taking part of any shopware stream it will be removed
207			* @param array $articleIds
208			*/
209			private function removeArticlesFromStream(array $articleIds)
210			{
211			$sourceIds = $this->helper->getArticleSourceIds($articleIds);
212			$items = $this->connectExport->fetchConnectItems($sourceIds, false);
213
214			foreach ($items as $item) {
215			$this->sdk->recordDelete($item['sourceId']);
216			}
217
218			$this->getStreamService()->removeMarkedStreamRelations();
219			$this->connectExport->updateConnectItemsStatus($sourceIds, Attribute::STATUS_DELETE);
220			}
221
222			/**
223			* @return ProductStreamService $streamService
224			*/
225			private function getStreamService()
226			{
227			if (!$this->streamService) {
228			$this->streamService = Shopware()->Container()->get('swagconnect.product_stream_service');
229			}
230
231			return $this->streamService;
232			}
233			}
234

shopware / SwagConnect

Pull Request — master (#358)

CronJob::exportDynamicStreams() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like