ctidigital/magento-configurator

Magento Configurator

Magento Configurator

A Magento module initially created by CTI Digital to create and maintain database variables using files. This module aims to bring the following benefits to a Magento developer's work flow:, _(*1)

• Install Magento from scratch with important database based configuration ready.
• Share and collaborate configuration with other colleagues using your own versioning system.
• Keep versions of your configurations using your own versioning system.
• Split your configuration based on the environment you're developing on.

If you're interested about finding out more about the background of the configurator, watch this lightning talk by Rick Steckles at Mage Titans in Manchester on [YouTube]., _(*2)

Version

0.15.0, _(*3)

Installation

Using Modman

$ cd <your magento install>
$ modman clone https://github.com/ctidigital/magento-configurator.git

Traditionally

Download and copy the contents of the src/ folder into your Magento base directory., _(*4)

How To Use

Firstly, we'll need to configure our components. You can find how to configure your component under the heading "Components"., _(*5)

In your magento directory you can run the configurator using:, _(*6)

$ cd <your magento install>/shell
$ php configurator.php

List Available Components

$ php configurator.php --list-components

Run Specific Components

$ php configurator.php --run-components "media,pages,staticBlocks"

Components

Websites & Stores

This is generally the first component that should be configured when starting a project. This is used to create and maintain your websites, stores and store views and is controlled using a YAML which will require to be located in app/etc/components/websites.yaml. The general structure follows:, _(*7)

- websites:
  - website_code_1:
      name: Website Name
      - store_groups:
          -
            name: Store Group Name
            root_category: Default Category
            stores:
              - store_code_1:
                  name: Default Store View Name
              - store_code_2:
                  name: Store View Name 2
         -
            name: Store Group Name 2
            root_category: New Root Category
            stores:
              - store_code_3:
                  name: Store View Name 3
  - website_code_2:
      name: Website Name 2
      - store_groups:
          -
            name: Store Group Name 3
            root_category: Default Category
            stores:
              - store_code_4:
                  name: Store View Name 4

The YAML follows a tree structure which supports the following rules: - Many websites can be created - A website can have many store groups - A store group branch can have many store views, _(*8)

Sort orders will automatically be created based on the order the YAML is written., _(*9)

Core Config Data

After your websites have been correctly set up this is required to set up the core configuration elements for default (global), website level, and store view level. The end nodes require a path and a value which will be set in your Magento's core_config_data. If you don't know what the path should be, you can find it out by looking at the module's system.xml file or save a page with the configuration from within Magento's admin followed by saving the relevant section in System->Configuration and looking it up within your database's core_config_data table. The file will require to be in app/etc/components/config.yaml. You can also find our config.yaml file as an example on how to structure the file., _(*10)

Default

- global:
    core_config:
      -
        path: design/package/name
        value: base
      -
        path: design/theme/default
        value: default

Inheritables

Sometimes we need to group configurations for use in many but not all websites or store views so in order to keep our YAML structure neat and tidy there is also support for grouped configurations. For example, some websites might share the same PayPal payment configuration., _(*11)

- grouped:
  - paypal:
      core_config:
        -
          path: payment/pbridge/profilestatus
          value: 0
        -
          path: payment/paypal_express/active
          value: 1
        -
          path: payment/paypal_express_bml/active
          value: 0

Websites

Should we require website specific configurations this can be defined as so:, _(*12)

- websites:
  - base:
      core_config:
        -
          path: general/locale/timezone
          value: Europe/London

We can also inherit our group configurations using the inherit key as so:, _(*13)

- websites:
  - base:
      inherit:
        - paypal
      core_config:
        -
          path: general/locale/timezone
          value: Europe/London

Stores

Similarly to websites, we can define store view level configuration which also has inheritance support as so:, _(*14)

- stores:
  - default:
      core_config:
        -
          path: general/locale/code
          value: en_GB

Encrypted Values

Some core magento fields also encrypts our configuration so we can define this as so:, _(*15)

        -
          path: paypal/wpp/api_password
          value: 111111111
          encrypted: 1

Product Attributes

The file that is used to maintain product attributes can be found in app/etc/components/attributes.yaml. This allows you to modify your custom attributes as well as maintain the attribute options using this file., _(*16)

