Git Product home page Git Product logo

akeneo-connector-base's Introduction

Akeneo Connector Utils

TL;DR

This component brings tools and utilities for connectors developers.

This adapter brings :

  • XML data source parsing tools
  • Attribute option value discovering
  • Attribute list input
  • Assets processor (images attributes)
  • Variant group assets export
  • Dummy reader/processor/writer
  • Utility traits for your connectors

Versions

PIM version Component version
1.6.* 1.2.*
1.5.* 1.1.*
1.4.* 1.0.*

Note : From version 1.1, namespace changed from Luni\Component\Connector to Kiboko\Component\Connector

Utilities

AttributeManager

This helps you to create parameterizable connectors:

<?php

$attributeManager = new Kiboko\Component\Connector\Manager\AttributeManager($attributeRepository);
$attributeManager->getAttributeChoices('pim_catalog_image'),

This is used for a media assets exporting job, like ProductAssetsProcessor

# Resources/config/readers.yml
parameters:
    luni_connector.reader.dummy_item.class: Kiboko\Component\Connector\Processor\DummyReader

services:
    luni_connector.reader.dummy_item:
        class: '%luni_connector.reader.dummy_item.class%'
# Resources/config/processors.yml
parameters:
    luni_connector.processor.dummy_item.class: Kiboko\Component\Connector\Processor\DummyProcessor

services:
    luni_connector.processor.dummy_item:
        class: '%luni_connector.processor.dummy_item.class%'
# Resources/config/writers.yml
parameters:
    luni_connector.writers.dummy_item.class: Kiboko\Component\Connector\Processor\DummyWriter

services:
    luni_connector.writers.dummy_item:
        class: '%luni_connector.writers.dummy_item.class%'

ProductAssetsProcessor and VariantGroupAssetsProcessor

These processors are suited for Magento assets exporting from Akeneo CE, when you have created multiple image attributes.

Assets export manager

In your bundle, you will need theses configurations:

# Resources/config/services.yml
# app/config/services.yml
parameters:
    acme_dummy_connector.manager.attributes.class: Kiboko\Component\Connector\Manager\AttributeManager

    acme_dummy_connector.job.job_parameters.validator.image_attribute_validator.class:      Kiboko\Component\Connector\JobParameters\Constraint\ImageAttributeValidator
    acme_dummy_connector.job.job_parameters.validator.image_attribute_list_validator.class: Kiboko\Component\Connector\JobParameters\Constraint\ImageAttributeListValidator
    
    acme_dummy_connector.job.job_parameters.default_values_provider.assets_export.class:        Kiboko\Component\Connector\JobParameters\DefaultValuesProvider\ProductAssetsExport
    acme_dummy_connector.job.job_parameters.constraint_collection_provider.assets_export.class: Kiboko\Component\Connector\JobParameters\ConstraintCollectionProvider\ProductAssetsExport
    acme_dummy_connector.job.job_parameters.form_configuration_provider.assets_export.class:     Kiboko\Component\Connector\JobParameters\FormConfigurationProvider\ProductAssetsExport
services:
    # Validation services
    validator.image_attribute:
        class: '%acme_dummy_connector.job.job_parameters.validator.image_attribute_validator.class%'
        arguments:
            - '@luni_assets.manager.attributes'
        tags:
            - { name: validator.constraint_validator }
    validator.image_attribute_list:
        class: '%acme_dummy_connector.job.job_parameters.validator.image_attribute_list_validator.class%'
        arguments:
            - '@luni_assets.manager.attributes'
        tags:
            - { name: validator.constraint_validator }
         
    # Default values for our JobParameters
    acme_dummy_connector.job.job_parameters.default_values_provider.assets_export:
        class: '%acme_dummy_connector.job.job_parameters.default_values_provider.assets_export.class%'
        arguments:
            -
                - 'assets_job' # the job name
        tags:
            - { name: akeneo_batch.job.job_parameters.default_values_provider }

    # Validation constraints for our JobParameters
    acme_dummy_connector.job.job_parameters.constraint_collection_provider.assets_export:
        class: '%acme_dummy_connector.job.job_parameters.constraint_collection_provider.assets_export.class%'
        arguments:
            -
                - 'assets_job' # the job name
        tags:
            - { name: akeneo_batch.job.job_parameters.constraint_collection_provider }

    # Form configuration for our JobParameters
    acme_dummy_connector.job.job_parameters.form_configuration_provider.assets_export:
        class: '%acme_dummy_connector.job.job_parameters.form_configuration_provider.assets_export.class%'
        arguments:
            -
                - 'assets_job' # the job name
        tags:
            - { name: pim_import_export.job_parameters.form_configuration_provider }

Removed functionality in version 1.2

NameAwareTrait and ConfigurationAwareTrait traits

The traits NameAwareTrait and ConfigurationAwareTrait were removed in version 1.2, since Akeneo 1.6 changed its options retrieval in batch steps

See Akeneo 1.6 changelog

Kiboko\Component\Connector\Writer\File\CsvVariantGroupWriter writer

This writer is not needed anymore

akeneo-connector-base's People

Contributors

gplanchat avatar jmleroux avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

akeneo-connector-base's Issues

One does not simply alter something in the vendors folder

Note: This will need a small patch in method
Pim\Bundle\ImportExportBundle\Twig\NormalizeConfigurationExtension::normalizeValueFilter()

In many cases (or almost always) the deployment processes do not use the developers local vendors content and/or use the composer.lock file to install the correct dependencies. This results into that any changes made in the vendors folder will get overwritten by composer.

I'd recommend to add your own NormalizeConfigurationExtension class and just to override the services class parameter pim_import_export.twig.normalize_configuration_extension.class to point to it. This way the changes won't get lost.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.