PHPackages ctidigital/magento-configurator - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. ctidigital/magento-configurator ActiveMagento-module[Utility & Helpers](/categories/utility) ctidigital/magento-configurator =============================== Magento Configurator v0.15.0(10y ago)7415618[3 issues](https://github.com/ctidigital/magento-configurator/issues)[1 PRs](https://github.com/ctidigital/magento-configurator/pulls)MITPHP Since Feb 2Pushed 9y ago24 watchersCompare [ Source](https://github.com/ctidigital/magento-configurator)[ Packagist](https://packagist.org/packages/ctidigital/magento-configurator)[ RSS](/packages/ctidigital-magento-configurator/feed)WikiDiscussions master Synced today READMEChangelog (1)DependenciesVersions (4)Used By (0) Magento Configurator ==================== [](#magento-configurator) A Magento module initially created by [CTI Digital](http://www.ctidigital.com/) to create and maintain database variables using files. This module aims to bring the following benefits to a Magento developer's work flow: - 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](https://twitter.com/rick_steckles) at Mage Titans in Manchester on [YouTube](https://www.youtube.com/watch?v=u9zHaX8G5_0). ### Version [](#version) 0.15.0 Installation ------------ [](#installation) ### Using Modman [](#using-modman) ``` $ cd $ modman clone https://github.com/ctidigital/magento-configurator.git ``` ### Traditionally [](#traditionally) Download and copy the contents of the `src/` folder into your Magento base directory. How To Use ---------- [](#how-to-use) Firstly, we'll need to configure our components. You can find how to configure your component under the heading "Components". In your magento directory you can run the configurator using: ``` $ cd /shell $ php configurator.php ``` ### List Available Components [](#list-available-components) ``` $ php configurator.php --list-components ``` ### Run Specific Components [](#run-specific-components) ``` $ php configurator.php --run-components "media,pages,staticBlocks" ``` Components ---------- [](#components) ### Websites & Stores [](#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: ``` - 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 Sort orders will automatically be created based on the order the YAML is written. ### Core Config Data [](#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. #### Default [](#default) ``` - global: core_config: - path: design/package/name value: base - path: design/theme/default value: default ``` #### Inheritables [](#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. ``` - 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 [](#websites) Should we require website specific configurations this can be defined as so: ``` - websites: - base: core_config: - path: general/locale/timezone value: Europe/London ``` We can also inherit our group configurations using the inherit key as so: ``` - websites: - base: inherit: - paypal core_config: - path: general/locale/timezone value: Europe/London ``` #### Stores [](#stores) Similarly to websites, we can define store view level configuration which also has inheritance support as so: ``` - stores: - default: core_config: - path: general/locale/code value: en_GB ``` #### Encrypted Values [](#encrypted-values) Some core magento fields also encrypts our configuration so we can define this as so: ``` - path: paypal/wpp/api_password value: 111111111 encrypted: 1 ``` ### Product Attributes [](#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. Here is a basic required structure for an attribute ``` - 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: ``` - 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: ``` - 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: ``` - 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. ### Attribute Sets [](#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: ``` - 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: ` 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. Please use our sample file as an example. ### Other Components [](#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. #### Limitations [](#limitations) - Cannot move attributes between attribute groups. - Cannot remove existing attributes from attribute sets. Development ----------- [](#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. ### Config.xml [](#configxml) Firstly, within `app/code/community/Cti/Configurator/etc/config.xml` you will find the following xml: ``` ... cti_configurator/components_website cti_configurator/components_config ... ``` 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`. ### Component Helper [](#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. 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. Roadmap ------- [](#roadmap) - Create a component for Admin Users & Roles - Better CLI Logging - Write Tests License ------- [](#license) MIT ### Health Score 32 — LowBetter than 69% of packages Maintenance19 Infrequent updates — may be unmaintained Popularity26 Limited adoption so far Community19 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 90.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 3732d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/7550729?v=4)[Raj Chevli](/maintainers/chevli)[@chevli](https://github.com/chevli) --- Top Contributors [![chevli](https://avatars.githubusercontent.com/u/7550729?v=4)](https://github.com/chevli "chevli (59 commits)")[![chrisgan](https://avatars.githubusercontent.com/u/2246778?v=4)](https://github.com/chrisgan "chrisgan (4 commits)")[![egon0](https://avatars.githubusercontent.com/u/2273316?v=4)](https://github.com/egon0 "egon0 (2 commits)") ### Embed Badge ![Health badge](/badges/ctidigital-magento-configurator/health.svg) ``` [![Health](https://phpackages.com/badges/ctidigital-magento-configurator/health.svg)](https://phpackages.com/packages/ctidigital-magento-configurator) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)