Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added feature to exclude attributes from import #185

Merged
merged 2 commits into from
Mar 22, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
added feature to exclude attributes from import
TheGrimmChester committed Mar 22, 2024
commit 36e4a847c081dd2aa9917107353fa288ac3717c9
11 changes: 11 additions & 0 deletions docs/CONFIGURE_DETAIL.md
Original file line number Diff line number Diff line change
@@ -120,6 +120,17 @@ This configuration will generally not be used, because the Akeneo module from Sy

This part allows you to manually map an Akeneo attribute to a Sylius attribute by indicating the attribute code on each of the solutions. Useful if the code of an attribute differs between Sylius and the PIM.

### Exclude attributes from import

```yaml
# config/packages/synolia_akeneo_plugin.yaml

synolia_sylius_akeneo:
excluded_attributes:
- supplier
- supplier_size
```

![Akeneo Attribute Code To Sylius Atribute Code](media/akeneo_attribute_to_sylius_code.png)
---

5 changes: 5 additions & 0 deletions src/DependencyInjection/Configuration.php
Original file line number Diff line number Diff line change
@@ -71,6 +71,11 @@ public function getConfigTreeBuilder()
->scalarPrototype()->example(['fr_CH', 'fr_CA', 'fr_FR'])->end()
->end()
->end()

->arrayNode('excluded_attributes')
->scalarPrototype()->example(['supplier'])->defaultValue([])->end()
->end()

->end()
;

13 changes: 13 additions & 0 deletions src/DependencyInjection/SynoliaSyliusAkeneoExtension.php
Original file line number Diff line number Diff line change
@@ -20,6 +20,8 @@
use Synolia\SyliusAkeneoPlugin\Provider\Configuration\Api\DatabaseApiConfigurationProvider;
use Synolia\SyliusAkeneoPlugin\Provider\Configuration\Api\DatabaseCategoryConfigurationProvider;
use Synolia\SyliusAkeneoPlugin\Provider\Configuration\Api\DotEnvApiConnectionProvider;
use Synolia\SyliusAkeneoPlugin\Provider\Configuration\ExcludedAttributesConfiguration;
use Synolia\SyliusAkeneoPlugin\Provider\Configuration\ExcludedAttributesConfigurationInterface;
use Synolia\SyliusAkeneoPlugin\Provider\Configuration\LocaleMappingConfiguration;
use Synolia\SyliusAkeneoPlugin\Provider\Configuration\LocaleMappingConfigurationInterface;

@@ -42,6 +44,7 @@ public function load(array $configs, ContainerBuilder $container): void
$this->processApiConfiguration($container, $config);
$this->processCategoryConfiguration($container, $config);
$this->processLocaleMapping($container, $config);
$this->processExcludedAttributes($container, $config);
}

public function prepend(ContainerBuilder $container): void
@@ -141,4 +144,14 @@ private function processLocaleMapping(ContainerBuilder $container, array $config

$container->setAlias(LocaleMappingConfigurationInterface::class, LocaleMappingConfiguration::class);
}

private function processExcludedAttributes(ContainerBuilder $container, array $config): void
{
$localeMappingConfigurationDefinition = $container->getDefinition(ExcludedAttributesConfiguration::class);
$localeMappingConfigurationDefinition
->setArgument('$excludedAttributeCodes', $config['excluded_attributes'])
;

$container->setAlias(ExcludedAttributesConfigurationInterface::class, ExcludedAttributesConfiguration::class);
}
}
18 changes: 18 additions & 0 deletions src/Provider/Configuration/ExcludedAttributesConfiguration.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

declare(strict_types=1);

namespace Synolia\SyliusAkeneoPlugin\Provider\Configuration;

class ExcludedAttributesConfiguration implements ExcludedAttributesConfigurationInterface
{
public function __construct(
private array $excludedAttributeCodes = [],
) {
}

public function get(): array
{
return $this->excludedAttributeCodes;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);

namespace Synolia\SyliusAkeneoPlugin\Provider\Configuration;

interface ExcludedAttributesConfigurationInterface
{
/**
* @return array<int, string>
*/
public function get(): array;
}
12 changes: 8 additions & 4 deletions src/Provider/ExcludedAttributesProvider.php
Original file line number Diff line number Diff line change
@@ -7,21 +7,25 @@
use Doctrine\Common\Collections\Collection;
use Sylius\Component\Resource\Repository\RepositoryInterface;
use Synolia\SyliusAkeneoPlugin\Entity\ProductConfiguration;
use Synolia\SyliusAkeneoPlugin\Provider\Configuration\ExcludedAttributesConfigurationInterface;

final class ExcludedAttributesProvider implements ExcludedAttributesProviderInterface
{
public function __construct(private RepositoryInterface $productConfigurationRepository)
{
public function __construct(
private RepositoryInterface $productConfigurationRepository,
private ExcludedAttributesConfigurationInterface $excludedAttributesConfiguration,
) {
}

public function getExcludedAttributes(): array
{
$excludedAttributeCodes = [];
$excludedAttributeCodes = $this->excludedAttributesConfiguration->get();

/** @var \Synolia\SyliusAkeneoPlugin\Entity\ProductConfiguration|null $productConfiguration */
$productConfiguration = $this->productConfigurationRepository->findOneBy([], ['id' => 'DESC']);

if (!$productConfiguration instanceof ProductConfiguration) {
return [];
return $excludedAttributeCodes;
}

if (null !== $productConfiguration->getAkeneoPriceAttribute()) {
Loading