akeneo-labs/custom-entity-bundle

Akeneo PIM Custom entity bundle

Installs: 59 460

Dependents: 8

Suggesters: 0

Security: 0

Stars: 45

Watchers: 29

Forks: 34

Open Issues: 18

Type:symfony-bundle


README

Scrutinizer Code Quality Build Status

Facilitates the creation of PIM reference data and related views in the PIM.

For more information, please see http://docs.akeneo.com/

Requirements

CustomEntityBundle Akeneo PIM Community Edition
v4.0.* v4.0.*
v3.0.* v3.0.*
v2.4.* v2.3.*
v2.3.* v2.2.*
v2.2.* v2.1.*
v2.1.* v2.1.*
v2.0.* v2.0.*
v1.10.* v1.7.*

Installation

You can install this bundle with composer (see requirements section):

    php composer.phar require "akeneo-labs/custom-entity-bundle":"4.0.*"

Then add the following lines at the end of your config/routes/routes.yml :

    pim_customentity:
        prefix: /reference-data
        resource: "@PimCustomEntityBundle/Resources/config/routing.yml"

and enable the bundle in the config/bundles.php file:

    return [
        // ...
        Pim\Bundle\CustomEntityBundle\PimCustomEntityBundle::class => ['all' => true]
    ];

If your installation is already set up, you have to run the following command in order to add the quick export job:

    php bin/console akeneo:batch:create-job "Akeneo Mass Edit Connector" "csv_reference_data_quick_export" "quick_export" "csv_reference_data_quick_export" '{"delimiter": ";", "enclosure": "\"", "withHeader": true, "filePath": "/tmp/reference_data_quick_export.csv"}'

Documentation

The reference data documentation can be found in the PIM documentation.

Detailled information can be found in the bundle documentation.

Run the Tests

Unit tests

    $ composer install
    $ vendor/bin/phpspec run

Code style

    $ composer install
    $ vendor/bin/php-cs-fixer fix -v --diff --config .php_cs.php

PHPUnit

  • Install an Akeneo PIM with the CustomEntityBundle
  • Copy Tests/Resources/phpunit.xml to project root
  • Copy Tests/Resources/.env.test to project root, and edit accordingly to your config
  • Copy Tests/Resources/bundles.php or Tests/Resources/bundles_ee.php (depending on your PIM version) content in the config/bundles.php file

Then:

    $ php bin/console cache:warmup --env=test

    If you're on EE Edition :
    $ php bin/console pim:installer:db --env=test --catalog vendor/akeneo/pim-enterprise-dev/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/minimal
    Else :
    $ php bin/console pim:installer:db --env=test --catalog vendor/akeneo/pim-community-dev/src/Akeneo/Platform/Bundle/InstallerBundle/Resources/fixtures/minimal

    $ vendor/bin/phpunit

Contributing

If you want to contribute to this open-source project, thank you to read and sign the following contributor agreement