Completed
Push — pac-96--override-images-option ( a7eed5 )
by Marcus
01:52
created

BunchSubject::setUp()   B

Complexity

Conditions 7
Paths 36

Size

Total Lines 41

Duplication

Lines 14
Ratio 34.15 %

Code Coverage

Tests 9
CRAP Score 12.1068

Importance

Changes 0
Metric Value
dl 14
loc 41
ccs 9
cts 17
cp 0.5294
rs 8.3306
c 0
b 0
f 0
cc 7
nc 36
nop 1
crap 12.1068
1
<?php
2
3
/**
4
 * TechDivision\Import\Product\Subjects\BunchSubject
5
 *
6
 * NOTICE OF LICENSE
7
 *
8
 * This source file is subject to the Open Software License (OSL 3.0)
9
 * that is available through the world-wide-web at this URL:
10
 * http://opensource.org/licenses/osl-3.0.php
11
 *
12
 * PHP version 5
13
 *
14
 * @author    Tim Wagner <[email protected]>
15
 * @copyright 2016 TechDivision GmbH <[email protected]>
16
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17
 * @link      https://github.com/techdivision/import-product
18
 * @link      http://www.techdivision.com
19
 */
20
21
namespace TechDivision\Import\Product\Subjects;
22
23
use Doctrine\Common\Collections\Collection;
24
use League\Event\EmitterInterface;
25
use TechDivision\Import\Loaders\LoaderInterface;
26
use TechDivision\Import\Services\RegistryProcessorInterface;
27
use TechDivision\Import\Utils\Generators\GeneratorInterface;
28
use TechDivision\Import\Utils\StoreViewCodes;
29
use TechDivision\Import\Product\Utils\MemberNames;
30
use TechDivision\Import\Product\Utils\RegistryKeys;
31
use TechDivision\Import\Product\Utils\VisibilityKeys;
32
use TechDivision\Import\Product\Utils\ConfigurationKeys;
33
use TechDivision\Import\Subjects\ExportableTrait;
34
use TechDivision\Import\Subjects\FileUploadTrait;
35
use TechDivision\Import\Subjects\ExportableSubjectInterface;
36
use TechDivision\Import\Subjects\FileUploadSubjectInterface;
37
use TechDivision\Import\Subjects\UrlKeyAwareSubjectInterface;
38
use TechDivision\Import\Subjects\CleanUpColumnsSubjectInterface;
39
40
/**
41
 * The subject implementation that handles the business logic to persist products.
42
 *
43
 * @author    Tim Wagner <[email protected]>
44
 * @copyright 2016 TechDivision GmbH <[email protected]>
45
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
46
 * @link      https://github.com/techdivision/import-product
47
 * @link      http://www.techdivision.com
48
 */
