storage-adapters.md

Storage Adapters

Zend\Db

Use this adapter if you want to use Zend\Db for settings persistence.

How

1. Import the MySQL schema located in vendor/hrevert/ht-settings-module/data/schema.sql if you use MySQL.
2. Install ZfcBase by adding "zf-commons/zfc-base": "0.1.*" to require section of composer.json
3. Add the following config:

return [
    'ht_settings' => [
        // This is optional.
        // You can specify this is config/autoload/ht-settings-module.global.php
        'parameter_entity_class' => 'HtSettingsModule\Entity\IdAwareParameter',
    ]
];

XML Adapter

Use this adapter if you want to store settings in XML format.

How

1. Install flysystem and Zend\Config.
2. Add the following config:

return [
    'ht_settings' => [
        // This is optional.
        // You can specify this in config/autoload/ht-settings-module.global.php
        'storage_path' => 'data/settings',
    ],
    'service_manager' => [
        'aliases' => [
            'HtSettingsModule_SettingsMapper' => 'HtSettingsModule\Mapper\XmlSettingsMapper',
        ]
    ]
];

JSON Adapter

Use this adapter if you want to store settings in JSON format.

How

1. Install flysystem and Zend\Json.
2. Add the following config:

return [
    'ht_settings' => [
        // This is optional.
        // You can specify this in config/autoload/ht-settings-module.global.php
        'storage_path' => 'data/settings',
    ],
    'service_manager' => [
        'aliases' => [
            'HtSettingsModule_SettingsMapper' => 'HtSettingsModule\Mapper\JsonSettingsMapper',
        ]
    ]
];