otrs -> rel-6_0 API documentation

NAME

Kernel::System::Ticket::Article::Backend::Invalid - backend for articles that have an unknown communication channel

DESCRIPTION

This is a fallback backend which exists for two purposes: first, to make sure that you can always chain-call on BackendForArticle, even if the article has a communication channel that is missing in the system. And second, to make it possible to delete such articles.

PUBLIC INTERFACE

ArticleCreate()

Dummy function. The invalid backend will not create any articles.

ArticleUpdate()

Dummy function. The invalid backend will not update any articles.

ArticleGet()

Returns article meta data as also returned by Kernel::System::Ticket::Article::ArticleList().

my %Article = $ArticleBackendObject->ArticleGet(
    TicketID      => 123,
    ArticleID     => 123,
    DynamicFields => 1,
);

ArticleDelete()

Delete an article. Override this method in your class.

my $Success = $ArticleBackendObject->ArticleDelete(
    TicketID  => 123,
    ArticleID => 123,
    UserID    => 123,
);

This method uses data stored in the communication channel entry to determine if there are any database tables that have foreign keys to the article table. Depending data will first be deleted, then the main article entry.

ArticleSearchableContentGet()

Dummy function. The invalid backend will not return any searchable data.

BackendSearchableFieldsGet()

Dummy function. The invalid backend will not return any searchable fields.

ArticleHasHTMLContent()

Dummy function. The invalid backend will always return 1.

ArticleAttachmentIndex()

Dummy function. The invalid backend will not return any attachments.

TERMS AND CONDITIONS

This software is part of the OTRS project (https://otrs.org/).

This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (GPL). If you did not receive this file, see https://www.gnu.org/licenses/gpl-3.0.txt.