1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0 |
5
|
|
|
* @copyright Aimeos (aimeos.org), 2015-2018 |
6
|
|
|
* @package Controller |
7
|
|
|
* @subpackage Common |
8
|
|
|
*/ |
9
|
|
|
|
10
|
|
|
|
11
|
|
|
namespace Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Text; |
12
|
|
|
|
13
|
|
|
|
14
|
|
|
/** |
15
|
|
|
* Text processor for CSV imports |
16
|
|
|
* |
17
|
|
|
* @package Controller |
18
|
|
|
* @subpackage Common |
19
|
|
|
*/ |
20
|
|
|
class Standard |
21
|
|
|
extends \Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Base |
22
|
|
|
implements \Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Iface |
23
|
|
|
{ |
24
|
|
|
/** controller/common/catalog/import/csv/processor/text/name |
25
|
|
|
* Name of the text processor implementation |
26
|
|
|
* |
27
|
|
|
* Use "Myname" if your class is named "\Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Text\Myname". |
28
|
|
|
* The name is case-sensitive and you should avoid camel case names like "MyName". |
29
|
|
|
* |
30
|
|
|
* @param string Last part of the processor class name |
31
|
|
|
* @since 2018.04 |
32
|
|
|
* @category Developer |
33
|
|
|
*/ |
34
|
|
|
|
35
|
|
|
private $listTypes; |
36
|
|
|
private $types; |
37
|
|
|
|
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* Initializes the object |
41
|
|
|
* |
42
|
|
|
* @param \Aimeos\MShop\Context\Item\Iface $context Context object |
43
|
|
|
* @param array $mapping Associative list of field position in CSV as key and domain item key as value |
44
|
|
|
* @param \Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Iface $object Decorated processor |
45
|
|
|
*/ |
46
|
|
|
public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $mapping, |
47
|
|
|
\Aimeos\Controller\Common\Catalog\Import\Csv\Processor\Iface $object = null ) |
48
|
|
|
{ |
49
|
|
|
parent::__construct( $context, $mapping, $object ); |
50
|
|
|
|
51
|
|
|
/** controller/common/catalog/import/csv/processor/text/listtypes |
52
|
|
|
* Names of the catalog list types for texts that are updated or removed |
53
|
|
|
* |
54
|
|
|
* If you want to associate text items manually via the administration |
55
|
|
|
* interface to catalogs and don't want these to be touched during the |
56
|
|
|
* import, you can specify the catalog list types for these texts |
57
|
|
|
* that shouldn't be updated or removed. |
58
|
|
|
* |
59
|
|
|
* @param array|null List of catalog list type names or null for all |
60
|
|
|
* @since 2018.04 |
61
|
|
|
* @category Developer |
62
|
|
|
* @category User |
63
|
|
|
* @see controller/common/catalog/import/csv/domains |
64
|
|
|
* @see controller/common/catalog/import/csv/processor/attribute/listtypes |
65
|
|
|
* @see controller/common/catalog/import/csv/processor/catalog/listtypes |
66
|
|
|
* @see controller/common/catalog/import/csv/processor/media/listtypes |
67
|
|
|
* @see controller/common/catalog/import/csv/processor/price/listtypes |
68
|
|
|
* @see controller/common/catalog/import/csv/processor/catalog/listtypes |
69
|
|
|
*/ |
70
|
|
|
$key = 'controller/common/catalog/import/csv/processor/text/listtypes'; |
71
|
|
|
$this->listTypes = $context->getConfig()->get( $key ); |
72
|
|
|
|
73
|
|
|
if( $this->listTypes === null ) |
74
|
|
|
{ |
75
|
|
|
$this->listTypes = []; |
76
|
|
|
$manager = \Aimeos\MShop::create( $context, 'catalog/lists/type' ); |
77
|
|
|
|
78
|
|
|
$search = $manager->createSearch()->setSlice( 0, 0x7fffffff ); |
79
|
|
|
$search->setConditions( $search->compare( '==', 'catalog.lists.type.domain', 'text' ) ); |
80
|
|
|
|
81
|
|
|
foreach( $manager->searchItems( $search ) as $item ) { |
82
|
|
|
$this->listTypes[$item->getCode()] = $item->getCode(); |
|
|
|
|
83
|
|
|
} |
84
|
|
|
} |
85
|
|
|
else |
86
|
|
|
{ |
87
|
|
|
$this->listTypes = array_flip( $this->listTypes ); |
88
|
|
|
} |
89
|
|
|
|
90
|
|
|
|
91
|
|
|
$manager = \Aimeos\MShop::create( $context, 'text/type' ); |
92
|
|
|
|
93
|
|
|
$search = $manager->createSearch()->setSlice( 0, 0x7fffffff ); |
94
|
|
|
$search->setConditions( $search->compare( '==', 'text.type.domain', 'catalog' ) ); |
95
|
|
|
|
96
|
|
|
foreach( $manager->searchItems( $search ) as $item ) { |
97
|
|
|
$this->types[$item->getCode()] = $item->getCode(); |
98
|
|
|
} |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
|
102
|
|
|
/** |
103
|
|
|
* Saves the catalog related data to the storage |
104
|
|
|
* |
105
|
|
|
* @param \Aimeos\MShop\Catalog\Item\Iface $catalog Catalog item with associated items |
106
|
|
|
* @param array $data List of CSV fields with position as key and data as value |
107
|
|
|
* @return array List of data which hasn't been imported |
108
|
|
|
*/ |
109
|
|
|
public function process( \Aimeos\MShop\Catalog\Item\Iface $catalog, array $data ) |
110
|
|
|
{ |
111
|
|
|
$listManager = \Aimeos\MShop::create( $this->getContext(), 'catalog/lists' ); |
112
|
|
|
$manager = \Aimeos\MShop::create( $this->getContext(), 'text' ); |
113
|
|
|
|
114
|
|
|
$listMap = []; |
115
|
|
|
$map = $this->getMappedChunk( $data, $this->getMapping() ); |
116
|
|
|
$listItems = $catalog->getListItems( 'text', $this->listTypes ); |
117
|
|
|
|
118
|
|
|
foreach( $listItems as $listItem ) |
119
|
|
|
{ |
120
|
|
|
if( ( $refItem = $listItem->getRefItem() ) !== null ) { |
121
|
|
|
$listMap[ $refItem->getContent() ][ $refItem->getType() ][ $listItem->getType() ] = $listItem; |
122
|
|
|
} |
123
|
|
|
} |
124
|
|
|
|
125
|
|
|
foreach( $map as $pos => $list ) |
126
|
|
|
{ |
127
|
|
|
if( $this->checkEntry( $list ) === false ) { |
128
|
|
|
continue; |
129
|
|
|
} |
130
|
|
|
|
131
|
|
|
$type = $this->getValue( $list, 'text.type', 'name' ); |
132
|
|
|
$listtype = $this->getValue( $list, 'catalog.lists.type', 'default' ); |
133
|
|
|
$content = $this->getValue( $list, 'text.content', '' ); |
134
|
|
|
|
135
|
|
|
if( isset( $listMap[$content][$type][$listtype] ) ) |
136
|
|
|
{ |
137
|
|
|
$listItem = $listMap[$content][$type][$listtype]; |
138
|
|
|
$refItem = $listItem->getRefItem(); |
139
|
|
|
unset( $listItems[ $listItem->getId() ] ); |
140
|
|
|
} |
141
|
|
|
else |
142
|
|
|
{ |
143
|
|
|
$listItem = $listManager->createItem()->setType( $listtype ); |
144
|
|
|
$refItem = $manager->createItem()->setType( $type ); |
145
|
|
|
} |
146
|
|
|
|
147
|
|
|
$listItem = $listItem->setPosition( $pos )->fromArray( $list ); |
148
|
|
|
|
149
|
|
|
$label = mb_strcut( $this->getValue( $list, 'text.content', '' ), 0, 255 ); |
150
|
|
|
$refItem = $refItem->setLabel( $label )->fromArray( $list ); |
151
|
|
|
|
152
|
|
|
$catalog->addListItem( 'text', $listItem, $refItem ); |
153
|
|
|
} |
154
|
|
|
|
155
|
|
|
$catalog->deleteListItems( $listItems, true ); |
156
|
|
|
|
157
|
|
|
return $this->getObject()->process( $catalog, $data ); |
158
|
|
|
} |
159
|
|
|
|
160
|
|
|
|
161
|
|
|
/** |
162
|
|
|
* Checks if an entry can be used for updating a media item |
163
|
|
|
* |
164
|
|
|
* @param array $list Associative list of key/value pairs from the mapping |
165
|
|
|
* @return boolean True if valid, false if not |
166
|
|
|
*/ |
167
|
|
|
protected function checkEntry( array $list ) |
168
|
|
|
{ |
169
|
|
|
if( $this->getValue( $list, 'text.content' ) === null ) { |
170
|
|
|
return false; |
171
|
|
|
} |
172
|
|
|
|
173
|
|
|
if( ( $type = $this->getValue( $list, 'catalog.lists.type' ) ) && !isset( $this->listTypes[$type] ) ) |
174
|
|
|
{ |
175
|
|
|
$msg = sprintf( 'Invalid type "%1$s" (%2$s)', $type, 'catalog list' ); |
176
|
|
|
throw new \Aimeos\Controller\Common\Exception( $msg ); |
177
|
|
|
} |
178
|
|
|
|
179
|
|
|
if( ( $type = $this->getValue( $list, 'text.type' ) ) && !isset( $this->types[$type] ) ) |
180
|
|
|
{ |
181
|
|
|
$msg = sprintf( 'Invalid type "%1$s" (%2$s)', $type, 'text' ); |
182
|
|
|
throw new \Aimeos\Controller\Common\Exception( $msg ); |
183
|
|
|
} |
184
|
|
|
|
185
|
|
|
return true; |
186
|
|
|
} |
187
|
|
|
} |
188
|
|
|
|