Magento 2 REST APIのDynamicRows(または連想配列)
モバイルアプリケーションにMagento2 RESTAPIを使用しています。私はいくつかの複雑さに直面しているので、あなたの助けが必要です。
UIフォームに2つのフィールドを持つDynamicRowsコンポーネントがあります。フィールドの名前はローカリゼーションです。
<container name="localization" sortOrder="9" >
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="component" xsi:type="string">Magento_Ui/js/dynamic-rows/dynamic-rows</item>
<item name="template" xsi:type="string">ui/dynamic-rows/templates/default</item>
<item name="componentType" xsi:type="string">dynamicRows</item>
<item name="label" xsi:type="string" translate="true">Data</item>
<item name="recordTemplate" xsi:type="string">record</item>
<item name="addButtonLabel" xsi:type="string">Add Parameter</item>
<item name="deleteProperty" xsi:type="boolean">false</item>
<item name="enabled" xsi:type="boolean">false</item>
</item>
</argument>
<container name="record">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="label" xsi:type="string" translate="true" />
<item name="component" xsi:type="string" translate="true">Magento_Ui/js/dynamic-rows/record</item>
<item name="isTemplate" xsi:type="boolean">true</item>
<item name="is_collection" xsi:type="boolean">true</item>
<item name="showFallbackReset" xsi:type="boolean">false</item>
</item>
</argument>
<field name="option_label">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="dataType" xsi:type="string">text</item>
<item name="label" xsi:type="string" translate="true">Parameter</item>
<item name="formElement" xsi:type="string">input</item>
<item name="dataScope" xsi:type="string">option_label</item>
<item name="showFallbackReset" xsi:type="boolean">false</item>
<item name="validation" xsi:type="array">
<item name="required-entry" xsi:type="boolean">true</item>
</item>
<item name="sortOrder" xsi:type="string">10</item>
</item>
</argument>
</field>
<field name="option_value">
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="dataType" xsi:type="string">text</item>
<item name="label" xsi:type="string" translate="true">Value</item>
<item name="formElement" xsi:type="string">input</item>
<item name="dataScope" xsi:type="string">option_value</item>
<item name="showFallbackReset" xsi:type="boolean">false</item>
<item name="additionalClasses" xsi:type="array">
<item name="cirklestudio_color_picker" xsi:type="boolean">true</item>
</item>
<item name="validation" xsi:type="array">
<item name="required-entry" xsi:type="boolean">true</item>
</item>
<item name="sortOrder" xsi:type="string">20</item>
</item>
</argument>
</field>
<actionDelete>
<argument name="data" xsi:type="array">
<item name="config" xsi:type="array">
<item name="componentType" xsi:type="string">actionDelete</item>
<item name="dataType" xsi:type="string">text</item>
<item name="fit" xsi:type="boolean">false</item>
<item name="label" xsi:type="string" />
<item name="additionalClasses" xsi:type="string">data-grid-actions-cell</item>
<item name="template" xsi:type="string">Magento_Backend/dynamic-rows/cells/action-delete</item>
</item>
</argument>
</actionDelete>
</container>
</container>
DynamicRowsの出力は以下のとおりです
Array
(
[0] => Array
(
[row_id] =>
[option_label] => tmp_dir
[option_value] => temp
[position] => 1
[record_id] => 0
[initialize] => true
)
[1] => Array
(
[record_id] => 1
[row_id] =>
[option_label] => main_dir
[option_value] => APD
[position] => 2
[initialize] => true
)
)
インターフェイスでgetLocalization()メソッドを宣言しました
/**
* Return localized parameters for the application
*
* @return mixed[]
*/
public function getLocalization();
それから私はメソッドを実装しました
/**
* @inheritdoc
*/
public function getLocalization()
{
// Unserialize array
$data = $this->_getData('localization') ? unserialize($this->_getData('localization')) : ""; $output = [];
foreach ($data as $param) {
$output[$param['option_label']] = $param['option_value']; } return $output;
}
上記の方法では、要件に従ってDynamicRows配列の出力を調整しました。
Array
(
[tmp_dir] => temp
[main_dir] => APD
)
REST APIエンドポイントに到達すると、次の応答が返されます。
<localization>
<item>temp</item>
<item>APD</item>
</localization>
私は次の応答を期待していますが
<localization>
<tmp_dir>temp</tmp_dir>
<main_dir>APD</main_dir>
</localization>
さまざまな記事を検索しましたが、要件に合う最適な回答が見つかりませんでした。
質問: DynamicRowsデータが常に同じであるとは限らず、別のレコードにoption_labelとoption_valueが異なる3つ以上のフィールドがある可能性があることを念頭に置いて、期待される結果を得るにはどうすればよいですか?
回答
私はなんとか次のことを思いついた:
私はあなたがそれからより多くを得るのに苦労すると思います。基本的に、アイテムキーはMagentoコア解析メソッドから取得されるため、結果はxmlとして表示されます。
手順を詳しく説明することはできますが、インターフェースが2つ増え、解析が少し行われます。この出力が妥協できるものかどうかをお知らせください。
ジョセフの答えは私のものよりも単純です(よりエレガントです)。しかし、以下は私のソリューションの中核です。また、自分で試してみるために、bitbucketリポジトリへのリンクを配置しました。https://bitbucket.org/magstaging/apiparser/src/master/
$output = []; foreach ($data as $param) { $output[$param['option_label']] = $param['option_value'];
}
return $this->parsedDataInterfaceFactory->create([ 'itemsData' => $output
]);
class ParsedResult implements ParsedDataInterface
{
/**
* @var \Mbs\Calculator\Api\Data\ParsedDataItemInterface[]
*/
private $items = []; /** * OperationResult constructor. * @param array $itemsData
* @param \Mbs\Calculator\Api\Data\ParsedDataItemInterfaceFactory $dataItemInterfaceFactory */ public function __construct( $itemsData,
\Mbs\Calculator\Api\Data\ParsedDataItemInterfaceFactory $dataItemInterfaceFactory ) { foreach ($itemsData as $itemLabel => $itemValue) {
$this->items[] = $dataItemInterfaceFactory->create([
'label' => $itemLabel, 'value' => $itemValue
]);
}
}
/**
* @return \Mbs\Calculator\Api\Data\ParsedDataItemInterface[]
*/
public function getLocalization()
{
return $this->items; } } class Item implements ParsedDataItemInterface { /** * @var string */ private $label;
/**
* @var string
*/
private $value; /** * @inheritdoc */ public function __construct( string $label,
string $value ) { $this->label = $label; $this->value = $value; } /** * @inheritdoc */ public function getLabel() { return $this->label;
}
/**
* @inheritdoc
*/
public function getValue()
{
return $this->value;
}
}
目的の結果を得るには、さらにクラスを作成する必要があります。
この場合getLocalization、次のようなクラスのインスタンスを返す必要があります。
/**
* @return \MyCompany\MyModule\Model\Localization[]
**/
public function getLocalization(): array
{
// Unserialize array
$data = $this->_getData('localization') ? unserialize($this->_getData('localization')) : ""; return array_map(function($option) {
return $this->localizationFactory->create([ 'label' => $param['option_label'],
'value' => $param['option_value']
]);
});
}
どこに$this->localizationFactoryありますか:\MyCompany\MyModule\Model\LocalizationFactory。
LocalizationFactory 2つの方法が必要です:
getLabelgetValue
これは冗長に見えるかもしれません、そしてそれはそうです。ただし、このルートでは、出力を100%制御できます。テスト容易性はボーナスです。