Developed with love by KnpLabs Hire us for your project!
59

CustomEntityBundle

by FriendsOfAkeneo

Eases the creation of custom entity and related views in the PIM

CustomEntityBundle

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

Installation

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

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

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

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

and enable the bundle in the app/AppKernel.php file in the registerProjectBundles() method:

    $bundles = [
        // ...
        new \Pim\Bundle\CustomEntityBundle\PimCustomEntityBundle(),
    ]

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 into your base app directory
  • Copy Tests/Resources/parameters_test.yml or Tests/Resources/parameters_test_ee.yml (depending on your PIM version) to app/config/parameters_test.yml, and edit accordingly to your config

Then:

    $ php bin/console cache:clear --no-warmup --env=test
    $ php bin/console pim:installer:db --env=test
    $ vendor/bin/phpunit -c app/phpunit.xml

Contributing

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

  • Merge pull request #202 from akeneo-labs/fix-ee-ajax-option
    By web-flow, 1 year ago
  • fix listing of ref data on the product form for EE
    By rybus, 1 year ago
  • #200 - Fix extension requirement in README
    By web-flow, 1 year ago
  • Merge branch 3.0 into master
    By jmleroux, 1 year ago
  • PIM v3.0 dependency (#199)
    By web-flow, 1 year ago
  • Update README documentation
    By jmleroux, 1 year ago
  • Merge branch 3.0 into master
    By jmleroux, 1 year ago
  • Update README documentation
    By jmleroux, 1 year ago
  • Move master branch to PIM 3.1
    By jmleroux, 1 year ago
  • composer update (#198)
    By web-flow, 1 year ago
  • Fix PIM dependency
    By web-flow, 1 year ago
  • PIM 3.0 dependency (#196)
    By web-flow, 1 year ago
  • Fix typo in filename - #194 from unreal4u/patch-1
    By web-flow, 1 year ago
  • Pim 3.0 compatibility (#195)
    By web-flow, 1 year ago
  • Fix typo in filename
    By web-flow, 1 year ago
  • Merge pull request #188 from akeneo-labs/mmetayer-patch-1
    By web-flow, 1 year ago
  • Update README.md
    By web-flow, 1 year ago
  • Merge pull request #182 from akeneo-labs/migration-2.3
    By web-flow, 1 year ago
  • Update composer.json and README
    By mmetayer, 1 year ago
  • Update service definition
    By mmetayer, 1 year ago
  • Merge pull request #181 from akeneo-labs/fix-creation-modal-violations
    By web-flow, 1 year ago
  • Fix violations display on creation modal
    By MarieMinasyan, 1 year ago
  • Merge pull request #178 from EricPaulson/patch-1
    By web-flow, 2 years ago
  • Update index.md
    By web-flow, 2 years ago
  • Update index.md
    By web-flow, 2 years ago
  • Merge pull request #173 from akeneo-labs/mass-delete-integration-test
    By web-flow, 2 years ago
  • Merge pull request #174 from akeneo-labs/remove-brand-mass-edit-actions
    By web-flow, 2 years ago
  • Merge pull request #177 from akeneo-labs/add-bundle-cookbook
    By web-flow, 2 years ago
  • Add rebuild assets part
    By web-flow, 2 years ago
  • add explanations for the translation files
    By , 2 years ago