getting-started.md

Basic Usage

Create configs

You will need to first create a new configuration. Todo this declare a service as fallows:

services:
  my_vendor.my_bundle.comfy.config1:
    class: oliverde8\ComfyBundle\Model\TextConfig
    arguments:
      $path: "test/test1"
      $name: "test.test1"
      $description: "test.test1_desc"
      $defaultValue: "Toto 1"
    tags:
      - "comfy.config"

The service id, will allow you to inject the configuration into the services you need. Thanks to autowiring this is trivial by just calling the argument $myBundleConfig1

The path as well as the name & description are used for the admin interfaces.

Finally, each config has a default value.

Set & Get Values from the command line

To check you config value you can use

./bin/console comfy:get test

or

./bin/console comfy:get test/test1

In order to set values you can use

./bin/console comfy:set test/test1 'my super value'

Use the configs

In order to use the configs, get and set values you will need to simply inject them into your service.

<?php
public function __construct(\oliverde8\ComfyBundle\Model\ConfigInterface $myBundleConfig1);

With autowiring the service id my_vendor.my_bundle.comfy.config1 becomes myBundleConfig1. In order for this to work please respect the service naming pattern.

Getting config values

You can now use it to get the config value:

<?php
$this->myConfig->get();

💡 The config service is responsible of transforming the data; so the data we get here depends on the type of config used.

This will return the config value for the current scope, which by default is the current locale.

We can also fetch the value for any other scope.

<?php
$this->myConfig->get("default/en_GB");

So even if we are on a "french" page the config will be the en_gb one;

If no value is set for a certain scope then the value of the parent scope will be returned. in the example above it's the en and if none is defined for en then it's the default.

Saving new config values

We can also set values the same way; either for the current scope, or a particular scope.

First we should validate the new value:

<?php
$results = $this->myConfig->validate($newValue);
if ($results->count() > 0) {
    // Do my thing.
}

?>

Once the value is validated we can set it.

<?php
$this->myConfig->set($newValue);
$this->myConfig->set($newValue, "default/en_GB");

Available config types:

Text config

  myvendor.mybundle.comfy.generic.name:
    class: oliverde8\ComfyBundle\Model\TextConfig
    arguments:
      $path: "dummy/generic/name"
      $name: "Website's name"
      $description: "The name of the website to display."
      $defaultValue: "My Super duper website"
      $isHidden: false
    tags:
      - "comfy.config"

Url config

  myvendor.mybundle.comfy.generic.url:
    class: oliverde8\ComfyBundle\Model\UrlConfig
    arguments:
      $path: "dummy/generic/url"
      $name: "Website's url"
      $description: "The url of the website, this is used for emails sent by cron jobs."
      $defaultValue: "https://test.com"
    tags:
      - "comfy.config"

Mail config

  myvendor.mybundle.comfy.generic.mail:
    class: oliverde8\ComfyBundle\Model\MailConfig
    arguments:
      $path: "dummy/generic/mail"
      $name: "Communication mail"
      $description: "The mail to use to send mails"
      $defaultValue: "test@test.com"
    tags:
      - "comfy.config"

Select / Multiple Select

  myvendor.mybundle.comfy.generic.select:
    class: oliverde8\ComfyBundle\Model\SelectConfig
    arguments:
      $path: "dummy/generic/countries"
      $name: "Countries"
      $description: "The countries the site works for"
      $defaultValue: '["fr", "ch"]'
      $options:
        "France": "fr"
        "Switzerland": "ch"
      $allowMultiple: true
    tags:
      - "comfy.config"

Json

  myvendor.mybundle.comfy.generic.select:
    class: oliverde8\ComfyBundle\Model\JsonConfig
    arguments:
      $path: "dummy/generic/complexJson"
      $name: "My Json"
      $description: "The complex object"
      $defaultValue: '{"test":"my value"}'
    tags:
      - "comfy.config"

Entity

  myvendor.mybundle.comfy.generic.entity:
    class: oliverde8\ComfyBundle\Model\JsonConfig
    arguments:
      $path: "dummy/generic/entity"
      $name: "My Entity"
      $description: "The selected entity object"
      $defaultValue: '12' # can be null
      $entity: 'App/Entity/MyEntity'
      $choiceLabel: 'label' # Name of the label field.
    tags:
      - "comfy.config"