|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0 |
|
5
|
|
|
* @copyright Aimeos (aimeos.org), 2018-2023 |
|
6
|
|
|
* @package Controller |
|
7
|
|
|
* @subpackage Common |
|
8
|
|
|
*/ |
|
9
|
|
|
|
|
10
|
|
|
|
|
11
|
|
|
namespace Aimeos\Controller\Common\Catalog\Import\Csv; |
|
12
|
|
|
|
|
13
|
|
|
|
|
14
|
|
|
/** |
|
15
|
|
|
* Common class for CSV catalog import job controllers and processors. |
|
16
|
|
|
* |
|
17
|
|
|
* @package Controller |
|
18
|
|
|
* @subpackage Common |
|
19
|
|
|
*/ |
|
20
|
|
|
class Base |
|
21
|
|
|
extends \Aimeos\Controller\Jobs\Base |
|
22
|
|
|
{ |
|
23
|
|
|
/** |
|
24
|
|
|
* Returns the cache object for the given type |
|
25
|
|
|
* |
|
26
|
|
|
* @param string $type Type of the cached data |
|
27
|
|
|
* @param string|null $name Name of the cache implementation |
|
28
|
|
|
* @return \Aimeos\Controller\Common\Catalog\Import\Csv\Cache\Iface Cache object |
|
29
|
|
|
* @throws \LogicException If class can't be instantiated |
|
30
|
|
|
*/ |
|
31
|
|
|
protected function getCache( string $type, $name = null ) : \Aimeos\Controller\Common\Catalog\Import\Csv\Cache\Iface |
|
32
|
|
|
{ |
|
33
|
|
|
$context = $this->context(); |
|
34
|
|
|
$config = $context->config(); |
|
35
|
|
|
|
|
36
|
|
|
if( ctype_alnum( $type ) === false ) { |
|
37
|
|
|
throw new \LogicException( sprintf( 'Invalid characters in class name "%1$s"', $type ), 400 ); |
|
38
|
|
|
} |
|
39
|
|
|
|
|
40
|
|
|
if( $name === null ) { |
|
41
|
|
|
$name = $config->get( 'controller/common/catalog/import/csv/cache/' . $type . '/name', 'Standard' ); |
|
42
|
|
|
} |
|
43
|
|
|
|
|
44
|
|
|
if( ctype_alnum( $name ) === false ) { |
|
45
|
|
|
throw new \LogicException( sprintf( 'Invalid characters in class name "%1$s"', $name ), 400 ); |
|
46
|
|
|
} |
|
47
|
|
|
|
|
48
|
|
|
$classname = '\\Aimeos\\Controller\\Common\\Catalog\\Import\\Csv\\Cache\\' . ucfirst( $type ) . '\\' . $name; |
|
49
|
|
|
$interface = \Aimeos\Controller\Common\Catalog\Import\Csv\Cache\Iface::class; |
|
50
|
|
|
|
|
51
|
|
|
return \Aimeos\Utils::create( $classname, [$context], $interface ); |
|
52
|
|
|
} |
|
53
|
|
|
|
|
54
|
|
|
|
|
55
|
|
|
/** |
|
56
|
|
|
* Returns the rows from the CSV file up to the maximum count |
|
57
|
|
|
* |
|
58
|
|
|
* @param resource $fh File handle to CSV file |
|
59
|
|
|
* @param int $maxcnt Maximum number of rows that should be retrieved at once |
|
60
|
|
|
* @param int $codePos Column position which contains the unique product code (starting from 0) |
|
61
|
|
|
* @return array List of arrays with product codes as keys and list of values from the CSV file |
|
62
|
|
|
*/ |
|
63
|
|
|
protected function getData( $fh, int $maxcnt, int $codePos ) : array |
|
64
|
|
|
{ |
|
65
|
|
|
$data = []; |
|
66
|
|
|
$count = 0; |
|
67
|
|
|
|
|
68
|
|
|
while( ( $row = fgetcsv( $fh ) ) !== false && $count++ < $maxcnt ) { |
|
69
|
|
|
$data[$row[$codePos]] = $row; |
|
70
|
|
|
} |
|
71
|
|
|
|
|
72
|
|
|
return $data; |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* Returns the default mapping for the CSV fields to the domain item keys |
|
78
|
|
|
* |
|
79
|
|
|
* Example: |
|
80
|
|
|
* 'item' => array( |
|
81
|
|
|
* 0 => 'catalog.code', // e.g. unique EAN code |
|
82
|
|
|
* 1 => 'catalog.parent', // Code of parent catalog node |
|
83
|
|
|
* 2 => 'catalog.label', // UTF-8 encoded text, also used as catalog name |
|
84
|
|
|
* 3 => 'catalog.status', // If category should be shown in the frontend |
|
85
|
|
|
* ), |
|
86
|
|
|
* 'text' => array( |
|
87
|
|
|
* 3 => 'text.type', // e.g. "short" for short description |
|
88
|
|
|
* 4 => 'text.content', // UTF-8 encoded text |
|
89
|
|
|
* ), |
|
90
|
|
|
* 'media' => array( |
|
91
|
|
|
* 5 => 'media.url', // relative URL of the catalog image on the server |
|
92
|
|
|
* ), |
|
93
|
|
|
* |
|
94
|
|
|
* @return array Associative list of domains as keys ("item" is special for the catalog itself) and a list of |
|
95
|
|
|
* positions and the domain item keys as values. |
|
96
|
|
|
*/ |
|
97
|
|
|
protected function getDefaultMapping() : array |
|
98
|
|
|
{ |
|
99
|
|
|
return array( |
|
100
|
|
|
'item' => array( |
|
101
|
|
|
0 => 'catalog.code', |
|
102
|
|
|
1 => 'catalog.parent', |
|
103
|
|
|
2 => 'catalog.label', |
|
104
|
|
|
3 => 'catalog.status', |
|
105
|
|
|
), |
|
106
|
|
|
'text' => array( |
|
107
|
|
|
4 => 'text.type', |
|
108
|
|
|
5 => 'text.content', |
|
109
|
|
|
), |
|
110
|
|
|
'media' => array( |
|
111
|
|
|
6 => 'media.url', |
|
112
|
|
|
), |
|
113
|
|
|
); |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
|
|
117
|
|
|
/** |
|
118
|
|
|
* Returns the mapped data from the CSV line |
|
119
|
|
|
* |
|
120
|
|
|
* @param array $data List of CSV fields with position as key and domain item key as value (mapped data is removed) |
|
121
|
|
|
* @param array $mapping List of domain item keys with the CSV field position as key |
|
122
|
|
|
* @return array List of associative arrays containing the chunked properties |
|
123
|
|
|
*/ |
|
124
|
|
|
protected function getMappedChunk( array &$data, array $mapping ) : array |
|
125
|
|
|
{ |
|
126
|
|
|
$idx = 0; |
|
127
|
|
|
$map = []; |
|
128
|
|
|
|
|
129
|
|
|
foreach( $mapping as $pos => $key ) |
|
130
|
|
|
{ |
|
131
|
|
|
if( isset( $map[$idx][$key] ) ) { |
|
132
|
|
|
$idx++; |
|
133
|
|
|
} |
|
134
|
|
|
|
|
135
|
|
|
if( isset( $data[$pos] ) ) |
|
136
|
|
|
{ |
|
137
|
|
|
$map[$idx][$key] = $data[$pos]; |
|
138
|
|
|
unset( $data[$pos] ); |
|
139
|
|
|
} |
|
140
|
|
|
} |
|
141
|
|
|
|
|
142
|
|
|
return $map; |
|
143
|
|
|
} |
|
144
|
|
|
|
|
145
|
|
|
|
|
146
|
|
|
/** |
|
147
|
|
|
* Returns the processor object for saving the catalog related information |
|
148
|
|
|
* |
|
149
|
|
|
* @param array $mappings Associative list of processor types as keys and index/data mappings as values |
|
150
|
|
|
* @return \Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Iface Processor object |
|
151
|
|
|
* @throws \LogicException If class can't be instantiated |
|
152
|
|
|
*/ |
|
153
|
|
|
protected function getProcessors( array $mappings ) : \Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Iface |
|
154
|
|
|
{ |
|
155
|
|
|
unset( $mappings['item'] ); |
|
156
|
|
|
|
|
157
|
|
|
$context = $this->context(); |
|
158
|
|
|
$config = $context->config(); |
|
159
|
|
|
|
|
160
|
|
|
$interface = \Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Iface::class; |
|
161
|
|
|
$object = new \Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Done( $context, [] ); |
|
162
|
|
|
|
|
163
|
|
|
foreach( $mappings as $type => $mapping ) |
|
164
|
|
|
{ |
|
165
|
|
|
if( ctype_alnum( $type ) === false ) { |
|
166
|
|
|
throw new \LogicException( sprintf( 'Invalid characters in class name "%1$s"', $type ), 400 ); |
|
167
|
|
|
} |
|
168
|
|
|
|
|
169
|
|
|
$name = $config->get( 'controller/common/catalog/import/csv/processor/' . $type . '/name', 'Standard' ); |
|
170
|
|
|
|
|
171
|
|
|
if( ctype_alnum( $name ) === false ) { |
|
172
|
|
|
throw new \LogicException( sprintf( 'Invalid characters in class name "%1$s"', $name ), 400 ); |
|
173
|
|
|
} |
|
174
|
|
|
|
|
175
|
|
|
$classname = '\\Aimeos\\Controller\\Common\\Catalog\\Import\\Csv\\Processor\\' . ucfirst( $type ) . '\\' . $name; |
|
176
|
|
|
|
|
177
|
|
|
$object = \Aimeos\Utils::create( $classname, [$context, $mapping, $object], $interface ); |
|
178
|
|
|
} |
|
179
|
|
|
|
|
180
|
|
|
return $object; |
|
181
|
|
|
} |
|
182
|
|
|
} |
|
183
|
|
|
|
aimeos /
ai-controller-jobs
