NAME

Kernel::System::CustomPage – Custom page management.

DESCRIPTION

All Custom Page functions.

PUBLIC INTERFACE

CustomPageAdd()

Add a new custom page.

    my $CustomPageID = $CustomPageObject->CustomPageAdd(
        InternalTitle => 'Internal title',  # (required) Internal page title (visible in admin module only)
        Slug          => 'Action=Custom',   # (required) URL slug
        ValidID       => 1,                 # (required) ValidID
        UserID        => 1,                 # (required) User ID
    );

Returns: $CustomPageID = 1;

CustomPageLookup()

Preform a custom page lookup based on its ID or name.

    my $Result = $CustomPageObject->CustomPageLookup(
        InternalTitle => 'Internal title',  # (required) Internal page title
                                            # or
        CustomPageID => 1,                  # (required) Custom page ID
                                            # or
        Slug => 'page-slug',                # (required) Slug
    );

Returns: $Result = 1; # or $Result = 'Internal title';

CustomPageUpdate()

Update an existing custom page.

    my $Success = $CustomPageObject->CustomPageUpdate(
        CustomPageID  => 1,                 # (required) CustomPageID
        InternalTitle => 'Internal title',  # (required) Internal page title (visible in admin module only)
        Slug          => 'page-slug',       # (required) URL slug
        ValidID       => 1,                 # (required) ValidID
        UserID        => 1,                 # (required) User ID
    );

Returns: $Success = 1;

CustomPageGet()

Get a custom page.

    my %CustomPage = $CustomPageObject->CustomPageGet(
        CustomPageID => 1,
    );

Returns: %CustomPage = ( ID => 1, InternalTitle => 'Internal title', Slug => 'Action=Custom', ValidID => 1, CreateTime => '2018-05-21 15:50:25', CreateBy => 1, ChangeTime => '2018-05-21 15:50:25', ChangeBy => 1, );

CustomPageList()

Returns a list of custom pages.

    my @CustomPages = $CustomPageObject->CustomPageList(
        Valid => 1,    # (optional) Return only valid pages
    );

Returns: @CustomPages = ( { ID => 1, InternalTitle => 'Internal title', Slug => 'Action=Custom', ValidID => 1, CreateTime => '2018-05-21 15:50:25', CreateBy => 1, ChangeTime => '2018-05-21 15:50:25', ChangeBy => 1, }, … );

CustomPageDelete()

Delete Custom page.

    my $Success = $CustomPageObject->CustomPageDelete(
        CustomPageID => 1,    # (required) CustomPageID
    );

Returns: $Success = 1;