Skip to content

Latest commit

 

History

History
103 lines (78 loc) · 3.06 KB

2.x-Installation.en.md

File metadata and controls

103 lines (78 loc) · 3.06 KB
Raw

Installing CJW ConfigProcessor Bundle for Ibexa Platform 2.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.

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:2.*

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project or an equivalent custom kernel of your own:

// app/AppKernel.php
public function registerBundles(): iterable
{
    //...
    $bundles[] = new CJW\CJWConfigProcessor\CJWConfigProcessorBundle();
}

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 app/AppKernel.php class must be publicly available.

Routing

Afterwards, you need to add the following content to your app/config/routing.yaml file:

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

Optional 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 (for more info on that, check the link above). To do that, you can either write the following configuration into the app/config/config.yml file, or you can create a yaml file in the app/config directory of your installation. If you did not create a file, simply paste the following lines into the app/config/config.yml.

# 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

If you did create a new file, name the file however you like, for example cjw_config_processor.yaml. Finally, set the following line in the app/config/config.yml and afterwards paste the lines from above into your created file:

import:
  #..
  - { resource: <the_file_name_you_chose> } # If you named it "cjw_config_processor.yaml", then write that name there

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