System Settings

<?php
    protected $custom_system_settings = [
        'myPackage.navSiteStart' => [
            'area' => 'Nav',
            'type' => 'numberfield',
            'value' => 0 //'The resource ID to which to send to MenuBuilder for the main navigation menu'
        ],
        'myPackage.navLogoUrl' => [
            'area' => 'Nav',
            'type' => 'textfield',
            'value' => '/' //'The URL to send user to when clicking on the logo in the main menu'
        ],
        'myPackage.navLogoImage' => [
            'area' => 'Nav',
            'type' => 'textfield',
            'value' => '/assets/templates/logo.png',
            // 'The logo image url'
        ],
        'myPackage.navLogoAlt' => [
            'area' => 'Nav',
            'type' => 'textfield',
            'value' => 'My Project',
            // 'Alt for the navigation logo'
        ],
    ];
/**
 * Run the migrations.
 *
 * @return void
 */
public function up()
{
    /** @var \LCI\Blend\Blendable\SystemSetting $coreSchema */
    $coreSchema = $this->blender->getBlendableLoader()->getBlendableSystemSetting('link_tag_scheme');
    $coreSchema
        ->setSeedsDir($this->getSeedsDir())
        ->setCoreLinkTagScheme('abs');

    if ($coreSchema->blend(true)) {
        $this->blender->outSuccess('The link_tag_scheme system setting has been set');
    } else {
        $this->blender->outError('The link_tag_scheme system setting has been set');
        $this->blender->outError(print_r($coreSchema->getErrorMessages(), true), \LCI\Blend\Blender::VERBOSITY_DEBUG);
    }
    
    /** @var \LCI\Blend\Blendable\SystemSetting $coreFriendlyUrls */
    $coreFriendlyUrls = $this->blender->getBlendableLoader()->getBlendableSystemSetting('friendly_urls');
    $coreFriendlyUrls
        ->setSeedsDir($this->getSeedsDir())
        ->setCoreFriendlyUrls(true);

    if ($coreFriendlyUrls->blend(true)) {
        $this->blender->outSuccess('The friendly_urls system setting has been set');
    } else {
        $this->blender->outError('The friendly_urls system setting has been set');
        $this->blender->outError(print_r($coreFriendlyUrls->getErrorMessages(), true), \LCI\Blend\Blender::VERBOSITY_DEBUG);
    }


    ////////////
    // More advanced:

    // MODX Namespace to attach system settings to
    $myPackageNamespace = $this->modx->getObject('modNamespace', 'myPackage');
    if (!$myPackageNamespace) {
        /** @var \modNamespace $myPackageNamespace */
        $myPackageNamespace = $this->modx->newObject('modNamespace');
        $myPackageNamespace->set('name', 'myPackage');
        $myPackageNamespace->set('path', '{core_path}vendor/my/package/src/');
        $myPackageNamespace->set('assets_path', '{assets_path}components/my/package/');

        if ($myPackageNamespace->save()) {
            $this->blender->outSuccess('The modNamespace myPackage has been created');
        } else {
            $this->blender->out('The modNamespace myPackage was not created', true);
        }
    }

    foreach ($this->custom_system_settings as $setting => $details) {
        /** @var LCI\Blend\Blendable\SystemSetting $mySystemSetting */
        $mySystemSetting = $this->blender->getBlendableLoader()->getBlendableSystemSetting($setting);

        $mySystemSetting->setSeedsDir($this->getSeedsDir());

        $mySystemSetting
            ->setFieldNamespace('myPackage')
            ->setFieldArea($details['area'])
            ->setFieldValue($details['value'])
            ->setFieldXType($details['type']);

        // The blend() method will create a back/down data before saving to allow for easy revert with the revertBlend method
        if ($mySystemSetting->blend(true)) {
            $this->blender->out($mySystemSetting->getFieldName() . ' was saved correctly');

        } else {
            //error
            $this->blender->outError($mySystemSetting->getFieldName() . ' did not save correctly ');
            $this->blender->outError(print_r($mySystemSetting->getErrorMessages(), true), \LCI\Blend\Blender::VERBOSITY_DEBUG);
        }
    }
}

/**
 * Reverse the migrations.
 *
 * @return void
 */
public function down()
{
    /** @var \LCI\Blend\Blendable\SystemSetting $coreSchema */
    $coreSchema = $this->blender->getBlendableLoader()->getBlendableSystemSetting('link_tag_scheme');
    $coreSchema->setSeedsDir($this->getSeedsDir());

    if ($coreSchema->revertBlend()) {
        $this->blender->out($coreSchema->getFieldName() . ' was reverted correctly');
    }

    /** @var \LCI\Blend\Blendable\SystemSetting $coreFriendlyUrls */
    $coreFriendlyUrls = $this->blender->getBlendableLoader()->getBlendableSystemSetting('friendly_urls');
    $coreFriendlyUrls->setSeedsDir($this->getSeedsDir());
    
    if ($coreFriendlyUrls->revertBlend()) {
        $this->blender->out($coreFriendlyUrls->getFieldName() . ' was reverted correctly');
    }

    // More advanced:
    // MODX Namespace to attach system settings to
    $myPackageNamespace = $this->modx->getObject('modNamespace', 'myPackage');
    if (is_object($myPackageNamespace)) {
        $myPackageNamespace->remove();
    }

    foreach ($this->custom_system_settings as $setting => $details) {
        /** @var LCI\Blend\Blendable\SystemSetting $mySystemSetting */
        $mySystemSetting = $this->blender->getBlendableLoader()->getBlendableSystemSetting($setting);

        $mySystemSetting->setSeedsDir($this->getSeedsDir());

        if ($mySystemSetting->revertBlend()) {
            $this->blender->out($mySystemSetting->getFieldName() . ' was reverted correctly');

        } else {
            //error
            $this->blender->outError($mySystemSetting->getFieldName() . ' did not save correctly ');
            $this->blender->outError(print_r($mySystemSetting->getErrorMessages(), true), \LCI\Blend\Blender::VERBOSITY_DEBUG);
        }
    }
}