7.5. Core Modules

Core modules are located under $OTRS_HOME/Kernel/System/*. This layer is for the logical work. The modules are used to handle system routines like "lock ticket" and "create ticket". These modules always need pod (Perl Documentation).

A few common core modules are: Log (Kernel::System::Log); Ticket (Kernel::System::Ticket), Auth (Kernel::System::Auth), User (Kernel::System::User), Email (Kernel::System::Email).

For more information on the core modules see http://dev.otrs.org

Format:

# --
# Kernel/System/Backend.pm - a core module
# Copyright (C) 2001-2009 OTRS AG, http://otrs.org/
# --
# $Id: module-format.xml,v 1.26 2009/01/06 10:34:20 martin Exp $
# --
# 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 http://www.gnu.org/licenses/gpl-2.0.txt.
# --

package Kernel::System::Backend;

use strict;

=head1 NAME

Kernel::System::Log - global log interface

=head1 SYNOPSIS

All log functions.

=head1 PUBLIC INTERFACE

=over 4

=item new()

create a backend object

use Kernel::Config;
use Kernel::System::Backend;

my $ConfigObject = Kernel::Config->new();
my $BackendObject    = Kernel::System::Backend->new(ConfigObject => $ConfigObject);

=cut

sub new {
    my $Type = shift;
    my %Param = @_;
    [...]
    return $Self;
}

=item SomeMethodeA()

some info about the methode

$BackendObject->SomeMethodeA(ParamA => 'error', ParamB => "Need something!");

=cut

sub SomeMethodeA{
    my $Self = shift;
    my %Param = @_;
    [...]
    return 1;
}
1;

=head1 TERMS AND CONDITIONS

This software is part of the OTRS project (http://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 http://www.gnu.org/licenses/gpl-2.0.txt.

=head1 VERSION

$Revision: 1.26 $ $Date: 2009/01/06 10:34:20 $

=cut