FrontendRegistration

FrontendRegistration#

NAME#

Kernel::System::SysConfig::ValueType::FrontendRegistration - System configuration frontend registration value type backed.

PUBLIC INTERFACE#

new()#

Create an object. Do not use it directly, instead use:

use Kernel::System::ObjectManager;
local $Kernel::OM = Kernel::System::ObjectManager->new();
my $ValueTypeObject = $Kernel::OM->Get('Kernel::System::SysConfig::ValueType::FrontendRegistration');

SettingEffectiveValueCheck()#

Check if provided EffectiveValue matches structure defined in XMLContentParsed.

my %Result = $ValueTypeObject->SettingEffectiveValueCheck(
    XMLContentParsed => {
        Value => [
            {
                'Item' => [
                    {
                        # ...
                    },
                ],
            },
        ],
    },
    EffectiveValue => {
        # ...
    },
);
Result:
%Result = (
EffectiveValue => { # Note for FrontendRegistration ValueTypes EffectiveValue is not changed.

# …

}, Success => 1, Error => undef,

);

EffectiveValueGet()#

Extracts the effective value from a XML parsed setting.

my $EffectiveValue = $ValueTypeObject->EffectiveValueGet(
    Value => [
        {
            ValueRegex => '',                       # optional
            Content    => 'TheEffectiveValue',
            ValueType  => 'AValueType',             # optional
            # ...
        }
    ],
);

Returns:

$EffectiveValue = 'TheEffectiveValue';

SettingRender()#

Extracts the effective value from a XML parsed setting.

my $SettingHTML = $ValueTypeObject->SettingRender(
    Name           => 'SettingName',
    DefaultID      =>  123,             # (required)
    EffectiveValue => '2016-02-02',
    DefaultValue   => 'Product 5',      # (optional)
    Class          => 'My class',       # (optional)
    RW             => 1,                # (optional) Allow editing. Default 0.
    Item           => [                 # (optional) XML parsed item
        {
            'ValueType' => 'FrontendRegistration',
            'Content' => '2016-02-02',
            'ValueRegex' => '',
        },
    ],
    IsArray  => 1,                      # (optional) Item is part of the array
    IsHash   => 1,                      # (optional) Item is part of the hash
    IDSuffix => 1,                      # (optional) Suffix will be added to the element ID
    SkipEffectiveValueCheck => 1,       # (optional) If enabled, system will not perform effective value check.
                                        #            Default: 1.
);

Returns:

$SettingHTML = '<div class "Field"...</div>';
Contents