install-standalone.md

Integrated installation

Context

Let's say you work for the WorldCompany and the connector name is WorldConnector. A widely used practice is to use the company name as the root namespace.

COMPANY_NAME=WorldCompany
PIM_PATH=/tmp/pim-standard-edition
CONNECTOR_NAME=WorldConnector
BUNDLE_NAME=${CONNECTOR_NAME}Bundle

Initialisation of the Standard Edition

In this kind of organization, we will work inside the host project.

pim-standard-edition
└── src
    └── WorldCompany
        ├── WorldConnectorBundle.php
        ├── composer.json
        └── ...

Create a new host project with the Standard Edition

composer create-project --prefer-dist akeneo/pim-community-standard ${PIM_PATH} "1.5.*@stable"

This will download the standard edition without git informations.

Initialisation of the starter kit

We will create the project in a WorldCompany (company name) folder and the new extension will be at src/WorldCompany/WorldConnectorBundle

cd ${PIM_PATH}/src
composer create-project akeneo-labs/extension-starter ${COMPANY_NAME}

Customization

Customise composer.json to replace company name and extension name (Note for OS X users: change sed command parameters into sed -i "" "s#...)

cd ${COMPANY_NAME}
cp doc/composer.json.dist composer.json
sed -i "s#Acme#${COMPANY_NAME}#g" composer.json
sed -i "s#acme#${COMPANY_NAME}#g" composer.json
sed -i "s#DemoConnectorBundle#${BUNDLE_NAME}#g" composer.json
sed -i "s#demo-extension#${CONNECTOR_NAME}#g" composer.json

Rename files accordingly to the chosen names:

mv DemoConnectorBundle.php ${BUNDLE_NAME}.php
mv DependencyInjection/DemoConnectorExtension.php DependencyInjection/${CONNECTOR_NAME}Extension.php

Change namespaces accordingly:

find . -name '*.php' -type f -print0 | xargs -0 sed -i "s#Acme#${COMPANY_NAME}#g"
find . -name '*.php' -type f -print0 | xargs -0 sed -i "s#DemoConnector#${CONNECTOR_NAME}#g"

Cleanup

At this point, you can clean all the starter kit initialization files:

rm -f doc/*
rm -rf vendor
rm -rf .git
echo "# ${CONNECTOR_NAME} extension" > README.md

And finally initialize a brand new git repository to start versioning your work:

git init

Activation

To use your new bundle in the host Standard Edition, you have to activate it in the app/AppKernel.php:

cd ${PIM_PATH}
vi app/AppKernel.php

and register your bundle in the registerBundles() method.

You must also add a PSR-4 autoload entry for our extension in the host composer composer.json:

vi composer.json

Modify the autoload section:

    "autoload": {
        "psr-4": {
            "WorldCompany\\Bundle\\WorldConnectorBundle\\": "src/WorldCompany"
        }
    },

And finally update the composer autoloader:

composer dump-autoload

You should now be able to test your bundle in your browser.