Skip to content

Latest commit

 

History

History
113 lines (83 loc) · 3.16 KB

3.x-Installation.en.md

File metadata and controls

113 lines (83 loc) · 3.16 KB
Raw

Installing CJW ConfigProcessor Bundle for Ibexa Platform 3.x

Versions

The bundle loosely follows the eZ / Ibexa platform version number to signify compatibility. This means, that version 3.x of the bundle is going to be compatible with version 3.x of the platform, version 2.x of the bundle with platform 2.x etc.

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require cjw-network/cjw-config-processor:3.*

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require cjw-network/cjw-config-processor:3.*

If you want the current (not necessarily stable) version between releases:

$ composer require cjw-network/cjw-config-processor:dev-main

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

// config/bundles.php

return [
    // ...
    // <vendor>\<bundle-name>\<bundle-long-name>::class => ['all' => true],
    CJW\CJWConfigProcessorBundle\CJWConfigProcessorBundle::class => ['all' => true],
];

Important Note:

The Symfony Kernel of your installation must not be final, since a substantial part of the location retrieval process builds upon that kernel and extends it. That means, that the src/Kernel.php class must be publicly available.

Routing

Afterwards, you need to add a yaml file to your config/routes directory. This file can be named (for example) cjw_config_processing.yaml and must contain the following content:

cjw_config_processor_bundle:
    resource: "@CJWConfigProcessorBundle/Resources/config/routing.yaml"

Additional Bundle Config

For more info on how to configure and customize the behaviour of the bundle check: Configure the ConfigProcessor

You can also customize a few bundle settings and adapt the bundle to your requirements. To do that, you can create a yaml file in the config/packages directory of your installation (the config can also be added to any other existing yaml file in the config directory). If you did create a new file, name the file however you like, for example cjw_config_processor.yaml. Finally, set the following (partially) optional options:

# example settings
cjw_config_processor:
  custom_site_access_parameters:
    allow: false
    scan_parameters: false
    parameters:
      - "user.defined.parameters"

  favourite_parameters:
    allow: true
    scan_parameters: true
    parameters:
      - "user.defined.parameters"

  env_variables:
    allow: true

Assets

Since it may happen, that composer does not automatically install the assets of this bundle after installing the bundle itself, to install the assets of the bundle simply write:

# For the assets to be copied into the assets folder:
$ php bin/console assets:install

# To Symlink the assets:
$ php bin/console assets:install --relative --symlink