Here is a basic required structure for an attribute, _(*17)

- attributes:
  - attribute_code:
      frontend_label: Attribute Code
      frontend_input: select
      product_types:
        - simple
        - configurable
        - bundle
        - grouped

Here is the basic structure of a typical attribute with its default values:, _(*18)

- attributes:
  - attribute_code:
      is_global: 0
      is_visible: 1
      is_searchable: 0
      is_filterable: 0
      is_comparable: 0
      is_visible_on_front: 0
      is_html_allowed_on_front: 0
      is_filterable_in_search: 0
      used_in_product_listing: 0
      used_for_sort_by: 0
      is_configurable: 0
      is_visible_in_advanced_search: 0
      position: 0
      is_wysiwyg_enabled: 0
      is_used_for_promo_rules: 0
      default_value_text: ''
      default_value_yesno: 0
      default_value_date: ''
      default_value_textarea: ''
      is_unique: 0
      is_required: 0
      frontend_input: boolean
      search_weight: 1

We can also specify product options for select type attributes as so:, _(*19)

- attributes:
  - colour:
      frontend_label: Colour
      frontend_input: select
      product_types:
        - simple
      options:
        - Red
        - Green
        - Yellow
        - Blue
        - Purple
        - Pink
        - Orange

We can also specify store labels for attributes as so:, _(*20)

- attributes:
  - attribute_code:
      frontend_label: Attribute Code
      frontend_input: select
      - store_labels:
        default: Default Store Label
        en: Label for store code en

Please note, certain attribute configurations follow certain rules so do ensure you're familiar with how Magento product attributes work in order to make best use of this component. An attribute's configuration elements are simply fields in the catalog_eav_attribute table with a few exceptions., _(*21)

Attribute Sets

Having created out custom product attributes these will need to be included as part of an attribute set. For this we will require the file app/etc/components/attribute-sets.yaml and the contents of the file will follow as so:, _(*22)

- attribute_sets:
  -
    name: Example Attribute Set
    inherit: Attribute Set to Inherit (Default)
    groups:
      -
        name: Attribute Group Name (General)
        attributes:
          - attribute_code
          - attribute_code2

Using inherit: <Attribute Set Name> will use an existing attribute set as a skeleton for your new attribute sets. By default, it will inherit attribute set named Default which must already exists in your Magento install., _(*23)

Please use our sample file as an example., _(*24)

Other Components

There are many other components to help populate Magento which you can view from samples/components. These can help you bootstrap your Magneto install with relevant sample/configuration data., _(*25)

Limitations

• Cannot move attributes between attribute groups.
• Cannot remove existing attributes from attribute sets.

Development

Want to contribute? Great! We've tried to structure the module to make it extendable so should you wish to contribute then it should be fairly easy. There are a few rules you have to follow though., _(*26)

Config.xml

Firstly, within app/code/community/Cti/Configurator/etc/config.xml you will find the following xml:, _(*27)

...
    <global>
        <configurator_processors>
            <components>
                <website>cti_configurator/components_website</website>
                <config>cti_configurator/components_config</config>
            </components>
        </configurator_processors>
    </global>
...

Here you can define any components you wish to contribute. Should you wish to extend to create your own component within your own module, you can do so by adding your own component helper alias within your own module's config.xml., _(*28)

Component Helper

You'll need to create a helper class within the module, preferably in a Components subfolder and it should extend Cti_Configurator_Helper_Components_Abstract which will require you to: - Specify a unique component name for logging processes and event dispatches $this->_componentName. - Specify the file you wish to process by assigning an absolute path to the variable $this->_filePath1. - (optional) Specify $this->_filePath2 as a way of splitting your configuration between environments. - Create a protected _processFile() function to parse your file(s) (and merge) into a format of your choice. - Create a protected _processComponent() function to process the data you've acquired from the file you've processed., _(*29)

The abstract function should handle the rest. You can look at our Helper/Components/Website.php and Helper/Components/Config.php as a guide to how you should structure your component helper., _(*30)

Roadmap

• Create a component for Admin Users & Roles
• Better CLI Logging
• Write Tests

License

MIT, _(*31)