49
class BunchSubject extends AbstractProductSubject implements ExportableSubjectInterface, FileUploadSubjectInterface, UrlKeyAwareSubjectInterface, CleanUpColumnsSubjectInterface
50
{
51
52
    /**
53
     * The trait that implements the export functionality.
54
     *
55
     * @var \TechDivision\Import\Subjects\ExportableTrait
56
     */
57
    use ExportableTrait;
58
59
    /**
60
     * The trait that provides file upload functionality.
61
     *
62
     * @var \TechDivision\Import\Subjects\FileUploadTrait
63
     */
64
    use FileUploadTrait;
65
66
    /**
67
     * The array with the pre-loaded entity IDs.
68
     *
69
     * @var array
70
     */
71
    protected $preLoadedEntityIds = array();
72
73
    /**
74
     * Mappings for the table column => CSV column header.
75
     *
76
     * @var array
77
     */
78
    protected $headerStockMappings = array(
79
        'qty'                         => array('qty', 'float'),
80
        'min_qty'                     => array('out_of_stock_qty', 'float'),
81
        'use_config_min_qty'          => array('use_config_min_qty', 'int'),
82
        'is_qty_decimal'              => array('is_qty_decimal', 'int'),
83
        'backorders'                  => array('allow_backorders', 'int'),
84
        'use_config_backorders'       => array('use_config_backorders', 'int'),
85
        'min_sale_qty'                => array('min_cart_qty', 'float'),
86
        'use_config_min_sale_qty'     => array('use_config_min_sale_qty', 'int'),
87
        'max_sale_qty'                => array('max_cart_qty', 'float'),
88
        'use_config_max_sale_qty'     => array('use_config_max_sale_qty', 'int'),
89
        'is_in_stock'                 => array('is_in_stock', 'int'),
90
        'notify_stock_qty'            => array('notify_on_stock_below', 'float'),
91
        'use_config_notify_stock_qty' => array('use_config_notify_stock_qty', 'int'),
92
        'manage_stock'                => array('manage_stock', 'int'),
93
        'use_config_manage_stock'     => array('use_config_manage_stock', 'int'),
94
        'use_config_qty_increments'   => array('use_config_qty_increments', 'int'),
95
        'qty_increments'              => array('qty_increments', 'float'),
96
        'use_config_enable_qty_inc'   => array('use_config_enable_qty_inc', 'int'),
97
        'enable_qty_increments'       => array('enable_qty_increments', 'int'),
98
        'is_decimal_divided'          => array('is_decimal_divided', 'int'),
99
    );
100
101
    /**
102
     * The array with the available visibility keys.
103
     *
104
     * @var array
105
     */
106
    protected $availableVisibilities = array(
107
        'Not Visible Individually' => VisibilityKeys::VISIBILITY_NOT_VISIBLE,
108
        'Catalog'                  => VisibilityKeys::VISIBILITY_IN_CATALOG,
109
        'Search'                   => VisibilityKeys::VISIBILITY_IN_SEARCH,
110
        'Catalog, Search'          => VisibilityKeys::VISIBILITY_BOTH
111
    );
112
113
    /**
114
     * The default callback mappings for the Magento standard product attributes.
115
     *
116
     * @var array
117
     */
118
    protected $defaultCallbackMappings = array(
119
        'visibility'           => array('import_product.callback.visibility'),
120
        'tax_class_id'         => array('import_product.callback.tax.class'),
121
        'bundle_price_type'    => array('import_product_bundle.callback.bundle.type'),
122
        'bundle_sku_type'      => array('import_product_bundle.callback.bundle.type'),
123
        'bundle_weight_type'   => array('import_product_bundle.callback.bundle.type'),
124
        'bundle_price_view'    => array('import_product_bundle.callback.bundle.price.view'),
125
        'bundle_shipment_type' => array('import_product_bundle.callback.bundle.shipment.type')
126
    );
127
128
    /**
129
     * The available entity types.
130
     *
131
     * @var array
132
     */
133
    protected $entityTypes = array();
134
135
    /**
136
     * The media roles loader instance.
137
     *
138
     * @var \TechDivision\Import\Loaders\LoaderInterface
139
     */
140
    protected $mediaRolesLoader;
141
142
    /**
143
     * BunchSubject constructor
144
     *
145
     * @param RegistryProcessorInterface $registryProcessor          The registry processor instance
146
     * @param GeneratorInterface         $coreConfigDataUidGenerator The generator instance
147
     * @param Collection                 $systemLoggers              The system logger collection
148
     * @param EmitterInterface           $emitter                    The emitter instance
149
     * @param LoaderInterface            $loader                     The media type loader instance
150
     */
151 18
    public function __construct(
152
        RegistryProcessorInterface $registryProcessor,
153
        GeneratorInterface $coreConfigDataUidGenerator,
154
        Collection $systemLoggers,
155
        EmitterInterface $emitter,
156
        LoaderInterface $loader
157
    ) {
158
159
        // set the loader for the media roles
160 18
        $this->mediaRolesLoader = $loader;
161
162
        // pass the other instances to the parent constructor
163 18
        parent::__construct($registryProcessor, $coreConfigDataUidGenerator, $systemLoggers, $emitter);
164 18
    }
165
166
    /**
167
     * Intializes the previously loaded global data for exactly one bunch.
168
     *
169
     * @param string $serial The serial of the actual import
170
     *
171
     * @return void
172
     */
173 18
    public function setUp($serial)
174
    {
175
176
        // load the status of the actual import
177 18
        $status = $this->getRegistryProcessor()->getAttribute(RegistryKeys::STATUS);
178
179
        // load the global data we've prepared initially
180 18
        $this->entityTypes = $status[RegistryKeys::GLOBAL_DATA][RegistryKeys::ENTITY_TYPES];
181
182
        // initialize the flag whether to copy images or not
183 18
        if ($this->getConfiguration()->hasParam(ConfigurationKeys::COPY_IMAGES)) {
184
            $this->setCopyImages($this->getConfiguration()->getParam(ConfigurationKeys::COPY_IMAGES));
185
        }
186
187
        // initialize the flag whether to override images or not
188
        // TODO: Create new constant ConfigurationKeys::OVERRIDE_IMAGES for future release
189 18
        if ($this->getConfiguration()->hasParam('override-images')) {
190
            $this->setOverrideImages($this->getConfiguration()->getParam('override-images'));
191
        }
192
193
        // initialize media directory => can be absolute or relative
194 18 View Code Duplication
        if ($this->getConfiguration()->hasParam(ConfigurationKeys::MEDIA_DIRECTORY)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
195
            try {
196
                $this->setMediaDir($this->resolvePath($this->getConfiguration()->getParam(ConfigurationKeys::MEDIA_DIRECTORY)));
197
            } catch (\InvalidArgumentException $iae) {
198
                $this->getSystemLogger()->warning($iae);
199
            }
200
        }
201
202
        // initialize images directory => can be absolute or relative
203 18 View Code Duplication
        if ($this->getConfiguration()->hasParam(ConfigurationKeys::IMAGES_FILE_DIRECTORY)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across 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...
204
            try {
205
                $this->setImagesFileDir($this->resolvePath($this->getConfiguration()->getParam(ConfigurationKeys::IMAGES_FILE_DIRECTORY)));
206
            } catch (\InvalidArgumentException $iae) {
207
                $this->getSystemLogger()->warning($iae);
208
            }
209
        }
210
211
        // invoke the parent method
212 18
        parent::setUp($serial);
213 18
    }
214
215
    /**
216
     * Clean up the global data after importing the bunch.
217
     *
218
     * @param string $serial The serial of the actual import
219
     *
220
     * @return void
221
     */
222
    public function tearDown($serial)
223
    {
224
225
        // invoke the parent method
226
        parent::tearDown($serial);
227
228
        // load the registry processor
229
        $registryProcessor = $this->getRegistryProcessor();
230
231
        // update the status
232
        $registryProcessor->mergeAttributesRecursive(
233
            RegistryKeys::STATUS,
234
            array(
235
                RegistryKeys::PRE_LOADED_ENTITY_IDS => $this->preLoadedEntityIds,
236
            )
237
        );
238
    }
239
240
    /**
241
     * Return's the default callback mappings.
242
     *
243
     * @return array The default callback mappings
244
     */
245
    public function getDefaultCallbackMappings()
246
    {
247
        return $this->defaultCallbackMappings;
248
    }
249
250
    /**
251
     * Return's the mappings for the table column => CSV column header.
252
     *
253
     * @return array The header stock mappings
254
     */
255 1
    public function getHeaderStockMappings()
256
    {
257 1
        return $this->headerStockMappings;
258
    }
259
260
    /**
261
     * Return's the visibility key for the passed visibility string.
262
     *
263
     * @param string $visibility The visibility string to return the key for
264
     *
265
     * @return integer The requested visibility key
266
     * @throws \Exception Is thrown, if the requested visibility is not available
267
     */
268
    public function getVisibilityIdByValue($visibility)
269
    {
270
271
        // query whether or not, the requested visibility is available
272
        if (isset($this->availableVisibilities[$visibility])) {
273
            // load the visibility ID, add the mapping and return the ID
274
            return $this->availableVisibilities[$visibility];
275
        }
276
277
        // throw an exception, if not
278
        throw new \Exception(
279
            $this->appendExceptionSuffix(
280
                sprintf('Found invalid visibility %s', $visibility)
281
            )
282
        );
283
    }
284
285
    /**
286
     * Pre-load the entity ID for the passed product.
287
     *
288
     * @param array $product The product to be pre-loaded
289
     *
290
     * @return void
291
     */
292
    public function preLoadEntityId(array $product)
293
    {
294
        $this->preLoadedEntityIds[$product[MemberNames::SKU]] = $product[MemberNames::ENTITY_ID];
295
    }
296
297
    /**
298
     * Return's the entity type for the configured entity type code.
299
     *
300
     * @return array The requested entity type
301
     * @throws \Exception Is thrown, if the requested entity type is not available
302
     */
303 1 View Code Duplication
    public function getEntityType()
0 ignored issues
show
Duplication introduced by
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...
304
    {
305
306
        // query whether or not the entity type with the passed code is available
307 1
        if (isset($this->entityTypes[$entityTypeCode = $this->getEntityTypeCode()])) {
308 1
            return $this->entityTypes[$entityTypeCode];
309
        }
310
311
        // throw a new exception
312
        throw new \Exception(
313
            $this->appendExceptionSuffix(
314
                sprintf('Requested entity type "%s" is not available', $entityTypeCode)
315
            )
316
        );
317
    }
318
319
    /**
320
     * Return's TRUE, if the passed URL key varchar value IS related with the actual PK.
321
     *
322
     * @param array $productVarcharAttribute The varchar value to check
323
     *
324
     * @return boolean TRUE if the URL key is related, else FALSE
325
     */
326
    public function isUrlKeyOf(array $productVarcharAttribute)
327
    {
328
        return ((integer) $productVarcharAttribute[MemberNames::ENTITY_ID] === (integer) $this->getLastEntityId()) &&
329
               ((integer) $productVarcharAttribute[MemberNames::STORE_ID] === (integer) $this->getRowStoreId(StoreViewCodes::ADMIN));
330
    }
331
332
    /**
333
     * Loads and returns the media roles.
334
     *
335
     * @return array The array with the media roles
336
     */
337
    public function getMediaRoles(): array
338
    {
339
        return $this->mediaRolesLoader->load();
340
    }
341
342
    /**
343
     * Merge the columns from the configuration with all image type columns to define which
344
     * columns should be cleaned-up.
345
     *
346
     * @return array The columns that has to be cleaned-up
347
     */
348 1
    public function getCleanUpColumns()
349
    {
350
351
        // initialize the array for the columns that has to be cleaned-up
352 1
        $cleanUpColumns = array();
0 ignored issues
show
Bug Compatibility introduced by
The expression array(); of type array adds the type array to the return on line 360 which is incompatible with the return type of the parent method TechDivision\Import\Prod...ject::getCleanUpColumns of type string.
Loading history...
353
354
        // query whether or not an array has been specified in the configuration
355 1
        if ($this->getConfiguration()->hasParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS)) {
356
            $cleanUpColumns = $this->getConfiguration()->getParam(ConfigurationKeys::CLEAN_UP_EMPTY_COLUMNS);
357
        }
358
359
        // return the array with the column names
360 1
        return $cleanUpColumns;
361
    }
362
}
363