doxygen of otrs cvs ref man

379
OTRS CVS Generated by Doxygen 1.7.4 Wed Feb 8 2012 11:24:04

Upload: h4ck3rm1k3

Post on 08-Oct-2014

470 views

Category:

Documents


1 download

DESCRIPTION

http://adventuresinotrs.blogspot.com/2012/02/start-of-doxygen-for-otrs.html

TRANSCRIPT

Page 1: doxygen of OTRS cvs Ref Man

OTRSCVS

Generated by Doxygen 1.7.4

Wed Feb 8 2012 11:24:04

Page 2: doxygen of OTRS cvs Ref Man
Page 3: doxygen of OTRS cvs Ref Man

Contents

Page 4: doxygen of OTRS cvs Ref Man
Page 5: doxygen of OTRS cvs Ref Man

Chapter 1

Namespace Index

1.1 Namespace List

Here is a list of all documented namespaces with brief descriptions:

DOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Holds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Stores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Page 6: doxygen of OTRS cvs Ref Man

2 Namespace Index

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 7: doxygen of OTRS cvs Ref Man

Chapter 2

Class Index

2.1 Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

URI::_foreign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_generic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

URI::file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Algorithm::Diff::_impl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_ldap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_punycode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

URI::_login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::rlogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::tn3270 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

URI::_userpass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

URI::_login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Mail::Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminAttachment . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminAutoResponse . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminCustomerCompany . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminCustomerUser . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminCustomerUserGroup . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminCustomerUserService . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicField . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldCheckbox . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldDateTime . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldDropdown . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldMultiselect . . . . . . . . . . . . . . . . . . . . ??

Page 8: doxygen of OTRS cvs Ref Man

4 Class Index

Modules::AdminDynamicFieldText . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminGenericAgent . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceDebugger . . . . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceInvokerDefault . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceMappingSimple . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceOperationDefault . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceTransportHTTPSOAP . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceWebservice . . . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceWebserviceHistory . . . . . . . . . . . . . . ??Modules::AdminGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminMailAccount . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminNotificationEvent . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPackageManager . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPerformanceLog . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPGP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPostMasterFilter . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPriority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminQueueAutoResponse . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminQueueResponses . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminResponseAttachment . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminRoleGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminRoleUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSalutation . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminScheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSelectBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSignature . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSLA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSMIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSysConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSystemAddress . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminUserGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentCustomerSearch . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentDashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentHTMLReference . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentLinkObject . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 9: doxygen of OTRS cvs Ref Man

2.1 Class Hierarchy 5

Modules::AgentSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentSpelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentStats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketActionCommon . . . . . . . . . . . . . . . . . . . . . . ??

Modules::AgentTicketClose . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketFreeText . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketNote . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketOwner . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPending . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPriority . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketResponsible . . . . . . . . . . . . . . . . . . . . . ??

Modules::AgentTicketAttachment . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketBounce . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketBulk . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketCompose . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketCustomer . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketEscalationView . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketForward . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketHistory . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketLock . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketLockedView . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketMove . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPhone . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPhoneCommon . . . . . . . . . . . . . . . . . . . . . . ??

Modules::AgentTicketPhoneInbound . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPhoneOutbound . . . . . . . . . . . . . . . . . . . ??

Modules::AgentTicketPlain . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketQueue . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketResponsibleView . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketSearch . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketStatusView . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketWatcher . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketWatchView . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketZoom . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentZoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::ANONYMOUS . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ArchiveRestore . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::ObjectType::Article . . . . . . . . . . . . . . . ??Output::HTML::ArticleAttachmentDownload . . . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleAttachmentHTMLViewer . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleCheckPGP . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleCheckSMIME . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleComposeCrypt . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleComposeSign . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ArticleSearchIndex . . . . . . . . . . . . . . . ??IO::AtomicFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 10: doxygen of OTRS cvs Ref Man

6 Class Index

HTTP::Headers::Auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::AuthSession . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericAgent::AutoPriorityIncrease . . . . . . . . . . . . . . ??Kernel::System::AutoResponse . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::BackendCommon . . . . . . . . . . ??file::Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Dumper::Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Loader::Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::blessed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

MIME::Body::File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Body::Scalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

MIME::Body::InCore . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

JSON::Boolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::SMTP::TLS::ButMaintained . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CacheInternal . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Cap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Carp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

CGI::Fast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Pretty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

CGITempFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Checkbox . . . . . . . . . . . . . . ??Kernel::System::CheckItem . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::Client . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Acl::CloseParentAfterClosedChilds . . . . . . . . . . ??Kernel::System::PostMaster::Filter::CMD . . . . . . . . . . . . . . . . . . . . ??Type::code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Common . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::Common . . . . . . . . . . . . . ??HTTP::Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::ConnCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Locale::Codes::Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Cookie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Locale::Codes::Country . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::CRAM_MD5 . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::CRAM_MD5 . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Crypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Text::CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Text::CSV_PP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerAccept . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 11: doxygen of OTRS cvs Ref Man

2.1 Class Hierarchy 7

Kernel::System::CustomerAuth . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerCompany . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerGroup . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::CustomerHeaderMetaTicketSearch . . . . . . . . . . . . . . . ??Kernel::System::Ticket::CustomerPermission::CustomerIDCheck . . . . . . . ??Output::HTML::CustomerNewTicketQueueSelectionGeneric . . . . . . . . . . ??Modules::CustomerPreferences . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketAttachment . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketMessage . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketOverview . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketPrint . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketSearch . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketZoom . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerUser . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::CustomerUserGeneric . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::CustomerUserGenericTicket . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::CustomerPermission::CustomerUserIDCheck . . . . . ??Proc::Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardCalendar . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardIFrame . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardImage . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardMOTD . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardProductNotify . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardRSS . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardTicketGeneric . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardTicketStatsGeneric . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardUserOnline . . . . . . . . . . . . . . . . . . . . . ??URI::data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Date . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::DateTime . . . . . . . . . . . . . . ??Kernel::System::Web::UploadCache::DB . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::LoopProtection::DB . . . . . . . . . . . . . . . . ??Kernel::System::User::Preferences::DB . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::VirtualFS::DB . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::DB . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::AuthSession::DB . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerAuth::DB . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerUser::DB . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerUser::Preferences::DB . . . . . . . . . . . . . . . . ??Kernel::System::DB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::db2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Apache::DBI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Debugger . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericInterface::DebugLog . . . . . . . . . . . . . . . . . . ??MIME::Decoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

MIME::Decoder::Base64 . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::Gzip64 . . . . . . . . . . . . . . . . . . . . . . . . . ??

MIME::Decoder::Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::BinHex . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 12: doxygen of OTRS cvs Ref Man

8 Class Index

MIME::Decoder::NBit . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::QuotedPrint . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::UU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Kernel::Config::Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::XMLSchemaApacheSOAP::Deserializer . . . . . . . . . . . . ??Kernel::System::PostMaster::DestQueue . . . . . . . . . . . . . . . . . . . . ??Text::Diff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Algorithm::Diff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Algorithm::DiffOld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Authen::Digest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::DIGEST_MD5 . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite::Packager::DIME . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Packager::DIME . . . . . . . . . . . . . . . . . . . . . . . . . ??Proc::PID::File::Temp::Dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??DocumentFragment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::DoNotSendEmail . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Dropdown . . . . . . . . . . . . . . ??Kernel::System::LinkObject::Dummy . . . . . . . . . . . . . . . . . . . . . . ??YAML::Dumper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicFieldValue . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::EmailParser . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Encode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Text::CSV::ErrorDiag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::Escape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Headers::ETag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::EventHandler . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::EXTERNAL . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::EXTERNAL . . . . . . . . . . . . . . . . . . . . . . . . ??file::FAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??XML::FeedPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Fh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Mail::Field::Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Field::ParamVal . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

MIME::Field::ContDisp . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Field::ConTraEnc . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Field::ContType . . . . . . . . . . . . . . . . . . . . . . . . . ??

Kernel::System::Log::File . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::Filer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

MIME::Parser::FileInto . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::FileUnder . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Kernel::System::Cache::FileRaw . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Cache::FileStorable . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::FileTemp . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 13: doxygen of OTRS cvs Ref Man

2.1 Class Hierarchy 9

Mail::Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::FollowUp . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::FollowUpArticleTypeCheck . . . . . . . . ??Kernel::System::Ticket::Event::ForceOwnerReset . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ForceState . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ForceUnlock . . . . . . . . . . . . . . . . . . . ??Kernel::System::VirtualFS::FS . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::UploadCache::FS . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::LoopProtection::FS . . . . . . . . . . . . . . . . ??Kernel::System::AuthSession::FS . . . . . . . . . . . . . . . . . . . . . . . . ??URI::ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Class::Inspector::Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Config::GenericAgent . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericAgent . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Scheduler::TaskHandler::GenericInterface . . . . . . . . . . . . . . . ??LWP::Protocol::GHTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::glob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::gopher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Permission::GroupCheck . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::CustomerPermission::GroupCheck . . . . . . . . . . ??Authen::SASL::Perl::GSSAPI . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Event::Handler . . . . . . . . . . . . . . . . . . . . ??MIME::Head . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::HeaderMetaRefresh . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::HeaderMetaTicketSearch . . . . . . . . . . . . . . . . . . . . ??HTTP::Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::UnitTest::Helper . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::HTMLUtils . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::HTTPBasicAuth . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerAuth::HTTPBasicAuth . . . . . . . . . . . . . . . . ??URI::https . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::IMAP . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::IMAPS . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::IMAPTLS . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::ingres . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::InnerFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Class::Inspector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::InterfaceAgent . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::InterfaceCustomer . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::InterfaceInstaller . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::InterfacePublic . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Invoker . . . . . . . . . . . . . . . . . . . . . . . . ??URI::IRI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??urn::isbn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??XML::FeedPP::Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 14: doxygen of OTRS cvs Ref Man

10 Class Index

JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutAJAX . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutDatepicker . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutLoader . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutPopup . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutTicket . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::ldap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::Sync::LDAP . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerAuth::LDAP . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerUser::LDAP . . . . . . . . . . . . . . . . . . . . . ??URI::ldapi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::ldaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::LinkObject . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LinkObjectTicket . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??XML::Parser::Lite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Encode::Locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::LOGIN . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::LoopProtection . . . . . . . . . . . . . . . . . . ??file::Mac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Mail::Mailer::rfc822 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::qmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::sendmail . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::smtp . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::smtps . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::testfile . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

URI::mailto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Main . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Manages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Mapping . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Marshall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??IO::WrapTie::Master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::Match . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::MatchDBSource . . . . . . . . . . . . . . ??LWP::MemberMixin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

LWP::Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Transport::HTTP::Test::CustomHTTPProtocol ??LWP::Protocol::cpan . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::data . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::file . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 15: doxygen of OTRS cvs Ref Man

2.1 Class Hierarchy 11

LWP::Protocol::ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::gopher . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::http . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::loopback . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::mailto . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::nntp . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::nogo . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

LWP::UserAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::RobotUA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

HTTP::Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

CSS::Minifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??JavaScript::Minifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::mms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Mo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::mssql . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MultipartBuffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Multiselect . . . . . . . . . . . . . . ??Kernel::System::DB::mysql . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::NagiosAcknowledge . . . . . . . . . . . . . . ??Output::HTML::NavBarCustomerCompany . . . . . . . . . . . . . . . . . . . ??Output::HTML::NavBarModuleAdmin . . . . . . . . . . . . . . . . . . . . . . ??URI::news . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::NewTicket . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::NewTicketReject . . . . . . . . . . . . . . ??URI::nntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationAgentOnline . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationAgentTicketEscalation . . . . . . . . . . . . . . . . ??Output::HTML::NotificationCustomerOnline . . . . . . . . . . . . . . . . . . . ??Kernel::System::NotificationEvent . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::NotificationEvent . . . . . . . . . . . . . . . . ??Output::HTML::NotificationGeneric . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationOutofOfficeCheck . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationSchedulerCheck . . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationUIDCheck . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericAgent::NotifyAgentGroupOfCustomQueue . . . . . . ??Kernel::System::GenericAgent::NotifyAgentGroupWithWritePermission . . . . ??Kernel::System::GenericInterface::ObjectLockState . . . . . . . . . . . . . . ??urn::oid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . ??file::OS2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::OutputFilterTextAutoLink . . . . . . . . . . . . . . . . . . . . ??Output::HTML::OutputFilterTextURL . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Permission::OwnerCheck . . . . . . . . . . . . . . . ??Kernel::System::Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite::Packager . . . . . . . . . . . . . . . . . . . . . . . . . . ??

HTTP::SOAP::Lite::Packager::MIME . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 16: doxygen of OTRS cvs Ref Man

12 Class Index

HTTP::SOAP::Packager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

HTTP::SOAP::Packager::MIME . . . . . . . . . . . . . . . . . . . . . . . ??

parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Crypt::PasswdMD5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Date::Pcalc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::PictureUpload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::smtp::pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::smtps::pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::testfile::pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::IMAP::Simple::PipeSocket . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::PLAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . ??XML::FeedPP::Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::POP3 . . . . . . . . . . . . . . . . . . . . . . ??Mail::POP3Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::POP3S . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::postgresql . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::postgresql_before_8_2 . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster . . . . . . . . . . . . . . . . . . . . . . . . . . . ??JSON::Backend::PP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesCustomQueue . . . . . . . . . . . . . . . . . . . ??Kernel::System::Service::PreferencesDB . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SLA::PreferencesDB . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Queue::PreferencesDB . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesGeneric . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesLanguage . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesOutOfOffice . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesPassword . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesPGP . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesSkin . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesSMIME . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesTheme . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesTicketWatcher . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesTimeZone . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SysConfig::PriorityValidate . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Provider . . . . . . . . . . . . . . . . . . . . . . . ??Provides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::PublicDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::PublicRepository . . . . . . . . . . . . . . . . . . . . . . . . . . . ??file::QNX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::QueryParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::QueuePreferencesGeneric . . . . . . . . . . . . . . . . . . . ??Kernel::System::SysConfig::QueueValidate . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::Radius . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 17: doxygen of OTRS cvs Ref Man

2.1 Class Hierarchy 13

Kernel::System::CustomerAuth::Radius . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::ReferenceData . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::regexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Reject . . . . . . . . . . . . . . . . . . . . . . . ??Apache2::Reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Represents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::Request . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Requester . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ResponsibleAutoSet . . . . . . . . . . . . . . ??Kernel::System::Ticket::Permission::ResponsibleCheck . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ResponsibleForQueue . . . . . . . . . . . . . ??Kernel::GenericInterface::Transport::HTTP::REST . . . . . . . . . . . . . . . ??MIME::Parser::Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::rsync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::rtsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::rtspu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Salutation . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??IO::ScalarArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

IO::Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SearchProfile . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::UnitTest::Selenium . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::Sendmail . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::XMLSchema1999::Serializer . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::XMLSchema::Serializer . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::XMLSchema2001::Serializer . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::Server . . . . . . . . . . . . . . . . . . . . . ??

HTTP::SOAP::Transport::HTTP::Apache . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::CGI . . . . . . . . . . . . . . . . . . . . ??

HTTP::SOAP::Transport::HTTP::FCGI . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::Daemon . . . . . . . . . . . . . . . . . . ??

Kernel::System::Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ServicePreferencesGeneric . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Session::SessionIDGet . . . . . . . . . . ??Kernel::System::Signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Mapping::Simple . . . . . . . . . . . . . . . . . . . ??URI::sip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::sips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SLA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::SLAPreferencesGeneric . . . . . . . . . . . . . . . . . . . . ??IO::WrapTie::Slave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

IO::WrapTie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::SMTP . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::SMTPS . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::SMTPTLS . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 18: doxygen of OTRS cvs Ref Man

14 Class Index

URI::snews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Transport::HTTP::SOAP . . . . . . . . . . . . . . . ??LWP::Protocol::http::SocketMethods . . . . . . . . . . . . . . . . . . . . . . ??

LWP::Protocol::http::Socket . . . . . . . . . . . . . . . . . . . . . . . . . ??

Kernel::System::Spelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::SpellingInline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::Split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::IMAP::Simple::SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::SMTP::SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::POP3::SSLWrapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::StandardResponse . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Stats::Static::StateAction . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SysConfig::StateValidate . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::StdAttachment . . . . . . . . . . . . . . . . . . . . . . . . . ??JSON::Backend::XS::Supportable . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SysConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Log::SysLog . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SystemAddress . . . . . . . . . . . . . . . . . . . . . . . . ??var::packagesetup::SystemMonitoring . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::SystemMonitoring . . . . . . . . . . . . . ??Modules::SystemStatsGeneric . . . . . . . . . . . . . . . . . . . . . . . . . ??Text::Diff::Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Scheduler::TaskHandler . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Scheduler::TaskManager . . . . . . . . . . . . . . . . . . . ??Proc::PID::File::Temp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::TemplateGenerator . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Invoker::Test::Test . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Test::Test . . . . . . . . . . . . . . . . . ??Modules::Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Scheduler::TaskHandler::Test . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::Test . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Mapping::Test . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Transport::HTTP::Test . . . . . . . . . . . . . . . . ??TestFieldTypeModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??TestPostEventModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Invoker::Test::TestSimple . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Text . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::TextArea . . . . . . . . . . . . . . . ??TextPatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??This . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Stats::Dynamic::Ticket . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::LinkObject::Ticket . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::ObjectType::Ticket . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketAcceleratorUpdate . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 19: doxygen of OTRS cvs Ref Man

2.1 Class Hierarchy 15

Kernel::System::Stats::Dynamic::TicketAccountedTime . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::TicketCreate . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketDynamicFieldDefault . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketEscalationIndex . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::TicketGet . . . . . . . . . . . . . ??Kernel::System::Stats::Dynamic::TicketList . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuGeneric . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuLock . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuMove . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuResponsible . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuTicketWatcher . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketNewMessageUpdate . . . . . . . . . . . ??Output::HTML::TicketOverviewMedium . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketOverviewPreview . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketOverviewSmall . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketPendingTimeReset . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::TicketSearch . . . . . . . . . . . ??Kernel::System::TicketSearch . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Kernel::System::Ticket . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Kernel::System::Stats::Dynamic::TicketSolutionResponseTime . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::TicketUpdate . . . . . . . . . . . ??Kernel::System::Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarLink . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketLocked . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketResponsible . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketSearchFulltext . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketSearchProfile . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketWatcher . . . . . . . . . . . . . . . . . . . . . . ??MIME::Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

MIME::ToolUtils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Kernel::GenericInterface::Transport . . . . . . . . . . . . . . . . . . . . . . . ??XML::TreePP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericAgent::TriggerEscalationStartEvents . . . . . . . . . ??Kernel::System::Ticket::Event::TriggerEscalationStopEvents . . . . . . . . . . ??Kernel::System::Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::undef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::UnitTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??file::Unix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::UploadCache . . . . . . . . . . . . . . . . . . . . . . ??URI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::urn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Headers::Util . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Util . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Util . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite::Utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Valid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 20: doxygen of OTRS cvs Ref Man

16 Class Index

Kernel::System::VariableCheck . . . . . . . . . . . . . . . . . . . . . . . . . ??Virtual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::VirtualFS . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Permission::WatcherCheck . . . . . . . . . . . . . . . ??Kernel::System::GenericInterface::Webservice . . . . . . . . . . . . . . . . . ??Kernel::System::GenericInterface::WebserviceHistory . . . . . . . . . . . . . ??Kernel::System::WebUserAgent . . . . . . . . . . . . . . . . . . . . . . . . . ??file::Win32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::WithBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::WordDecoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

MIME::WordDecoder::ISO_8859 . . . . . . . . . . . . . . . . . . . . . . ??MIME::WordDecoder::US_ASCII . . . . . . . . . . . . . . . . . . . . ??

MIME::Words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??IO::Wrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::XMLMaster . . . . . . . . . . . . . . . . . . . . . . . . . . . ??JSON::Backend::XS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 21: doxygen of OTRS cvs Ref Man

Chapter 3

Class Index

3.1 Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

URI::_foreign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_generic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Algorithm::Diff::_impl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_ldap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_punycode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::_userpass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminAttachment . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminAutoResponse . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminCustomerCompany . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminCustomerUser . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminCustomerUserGroup . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminCustomerUserService . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicField . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldCheckbox . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldDateTime . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldDropdown . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldMultiselect . . . . . . . . . . . . . . . . . . . . ??Modules::AdminDynamicFieldText . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminGenericAgent . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceDebugger . . . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceInvokerDefault . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceMappingSimple . . . . . . . . . . . . . . . ??

Page 22: doxygen of OTRS cvs Ref Man

18 Class Index

Modules::AdminGenericInterfaceOperationDefault . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceTransportHTTPSOAP . . . . . . . . . . . . ??Modules::AdminGenericInterfaceWebservice . . . . . . . . . . . . . . . . . ??Modules::AdminGenericInterfaceWebserviceHistory . . . . . . . . . . . . . . ??Modules::AdminGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminInit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminMailAccount . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminNotification . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminNotificationEvent . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPackageManager . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPerformanceLog . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPGP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPostMasterFilter . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminPriority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminQueueAutoResponse . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminQueueResponses . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminResponseAttachment . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminRole . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminRoleGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminRoleUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSalutation . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminScheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSelectBox . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSession . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSignature . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSLA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSMIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSysConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminSystemAddress . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AdminUserGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentCustomerSearch . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentDashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentHTMLReference . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentLinkObject . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentSpelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentStats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketActionCommon . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketAttachment . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketBounce . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 23: doxygen of OTRS cvs Ref Man

3.1 Class List 19

Modules::AgentTicketBulk . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketClose . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketCompose . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketCustomer . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketEscalationView . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketForward . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketFreeText . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketHistory . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketLock . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketLockedView . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketMerge . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketMove . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketNote . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketOwner . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPending . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPhone . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPhoneCommon . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPhoneInbound . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPhoneOutbound . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPlain . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPrint . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketPriority . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketQueue . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketResponsible . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketResponsibleView . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketSearch . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketStatusView . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketWatcher . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketWatchView . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentTicketZoom . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::AgentZoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::ANONYMOUS . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::Apache . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ArchiveRestore . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::ObjectType::Article . . . . . . . . . . . . . . ??Output::HTML::ArticleAttachmentDownload . . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleAttachmentHTMLViewer . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleCheckPGP . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleCheckSMIME . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleComposeCrypt . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ArticleComposeSign . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ArticleSearchIndex . . . . . . . . . . . . . . . ??IO::AtomicFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Headers::Auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::AuthSession . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericAgent::AutoPriorityIncrease . . . . . . . . . . . . . . ??Kernel::System::AutoResponse . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 24: doxygen of OTRS cvs Ref Man

20 Class Index

Kernel::System::DynamicField::Backend::BackendCommon . . . . . . . . . . ??file::Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Dumper::Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Loader::Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::Base64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::BinHex . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::blessed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??JSON::Boolean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::SMTP::TLS::ButMaintained . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CacheInternal . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Cap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Carp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::CGI . . . . . . . . . . . . . . . . . . . . . . ??CGI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGITempFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Checkbox . . . . . . . . . . . . . . ??Kernel::System::CheckItem . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::Client . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Acl::CloseParentAfterClosedChilds . . . . . . . . . . ??Kernel::System::PostMaster::Filter::CMD . . . . . . . . . . . . . . . . . . . . ??Type::code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Common . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::Common . . . . . . . . . . . . . ??HTTP::Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::ConnCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Locale::Codes::Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Field::ContDisp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Field::ConTraEnc . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Field::ContType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Cookie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Locale::Codes::Country . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::cpan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::CRAM_MD5 . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::CRAM_MD5 . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Crypt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Text::CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Text::CSV_PP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerAccept . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerAuth . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerCompany . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerGroup . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::CustomerHeaderMetaTicketSearch . . . . . . . . . . . . . . ??Kernel::System::Ticket::CustomerPermission::CustomerIDCheck . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 25: doxygen of OTRS cvs Ref Man

3.1 Class List 21

Output::HTML::CustomerNewTicketQueueSelectionGeneric . . . . . . . . . ??Modules::CustomerPreferences . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketAttachment . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketMessage . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketOverview . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketPrint . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketSearch . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::CustomerTicketZoom . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerUser . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::CustomerUserGeneric . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::CustomerUserGenericTicket . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::CustomerPermission::CustomerUserIDCheck . . . . ??Kernel::GenericInterface::Transport::HTTP::Test::CustomHTTPProtocol . . . . ??Proc::Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::Daemon . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardCalendar . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardIFrame . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardImage . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardMOTD . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardProductNotify . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardRSS . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardTicketGeneric . . . . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardTicketStatsGeneric . . . . . . . . . . . . . . . . . ??Output::HTML::DashboardUserOnline . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Field::Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Date . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::DateTime . . . . . . . . . . . . . . ??Kernel::System::Web::UploadCache::DB . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::LoopProtection::DB . . . . . . . . . . . . . . . ??Kernel::System::User::Preferences::DB . . . . . . . . . . . . . . . . . . . . ??Kernel::System::VirtualFS::DB . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::DB . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::AuthSession::DB . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerAuth::DB . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerUser::DB . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerUser::Preferences::DB . . . . . . . . . . . . . . . ??Kernel::System::DB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::db2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Apache::DBI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Debugger . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericInterface::DebugLog . . . . . . . . . . . . . . . . . ??MIME::Decoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Config::Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::XMLSchemaApacheSOAP::Deserializer . . . . . . . . . . . . ??Kernel::System::PostMaster::DestQueue . . . . . . . . . . . . . . . . . . . . ??Text::Diff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Algorithm::Diff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Algorithm::DiffOld . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 26: doxygen of OTRS cvs Ref Man

22 Class Index

LWP::Authen::Digest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::DIGEST_MD5 . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite::Packager::DIME . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Packager::DIME . . . . . . . . . . . . . . . . . . . . . . . . . ??Proc::PID::File::Temp::Dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??DocumentFragment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::DoNotSendEmail . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Dropdown . . . . . . . . . . . . . . ??Kernel::System::LinkObject::Dummy . . . . . . . . . . . . . . . . . . . . . . ??YAML::Dumper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicFieldValue . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::EmailParser . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Encode . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Text::CSV::ErrorDiag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::Escape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Headers::ETag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::EventHandler . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::EXTERNAL . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::EXTERNAL . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Fast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??file::FAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::FCGI . . . . . . . . . . . . . . . . . . . . . ??XML::FeedPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Fh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Log::File . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Body::File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::FileInto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::Filer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Cache::FileRaw . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Cache::FileStorable . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::FileTemp . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::FileUnder . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::FollowUp . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::FollowUpArticleTypeCheck . . . . . . . . ??Kernel::System::Ticket::Event::ForceOwnerReset . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ForceState . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ForceUnlock . . . . . . . . . . . . . . . . . . ??Kernel::System::VirtualFS::FS . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::UploadCache::FS . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::LoopProtection::FS . . . . . . . . . . . . . . . ??Kernel::System::AuthSession::FS . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 27: doxygen of OTRS cvs Ref Man

3.1 Class List 23

LWP::Protocol::ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::ftp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Class::Inspector::Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Config::GenericAgent . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericAgent . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Scheduler::TaskHandler::GenericInterface . . . . . . . . . . . . . . . ??LWP::Protocol::GHTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::glob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::gopher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::gopher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Permission::GroupCheck . . . . . . . . . . . . . . . ??Kernel::System::Ticket::CustomerPermission::GroupCheck . . . . . . . . . . ??Authen::SASL::Perl::GSSAPI . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::Gzip64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Event::Handler . . . . . . . . . . . . . . . . . . . . ??MIME::Head . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::HeaderMetaRefresh . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::HeaderMetaTicketSearch . . . . . . . . . . . . . . . . . . . ??HTTP::Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::UnitTest::Helper . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::HTMLUtils . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::http . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::HTTPBasicAuth . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerAuth::HTTPBasicAuth . . . . . . . . . . . . . . . . ??URI::https . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::IMAP . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::IMAPS . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::IMAPTLS . . . . . . . . . . . . . . . . . . . . ??MIME::Body::InCore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::ingres . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::InnerFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Class::Inspector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::InterfaceAgent . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::InterfaceCustomer . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::InterfaceInstaller . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::InterfacePublic . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Invoker . . . . . . . . . . . . . . . . . . . . . . . . ??URI::IRI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??urn::isbn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::WordDecoder::ISO_8859 . . . . . . . . . . . . . . . . . . . . . . . . ??XML::FeedPP::Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutAJAX . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 28: doxygen of OTRS cvs Ref Man

24 Class Index

Output::HTML::LayoutDatepicker . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutLoader . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutPopup . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LayoutTicket . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::ldap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::Sync::LDAP . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerAuth::LDAP . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerUser::LDAP . . . . . . . . . . . . . . . . . . . . . ??URI::ldapi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::ldaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??IO::Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::LinkObject . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::LinkObjectTicket . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??XML::Parser::Lite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Loader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Encode::Locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::LOGIN . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::loopback . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::LoopProtection . . . . . . . . . . . . . . . . . . ??file::Mac . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::mailto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::mailto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Main . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Manages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Mapping . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Marshall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??IO::WrapTie::Master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::Match . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::MatchDBSource . . . . . . . . . . . . . . ??LWP::MemberMixin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite::Packager::MIME . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Packager::MIME . . . . . . . . . . . . . . . . . . . . . . . . . ??CSS::Minifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??JavaScript::Minifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::mms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Mo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::mssql . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MultipartBuffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Multiselect . . . . . . . . . . . . . ??Kernel::System::DB::mysql . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::NagiosAcknowledge . . . . . . . . . . . . . . ??Output::HTML::NavBarCustomerCompany . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 29: doxygen of OTRS cvs Ref Man

3.1 Class List 25

Output::HTML::NavBarModuleAdmin . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::NBit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::news . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::NewTicket . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::NewTicketReject . . . . . . . . . . . . . ??LWP::Protocol::nntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::nntp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::nogo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Notification . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationAgentOnline . . . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationAgentTicketEscalation . . . . . . . . . . . . . . . ??Output::HTML::NotificationCustomerOnline . . . . . . . . . . . . . . . . . . ??Kernel::System::NotificationEvent . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::NotificationEvent . . . . . . . . . . . . . . . . ??Output::HTML::NotificationGeneric . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationOutofOfficeCheck . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationSchedulerCheck . . . . . . . . . . . . . . . . . . ??Output::HTML::NotificationUIDCheck . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericAgent::NotifyAgentGroupOfCustomQueue . . . . . . ??Kernel::System::GenericAgent::NotifyAgentGroupWithWritePermission . . . . ??Kernel::System::GenericInterface::ObjectLockState . . . . . . . . . . . . . . ??urn::oid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . ??file::OS2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::OutputFilterTextAutoLink . . . . . . . . . . . . . . . . . . . . ??Output::HTML::OutputFilterTextURL . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Permission::OwnerCheck . . . . . . . . . . . . . . . ??Kernel::System::Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite::Packager . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Packager . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Field::ParamVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Crypt::PasswdMD5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Date::Pcalc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PDF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::PictureUpload . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::smtp::pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::smtps::pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::testfile::pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::IMAP::Simple::PipeSocket . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL::Perl::PLAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . ??XML::FeedPP::Plugin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::pop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::POP3 . . . . . . . . . . . . . . . . . . . . . . ??Mail::POP3Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::MailAccount::POP3S . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DB::postgresql . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 30: doxygen of OTRS cvs Ref Man

26 Class Index

Kernel::System::DB::postgresql_before_8_2 . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster . . . . . . . . . . . . . . . . . . . . . . . . . . ??JSON::Backend::PP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesCustomQueue . . . . . . . . . . . . . . . . . . . ??Kernel::System::Service::PreferencesDB . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SLA::PreferencesDB . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Queue::PreferencesDB . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesGeneric . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesLanguage . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesOutOfOffice . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesPassword . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesPGP . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesSkin . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesSMIME . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesTheme . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesTicketWatcher . . . . . . . . . . . . . . . . . . . ??Output::HTML::PreferencesTimeZone . . . . . . . . . . . . . . . . . . . . . ??CGI::Pretty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SysConfig::PriorityValidate . . . . . . . . . . . . . . . . . . ??LWP::Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Provider . . . . . . . . . . . . . . . . . . . . . . . ??Provides . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::PublicDefault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::PublicRepository . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::qmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??file::QNX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::QueryParam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Queue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::QueuePreferencesGeneric . . . . . . . . . . . . . . . . . . . ??Kernel::System::SysConfig::QueueValidate . . . . . . . . . . . . . . . . . . ??MIME::Decoder::QuotedPrint . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Auth::Radius . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::CustomerAuth::Radius . . . . . . . . . . . . . . . . . . . . ??MIME::Parser::Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::ref . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::ReferenceData . . . . . . . . . . . . . . . . . . . . . . . . ??Type::regexp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Reject . . . . . . . . . . . . . . . . . . . . . . ??Apache2::Reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Represents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::Request . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Requester . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ResponsibleAutoSet . . . . . . . . . . . . . . ??Kernel::System::Ticket::Permission::ResponsibleCheck . . . . . . . . . . . . ??Kernel::System::Ticket::Event::ResponsibleForQueue . . . . . . . . . . . . . ??Kernel::GenericInterface::Transport::HTTP::REST . . . . . . . . . . . . . . . ??MIME::Parser::Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 31: doxygen of OTRS cvs Ref Man

3.1 Class List 27

Mail::Mailer::rfc822 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::rlogin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::RobotUA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::rsync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::rtsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::rtspu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Salutation . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Authen::SASL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Body::Scalar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??IO::ScalarArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SearchProfile . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::UnitTest::Selenium . . . . . . . . . . . . . . . . . . . . . . ??Mail::Send . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::sendmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::Sendmail . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::XMLSchema1999::Serializer . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::XMLSchema::Serializer . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::XMLSchema2001::Serializer . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Transport::HTTP::Server . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ServicePreferencesGeneric . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Session::SessionIDGet . . . . . . . . . ??Kernel::System::Signature . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Mapping::Simple . . . . . . . . . . . . . . . . . . . ??URI::sip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::sips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SLA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::SLAPreferencesGeneric . . . . . . . . . . . . . . . . . . . . ??IO::WrapTie::Slave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::smtp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::SMTP . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::SMTPS . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::smtps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Email::SMTPTLS . . . . . . . . . . . . . . . . . . . . . . . ??URI::snews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Transport::HTTP::SOAP . . . . . . . . . . . . . . . ??LWP::Protocol::http::Socket . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::Protocol::http::SocketMethods . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Spelling . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Modules::SpellingInline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::Split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::ssh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::IMAP::Simple::SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::SMTP::SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Net::POP3::SSLWrapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::StandardResponse . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Stats::Static::StateAction . . . . . . . . . . . . . . . . . . . ??Kernel::System::SysConfig::StateValidate . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 32: doxygen of OTRS cvs Ref Man

28 Class Index

Kernel::System::Stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::StdAttachment . . . . . . . . . . . . . . . . . . . . . . . . . ??JSON::Backend::XS::Supportable . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SysConfig . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Log::SysLog . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::SystemAddress . . . . . . . . . . . . . . . . . . . . . . . . ??var::packagesetup::SystemMonitoring . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::PostMaster::Filter::SystemMonitoring . . . . . . . . . . . . . ??Modules::SystemStatsGeneric . . . . . . . . . . . . . . . . . . . . . . . . . ??Text::Diff::Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Scheduler::TaskHandler . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Scheduler::TaskManager . . . . . . . . . . . . . . . . . . . ??URI::telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Proc::PID::File::Temp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::TemplateGenerator . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Invoker::Test::Test . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Test::Test . . . . . . . . . . . . . . . . . ??Modules::Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::Scheduler::TaskHandler::Test . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::Test . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Mapping::Test . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Transport::HTTP::Test . . . . . . . . . . . . . . . . ??TestFieldTypeModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Mailer::testfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??TestPostEventModule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Invoker::Test::TestSimple . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::Text . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::Backend::TextArea . . . . . . . . . . . . . . ??TextPatch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??This . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Stats::Dynamic::Ticket . . . . . . . . . . . . . . . . . . . . ??Kernel::System::LinkObject::Ticket . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::DynamicField::ObjectType::Ticket . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketAcceleratorUpdate . . . . . . . . . . . . ??Kernel::System::Stats::Dynamic::TicketAccountedTime . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::TicketCreate . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketDynamicFieldDefault . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketEscalationIndex . . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::TicketGet . . . . . . . . . . . . . ??Kernel::System::Stats::Dynamic::TicketList . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuGeneric . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuLock . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuMove . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuResponsible . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketMenuTicketWatcher . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketNewMessageUpdate . . . . . . . . . . . ??Output::HTML::TicketOverviewMedium . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 33: doxygen of OTRS cvs Ref Man

3.1 Class List 29

Output::HTML::TicketOverviewPreview . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::TicketOverviewSmall . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Event::TicketPendingTimeReset . . . . . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::TicketSearch . . . . . . . . . . . ??Kernel::System::TicketSearch . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Stats::Dynamic::TicketSolutionResponseTime . . . . . . . . ??Kernel::GenericInterface::Operation::Ticket::TicketUpdate . . . . . . . . . . . ??Kernel::System::Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::tn3270 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarLink . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketLocked . . . . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketResponsible . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketSearchFulltext . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketSearchProfile . . . . . . . . . . . . . . . . . . . ??Output::HTML::ToolBarTicketWatcher . . . . . . . . . . . . . . . . . . . . . ??MIME::Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::ToolUtils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::GenericInterface::Transport . . . . . . . . . . . . . . . . . . . . . . . ??XML::TreePP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::GenericAgent::TriggerEscalationStartEvents . . . . . . . . . ??Kernel::System::Ticket::Event::TriggerEscalationStopEvents . . . . . . . . . . ??Kernel::System::Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Type::undef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::UnitTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??file::Unix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Web::UploadCache . . . . . . . . . . . . . . . . . . . . . . ??URI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::urn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::WordDecoder::US_ASCII . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??LWP::UserAgent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::Headers::Util . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??CGI::Util . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Mail::Util . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??HTTP::SOAP::Lite::Utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::Decoder::UU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Valid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::VariableCheck . . . . . . . . . . . . . . . . . . . . . . . . . ??Virtual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::VirtualFS . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML::Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::Ticket::Permission::WatcherCheck . . . . . . . . . . . . . . ??Kernel::System::GenericInterface::Webservice . . . . . . . . . . . . . . . . . ??Kernel::System::GenericInterface::WebserviceHistory . . . . . . . . . . . . . ??Kernel::System::WebUserAgent . . . . . . . . . . . . . . . . . . . . . . . . ??file::Win32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??URI::WithBase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??MIME::WordDecoder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 34: doxygen of OTRS cvs Ref Man

30 Class Index

MIME::Words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??IO::Wrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??IO::WrapTie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??Kernel::System::XMLMaster . . . . . . . . . . . . . . . . . . . . . . . . . . ??JSON::Backend::XS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??YAML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ??

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 35: doxygen of OTRS cvs Ref Man

Chapter 4

Namespace Documentation

4.1 DOM Namespace Reference

4.1.1 Detailed Description

Defines the CKEDITOR.dom object, which contains DOM manipulation objects andfunction. manipulation objects, classes and functions.

See also

CKEDITOR.dom.elementCKEDITOR.dom.node

4.2 Environment Namespace Reference

4.2.1 Detailed Description

Defines the CKEDITOR.env object, which constains environment and browser informa-tion.

4.3 Holds Namespace Reference

4.3.1 Detailed Description

Defines the CKEDITOR.dtd object, which holds the DTD mapping for XHTML 1.0 Tran-sitional. This file was automatically generated from the file: xhtml1-transitional.dtd.and object representation of the HTML DTD to be used by the editor in its internal op-erations.

Each element in the DTD is represented by a property in this object. Each propertycontains the list of elements that can be contained by the element. Text is represented

Page 36: doxygen of OTRS cvs Ref Man

32 Namespace Documentation

by the "#" property.

Several special grouping properties are also available. Their names start with the "$"character.

4.4 Stores Namespace Reference

4.4.1 Detailed Description

default configuration settings. Changes to this object are reflected in all editor instances,if not specified otherwise for a particular instance.

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 37: doxygen of OTRS cvs Ref Man

Chapter 5

Class Documentation

5.1 URI:: foreign Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_foreign.pm

5.2 URI:: generic Class Reference

Inheritance diagram for URI::_generic:

URI::_generic

URI::file

Public Member Functions

Public Object Methods

• retval authority (scalar auth)• retval path ()• retval path_query ()• retval path_segments ()• retval abs ()• retval rel ()

Protected Object Methods

• protected retval _split_segment ()

Page 38: doxygen of OTRS cvs Ref Man

34 Class Documentation

Protected Functions

• protected retval _no_scheme_ok ()• protected retval _check_path (scalar path, scalar pre)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_generic.pm

5.3 Algorithm::Diff:: impl Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar us, scalar seq1, scalar seq2, scalar opts)• retval new (scalar package)

Public Functions

• retval Die ()• retval getObjPkg (scalar us)• retval Reset (scalar me, scalar pos)• retval Base (scalar me, scalar base)• retval Copy (scalar me, scalar pos, scalar base)• retval Next (scalar me, scalar steps)• retval Prev (scalar me, scalar steps)• retval Diff (scalar me)• retval Min (scalar me, scalar seq, scalar base)• retval Max (scalar me, scalar seq, scalar base)• retval Range (scalar me, scalar seq, scalar base)• retval Items (scalar me, scalar seq)• retval Same (scalar me)• retval Get ()• retval clone (scalar old)• retval hash ()

Protected Functions

• protected retval _Idx ()• protected retval _End ()• protected retval _Same ()• protected retval _Base ()• protected retval _Pos ()• protected retval _Off ()• protected retval _Min ()• protected retval _ChkPos (scalar me)• protected retval _ChkSeq (scalar me, scalar seq)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Algorithm/Diff.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 39: doxygen of OTRS cvs Ref Man

5.4 URI::_ldap Class Reference 35

5.4 URI:: ldap Class Reference

Public Member Functions

Public Object Methods

• retval dn ()• retval attributes ()• retval extensions (scalar key, scalar value)• retval canonical ()

Public Functions

• retval scope ()• retval filter ()

Protected Object Methods

• protected retval _ldap_elem (scalar elem)• protected retval _scope ()• protected retval _filter ()

Protected Functions

• protected retval _normalize_dn (scalar dn)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_ldap.pm

5.5 URI:: login Class Reference

Inheritance diagram for URI::_login:

URI::_login

URI::_server URI::_userpass

URI::rlogin URI::telnet URI::tn3270

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_login.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 40: doxygen of OTRS cvs Ref Man

36 Class Documentation

5.6 URI:: punycode Class Reference

Public Member Functions

Public Functions

• retval digit_value (scalar code)• retval code_point (scalar digit)• retval adapt (scalar delta, scalar numpoints, scalar firsttime)• retval decode_punycode (scalar code)• retval encode_punycode (scalar input)• retval min (scalar min)

Protected Functions

• protected retval _croak ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_punycode.pm

5.7 URI:: query Class Reference

Public Member Functions

Public Object Methods

• retval query (scalar q)• retval query_keywords ()

Public Functions

• retval query_form (scalar r)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_query.pm

5.8 URI:: segment Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_segment.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 41: doxygen of OTRS cvs Ref Man

5.9 URI::_server Class Reference 37

5.9 URI:: server Class Reference

Inheritance diagram for URI::_server:

URI::_server

URI::_login

URI::rlogin URI::telnet URI::tn3270

Public Member Functions

Public Object Methods

• retval as_iri ()• retval userinfo ()• retval host ()• retval ihost ()• retval port ()• retval host_port ()• retval canonical ()

Public Functions

• retval default_port ()

Protected Class Methods

• protected retval _uric_escape (scalar class, scalar str)

Protected Object Methods

• protected retval _port ()

Protected Functions

• protected retval _host_escape ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_server.pm

5.10 URI:: userpass Class Reference

Inheritance diagram for URI::_userpass:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 42: doxygen of OTRS cvs Ref Man

38 Class Documentation

URI::_userpass

URI::_login

URI::rlogin URI::telnet URI::tn3270

Public Member Functions

Public Object Methods

• retval user (scalar new)• retval password (scalar new)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/_userpass.pm

5.11 Mail::Address Class Reference

Public Member Functions

Public Class Methods

• retval new ()

Public Object Methods

• retval phrase (scalar self, scalar self)• retval address (scalar self)• retval comment ()

Public Functions

• retval Version ()• retval parse ()• retval set_or_get ()• retval format ()• retval name ()• retval host ()• retval user ()

Protected Functions

• protected retval _extract_name ()• protected retval _tokenise ()• protected retval _find_next ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 43: doxygen of OTRS cvs Ref Man

5.12 Modules::Admin Class Reference 39

• protected retval _complete ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Address.pm

5.12 Modules::Admin Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/Admin.pm

5.13 Modules::AdminAttachment Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminAttachment.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 44: doxygen of OTRS cvs Ref Man

40 Class Documentation

5.14 Modules::AdminAutoResponse Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminAutoResponse.pm

5.15 Modules::AdminCustomerCompany Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminCustomerCompany.pm

5.16 Modules::AdminCustomerUser Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 45: doxygen of OTRS cvs Ref Man

5.17 Modules::AdminCustomerUserGroup Class Reference 41

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Overview (scalar Self, hash Param)• protected retval _Edit (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminCustomerUser.pm

5.17 Modules::AdminCustomerUserGroup Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Change (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)• protected retval _Disabled (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminCustomerUserGroup.pm

5.18 Modules::AdminCustomerUserService Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 46: doxygen of OTRS cvs Ref Man

42 Class Documentation

Protected Functions

• protected retval _Change (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminCustomerUserService.pm

5.19 Modules::AdminDynamicField Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _ShowOverview (scalar Self, hash Param)• protected retval _DynamicFieldsListShow (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminDynamicField.pm

5.20 Modules::AdminDynamicFieldCheckbox Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Add (scalar Self, hash Param)• protected retval _AddAction (scalar Self, hash Param)• protected retval _Change (scalar Self, hash Param)• protected retval _ChangeAction (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 47: doxygen of OTRS cvs Ref Man

5.21 Modules::AdminDynamicFieldDateTime Class Reference 43

• protected retval _ShowScreen (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminDynamicFieldCheckbox.pm

5.21 Modules::AdminDynamicFieldDateTime Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Add (scalar Self, hash Param)• protected retval _AddAction (scalar Self, hash Param)• protected retval _Change (scalar Self, hash Param)• protected retval _ChangeAction (scalar Self, hash Param)• protected retval _ShowScreen (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminDynamicFieldDateTime.pm

5.22 Modules::AdminDynamicFieldDropdown Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Add (scalar Self, hash Param)• protected retval _AddAction (scalar Self, hash Param)• protected retval _Change (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 48: doxygen of OTRS cvs Ref Man

44 Class Documentation

• protected retval _ChangeAction (scalar Self, hash Param)• protected retval _ShowScreen (scalar Self, hash Param)• protected retval _GetPossibleValues (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminDynamicFieldDropdown.pm

5.23 Modules::AdminDynamicFieldMultiselect Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Add (scalar Self, hash Param)• protected retval _AddAction (scalar Self, hash Param)• protected retval _Change (scalar Self, hash Param)• protected retval _ChangeAction (scalar Self, hash Param)• protected retval _ShowScreen (scalar Self, hash Param)• protected retval _GetPossibleValues (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminDynamicFieldMultiselect.pm

5.24 Modules::AdminDynamicFieldText Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 49: doxygen of OTRS cvs Ref Man

5.25 Modules::AdminEmail Class Reference 45

Protected Functions

• protected retval _Add (scalar Self, hash Param)• protected retval _AddAction (scalar Self, hash Param)• protected retval _Change (scalar Self, hash Param)• protected retval _ChangeAction (scalar Self, hash Param)• protected retval _ShowScreen (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminDynamicFieldText.pm

5.25 Modules::AdminEmail Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminEmail.pm

5.26 Modules::AdminGenericAgent Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _MaskUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGenericAgent.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 50: doxygen of OTRS cvs Ref Man

46 Class Documentation

5.27 Modules::AdminGenericInterfaceDebugger Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _ShowScreen (scalar Self, hash Param)• protected retval _GetRequestList (scalar Self, hash Param)• protected retval _GetCommunicationDetails (scalar Self, hash Param)• protected retval _ClearDebugLog (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGenericInterfaceDebugger.pm

5.28 Modules::AdminGenericInterfaceInvokerDefault Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Add (scalar Self, hash Param)• protected retval _AddAction (scalar Self, hash Param)• protected retval _Change (scalar Self, hash Param)• protected retval _ChangeAction (scalar Self, hash Param)• protected retval _DeleteAction (scalar Self, hash Param)• protected retval _ShowScreen (scalar Self, hash Param)• protected retval _AddEvent (scalar Self, hash Param)• protected retval _DeleteEvent (scalar Self, hash Param)• protected retval _InvokerTypeCheck (scalar Self, hash Param)• protected retval _MappingTypeCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGenericInterfaceInvokerDefault.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 51: doxygen of OTRS cvs Ref Man

5.29 Modules::AdminGenericInterfaceMappingSimple Class Reference 47

5.29 Modules::AdminGenericInterfaceMappingSimple Class Refer-ence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _ShowEdit (scalar Self, hash Param)• protected retval _GetParams (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGenericInterfaceMappingSimple.pm

5.30 Modules::AdminGenericInterfaceOperationDefault Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Add (scalar Self, hash Param)• protected retval _AddAction (scalar Self, hash Param)• protected retval _Change (scalar Self, hash Param)• protected retval _ChangeAction (scalar Self, hash Param)• protected retval _DeleteAction (scalar Self, hash Param)• protected retval _ShowScreen (scalar Self, hash Param)• protected retval _OperationTypeCheck (scalar Self, hash Param)• protected retval _MappingTypeCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGenericInterfaceOperationDefault.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 52: doxygen of OTRS cvs Ref Man

48 Class Documentation

5.31 Modules::AdminGenericInterfaceTransportHTTPSOAP Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _ShowEdit (scalar Self, hash Param)• protected retval _GetParams (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGenericInterfaceTransportHTTPSOAP.pm

5.32 Modules::AdminGenericInterfaceWebservice Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _ShowOverview (scalar Self, hash Param)• protected retval _ShowEdit (scalar Self, hash Param)• protected retval _OutputGIConfig (scalar Self, hash Param)• protected retval _GetParams (scalar Self, hash Param)• protected retval _UpdateConfiguration (scalar Self, hash Param)• protected retval _DeleteAction (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGenericInterfaceWebservice.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 53: doxygen of OTRS cvs Ref Man

5.33 Modules::AdminGenericInterfaceWebserviceHistory Class Reference 49

5.33 Modules::AdminGenericInterfaceWebserviceHistory Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _ShowScreen (scalar Self, hash Param)• protected retval _GetWebserviceList (scalar Self, hash Param)• protected retval _GetWebserviceHistoryDetails (scalar Self, hash Param)• protected retval _ExportWebserviceHistory (scalar Self, hash Param)• protected retval _RollbackWebserviceHistory (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGenericInterfaceWebserviceHistory.pm

5.34 Modules::AdminGroup Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminGroup.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 54: doxygen of OTRS cvs Ref Man

50 Class Documentation

5.35 Modules::AdminInit Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminInit.pm

5.36 Modules::AdminLog Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminLog.pm

5.37 Modules::AdminMailAccount Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 55: doxygen of OTRS cvs Ref Man

5.38 Modules::AdminNotification Class Reference 51

Protected Functions

• protected retval _Overview (scalar Self, hash Param)• protected retval _MaskUpdateMailAccount (scalar Self, hash Param)• protected retval _MaskAddMailAccount (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminMailAccount.pm

5.38 Modules::AdminNotification Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _MaskNotificationForm (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminNotification.pm

5.39 Modules::AdminNotificationEvent Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminNotificationEvent.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 56: doxygen of OTRS cvs Ref Man

52 Class Documentation

5.40 Modules::AdminPackageManager Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _MessageGet (scalar Self, hash Param)• protected retval _DocumentationGet (scalar Self, hash Param)• protected retval _InstallHandling (scalar Self, hash Param)• protected retval _UpgradeHandling (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminPackageManager.pm

5.41 Modules::AdminPerformanceLog Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _DatabaseCheck (scalar Self, hash Param)• protected retval _DatabaseReset (scalar Self, hash Param)• protected retval _DatabaseRead (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminPerformanceLog.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 57: doxygen of OTRS cvs Ref Man

5.42 Modules::AdminPGP Class Reference 53

5.42 Modules::AdminPGP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminPGP.pm

5.43 Modules::AdminPostMasterFilter Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _MaskUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminPostMasterFilter.pm

5.44 Modules::AdminPriority Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 58: doxygen of OTRS cvs Ref Man

54 Class Documentation

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminPriority.pm

5.45 Modules::AdminQueue Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminQueue.pm

5.46 Modules::AdminQueueAutoResponse Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminQueueAutoResponse.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 59: doxygen of OTRS cvs Ref Man

5.47 Modules::AdminQueueResponses Class Reference 55

5.47 Modules::AdminQueueResponses Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Change (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminQueueResponses.pm

5.48 Modules::AdminResponse Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminResponse.pm

5.49 Modules::AdminResponseAttachment Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 60: doxygen of OTRS cvs Ref Man

56 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Change (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminResponseAttachment.pm

5.50 Modules::AdminRole Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminRole.pm

5.51 Modules::AdminRoleGroup Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 61: doxygen of OTRS cvs Ref Man

5.52 Modules::AdminRoleUser Class Reference 57

Protected Functions

• protected retval _Change (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminRoleGroup.pm

5.52 Modules::AdminRoleUser Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Change (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminRoleUser.pm

5.53 Modules::AdminSalutation Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminSalutation.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 62: doxygen of OTRS cvs Ref Man

58 Class Documentation

5.54 Modules::AdminScheduler Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminScheduler.pm

5.55 Modules::AdminSelectBox Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminSelectBox.pm

5.56 Modules::AdminService Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 63: doxygen of OTRS cvs Ref Man

5.57 Modules::AdminSession Class Reference 59

Protected Functions

• protected retval _MaskNew (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminService.pm

5.57 Modules::AdminSession Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminSession.pm

5.58 Modules::AdminSignature Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminSignature.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 64: doxygen of OTRS cvs Ref Man

60 Class Documentation

5.59 Modules::AdminSLA Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _MaskNew (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminSLA.pm

5.60 Modules::AdminSMIME Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _MaskAdd (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)• protected retval _SignerCertificateOverview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminSMIME.pm

5.61 Modules::AdminState Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 65: doxygen of OTRS cvs Ref Man

5.62 Modules::AdminSysConfig Class Reference 61

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminState.pm

5.62 Modules::AdminSysConfig Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval ListConfigItem (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminSysConfig.pm

5.63 Modules::AdminSystemAddress Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminSystemAddress.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 66: doxygen of OTRS cvs Ref Man

62 Class Documentation

5.64 Modules::AdminType Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminType.pm

5.65 Modules::AdminUser Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Edit (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminUser.pm

5.66 Modules::AdminUserGroup Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 67: doxygen of OTRS cvs Ref Man

5.67 Modules::AgentBook Class Reference 63

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Change (scalar Self, hash Param)• protected retval _Overview (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AdminUserGroup.pm

5.67 Modules::AgentBook Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentBook.pm

5.68 Modules::AgentCustomerSearch Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentCustomerSearch.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 68: doxygen of OTRS cvs Ref Man

64 Class Documentation

5.69 Modules::AgentDashboard Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Element (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentDashboard.pm

5.70 Modules::AgentHTMLReference Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentHTMLReference.pm

5.71 Modules::AgentInfo Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 69: doxygen of OTRS cvs Ref Man

5.72 Modules::AgentLinkObject Class Reference 65

Public Functions

• retval PreRun (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentInfo.pm

5.72 Modules::AgentLinkObject Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentLinkObject.pm

5.73 Modules::AgentPreferences Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval AgentPreferencesForm (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentPreferences.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 70: doxygen of OTRS cvs Ref Man

66 Class Documentation

5.74 Modules::AgentSearch Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentSearch.pm

5.75 Modules::AgentSpelling Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Mask (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentSpelling.pm

5.76 Modules::AgentStats Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 71: doxygen of OTRS cvs Ref Man

5.77 Modules::AgentTicketActionCommon Class Reference 67

Protected Functions

• protected retval _Notify (scalar Self, hash Param)• protected retval _Timeoutput (scalar Self, hash Param)• protected retval _TimeScaleBuildSelection ()• protected retval _TimeScale ()• protected retval _ColumnAndRowTranslation (scalar Self, hash Param)• protected retval _TimeInSeconds (scalar Self, hash Param)• protected retval _OutputHTMLTable (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentStats.pm

5.77 Modules::AgentTicketActionCommon Class Reference

Inheritance diagram for Modules::AgentTicketActionCommon:

Modules::AgentTicketActionCommon

Modules::AgentTicketClose Modules::AgentTicketFreeText Modules::AgentTicketNote Modules::AgentTicketOwner Modules::AgentTicketPending Modules::AgentTicketPriority Modules::AgentTicketResponsible

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Mask (scalar Self, hash Param)• protected retval _GetNextStates (scalar Self, hash Param)• protected retval _GetResponsible (scalar Self, hash Param)• protected retval _GetOwners (scalar Self, hash Param)• protected retval _GetOldOwners (scalar Self, hash Param)• protected retval _GetServices (scalar Self, hash Param)• protected retval _GetSLAs (scalar Self, hash Param)• protected retval _GetPriorities (scalar Self, hash Param)• protected retval _GetFieldsToUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketActionCommon.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 72: doxygen of OTRS cvs Ref Man

68 Class Documentation

5.78 Modules::AgentTicketAttachment Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketAttachment.pm

5.79 Modules::AgentTicketBounce Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketBounce.pm

5.80 Modules::AgentTicketBulk Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 73: doxygen of OTRS cvs Ref Man

5.81 Modules::AgentTicketClose Class Reference 69

Protected Functions

• protected retval _Mask (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketBulk.pm

5.81 Modules::AgentTicketClose Class Reference

Inheritance diagram for Modules::AgentTicketClose:

Modules::AgentTicketClose

Modules::AgentTicketActionCommon

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketClose.pm

5.82 Modules::AgentTicketCompose Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _GetNextStates (scalar Self, hash Param)• protected retval _Mask (scalar Self, hash Param)• protected retval _GetFieldsToUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketCompose.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 74: doxygen of OTRS cvs Ref Man

70 Class Documentation

5.83 Modules::AgentTicketCustomer Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval Form (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketCustomer.pm

5.84 Modules::AgentTicketEmail Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _GetNextStates (scalar Self, hash Param)• protected retval _GetUsers (scalar Self, hash Param)• protected retval _GetResponsibles (scalar Self, hash Param)• protected retval _GetPriorities (scalar Self, hash Param)• protected retval _GetTypes (scalar Self, hash Param)• protected retval _GetServices (scalar Self, hash Param)• protected retval _GetSLAs (scalar Self, hash Param)• protected retval _GetTos (scalar Self, hash Param)• protected retval _GetSignature (scalar Self, hash Param)• protected retval _MaskEmailNew (scalar Self, hash Param)• protected retval _GetFieldsToUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketEmail.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 75: doxygen of OTRS cvs Ref Man

5.85 Modules::AgentTicketEscalationView Class Reference 71

5.85 Modules::AgentTicketEscalationView Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketEscalationView.pm

5.86 Modules::AgentTicketForward Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval Form (scalar Self, hash Param)• retval SendEmail (scalar Self, hash Param)• retval AjaxUpdate (scalar Self, hash Param)

Protected Functions

• protected retval _GetNextStates (scalar Self, hash Param)• protected retval _Mask (scalar Self, hash Param)• protected retval _GetFieldsToUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketForward.pm

5.87 Modules::AgentTicketFreeText Class Reference

Inheritance diagram for Modules::AgentTicketFreeText:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 76: doxygen of OTRS cvs Ref Man

72 Class Documentation

Modules::AgentTicketFreeText

Modules::AgentTicketActionCommon

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketFreeText.pm

5.88 Modules::AgentTicketHistory Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketHistory.pm

5.89 Modules::AgentTicketLock Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketLock.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 77: doxygen of OTRS cvs Ref Man

5.90 Modules::AgentTicketLockedView Class Reference 73

5.90 Modules::AgentTicketLockedView Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketLockedView.pm

5.91 Modules::AgentTicketMerge Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketMerge.pm

5.92 Modules::AgentTicketMove Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval AgentMove (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 78: doxygen of OTRS cvs Ref Man

74 Class Documentation

Protected Functions

• protected retval _GetUsers (scalar Self, hash Param)• protected retval _GetOldOwners (scalar Self, hash Param)• protected retval _GetPriorities (scalar Self, hash Param)• protected retval _GetNextStates (scalar Self, hash Param)• protected retval _GetFieldsToUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketMove.pm

5.93 Modules::AgentTicketNote Class Reference

Inheritance diagram for Modules::AgentTicketNote:

Modules::AgentTicketNote

Modules::AgentTicketActionCommon

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketNote.pm

5.94 Modules::AgentTicketOwner Class Reference

Inheritance diagram for Modules::AgentTicketOwner:

Modules::AgentTicketOwner

Modules::AgentTicketActionCommon

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketOwner.pm

5.95 Modules::AgentTicketPending Class Reference

Inheritance diagram for Modules::AgentTicketPending:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 79: doxygen of OTRS cvs Ref Man

5.96 Modules::AgentTicketPhone Class Reference 75

Modules::AgentTicketPending

Modules::AgentTicketActionCommon

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketPending.pm

5.96 Modules::AgentTicketPhone Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _GetNextStates (scalar Self, hash Param)• protected retval _GetUsers (scalar Self, hash Param)• protected retval _GetResponsibles (scalar Self, hash Param)• protected retval _GetPriorities (scalar Self, hash Param)• protected retval _GetTypes (scalar Self, hash Param)• protected retval _GetServices (scalar Self, hash Param)• protected retval _GetSLAs (scalar Self, hash Param)• protected retval _GetTos (scalar Self, hash Param)• protected retval _MaskPhoneNew (scalar Self, hash Param)• protected retval _GetFieldsToUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketPhone.pm

5.97 Modules::AgentTicketPhoneCommon Class Reference

Inheritance diagram for Modules::AgentTicketPhoneCommon:

Modules::AgentTicketPhoneCommon

Modules::AgentTicketPhoneInbound Modules::AgentTicketPhoneOutbound

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 80: doxygen of OTRS cvs Ref Man

76 Class Documentation

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _GetNextStates (scalar Self, hash Param)• protected retval _GetUsers (scalar Self, hash Param)• protected retval _GetTos (scalar Self, hash Param)• protected retval _MaskPhone (scalar Self, hash Param)• protected retval _GetFieldsToUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketPhoneCommon.pm

5.98 Modules::AgentTicketPhoneInbound Class Reference

Inheritance diagram for Modules::AgentTicketPhoneInbound:

Modules::AgentTicketPhoneInbound

Modules::AgentTicketPhoneCommon

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketPhoneInbound.pm

5.99 Modules::AgentTicketPhoneOutbound Class Reference

Inheritance diagram for Modules::AgentTicketPhoneOutbound:

Modules::AgentTicketPhoneOutbound

Modules::AgentTicketPhoneCommon

The documentation for this class was generated from the following file:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 81: doxygen of OTRS cvs Ref Man

5.100 Modules::AgentTicketPlain Class Reference 77

• Kernel/Modules/AgentTicketPhoneOutbound.pm

5.100 Modules::AgentTicketPlain Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketPlain.pm

5.101 Modules::AgentTicketPrint Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _PDFOutputTicketInfos (scalar Self, hash Param)• protected retval _PDFOutputLinkedObjects (scalar Self, hash Param)• protected retval _PDFOutputTicketDynamicFields (scalar Self, hash Param)

• protected retval _PDFOutputCustomerInfos (scalar Self, hash Param)• protected retval _PDFOutputArticles (scalar Self, hash Param)• protected retval _HTMLMask (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketPrint.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 82: doxygen of OTRS cvs Ref Man

78 Class Documentation

5.102 Modules::AgentTicketPriority Class Reference

Inheritance diagram for Modules::AgentTicketPriority:

Modules::AgentTicketPriority

Modules::AgentTicketActionCommon

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketPriority.pm

5.103 Modules::AgentTicketQueue Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval BuildQueueView (scalar Self, hash Param)

Protected Functions

• protected retval _MaskQueueView (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketQueue.pm

5.104 Modules::AgentTicketResponsible Class Reference

Inheritance diagram for Modules::AgentTicketResponsible:

Modules::AgentTicketResponsible

Modules::AgentTicketActionCommon

The documentation for this class was generated from the following file:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 83: doxygen of OTRS cvs Ref Man

5.105 Modules::AgentTicketResponsibleView Class Reference 79

• Kernel/Modules/AgentTicketResponsible.pm

5.105 Modules::AgentTicketResponsibleView Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketResponsibleView.pm

5.106 Modules::AgentTicketSearch Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketSearch.pm

5.107 Modules::AgentTicketStatusView Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 84: doxygen of OTRS cvs Ref Man

80 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketStatusView.pm

5.108 Modules::AgentTicketWatcher Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketWatcher.pm

5.109 Modules::AgentTicketWatchView Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketWatchView.pm

5.110 Modules::AgentTicketZoom Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 85: doxygen of OTRS cvs Ref Man

5.111 Modules::AgentZoom Class Reference 81

Public Functions

• retval Run (scalar Self, hash Param)• retval MaskAgentZoom (scalar Self, hash Param)

Protected Functions

• protected retval _ArticleTree (scalar Self, hash Param)• protected retval _TicketItemSeen (scalar Self, hash Param)• protected retval _ArticleItemSeen (scalar Self, hash Param)• protected retval _ArticleItem (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentTicketZoom.pm

5.111 Modules::AgentZoom Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/AgentZoom.pm

5.112 Authen::SASL::Perl::ANONYMOUS Class Reference

Public Member Functions

Public Object Methods

• retval client_start ()• retval client_step ()

Public Functions

• retval mechanism ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 86: doxygen of OTRS cvs Ref Man

82 Class Documentation

Protected Functions

• protected retval _order ()• protected retval _secflags ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/Perl/ANONYMOUS.pm

5.113 HTTP::SOAP::Transport::HTTP::Apache Class Reference

Inheritance diagram for HTTP::SOAP::Transport::HTTP::Apache:

HTTP::SOAP::Transport::HTTP::Apache

HTTP::SOAP::Transport::HTTP::Server

Public Member Functions

Public Object Methods

• retval new ()

Public Functions

• retval DESTROY ()• retval handler (scalar r)• retval configure ()• retval handle ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Transport/HTTP.pm

5.114 Kernel::System::Ticket::Event::ArchiveRestore Class Refer-ence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 87: doxygen of OTRS cvs Ref Man

5.115 Kernel::System::DynamicField::ObjectType::Article Class Reference 83

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/ArchiveRestore.pm

5.115 Kernel::System::DynamicField::ObjectType::Article Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval PostValueSet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/ObjectType/Article.pm

5.116 Output::HTML::ArticleAttachmentDownload Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ArticleAttachmentDownload.pm

5.117 Output::HTML::ArticleAttachmentHTMLViewer Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 88: doxygen of OTRS cvs Ref Man

84 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ArticleAttachmentHTMLViewer.pm

5.118 Output::HTML::ArticleCheckPGP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Check (scalar Self, hash Param)• retval Filter (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ArticleCheckPGP.pm

5.119 Output::HTML::ArticleCheckSMIME Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Check (scalar Self, hash Param)• retval Filter (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ArticleCheckSMIME.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 89: doxygen of OTRS cvs Ref Man

5.120 Output::HTML::ArticleComposeCrypt Class Reference 85

5.120 Output::HTML::ArticleComposeCrypt Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Option (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Data (scalar Self, hash Param)• retval ArticleOption (scalar Self, hash Param)• retval Error (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ArticleComposeCrypt.pm

5.121 Output::HTML::ArticleComposeSign Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Option (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Data (scalar Self, hash Param)• retval ArticleOption (scalar Self, hash Param)• retval Error (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ArticleComposeSign.pm

5.122 Kernel::System::Ticket::Event::ArticleSearchIndex Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 90: doxygen of OTRS cvs Ref Man

86 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/ArticleSearchIndex.pm

5.123 IO::AtomicFile Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval DESTROY ()• retval open (scalar path, scalar mode)• retval close (scalar die)• retval delete ()• retval detach ()

Protected Object Methods

• protected retval _closed ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/IO/AtomicFile.pm

5.124 HTTP::Headers::Auth Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/HTTP/Headers/Auth.pm

5.125 Kernel::System::Auth Class Reference

Classes

• class DB• class HTTPBasicAuth• class LDAP• class Radius

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 91: doxygen of OTRS cvs Ref Man

5.126 Kernel::System::AuthSession Class Reference 87

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Auth.pm

5.126 Kernel::System::AuthSession Class Reference

Classes

• class DB

• class FS

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval CheckSessionID (scalar Self, hash Param)• retval CheckSessionIDMessage (scalar Self, hash Param)• retval GetSessionIDData (scalar Self, hash Param)• retval CreateSessionID (scalar Self, hash Param)• retval RemoveSessionID (scalar Self, hash Param)• retval UpdateSessionID (scalar Self, hash Param)• retval GetExpiredSessionIDs (scalar Self, hash Param)• retval GetAllSessionIDs (scalar Self, hash Param)• retval CleanUp (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/AuthSession.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 92: doxygen of OTRS cvs Ref Man

88 Class Documentation

5.127 Kernel::System::GenericAgent::AutoPriorityIncrease Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericAgent/AutoPriorityIncrease.pm

5.128 Kernel::System::AutoResponse Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval AutoResponseAdd (scalar Self, hash Param)• retval AutoResponseGet (scalar Self, hash Param)• retval AutoResponseUpdate (scalar Self, hash Param)• retval AutoResponseGetByTypeQueueID (scalar Self, hash Param)• retval AutoResponseList (scalar Self, hash Param)• retval AutoResponseTypeList (scalar Self, hash Param)• retval AutoResponseQueue (scalar Self, hash Param)

Protected Functions

• protected retval _NameExistsCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/AutoResponse.pm

5.129 Kernel::System::DynamicField::Backend Class Reference

Classes

• class BackendCommon

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 93: doxygen of OTRS cvs Ref Man

5.130 Kernel::System::DynamicField::Backend::BackendCommon ClassReference 89

• class Checkbox• class Date• class DateTime• class Dropdown• class Multiselect• class Text• class TextArea

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval EditFieldRender (scalar Self, hash Param)• retval DisplayValueRender (scalar Self, hash Param)• retval ValueSet (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval ValueGet (scalar Self, hash Param)• retval SearchSQLGet (scalar Self, hash Param)• retval SearchSQLOrderFieldGet (scalar Self, hash Param)• retval EditFieldValueGet (scalar Self, hash Param)• retval EditFieldValueValidate (scalar Self, hash Param)• retval IsSortable (scalar Self, hash Param)• retval SearchFieldRender (scalar Self, hash Param)• retval SearchFieldValueGet (scalar Self, hash Param)• retval SearchFieldParameterBuild (scalar Self, hash Param)• retval StatsFieldParameterBuild (scalar Self, hash Param)• retval CommonSearchFieldParameterBuild (scalar Self, hash Param)• retval ReadableValueRender (scalar Self, hash Param)• retval TemplateValueTypeGet (scalar Self, hash Param)• retval IsAJAXUpdateable (scalar Self, hash Param)• retval RandomValueSet (scalar Self, hash Param)• retval IsMatchable (scalar Self, hash Param)• retval ObjectMatch (scalar Self, hash Param)• retval AJAXPossibleValuesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend.pm

5.130 Kernel::System::DynamicField::Backend::BackendCommon ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 94: doxygen of OTRS cvs Ref Man

90 Class Documentation

Public Functions

• retval EditLabelRender (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend/BackendCommon.pm

5.131 file::Base Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar path)

Public Object Methods

• retval dir ()

Public Functions

• retval file ()

Protected Class Methods

• protected retval _file_extract_authority (scalar class, scalar path)

Protected Functions

• protected retval _file_extract_path ()• protected retval _file_is_absolute ()• protected retval _file_is_localhost ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/file/Base.pm

5.132 YAML::Base Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 95: doxygen of OTRS cvs Ref Man

5.133 YAML::Dumper::Base Class Reference 91

Public Object Methods

• retval die ()• retval warn ()• retval node_info (scalar stringify)

Public Functions

• retval XXX ()• retval field ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Base.pm

5.133 YAML::Dumper::Base Class Reference

Public Member Functions

Public Object Methods

• retval set_global_options ()• retval dump ()

Public Functions

• retval blessed (scalar ref)• retval bless (scalar ref, scalar blessing)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Dumper/Base.pm

5.134 YAML::Loader::Base Class Reference

Public Member Functions

Public Object Methods

• retval set_global_options ()

Public Functions

• retval load ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Loader/Base.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 96: doxygen of OTRS cvs Ref Man

92 Class Documentation

5.135 MIME::Decoder::Base64 Class Reference

Inheritance diagram for MIME::Decoder::Base64:

MIME::Decoder::Base64

MIME::Decoder

MIME::Decoder::Gzip64

Public Member Functions

Public Object Methods

• retval decode_it (scalar in, scalar out)• retval encode_it (scalar in, scalar out)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Decoder/Base64.pm

5.136 MIME::Decoder::Binary Class Reference

Inheritance diagram for MIME::Decoder::Binary:

MIME::Decoder::Binary

MIME::Decoder

Public Member Functions

Public Object Methods

• retval decode_it (scalar in, scalar out)• retval encode_it (scalar in, scalar out)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Decoder/Binary.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 97: doxygen of OTRS cvs Ref Man

5.137 MIME::Decoder::BinHex Class Reference 93

5.137 MIME::Decoder::BinHex Class Reference

Inheritance diagram for MIME::Decoder::BinHex:

MIME::Decoder::BinHex

MIME::Decoder

Public Member Functions

Public Object Methods

• retval decode_it (scalar in, scalar out)• retval encode_it (scalar in, scalar out)• retval last_preamble ()

Public Functions

• retval last_mode ()• retval last_filename ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Decoder/BinHex.pm

5.138 Type::blessed Class Reference

Public Member Functions

Public Functions

• retval yaml_dump (scalar value)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Types.pm

5.139 MIME::Body Class Reference

Inheritance diagram for MIME::Body:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 98: doxygen of OTRS cvs Ref Man

94 Class Documentation

MIME::Body

MIME::Body::File MIME::Body::Scalar

MIME::Body::InCore

Classes

• class File• class InCore• class Scalar

Public Member Functions

Public Class Methods

• retval new ()

Public Object Methods

• retval as_lines ()• retval as_string ()• retval binmode (scalar onoff)• retval is_encoded (scalar yesno)• retval dup ()• retval path ()• retval print (scalar fh)

Public Functions

• retval init ()• retval open ()• retval purge ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Body.pm

5.140 JSON::Boolean Class Reference

Public Member Functions

Protected Functions

• protected retval _overrride_overload ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 99: doxygen of OTRS cvs Ref Man

5.141 Net::SMTP::TLS::ButMaintained Class Reference 95

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/JSON.pm

5.141 Net::SMTP::TLS::ButMaintained Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar pkg, scalar host)

Public Functions

• retval hello (scalar me)• retval starttls (scalar me)• retval login (scalar me)• retval auth_LOGIN (scalar me)• retval auth_MD5 (scalar me)• retval auth_PLAIN (scalar me)• retval mail (scalar me, scalar from)• retval recipient (scalar me)• retval data (scalar me)• retval datasend (scalar cmd)• retval dataend (scalar me)• retval quit (scalar me)

Protected Functions

• protected retval _command (scalar me, scalar command)• protected retval _response (scalar me)• protected retval _addr (scalar addr)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Net/SMTP/TLS/ButMaintained.pm

5.142 Kernel::System::Cache Class Reference

Classes

• class FileRaw• class FileStorable

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 100: doxygen of OTRS cvs Ref Man

96 Class Documentation

Public Functions

• retval Set (scalar Self, hash Param)• retval Get (scalar Self, hash Param)• retval Delete (scalar Self, hash Param)• retval CleanUp (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Cache.pm

5.143 Kernel::System::CacheInternal Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Set (scalar Self, hash Param)• retval Get (scalar Self, hash Param)• retval Delete (scalar Self, hash Param)• retval CleanUp (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CacheInternal.pm

5.144 Mail::Cap Class Reference

Public Member Functions

Public Class Methods

• retval new ()

Public Object Methods

• retval description (scalar self, scalar self, scalar self)• retval textualnewlines (scalar self, scalar self)• retval x11_bitmap (scalar self)• retval nametemplate ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 101: doxygen of OTRS cvs Ref Man

5.145 CGI::Carp Class Reference 97

Public Functions

• retval Version ()• retval view ()• retval compose ()• retval edit ()• retval print ()• retval viewCmd ()• retval composeCmd ()• retval editCmd ()• retval printCmd ()• retval makeName ()• retval field ()• retval getEntry ()• retval expandPercentMacros ()• retval dumpEntry ()• retval dump ()

Protected Functions

• protected retval _process_file ()• protected retval _run ()• protected retval _createCommand ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Cap.pm

5.145 CGI::Carp Class Reference

Public Member Functions

Public Functions

• retval handle_errors (scalar msg)• retval handle_errors (scalar msg)• retval import (scalar pkg)• retval realwarn ()• retval realdie ()• retval id (scalar level)• retval stamp ()• retval set_progname ()• retval warn (scalar message)• retval ineval ()• retval die (scalar arg, list rest)• retval set_message ()• retval set_die_handler ((scalar handler))• retval confess ()• retval croak ()• retval carp ()• retval cluck ()• retval carpout (scalar in)• retval warningsToBrowser ()• retval fatalsToBrowser (scalar msg)• retval to_filehandle (scalar thingy)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 102: doxygen of OTRS cvs Ref Man

98 Class Documentation

Protected Functions

• protected retval _warn (scalar msg)• protected retval _longmess ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI/Carp.pm

5.146 HTTP::SOAP::Transport::HTTP::CGI Class Reference

Inheritance diagram for HTTP::SOAP::Transport::HTTP::CGI:

HTTP::SOAP::Transport::HTTP::CGI

HTTP::SOAP::Transport::HTTP::Server

HTTP::SOAP::Transport::HTTP::FCGI

Public Member Functions

Public Object Methods

• retval new ()• retval make_response ()

Public Functions

• retval DESTROY ()• retval handle ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Transport/HTTP.pm

5.147 CGI Class Reference

Inheritance diagram for CGI:

CGI

CGI::Fast CGI::Pretty CGI::Push

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 103: doxygen of OTRS cvs Ref Man

5.147 CGI Class Reference 99

Classes

• class Carp• class Cookie• class Fast• class Pretty• class Push• class Util

Public Member Functions

Public Class Methods

• retval can (scalar class, scalar method)• retval new (scalar class, list initializer)

Public Object Methods

• retval import ()• retval DESTROY ()• retval r ()• retval init (scalar initializer)• retval save_request ()• retval parse_params (scalar tosplit)• retval add_parameter (scalar param)• retval all_parameters ()• retval new_MultipartBuffer (scalar boundary, scalar length)• retval read_from_client (scalar buff, scalar len, scalar offset)• retval STORE (scalar tag, scalar vals)• retval parse_keywordlist (scalar tosplit)• retval protocol ()• retval previous_or_default (scalar name, scalar defaults, scalar override)• retval register_parameter (scalar param)• retval get_fields ()• retval read_multipart (scalar boundary, scalar length)• retval read_multipart_related (scalar start, scalar boundary, scalar length)

Public Functions

• retval initialize_globals ()• retval compile (scalar pack)• retval expand_tags (scalar tag)• retval upload_hook ()• retval param ()• retval self_or_default ()• retval self_or_CGI ()• retval to_filehandle (scalar thingy)• retval put ()• retval print ()• retval cgi_error ()• retval binmode ()• retval AUTOLOAD ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 104: doxygen of OTRS cvs Ref Man

100 Class Documentation

• retval charset ()• retval element_id ()• retval element_tab ()• retval URL_ENCODED ()• retval MULTIPART ()• retval SERVER_PUSH ()• retval delete ()• retval import_names ()• retval keywords ()• retval Vars (scalar q)• retval ReadParse ()• retval PrintHeader ()• retval HtmlTop ()• retval HtmlBot ()• retval SplitParam (scalar param)• retval MethGet ()• retval MethPost ()• retval MethPut ()• retval TIEHASH (scalar arg)• retval FETCH ()• retval FIRSTKEY ()• retval NEXTKEY ()• retval EXISTS ()• retval DELETE ()• retval CLEAR ()• retval append ()• retval delete_all ()• retval Delete ()• retval Delete_all ()• retval autoEscape ()• retval version ()• retval url_param ()• retval Dump ()• retval as_string ()• retval save ()• retval save_parameters (scalar fh)• retval restore_parameters ()• retval multipart_init ()• retval multipart_start ()• retval multipart_end ()• retval multipart_final ()• retval header ()• retval cache ()• retval redirect ()• retval start_html ()• retval end_html ()• retval isindex ()• retval startform ()• retval start_form ()• retval start_multipart_form ()• retval end_form ()• retval end_multipart_form ()• retval textfield ()• retval filefield ()• retval password_field ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 105: doxygen of OTRS cvs Ref Man

5.147 CGI Class Reference 101

• retval textarea ()• retval button ()• retval submit ()• retval reset ()• retval defaults ()• retval comment ()• retval checkbox ()• retval escapeHTML ()• retval unescapeHTML ()• retval radio_group ()• retval checkbox_group ()• retval popup_menu ()• retval optgroup ()• retval scrolling_list ()• retval hidden ()• retval image_button ()• retval self_url ()• retval state ()• retval url ()• retval cookie ()• retval param_fetch ()• retval path_info ()• retval request_method ()• retval content_type ()• retval path_translated ()• retval request_uri ()• retval query_string ()• retval Accept ()• retval user_agent ()• retval raw_cookie ()• retval virtual_host ()• retval remote_host ()• retval remote_addr ()• retval script_name ()• retval referer ()• retval server_name ()• retval server_software ()• retval virtual_port ()• retval server_port ()• retval server_protocol ()• retval http ()• retval https ()• retval remote_ident ()• retval auth_type ()• retval remote_user ()• retval user_name ()• retval nosticky ()• retval nph ()• retval private_tempfiles ()• retval close_upload_files ()• retval default_dtd ()• retval read_from_cmdline ()• retval upload ()• retval tmpFileName ()• retval uploadInfo ()• retval hook (scalar filename, scalar buffer, scalar bytes_read, scalar data)• retval print_prompt ()• retval do_work ()• retval print_tail ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 106: doxygen of OTRS cvs Ref Man

102 Class Documentation

Protected Object Methods

• protected retval _decode_utf8 (scalar val)• protected retval _make_tag_func (scalar tagname)• protected retval _selected (scalar value)• protected retval _checked (scalar value)• protected retval _setup_symbols ()• protected retval _style (scalar style)• protected retval _script (scalar script)• protected retval _box_group (scalar box_type)• protected retval _name_and_path_from_env ()

Protected Functions

• protected retval _compile ()• protected retval _reset_globals ()• protected retval _textfield ()• protected retval _tableize (scalar rows, scalar columns, scalar rowheaders,

scalar colheaders, list elements)• protected retval _maybe_escapeHTML ()• protected retval _set_values_and_labels (scalar v, scalar l, scalar n)• protected retval _set_attributes (scalar element, scalar attributes)• protected retval _compile_all ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI.pm

5.148 CGITempFile Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar package, scalar sequence)

Public Object Methods

• retval DESTROY ()• retval as_string ()

Public Functions

• retval find_tempdir ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 107: doxygen of OTRS cvs Ref Man

5.149 Kernel::System::DynamicField::Backend::Checkbox Class Reference 103

5.149 Kernel::System::DynamicField::Backend::Checkbox Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ValueGet (scalar Self, hash Param)• retval ValueSet (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval SearchSQLGet (scalar Self, hash Param)• retval SearchSQLOrderFieldGet (scalar Self, hash Param)• retval EditFieldRender (scalar Self, hash Param)• retval EditFieldValueGet (scalar Self, hash Param)• retval EditFieldValueValidate (scalar Self, hash Param)• retval DisplayValueRender (scalar Self, hash Param)• retval IsSortable (scalar Self, hash Param)• retval SearchFieldRender (scalar Self, hash Param)• retval SearchFieldValueGet (scalar Self, hash Param)• retval SearchFieldParameterBuild (scalar Self, hash Param)• retval StatsFieldParameterBuild (scalar Self, hash Param)• retval CommonSearchFieldParameterBuild (scalar Self, hash Param)• retval ReadableValueRender (scalar Self, hash Param)• retval TemplateValueTypeGet (scalar Self, hash Param)• retval IsAJAXUpdateable (scalar Self, hash Param)• retval RandomValueSet (scalar Self, hash Param)• retval IsMatchable (scalar Self, hash Param)• retval ObjectMatch (scalar Self, hash Param)• retval AJAXPossibleValuesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend/Checkbox.pm

5.150 Kernel::System::CheckItem Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 108: doxygen of OTRS cvs Ref Man

104 Class Documentation

Public Functions

• retval CheckError (scalar Self)• retval CheckErrorType (scalar Self)• retval CheckEmail (scalar Self, hash Param)• retval StringClean (scalar Self, hash Param)• retval CreditCardClean (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CheckItem.pm

5.151 HTTP::SOAP::Transport::HTTP::Client Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval http_request ()• retval http_response ()• retval send_receive (hash parameters)

Public Functions

• retval patch ()• retval LWP::UserAgent::redirect_ok ()• retval DESTROY ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Transport/HTTP.pm

5.152 Kernel::System::Ticket::Acl::CloseParentAfterClosedChilds ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 109: doxygen of OTRS cvs Ref Man

5.153 Kernel::System::PostMaster::Filter::CMD Class Reference 105

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Acl/CloseParentAfterClosedChilds.pm

5.153 Kernel::System::PostMaster::Filter::CMD Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/Filter/CMD.pm

5.154 Type::code Class Reference

Public Member Functions

Public Functions

• retval yaml_dump (scalar dumpflag, scalar value)• retval yaml_load (scalar node, scalar class, scalar loader)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Types.pm

5.155 Kernel::GenericInterface::Operation::Common Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 110: doxygen of OTRS cvs Ref Man

106 Class Documentation

Public Functions

• retval Auth (scalar Self, hash Param)• retval GetSessionID (scalar Self, hash Param)• retval ReturnError (scalar Self, hash Param)

Protected Functions

• protected retval _AuthUser (scalar Self, hash Param)• protected retval _AuthCustomerUser (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation/Common.pm

5.156 Kernel::GenericInterface::Operation::Ticket::Common Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ReturnError (scalar Self, hash Param)• retval ValidateQueue (scalar Self, hash Param)• retval ValidateLock (scalar Self, hash Param)• retval ValidateType (scalar Self, hash Param)• retval ValidateCustomer (scalar Self, hash Param)• retval ValidateService (scalar Self, hash Param)• retval ValidateSLA (scalar Self, hash Param)• retval ValidateState (scalar Self, hash Param)• retval ValidatePriority (scalar Self, hash Param)• retval ValidateOwner (scalar Self, hash Param)• retval ValidateResponsible (scalar Self, hash Param)• retval ValidatePendingTime (scalar Self, hash Param)• retval ValidateAutoResponseType (scalar Self, hash Param)• retval ValidateArticleType (scalar Self, hash Param)• retval ValidateFrom (scalar Self, hash Param)• retval ValidateSenderType (scalar Self, hash Param)• retval ValidateMimeType (scalar Self, hash Param)• retval ValidateCharset (scalar Self, hash Param)• retval ValidateHistoryType (scalar Self, hash Param)• retval ValidateTimeUnit (scalar Self, hash Param)• retval ValidateUserID (scalar Self, hash Param)• retval ValidateDynamicFieldName (scalar Self, hash Param)• retval ValidateDynamicFieldValue (scalar Self, hash Param)• retval ValidateDynamicFieldObjectType (scalar Self, hash Param)• retval SetDynamicFieldValue (scalar Self, hash Param)• retval CreateAttachment (scalar Self, hash Param)• retval CheckCreatePermissions (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 111: doxygen of OTRS cvs Ref Man

5.157 HTTP::Config Class Reference 107

Protected Functions

• protected retval _ValidateUser (scalar Self, hash Param)• protected retval _CharsetList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation/Ticket/Common.pm

5.157 HTTP::Config Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval entries ()• retval empty ()• retval add ()• retval find2 (hash spec)• retval find ()• retval remove (hash spec)• retval matching ()• retval add_item (scalar item)• retval remove_items ()• retval matching_items ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/HTTP/Config.pm

5.158 Kernel::Config Class Reference

Classes

• class Defaults• class GenericAgent

Public Member Functions

Public Functions

• retval Load (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/Config.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 112: doxygen of OTRS cvs Ref Man

108 Class Documentation

5.159 LWP::ConnCache Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class, hash cnf)

Public Object Methods

• retval deposit (scalar type, scalar key, scalar conn)• retval withdraw (scalar type, scalar key)• retval total_capacity ()• retval capacity (scalar type)• retval enforce_limits (scalar type)• retval dropping (scalar c, scalar reason)• retval drop (scalar checker, scalar reason)• retval prune ()• retval get_types ()• retval get_connections (scalar type)

Protected Functions

• protected retval _looks_like_number ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/ConnCache.pm

5.160 Locale::Codes::Constants Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Locale/Codes/Constants.pm

5.161 MIME::Field::ContDisp Class Reference

Inheritance diagram for MIME::Field::ContDisp:

MIME::Field::ContDisp

MIME::Field::ParamVal

Mail::Field

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 113: doxygen of OTRS cvs Ref Man

5.162 MIME::Field::ConTraEnc Class Reference 109

Public Member Functions

Public Object Methods

• retval filename ()• retval type ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Field/ContDisp.pm

5.162 MIME::Field::ConTraEnc Class Reference

Inheritance diagram for MIME::Field::ConTraEnc:

MIME::Field::ConTraEnc

MIME::Field::ParamVal

Mail::Field

Public Member Functions

Public Object Methods

• retval encoding ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Field/ConTraEnc.pm

5.163 MIME::Field::ContType Class Reference

Inheritance diagram for MIME::Field::ContType:

MIME::Field::ContType

MIME::Field::ParamVal

Mail::Field

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 114: doxygen of OTRS cvs Ref Man

110 Class Documentation

Public Member Functions

Public Object Methods

• retval charset ()• retval id ()• retval name ()• retval number ()• retval total ()• retval boundary ()• retval multipart_boundary ()• retval type ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Field/ContType.pm

5.164 CGI::Cookie Class Reference

Public Member Functions

Public Class Methods

• retval fetch (scalar class)• retval raw_fetch (scalar class)• retval new (scalar class, list params)

Public Object Methods

• retval parse (scalar raw_cookie)• retval as_string ()• retval compare (scalar value)• retval bake (scalar r)• retval name (scalar name)• retval value (scalar value)• retval domain (scalar domain)• retval secure (scalar secure)• retval expires (scalar expires)• retval max_age (scalar max_age)• retval path (scalar path)• retval httponly (scalar httponly)

Public Functions

• retval get_raw_cookie (scalar r)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI/Cookie.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 115: doxygen of OTRS cvs Ref Man

5.165 Core Class Reference 111

5.165 Core Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Self)

Public Functions

• retval Dispatch (scalar Self, scalar User, scalar Pw, scalar Object, scalarMethod, hash Param)

• retval DispatchMultipleTicketMethods (scalar Self, scalar User, scalar Pw,scalar Object, scalar MethodParamArrayRef)

The documentation for this class was generated from the following file:

• bin/cgi-bin/rpc.pl

5.166 Locale::Codes::Country Class Reference

Public Member Functions

Public Functions

• retval code2country ()• retval country2code (scalar country, scalar codeset)• retval country_code2code (scalar code, scalar inset, scalar outset)• retval all_country_codes (scalar codeset)• retval all_country_names (scalar codeset)• retval rename_country (scalar code, scalar new_name, list args)• retval add_country (scalar code, scalar name, list args)• retval delete_country (scalar code, list args)• retval add_country_alias (scalar name, scalar new_name, scalar nowarn)• retval delete_country_alias (scalar name, scalar nowarn)• retval rename_country_code (scalar code, scalar new_code, list args)• retval add_country_code_alias (scalar code, scalar new_code, list args)• retval delete_country_code_alias (scalar code, list args)• retval alias_code (scalar alias, scalar code, list args)

Protected Functions

• protected retval _code (scalar code, scalar codeset)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Locale/Codes/Country.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 116: doxygen of OTRS cvs Ref Man

112 Class Documentation

5.167 LWP::Protocol::cpan Class Reference

Inheritance diagram for LWP::Protocol::cpan:

LWP::Protocol::cpan

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/cpan.pm

5.168 Authen::SASL::CRAM MD5 Class Reference

Public Member Functions

Public Class Methods

• retval new ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/CRAM_MD5.pm

5.169 Authen::SASL::Perl::CRAM MD5 Class Reference

Public Member Functions

Public Object Methods

• retval client_step (scalar string)

Public Functions

• retval mechanism ()• retval client_start ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 117: doxygen of OTRS cvs Ref Man

5.170 Kernel::System::Crypt Class Reference 113

Protected Functions

• protected retval _order ()• protected retval _secflags ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/Perl/CRAM_MD5.pm

5.170 Kernel::System::Crypt Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Crypt.pm

5.171 Text::CSV Class Reference

Classes

• class ErrorDiag

Public Member Functions

Public Class Methods

• retval import (scalar class, scalar option)• retval new (scalar proto)

Public Object Methods

• retval AUTOLOAD ()• retval parse ()

Public Functions

• retval require_xs_version ()• retval module (scalar proto)• retval is_xs ()• retval is_pp ()• retval is_dynamic ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 118: doxygen of OTRS cvs Ref Man

114 Class Documentation

Protected Class Methods

• protected retval _set_methods (scalar class)

Protected Functions

• protected retval _load_xs (scalar opt)• protected retval _load_pp (scalar opt)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Text/CSV.pm

5.172 Kernel::System::CSV Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Array2CSV (scalar Self, hash Param)• retval CSV2Array (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CSV.pm

5.173 Text::CSV PP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar proto)

Public Object Methods

• retval error_diag ()• retval print (scalar io, scalar cols)• retval getline (scalar io)• retval getline_all (scalar io, scalar offset, scalar len)• retval getline_hr (scalar io)• retval getline_hr_all (scalar io, list args)• retval column_names (list columns)• retval bind_columns (list refs)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 119: doxygen of OTRS cvs Ref Man

5.174 Modules::CustomerAccept Class Reference 115

• retval types ()• retval sep_char ()• retval quote_char ()• retval escape_char ()• retval allow_whitespace (scalar aw)

Public Functions

• retval PV ()• retval IV ()• retval NV ()• retval IS_QUOTED ()• retval IS_BINARY ()• retval version ()• retval status ()• retval error_input ()• retval eof ()• retval meta_info ()• retval is_quoted ()• retval is_binary ()• retval eol ()• retval SetDiag ()

Protected Object Methods

• protected retval _check_sanity ()• protected retval _combine (list part)• protected retval _parse (scalar line)• protected retval _set_error_diag (scalar error, scalar pos)

Protected Functions

• protected retval _string ()• protected retval _fields ()• protected retval _make_regexp_split_column (scalar esc, scalar quot, scalar

sep)• protected retval _make_regexp_split_column_allow_sp (scalar esc, scalar

quot, scalar sep)• protected retval _return_getline_result ()• protected retval _check_type (scalar col_ref, scalar type)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Text/CSV_PP.pm

5.174 Modules::CustomerAccept Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 120: doxygen of OTRS cvs Ref Man

116 Class Documentation

Public Functions

• retval PreRun (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/CustomerAccept.pm

5.175 Kernel::System::CustomerAuth Class Reference

Classes

• class DB

• class HTTPBasicAuth

• class LDAP

• class Radius

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerAuth.pm

5.176 Kernel::System::CustomerCompany Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 121: doxygen of OTRS cvs Ref Man

5.177 Kernel::System::CustomerGroup Class Reference 117

Public Functions

• retval CustomerCompanyAdd (scalar Self, hash Param)• retval CustomerCompanyGet (scalar Self, hash Param)• retval CustomerCompanyUpdate (scalar Self, hash Param)• retval CustomerCompanyList (scalar Self, hash Param)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerCompany.pm

5.177 Kernel::System::CustomerGroup Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GroupMemberAdd (scalar Self, hash Param)• retval GroupMemberList (scalar Self, hash Param)• retval GroupLookup (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerGroup.pm

5.178 Output::HTML::CustomerHeaderMetaTicketSearch Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/CustomerHeaderMetaTicketSearch.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 122: doxygen of OTRS cvs Ref Man

118 Class Documentation

5.179 Kernel::System::Ticket::CustomerPermission::CustomerIDCheckClass Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/CustomerPermission/CustomerIDCheck.pm

5.180 Output::HTML::CustomerNewTicketQueueSelectionGeneric ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/CustomerNewTicketQueueSelectionGeneric.pm

5.181 Modules::CustomerPreferences Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 123: doxygen of OTRS cvs Ref Man

5.182 Modules::CustomerTicketAttachment Class Reference 119

Public Functions

• retval Run (scalar Self, hash Param)• retval CustomerPreferencesForm (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/CustomerPreferences.pm

5.182 Modules::CustomerTicketAttachment Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/CustomerTicketAttachment.pm

5.183 Modules::CustomerTicketMessage Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _MaskNew (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/CustomerTicketMessage.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 124: doxygen of OTRS cvs Ref Man

120 Class Documentation

5.184 Modules::CustomerTicketOverview Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval ShowTicketStatus (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/CustomerTicketOverview.pm

5.185 Modules::CustomerTicketPrint Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _PDFOutputTicketInfos (scalar Self, hash Param)• protected retval _PDFOutputTicketDynamicFields (scalar Self, hash Param)

• protected retval _PDFOutputCustomerInfos (scalar Self, hash Param)• protected retval _PDFOutputArticles (scalar Self, hash Param)• protected retval _HTMLMask (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/CustomerTicketPrint.pm

5.186 Modules::CustomerTicketSearch Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 125: doxygen of OTRS cvs Ref Man

5.187 Modules::CustomerTicketZoom Class Reference 121

Public Functions

• retval Run (scalar Self, hash Param)• retval MaskForm (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/CustomerTicketSearch.pm

5.187 Modules::CustomerTicketZoom Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Mask (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/CustomerTicketZoom.pm

5.188 Kernel::System::CustomerUser Class Reference

Classes

• class DB

• class LDAP

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 126: doxygen of OTRS cvs Ref Man

122 Class Documentation

Public Functions

• retval CustomerSourceList (scalar Self, hash Param)• retval CustomerSearch (scalar Self, hash Param)• retval CustomerUserList (scalar Self, hash Param)• retval CustomerName (scalar Self, hash Param)• retval CustomerIDs (scalar Self, hash Param)• retval CustomerUserDataGet (scalar Self, hash Param)• retval CustomerUserAdd (scalar Self, hash Param)• retval CustomerUserUpdate (scalar Self, hash Param)• retval SetPassword (scalar Self, hash Param)• retval GenerateRandomPassword (scalar Self, hash Param)• retval SetPreferences (scalar Self, hash Param)• retval GetPreferences (scalar Self, hash Param)• retval SearchPreferences (scalar Self, hash Param)• retval TokenGenerate (scalar Self, hash Param)• retval TokenCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerUser.pm

5.189 Output::HTML::CustomerUserGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/CustomerUserGeneric.pm

5.190 Output::HTML::CustomerUserGenericTicket Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 127: doxygen of OTRS cvs Ref Man

5.191 Kernel::System::Ticket::CustomerPermission::CustomerUserIDCheckClass Reference 123

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/CustomerUserGenericTicket.pm

5.191 Kernel::System::Ticket::CustomerPermission::CustomerUserIDCheckClass Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/CustomerPermission/CustomerUserIDCheck.pm

5.192 Kernel::GenericInterface::Transport::HTTP::Test::CustomHTTPProtocolClass Reference

Inheritance diagram for Kernel::GenericInterface::Transport::HTTP::Test::CustomHTTPProtocol:

Kernel::GenericInterface::Transport::HTTP::Test::CustomHTTPProtocol

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Class Methods

• retval new (scalar Class)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 128: doxygen of OTRS cvs Ref Man

124 Class Documentation

Public Functions

• retval request (scalar Request, scalar Proxy, scalar Arg, scalar Size, scalarTimeout)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Transport/HTTP/Test.pm

5.193 Proc::Daemon Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class, hash args)

Public Functions

• retval Init (scalar settings_ref)• retval adjust_settings ()• retval fix_filename (scalar key)• retval Fork ()• retval OpenMax ()• retval Status (scalar pid)• retval Kill_Daemon (scalar pid)• retval get_pid ()• retval get_pid_by_proc_table_attr (scalar command, scalar match)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Proc/Daemon.pm

5.194 HTTP::SOAP::Transport::HTTP::Daemon Class Reference

Inheritance diagram for HTTP::SOAP::Transport::HTTP::Daemon:

HTTP::SOAP::Transport::HTTP::Daemon

HTTP::SOAP::Transport::HTTP::Server

Public Member Functions

Public Object Methods

• retval new ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 129: doxygen of OTRS cvs Ref Man

5.195 Output::HTML::DashboardCalendar Class Reference 125

Public Functions

• retval DESTROY ()• retval SSL ()• retval http_daemon_class ()• retval AUTOLOAD ()• retval handle ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Transport/HTTP.pm

5.195 Output::HTML::DashboardCalendar Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardCalendar.pm

5.196 Output::HTML::DashboardIFrame Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardIFrame.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 130: doxygen of OTRS cvs Ref Man

126 Class Documentation

5.197 Output::HTML::DashboardImage Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardImage.pm

5.198 Output::HTML::DashboardMOTD Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardMOTD.pm

5.199 Output::HTML::DashboardProductNotify Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 131: doxygen of OTRS cvs Ref Man

5.200 Output::HTML::DashboardRSS Class Reference 127

Protected Functions

• protected retval _CheckVersion (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardProductNotify.pm

5.200 Output::HTML::DashboardRSS Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardRSS.pm

5.201 Output::HTML::DashboardTicketGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardTicketGeneric.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 132: doxygen of OTRS cvs Ref Man

128 Class Documentation

5.202 Output::HTML::DashboardTicketStatsGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardTicketStatsGeneric.pm

5.203 Output::HTML::DashboardUserOnline Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Preferences (scalar Self, hash Param)• retval Config (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/DashboardUserOnline.pm

5.204 LWP::Protocol::data Class Reference

Inheritance diagram for LWP::Protocol::data:

LWP::Protocol::data

LWP::Protocol

LWP::MemberMixin

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 133: doxygen of OTRS cvs Ref Man

5.205 URI::data Class Reference 129

Public Member Functions

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/data.pm

5.205 URI::data Class Reference

Public Member Functions

Public Object Methods

• retval media_type ()• retval data ()

Protected Functions

• protected retval _uric_count ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/data.pm

5.206 Mail::Field::Date Class Reference

Inheritance diagram for Mail::Field::Date:

Mail::Field::Date

Mail::Field

Public Member Functions

Public Functions

• retval set ()• retval parse ()• retval time ()• retval stringify ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 134: doxygen of OTRS cvs Ref Man

130 Class Documentation

• retval reformat ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Field/Date.pm

5.207 Kernel::System::DynamicField::Backend::Date Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ValueGet (scalar Self, hash Param)• retval ValueSet (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval SearchSQLGet (scalar Self, hash Param)• retval SearchSQLOrderFieldGet (scalar Self, hash Param)• retval EditFieldRender (scalar Self, hash Param)• retval EditFieldValueGet (scalar Self, hash Param)• retval EditFieldValueValidate (scalar Self, hash Param)• retval DisplayValueRender (scalar Self, hash Param)• retval IsSortable (scalar Self, hash Param)• retval SearchFieldRender (scalar Self, hash Param)• retval SearchFieldValueGet (scalar Self, hash Param)• retval SearchFieldParameterBuild (scalar Self, hash Param)• retval StatsFieldParameterBuild (scalar Self, hash Param)• retval CommonSearchFieldParameterBuild (scalar Self, hash Param)• retval ReadableValueRender (scalar Self, hash Param)• retval TemplateValueTypeGet (scalar Self, hash Param)• retval IsAJAXUpdateable (scalar Self, hash Param)• retval RandomValueSet (scalar Self, hash Param)• retval IsMatchable (scalar Self, hash Param)• retval ObjectMatch (scalar Self, hash Param)• retval AJAXPossibleValuesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend/Date.pm

5.208 Kernel::System::DynamicField::Backend::DateTime Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 135: doxygen of OTRS cvs Ref Man

5.209 Kernel::System::Web::UploadCache::DB Class Reference 131

Public Functions

• retval ValueGet (scalar Self, hash Param)• retval ValueSet (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval SearchSQLGet (scalar Self, hash Param)• retval SearchSQLOrderFieldGet (scalar Self, hash Param)• retval EditFieldRender (scalar Self, hash Param)• retval EditFieldValueGet (scalar Self, hash Param)• retval EditFieldValueValidate (scalar Self, hash Param)• retval DisplayValueRender (scalar Self, hash Param)• retval IsSortable (scalar Self, hash Param)• retval SearchFieldRender (scalar Self, hash Param)• retval SearchFieldValueGet (scalar Self, hash Param)• retval SearchFieldParameterBuild (scalar Self, hash Param)• retval StatsFieldParameterBuild (scalar Self, hash Param)• retval CommonSearchFieldParameterBuild (scalar Self, hash Param)• retval ReadableValueRender (scalar Self, hash Param)• retval TemplateValueTypeGet (scalar Self, hash Param)• retval IsAJAXUpdateable (scalar Self, hash Param)• retval RandomValueSet (scalar Self, hash Param)• retval IsMatchable (scalar Self, hash Param)• retval ObjectMatch (scalar Self, hash Param)• retval AJAXPossibleValuesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend/DateTime.pm

5.209 Kernel::System::Web::UploadCache::DB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval FormIDCreate (scalar Self, hash Param)• retval FormIDRemove (scalar Self, hash Param)• retval FormIDAddFile (scalar Self, hash Param)• retval FormIDRemoveFile (scalar Self, hash Param)• retval FormIDGetAllFilesData (scalar Self, hash Param)• retval FormIDGetAllFilesMeta (scalar Self, hash Param)• retval FormIDCleanUp (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Web/UploadCache/DB.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 136: doxygen of OTRS cvs Ref Man

132 Class Documentation

5.210 Kernel::System::PostMaster::LoopProtection::DB Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SendEmail (scalar Self, hash Param)• retval Check (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/LoopProtection/DB.pm

5.211 Kernel::System::User::Preferences::DB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SetPreferences (scalar Self, hash Param)• retval GetPreferences (scalar Self, hash Param)• retval SearchPreferences (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/User/Preferences/DB.pm

5.212 Kernel::System::VirtualFS::DB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 137: doxygen of OTRS cvs Ref Man

5.213 Kernel::System::Auth::DB Class Reference 133

Public Functions

• retval Read (scalar Self, hash Param)• retval Write (scalar Self, hash Param)• retval Delete (scalar Self, hash Param)

Protected Functions

• protected retval _FileLookup (scalar Self, scalar Filename)• protected retval _BackendKeyGenerate (scalar Self, hash Param)• protected retval _BackendKeyParse (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/VirtualFS/DB.pm

5.213 Kernel::System::Auth::DB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Auth/DB.pm

5.214 Kernel::System::AuthSession::DB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval CheckSessionID (scalar Self, hash Param)• retval CheckSessionIDMessage (scalar Self, hash Param)• retval GetSessionIDData (scalar Self, hash Param)• retval CreateSessionID (scalar Self, hash Param)• retval RemoveSessionID (scalar Self, hash Param)• retval UpdateSessionID (scalar Self, hash Param)• retval GetAllSessionIDs (scalar Self, hash Param)• retval CleanUp (scalar Self, hash Param)• retval DESTROY (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 138: doxygen of OTRS cvs Ref Man

134 Class Documentation

Protected Functions

• protected retval _Encode (scalar Self, scalar Key, scalar Value)• protected retval _Decode (scalar Self, scalar Value)• protected retval _SyncToStorage (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/AuthSession/DB.pm

5.215 Kernel::System::CustomerAuth::DB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerAuth/DB.pm

5.216 Kernel::System::CustomerUser::DB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval CustomerName (scalar Self, hash Param)• retval CustomerSearch (scalar Self, hash Param)• retval CustomerUserList (scalar Self, hash Param)• retval CustomerIDs (scalar Self, hash Param)• retval CustomerUserDataGet (scalar Self, hash Param)• retval CustomerUserAdd (scalar Self, hash Param)• retval CustomerUserUpdate (scalar Self, hash Param)• retval SetPassword (scalar Self, hash Param)• retval GenerateRandomPassword (scalar Self, hash Param)• retval SetPreferences (scalar Self, hash Param)• retval GetPreferences (scalar Self, hash Param)• retval SearchPreferences (scalar Self, hash Param)• retval DESTROY (scalar Self)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 139: doxygen of OTRS cvs Ref Man

5.217 Kernel::System::CustomerUser::Preferences::DB Class Reference 135

Protected Functions

• protected retval _ConvertFrom (scalar Self, scalar Text)• protected retval _ConvertTo (scalar Self, scalar Text)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerUser/DB.pm

5.217 Kernel::System::CustomerUser::Preferences::DB Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SetPreferences (scalar Self, hash Param)• retval GetPreferences (scalar Self, hash Param)• retval SearchPreferences (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerUser/Preferences/DB.pm

5.218 Kernel::System::DB Class Reference

Classes

• class db2• class ingres• class mssql• class mysql• class oracle• class postgresql• class postgresql_before_8_2

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 140: doxygen of OTRS cvs Ref Man

136 Class Documentation

Public Functions

• retval Connect (scalar Self)• retval Disconnect (scalar Self)• retval Quote (scalar Self, scalar Text, scalar Type)• retval Error (scalar Self)• retval Do (scalar Self, hash Param)• retval Prepare (scalar Self, hash Param)• retval FetchrowArray (scalar Self)• retval SelectAll (scalar Self, hash Param)• retval GetDatabaseFunction (scalar Self, scalar What)• retval SQLProcessor (scalar Self, hash Param)• retval SQLProcessorPost (scalar Self, hash Param)• retval GetTableData (scalar Self, hash Param)• retval QueryCondition (scalar Self, hash Param)• retval QueryStringEscape (scalar Self, hash Param)• retval DESTROY (scalar Self)

Protected Functions

• protected retval _Decrypt (scalar Self, scalar Pw)• protected retval _Encrypt (scalar Self, scalar Pw)• protected retval _TypeCheck (scalar Self, scalar Tag)• protected retval _NameCheck (scalar Self, scalar Tag)• protected retval _SpecialCharactersGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DB.pm

5.219 Kernel::System::DB::db2 Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval LoadPreferences (scalar Self, hash Param)• retval Quote (scalar Self, scalar Text, scalar Type)• retval DatabaseCreate (scalar Self, hash Param)• retval DatabaseDrop (scalar Self, hash Param)• retval TableCreate (scalar Self, list Param)• retval TableDrop (scalar Self, list Param)• retval TableAlter (scalar Self, list Param)• retval IndexCreate (scalar Self, hash Param)• retval IndexDrop (scalar Self, hash Param)• retval ForeignKeyCreate (scalar Self, hash Param)• retval ForeignKeyDrop (scalar Self, hash Param)• retval UniqueCreate (scalar Self, hash Param)• retval UniqueDrop (scalar Self, hash Param)• retval Insert (scalar Self, list Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 141: doxygen of OTRS cvs Ref Man

5.220 Apache::DBI Class Reference 137

Protected Functions

• protected retval _TypeTranslation (scalar Self, scalar Tag)

The documentation for this class was generated from the following file:

• Kernel/System/DB/db2.pm

5.220 Apache::DBI Class Reference

Public Member Functions

Public Class Methods

• retval setPingTimeOut (scalar class, scalar data_source, scalar timeout)• retval connect (scalar class, scalar drh)

Public Functions

• retval debug ()• retval connect_on_init ()• retval childinit ()• retval childexit ()• retval cleanup (scalar Idx)• retval set_startup_state (scalar Idx)• retval reset_startup_state (scalar Idx)• retval all_handlers ()• retval disconnect ()• retval status_function (scalar r, scalar q)• retval ping (scalar dbh)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Apache/DBI.pm

5.221 Kernel::GenericInterface::Debugger Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval DebugLog (scalar Self, hash Param)• retval Debug (scalar Self, hash Param)• retval Info (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 142: doxygen of OTRS cvs Ref Man

138 Class Documentation

• retval Notice (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Debugger.pm

5.222 Kernel::System::GenericInterface::DebugLog Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval LogAdd (scalar Self, hash Param)• retval LogGet (scalar Self, hash Param)• retval LogGetWithData (scalar Self, hash Param)• retval LogDelete (scalar Self, hash Param)• retval LogSearch (scalar Self, hash Param)

Protected Functions

• protected retval _LogAddChain (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericInterface/DebugLog.pm

5.223 MIME::Decoder Class Reference

Inheritance diagram for MIME::Decoder:

MIME::Decoder

MIME::Decoder::Base64 MIME::Decoder::Binary MIME::Decoder::BinHex MIME::Decoder::NBit MIME::Decoder::QuotedPrint MIME::Decoder::UU

MIME::Decoder::Gzip64

Classes

• class Base64• class Binary

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 143: doxygen of OTRS cvs Ref Man

5.224 Kernel::Config::Defaults Class Reference 139

• class BinHex

• class Gzip64

• class NBit

• class QuotedPrint

• class UU

Public Member Functions

Public Class Methods

• retval new (scalar class, list args)• retval best (scalar class, scalar enc, list args)• retval supported (scalar class, scalar decoder)• retval install (scalar class)

Public Object Methods

• retval decode (scalar in, scalar out)• retval encode (scalar in, scalar out, scalar textual_type)• retval head (scalar head)• retval decode_it (scalar in, scalar out)• retval filter (scalar in, scalar out, list cmd)• retval decode_it (scalar in, scalar out)• retval encode_it (scalar in, scalar out)

Public Functions

• retval encoding ()• retval decode_it ()• retval encode_it ()• retval init ()• retval uninstall ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Decoder.pm

5.224 Kernel::Config::Defaults Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 144: doxygen of OTRS cvs Ref Man

140 Class Documentation

Public Functions

• retval LoadDefaults (scalar Self)• retval Get (scalar Self, scalar What)• retval Set (scalar Self, hash Param)• retval ConfigChecksum (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/Config/Defaults.pm

5.225 HTTP::SOAP::XMLSchemaApacheSOAP::Deserializer Class Ref-erence

Public Member Functions

Public Object Methods

• retval as_map ()• retval as_Map ()• retval as_vector ()• retval as_Vector ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite.pm

5.226 Kernel::System::PostMaster::DestQueue Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetQueueID (scalar Self, hash Param)• retval GetTrustedQueueID (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/DestQueue.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 145: doxygen of OTRS cvs Ref Man

5.227 Text::Diff Class Reference 141

5.227 Text::Diff Class Reference

Classes

• class Table

Public Member Functions

Public Class Methods

• retval new (scalar proto)

Public Functions

• retval diff ()• retval file_header ()• retval hunk_header ()• retval hunk ()• retval hunk_footer ()• retval file_footer ()• retval Unified::file_header ()• retval Unified::hunk_header ()• retval Unified::hunk ()• retval Context::file_header ()• retval Context::hunk_header ()• retval Context::hunk ()• retval OldStyle::hunk_header ()• retval OldStyle::hunk ()• retval footer ()

Protected Functions

• protected retval _header (scalar h)• protected retval _range (scalar ops, scalar a_or_b, scalar format)• protected retval _op_to_line (scalar seqs, scalar op, scalar a_or_b, scalar

op_prefixes)• protected retval _op (scalar ops)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Text/Diff.pm

5.228 Algorithm::Diff Class Reference

Classes

• class _impl

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 146: doxygen of OTRS cvs Ref Man

142 Class Documentation

Public Member Functions

Public Functions

• retval traverse_sequences (scalar a, scalar b)• retval traverse_balanced (scalar a, scalar b)• retval prepare (scalar a, scalar keyGen)• retval LCS (scalar a, scalar b)• retval LCS_length (scalar a, scalar b)• retval LCSidx ()• retval compact_diff ()• retval diff (scalar a, scalar b)• retval sdiff (scalar a, scalar b)

Protected Functions

• protected retval _withPositionsOfInInterval (scalar aCollection, scalar start,scalar end, scalar keyGen)

• protected retval _replaceNextLargerWith (scalar array, scalar aValue, scalarhigh)

• protected retval _longestCommonSubsequence (scalar a, scalar b, scalarcounting, scalar keyGen)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Algorithm/Diff.pm

5.229 Algorithm::DiffOld Class Reference

Public Member Functions

Public Functions

• retval someFunkyComparisonFunction (scalar a, scalar b)• retval traverse_sequences (scalar a, scalar b)• retval LCS (scalar a)• retval diff (scalar a, scalar b)

Protected Functions

• protected retval _replaceNextLargerWith (scalar array, scalar aValue, scalarhigh)

• protected retval _longestCommonSubsequence (scalar a, scalar b)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Algorithm/DiffOld.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 147: doxygen of OTRS cvs Ref Man

5.230 LWP::Authen::Digest Class Reference 143

5.230 LWP::Authen::Digest Class Reference

Public Member Functions

Public Class Methods

• retval auth_header (scalar class, scalar user, scalar pass, scalar request,scalar ua, scalar h)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Authen/Digest.pm

5.231 Authen::SASL::Perl::DIGEST MD5 Class Reference

Public Member Functions

Public Object Methods

• retval init_sec_layer ()• retval client_start ()• retval server_start (scalar challenge)• retval client_step (scalar challenge)• retval server_step (scalar challenge)• retval is_qop_supported (scalar qop)• retval encode ()• retval decode (scalar buf, scalar len)

Public Functions

• retval mechanism ()

Protected Object Methods

• protected retval _compute_digests_and_set_keys (scalar password, scalarparams)

• protected retval _parse_challenge (scalar challenge_ref, scalar type, scalarparams)

• protected retval _server_layer (scalar auth)• protected retval _client_layer (scalar sparams, scalar response)• protected retval _select_cipher (scalar minssf, scalar maxssf, scalar ciphers)

Protected Functions

• protected retval _order ()• protected retval _secflags ()• protected retval _init (scalar pkg, scalar self)• protected retval _init_server (scalar server)• protected retval _response (scalar response, scalar is_client)• protected retval _qdval (scalar k, scalar v, scalar is_client)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 148: doxygen of OTRS cvs Ref Man

144 Class Documentation

• protected retval _crypt ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/Perl/DIGEST_MD5.pm

5.232 HTTP::SOAP::Lite::Packager::DIME Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar classname)

Public Object Methods

• retval initialize_parser ()• retval c2f ()

Public Functions

• retval BEGIN ()• retval package (scalar envelope, scalar context)• retval unpackage (scalar raw_input, scalar context)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite/Packager.pm

5.233 HTTP::SOAP::Packager::DIME Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar classname)

Public Object Methods

• retval initialize_parser ()• retval c2f ()

Public Functions

• retval BEGIN ()• retval package (scalar envelope, scalar context)• retval unpackage (scalar raw_input, scalar context)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Packager.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 149: doxygen of OTRS cvs Ref Man

5.236 Kernel::System::Email::DoNotSendEmail Class Reference 145

5.234 Proc::PID::File::Temp::Dir Class Reference

Public Member Functions

Public Object Methods

• retval dirname ()• retval STRINGIFY ()• retval unlink_on_destroy ()• retval DESTROY ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/File/Temp.pm

5.235 DocumentFragment Class Reference

5.235.1 Detailed Description

"lightweight" or "minimal" Document object. It is commonly used to extract a portion ofa document’s tree or to create a new fragment of a document. Various operations maytake DocumentFragment objects as arguments and results in all the child nodes of theDocumentFragment being moved to the child list of this node.

Parameters{Object} ownerDocument

The documentation for this class was generated from the following file:

• var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/dom/documentfragment.js

5.236 Kernel::System::Email::DoNotSendEmail Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Send (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Email/DoNotSendEmail.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 150: doxygen of OTRS cvs Ref Man

146 Class Documentation

5.237 Kernel::System::DynamicField::Backend::Dropdown Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ValueGet (scalar Self, hash Param)• retval ValueSet (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval SearchSQLGet (scalar Self, hash Param)• retval SearchSQLOrderFieldGet (scalar Self, hash Param)• retval EditFieldRender (scalar Self, hash Param)• retval EditFieldValueGet (scalar Self, hash Param)• retval EditFieldValueValidate (scalar Self, hash Param)• retval DisplayValueRender (scalar Self, hash Param)• retval IsSortable (scalar Self, hash Param)• retval SearchFieldRender (scalar Self, hash Param)• retval SearchFieldValueGet (scalar Self, hash Param)• retval SearchFieldParameterBuild (scalar Self, hash Param)• retval StatsFieldParameterBuild (scalar Self, hash Param)• retval CommonSearchFieldParameterBuild (scalar Self, hash Param)• retval ReadableValueRender (scalar Self, hash Param)• retval TemplateValueTypeGet (scalar Self, hash Param)• retval IsAJAXUpdateable (scalar Self, hash Param)• retval RandomValueSet (scalar Self, hash Param)• retval IsMatchable (scalar Self, hash Param)• retval ObjectMatch (scalar Self, hash Param)• retval AJAXPossibleValuesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend/Dropdown.pm

5.238 Kernel::System::LinkObject::Dummy Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 151: doxygen of OTRS cvs Ref Man

5.239 YAML::Dumper Class Reference 147

Public Functions

• retval LinkListWithData (scalar Self, hash Param)• retval ObjectDescriptionGet (scalar Self, hash Param)• retval ObjectSearch (scalar Self, hash Param)• retval LinkAddPre (scalar Self, hash Param)• retval LinkAddPost (scalar Self, hash Param)• retval LinkDeletePre (scalar Self, hash Param)• retval LinkDeletePost (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• scripts/test/sample/LinkObject/LinkBackendDummy.pm

5.239 YAML::Dumper Class Reference

Classes

• class Base

Public Member Functions

Public Object Methods

• retval dump ()• retval is_valid_plain ()

Public Functions

• retval indent (scalar text)• retval escape (scalar text)

Protected Object Methods

• protected retval _prewalk ()• protected retval _emit_node ()• protected retval _emit ()• protected retval _emit_str (scalar type)• protected retval _emit_plain ()• protected retval _emit_double ()• protected retval _emit_single (scalar item)

Protected Functions

• protected retval _emit_header (scalar node)• protected retval _emit_mapping (scalar value, scalar tag, scalar node_id,

scalar context)• protected retval _emit_sequence (scalar value, scalar tag)• protected retval _emit_key (scalar value, scalar context)• protected retval _emit_scalar (scalar value, scalar tag)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 152: doxygen of OTRS cvs Ref Man

148 Class Documentation

• protected retval _emit_block (scalar indicator, scalar value)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Dumper.pm

5.240 Kernel::System::DynamicField Class Reference

Classes

• class Backend

• class Backend

• class Backend

• class Backend

• class Backend

• class Backend

• class Backend

• class Backend

• class Backend

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval DynamicFieldAdd (scalar Self, hash Param)• retval DynamicFieldGet (scalar Self, hash Param)• retval DynamicFieldUpdate (scalar Self, hash Param)• retval DynamicFieldDelete (scalar Self, hash Param)• retval DynamicFieldList (scalar Self, hash Param)• retval DynamicFieldListGet (scalar Self, hash Param)

Protected Functions

• protected retval _DynamicFieldReorder (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 153: doxygen of OTRS cvs Ref Man

5.241 Kernel::System::DynamicFieldValue Class Reference 149

5.241 Kernel::System::DynamicFieldValue Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ValueSet (scalar Self, hash Param)• retval ValueGet (scalar Self, hash Param)• retval ValueDelete (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval HistoricalValueGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicFieldValue.pm

5.242 Kernel::System::Email Class Reference

Classes

• class DoNotSendEmail• class Sendmail• class SMTP• class SMTPS• class SMTPTLS

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Send (scalar Self, hash Param)• retval Check (scalar Self, hash Param)• retval Bounce (scalar Self, hash Param)

Protected Functions

• protected retval _EncodeMIMEWords (scalar Self, hash Param)• protected retval _MessageIDCreate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Email.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 154: doxygen of OTRS cvs Ref Man

150 Class Documentation

5.243 Kernel::System::EmailParser Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetPlainEmail (scalar Self)• retval GetParam (scalar Self, hash Param)• retval GetEmailAddress (scalar Self, hash Param)• retval GetRealname (scalar Self, hash Param)• retval SplitAddressLine (scalar Self, hash Param)• retval GetContentType (scalar Self)• retval GetCharset (scalar Self)• retval GetReturnContentType (scalar Self)• retval GetReturnCharset (scalar Self)• retval GetMessageBody (scalar Self, hash Param)• retval GetAttachments (scalar Self, hash Param)• retval PartsAttachments (scalar Self, hash Param)• retval GetReferences (scalar Self, hash Param)• retval GetContentTypeParams (scalar Self, hash Param)• retval CheckMessageBody (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/EmailParser.pm

5.244 Kernel::System::Encode Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Convert (scalar Self, hash Param)• retval Convert2CharsetInternal (scalar Self, hash Param)• retval EncodeInput (scalar Self, scalar What)• retval EncodeOutput (scalar Self, scalar What)• retval SetIO (scalar Self, list Array)• retval CharsetInternal (scalar Self)• retval EncodeInternalUsed (scalar Self)• retval Encode (scalar Self)• retval Decode (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Encode.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 155: doxygen of OTRS cvs Ref Man

5.245 MIME::Entity Class Reference 151

5.245 MIME::Entity Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval add_part (scalar part, scalar index)• retval attach ()• retval build (list paramlist)• retval dup ()• retval body (scalar value)• retval bodyhandle (scalar newvalue)• retval effective_type ()• retval epilogue (scalar lines)• retval head (scalar value)• retval is_multipart ()• retval mime_type ()• retval open ()• retval parts ()• retval parts_DFS ()• retval preamble (scalar lines)• retval make_multipart (scalar subtype, hash opts)• retval make_singlepart ()• retval purge ()• retval remove_sig (scalar nlines)• retval sign ()• retval suggest_encoding ()• retval suggest_encoding_lite ()• retval sync_headers ()• retval dump_skeleton (scalar fh, scalar indent)• retval print (scalar out)• retval print_body (scalar out)• retval print_bodyhandle (scalar out)• retval stringify ()• retval stringify_body ()

Public Functions

• retval known_field ()• retval make_boundary ()• retval tidy_body ()• retval as_string ()• retval body_as_string ()• retval stringify_header ()• retval header_as_string ()

Protected Functions

• protected retval _do_remove_sig (scalar body, scalar nlines)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Entity.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 156: doxygen of OTRS cvs Ref Man

152 Class Documentation

5.246 YAML::Error Class Reference

Public Member Functions

Public Object Methods

• retval format_message ()

Public Functions

• retval error_messages ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Error.pm

5.247 Text::CSV::ErrorDiag Class Reference

Public Member Functions

Public Functions

• retval numeric (scalar left, scalar right)• retval stringify ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Text/CSV_PP.pm

5.248 URI::Escape Class Reference

Public Member Functions

Public Functions

• retval uri_escape (scalar text, scalar patn)• retval uri_escape_utf8 (scalar text)• retval uri_unescape (scalar str)• retval escape_char ()

Protected Functions

• protected retval _fail_hi (scalar chr)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/Escape.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 157: doxygen of OTRS cvs Ref Man

5.249 HTTP::Headers::ETag Class Reference 153

5.249 HTTP::Headers::ETag Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/HTTP/Headers/ETag.pm

5.250 Kernel::System::EventHandler Class Reference

Public Member Functions

Public Functions

• retval EventHandlerInit (scalar Self, hash Param)• retval EventHandler (scalar Self, hash Param)• retval DESTROY (scalar Self)• retval EventHandlerTransaction (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/EventHandler.pm

5.251 Authen::SASL::EXTERNAL Class Reference

Public Member Functions

Public Class Methods

• retval new ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/EXTERNAL.pm

5.252 Authen::SASL::Perl::EXTERNAL Class Reference

Public Member Functions

Public Object Methods

• retval client_start ()

Public Functions

• retval mechanism ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 158: doxygen of OTRS cvs Ref Man

154 Class Documentation

Protected Functions

• protected retval _order ()• protected retval _secflags ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/Perl/EXTERNAL.pm

5.253 CGI::Fast Class Reference

Inheritance diagram for CGI::Fast:

CGI::Fast

CGI

Public Member Functions

Public Object Methods

• retval new (scalar initializer, list param)

Public Functions

• retval save_request ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI/Fast.pm

5.254 file::FAT Class Reference

Public Member Functions

Public Functions

• retval fix_path ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/file/FAT.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 159: doxygen of OTRS cvs Ref Man

5.255 HTTP::SOAP::Transport::HTTP::FCGI Class Reference 155

5.255 HTTP::SOAP::Transport::HTTP::FCGI Class Reference

Inheritance diagram for HTTP::SOAP::Transport::HTTP::FCGI:

HTTP::SOAP::Transport::HTTP::FCGI

HTTP::SOAP::Transport::HTTP::CGI

HTTP::SOAP::Transport::HTTP::Server

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Functions

• retval DESTROY ()• retval handle ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Transport/HTTP.pm

5.256 XML::FeedPP Class Reference

Classes

• class Item• class Plugin

Public Member Functions

Public Class Methods

• retval new (scalar package)

Public Object Methods

• retval load (scalar source)• retval to_string ()• retval to_file (scalar file)• retval merge (scalar source)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 160: doxygen of OTRS cvs Ref Man

156 Class Documentation

• retval merge_channel ()• retval merge_item ()• retval merge_common_channel ()• retval add_clone_item ()• retval merge_module_nodes (scalar item1, scalar item2)• retval normalize ()• retval normalize_pubDate ()• retval xmlns (scalar ns, scalar url)• retval get_pubDate_w3cdtf ()• retval get_pubDate_rfc1123 ()• retval get_pubDate_epoch ()• retval call (scalar name)• retval elements ()• retval match_item ()

Public Functions

• retval feed_bless (scalar package, scalar self)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/XML/FeedPP.pm

5.257 Fh Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar pack, scalar name, scalar file, scalar delete)

Public Object Methods

• retval DESTROY ()• retval asString ()• retval compare (scalar value)• retval handle ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI.pm

5.258 Mail::Field Class Reference

Inheritance diagram for Mail::Field:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 161: doxygen of OTRS cvs Ref Man

5.259 Kernel::System::Log::File Class Reference 157

Mail::Field

Mail::Field::Date MIME::Field::ParamVal

MIME::Field::ContDisp MIME::Field::ConTraEnc MIME::Field::ContType

Classes

• class Date

Public Member Functions

Public Class Methods

• retval new ()

Public Functions

• retval import ()• retval register ()• retval combine ()• retval AUTOLOAD ()• retval extract ()• retval create ()• retval parse ()• retval stringify ()• retval tag ()• retval set (list)• retval DESTROY ()• retval text ()

Protected Functions

• protected retval _header_pkg_name ()• protected retval _require_dir ()• protected retval _build ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Field.pm

5.259 Kernel::System::Log::File Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 162: doxygen of OTRS cvs Ref Man

158 Class Documentation

Public Functions

• retval Log (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Log/File.pm

5.260 LWP::Protocol::file Class Reference

Inheritance diagram for LWP::Protocol::file:

LWP::Protocol::file

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/file.pm

5.261 URI::file Class Reference

Inheritance diagram for URI::file:

URI::file

URI::_generic

Public Member Functions

Public Class Methods

• retval host (scalar class, scalar path, scalar os)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 163: doxygen of OTRS cvs Ref Man

5.262 MIME::Body::File Class Reference 159

• retval new (scalar class, scalar path, scalar os)• retval new_abs (scalar class)• retval cwd (scalar class)

Public Object Methods

• retval canonical ()• retval file (scalar os)• retval dir (scalar os)

Public Functions

• retval os_class ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/file.pm

5.262 MIME::Body::File Class Reference

Inheritance diagram for MIME::Body::File:

MIME::Body::File

MIME::Body

Public Member Functions

Public Object Methods

• retval init (scalar path)• retval open (scalar mode)• retval purge ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Body.pm

5.263 MIME::Parser::FileInto Class Reference

Inheritance diagram for MIME::Parser::FileInto:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 164: doxygen of OTRS cvs Ref Man

160 Class Documentation

MIME::Parser::FileInto

MIME::Parser::Filer

Public Member Functions

Public Object Methods

• retval init (scalar dir)

Public Functions

• retval output_dir ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Parser/Filer.pm

5.264 MIME::Parser::Filer Class Reference

Inheritance diagram for MIME::Parser::Filer:

MIME::Parser::Filer

MIME::Parser::FileInto MIME::Parser::FileUnder

Public Member Functions

Public Class Methods

• retval new (scalar class, list initargs)

Public Object Methods

• retval cleanup_dir (scalar dir)• retval results (scalar results)• retval debug ()• retval whine ()• retval init_parse ()• retval evil_filename (scalar name)• retval exorcise_filename (scalar fname)• retval find_unused_path (scalar dir, scalar fname)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 165: doxygen of OTRS cvs Ref Man

5.265 Kernel::System::Cache::FileRaw Class Reference 161

• retval ignore_filename ()• retval output_dir (scalar head)• retval output_filename (scalar head)• retval output_prefix (scalar prefix)• retval output_type_ext ()• retval output_path (scalar head)• retval purge ()• retval purgeable (scalar path)

Public Functions

• retval init ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Parser/Filer.pm

5.265 Kernel::System::Cache::FileRaw Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Set (scalar Self, hash Param)• retval Get (scalar Self, hash Param)• retval Delete (scalar Self, hash Param)• retval CleanUp (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Cache/FileRaw.pm

5.266 Kernel::System::Cache::FileStorable Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 166: doxygen of OTRS cvs Ref Man

162 Class Documentation

Public Functions

• retval Set (scalar Self, hash Param)• retval Get (scalar Self, hash Param)• retval Delete (scalar Self, hash Param)• retval CleanUp (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Cache/FileStorable.pm

5.267 Kernel::System::FileTemp Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval TempFile (scalar Self)• retval DESTROY (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/FileTemp.pm

5.268 MIME::Parser::FileUnder Class Reference

Inheritance diagram for MIME::Parser::FileUnder:

MIME::Parser::FileUnder

MIME::Parser::Filer

Public Member Functions

Public Object Methods

• retval init (scalar basedir, hash opts)• retval init_parse ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 167: doxygen of OTRS cvs Ref Man

5.269 Kernel::System::PostMaster::Filter Class Reference 163

Public Functions

• retval output_dir ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Parser/Filer.pm

5.269 Kernel::System::PostMaster::Filter Class Reference

Classes

• class CMD

• class FollowUpArticleTypeCheck

• class Match

• class MatchDBSource

• class NewTicketReject

• class SystemMonitoring

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval FilterList (scalar Self, hash Param)• retval FilterAdd (scalar Self, hash Param)• retval FilterDelete (scalar Self, hash Param)• retval FilterGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/Filter.pm

5.270 Mail::Filter Class Reference

Public Member Functions

Public Class Methods

• retval new ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 168: doxygen of OTRS cvs Ref Man

164 Class Documentation

Public Functions

• retval add ()• retval filter ()• retval folder ()• retval msgnum ()

Protected Functions

• protected retval _filter ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Filter.pm

5.271 Kernel::System::PostMaster::FollowUp Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/FollowUp.pm

5.272 Kernel::System::PostMaster::Filter::FollowUpArticleTypeCheckClass Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/Filter/FollowUpArticleTypeCheck.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 169: doxygen of OTRS cvs Ref Man

5.273 Kernel::System::Ticket::Event::ForceOwnerReset Class Reference 165

5.273 Kernel::System::Ticket::Event::ForceOwnerReset Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/ForceOwnerReset.pm

5.274 Kernel::System::Ticket::Event::ForceState Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/ForceState.pm

5.275 Kernel::System::Ticket::Event::ForceUnlock Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/ForceUnlock.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 170: doxygen of OTRS cvs Ref Man

166 Class Documentation

5.276 Kernel::System::VirtualFS::FS Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Read (scalar Self, hash Param)• retval Write (scalar Self, hash Param)• retval Delete (scalar Self, hash Param)

Protected Functions

• protected retval _BackendKeyGenerate (scalar Self, hash Param)• protected retval _BackendKeyParse (scalar Self, hash Param)• protected retval _SplitDir (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/VirtualFS/FS.pm

5.277 Kernel::System::Web::UploadCache::FS Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval FormIDCreate (scalar Self, hash Param)• retval FormIDRemove (scalar Self, hash Param)• retval FormIDAddFile (scalar Self, hash Param)• retval FormIDRemoveFile (scalar Self, hash Param)• retval FormIDGetAllFilesData (scalar Self, hash Param)• retval FormIDGetAllFilesMeta (scalar Self, hash Param)• retval FormIDCleanUp (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Web/UploadCache/FS.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 171: doxygen of OTRS cvs Ref Man

5.278 Kernel::System::PostMaster::LoopProtection::FS Class Reference 167

5.278 Kernel::System::PostMaster::LoopProtection::FS Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SendEmail (scalar Self, hash Param)• retval Check (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/LoopProtection/FS.pm

5.279 Kernel::System::AuthSession::FS Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval CheckSessionID (scalar Self, hash Param)• retval CheckSessionIDMessage (scalar Self, hash Param)• retval GetSessionIDData (scalar Self, hash Param)• retval CreateSessionID (scalar Self, hash Param)• retval RemoveSessionID (scalar Self, hash Param)• retval UpdateSessionID (scalar Self, hash Param)• retval GetAllSessionIDs (scalar Self, hash Param)• retval CleanUp (scalar Self, hash Param)• retval DESTROY (scalar Self, hash Param)

Protected Functions

• protected retval _Encode (scalar Self, scalar Key, scalar Value)• protected retval _Decode (scalar Self, scalar Value)• protected retval _SyncToStorage (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/AuthSession/FS.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 172: doxygen of OTRS cvs Ref Man

168 Class Documentation

5.280 LWP::Protocol::ftp Class Reference

Inheritance diagram for LWP::Protocol::ftp:

LWP::Protocol::ftp

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval http_server ()• retval home ()• retval go_home ()• retval request_count ()• retval ping ()• retval request (scalar request, scalar proxy, scalar arg, scalar size, scalar time-

out)

Protected Object Methods

• protected retval _connect (scalar host, scalar port, scalar user, scalar account,scalar password, scalar timeout)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/ftp.pm

5.281 URI::ftp Class Reference

Public Member Functions

Public Object Methods

• retval path ()• retval user ()• retval password ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 173: doxygen of OTRS cvs Ref Man

5.282 Class::Inspector::Functions Class Reference 169

Public Functions

• retval default_port ()

Protected Functions

• protected retval _user ()• protected retval _password ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/ftp.pm

5.282 Class::Inspector::Functions Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Class/Inspector/Functions.pm

5.283 Kernel::Config::GenericAgent Class Reference

The documentation for this class was generated from the following file:

• Kernel/Config/GenericAgent.pm

5.284 Kernel::System::GenericAgent Class Reference

Classes

• class AutoPriorityIncrease• class NotifyAgentGroupOfCustomQueue• class NotifyAgentGroupWithWritePermission• class TriggerEscalationStartEvents

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval JobRun (scalar Self, hash Param)• retval JobList (scalar Self, hash Param)• retval JobGet (scalar Self, hash Param)• retval JobAdd (scalar Self, hash Param)• retval JobDelete (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 174: doxygen of OTRS cvs Ref Man

170 Class Documentation

Protected Functions

• protected retval _JobRunTicket (scalar Self, hash Param)• protected retval _JobUpdateRunTime (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericAgent.pm

5.285 Kernel::Scheduler::TaskHandler::GenericInterface Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Scheduler/TaskHandler/GenericInterface.pm

5.286 LWP::Protocol::GHTTP Class Reference

Public Member Functions

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size, scalar time-out)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/GHTTP.pm

5.287 Type::glob Class Reference

Public Member Functions

Public Object Methods

• retval yaml_dump ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 175: doxygen of OTRS cvs Ref Man

5.288 LWP::Protocol::gopher Class Reference 171

Public Functions

• retval yaml_load (scalar node, scalar class, scalar loader)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Types.pm

5.288 LWP::Protocol::gopher Class Reference

Inheritance diagram for LWP::Protocol::gopher:

LWP::Protocol::gopher

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size, scalar time-out)

Public Functions

• retval gopher2url (scalar gophertype, scalar path, scalar host, scalar port)• retval menu2html (scalar menu)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/gopher.pm

5.289 URI::gopher Class Reference

Public Member Functions

Public Object Methods

• retval gopher_type ()• retval selector (scalar self, scalar self, scalar self, scalar fno)• retval search (scalar self, scalar self, scalar fno)• retval string (scalar self, scalar fno)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 176: doxygen of OTRS cvs Ref Man

172 Class Documentation

Public Functions

• retval default_port ()

Protected Object Methods

• protected retval _gopher_type ()• protected retval _gfield (scalar fno)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/gopher.pm

5.290 Kernel::System::Group Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GroupLookup (scalar Self, hash Param)• retval GroupAdd (scalar Self, hash Param)• retval GroupGet (scalar Self, hash Param)• retval GroupUpdate (scalar Self, hash Param)• retval GroupList (scalar Self, hash Param)• retval GroupMemberAdd (scalar Self, hash Param)• retval GroupMemberList (scalar Self, hash Param)• retval GroupMemberInvolvedList (scalar Self, hash Param)• retval GroupGroupMemberList (scalar Self, hash Param)• retval GroupRoleMemberList (scalar Self, hash Param)• retval GroupRoleMemberAdd (scalar Self, hash Param)• retval GroupUserRoleMemberList (scalar Self, hash Param)• retval GroupUserRoleMemberAdd (scalar Self, hash Param)• retval RoleLookup (scalar Self, hash Param)• retval RoleGet (scalar Self, hash Param)• retval RoleAdd (scalar Self, hash Param)• retval RoleUpdate (scalar Self, hash Param)• retval RoleList (scalar Self, hash Param)

Protected Functions

• protected retval _GetTypeString (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Group.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 177: doxygen of OTRS cvs Ref Man

5.291 Kernel::System::Ticket::Permission::GroupCheck Class Reference 173

5.291 Kernel::System::Ticket::Permission::GroupCheck Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Permission/GroupCheck.pm

5.292 Kernel::System::Ticket::CustomerPermission::GroupCheck ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/CustomerPermission/GroupCheck.pm

5.293 Authen::SASL::Perl::GSSAPI Class Reference

Public Member Functions

Public Object Methods

• retval client_start ()• retval client_step (scalar challenge)• retval encode ()• retval decode ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 178: doxygen of OTRS cvs Ref Man

174 Class Documentation

Public Functions

• retval mechanism ()

Protected Object Methods

• protected retval _layer (scalar theirmask, scalar rsz, scalar lsz)

Protected Functions

• protected retval _order ()• protected retval _secflags ()• protected retval _init (scalar pkg, scalar self)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/Perl/GSSAPI.pm

5.294 MIME::Decoder::Gzip64 Class Reference

Inheritance diagram for MIME::Decoder::Gzip64:

MIME::Decoder::Gzip64

MIME::Decoder::Base64

MIME::Decoder

Public Member Functions

Public Object Methods

• retval decode_it (scalar in, scalar out)• retval encode_it (scalar in, scalar out)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Decoder/Gzip64.pm

5.295 Kernel::GenericInterface::Event::Handler Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 179: doxygen of OTRS cvs Ref Man

5.296 MIME::Head Class Reference 175

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Event/Handler.pm

5.296 MIME::Head Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval from_file (scalar file, list opts)• retval read ()• retval copy ()• retval decode ()• retval exists ()• retval fields ()• retval get_all (scalar tag)• retval original_text ()• retval print (scalar fh)• retval set ()• retval stringify ()• retval as_string ()• retval params (scalar tag)• retval mime_attr (scalar attr, scalar value)• retval mime_encoding ()• retval mime_type (scalar default)• retval multipart_boundary ()• retval recommended_filename ()• retval tweak_FROM_parsing ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Head.pm

5.297 Output::HTML::HeaderMetaRefresh Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 180: doxygen of OTRS cvs Ref Man

176 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/HeaderMetaRefresh.pm

5.298 Output::HTML::HeaderMetaTicketSearch Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/HeaderMetaTicketSearch.pm

5.299 HTTP::Headers Class Reference

Classes

• class Auth• class ETag• class Util

Public Member Functions

Public Object Methods

• retval www_authenticate (scalar self)• retval proxy_authenticate ()• retval etag (scalar self, scalar self, scalar self, scalar new)• retval if_match (scalar self, scalar self, scalar new)• retval if_none_match (scalar self, scalar new)• retval if_range (scalar new)• retval header ()• retval clear ()• retval push_header ()• retval init_header ()• retval remove_header (list fields)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 181: doxygen of OTRS cvs Ref Man

5.299 HTTP::Headers Class Reference 177

• retval remove_content_headers ()• retval header_field_names ()• retval scan (scalar sub)• retval as_string (scalar endl)• retval date (scalar self, scalar self, scalar self, scalar self, scalar self, scalar

self, scalar self)• retval expires (scalar self, scalar self, scalar self, scalar self, scalar self, scalar

self)• retval if_modified_since (scalar self, scalar self, scalar self, scalar self, scalar

self)• retval if_unmodified_since (scalar self, scalar self, scalar self, scalar self)• retval last_modified (scalar self, scalar self, scalar self)• retval client_date (scalar self, scalar self)• retval content_type ()• retval content_type_charset ()• retval content_is_text ()• retval content_is_html ()• retval referer (scalar uri)• retval title (scalar h, scalar user, scalar passwd)• retval content_encoding (scalar h, scalar user, scalar passwd)• retval content_language (scalar h, scalar user, scalar passwd)• retval content_length (scalar h, scalar user, scalar passwd)• retval user_agent (scalar h, scalar user, scalar passwd)• retval server (scalar h, scalar user, scalar passwd)• retval from (scalar h, scalar user, scalar passwd)• retval warning (scalar h, scalar user, scalar passwd)• retval www_authenticate (scalar h, scalar user, scalar passwd)• retval authorization (scalar h, scalar user, scalar passwd)• retval proxy_authenticate (scalar h, scalar user, scalar passwd)• retval proxy_authorization (scalar h, scalar user, scalar passwd)• retval authorization_basic (scalar h, scalar user, scalar passwd)• retval proxy_authorization_basic (scalar h, scalar user, scalar passwd)

Protected Object Methods

• protected retval _authenticate (scalar header)• protected retval _etags (scalar header)• protected retval _header (scalar field, scalar val, scalar op)• protected retval _sorted_field_names ()• protected retval _date_header (scalar header, scalar time)• protected retval _basic_auth (scalar h, scalar user, scalar passwd)

Protected Functions

• protected retval _parse_authenticate ()• protected retval _split_etag_list (list val)• protected retval _process_newline (scalar _, scalar endl)

Public Class Methods

• retval new ((scalar class))

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 182: doxygen of OTRS cvs Ref Man

178 Class Documentation

Public Functions

• retval content_is_xhtml ()• retval content_is_xml ()

The documentation for this class was generated from the following files:

• Kernel/cpan-lib/HTTP/Headers/Auth.pm• Kernel/cpan-lib/HTTP/Headers/ETag.pm• Kernel/cpan-lib/HTTP/Headers.pm

5.300 Kernel::System::UnitTest::Helper Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetRandomID (scalar Self, hash Param)• retval TestUserCreate (scalar Self, hash Param)• retval TestCustomerUserCreate (scalar Self, hash Param)• retval SeleniumScenariosGet (scalar Self)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/UnitTest/Helper.pm

5.301 Kernel::System::HTMLUtils Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ToAscii (scalar Self, hash Param)• retval ToHTML (scalar Self, hash Param)• retval DocumentComplete (scalar Self, hash Param)• retval DocumentStrip (scalar Self, hash Param)• retval DocumentStyleCleanup (scalar Self, hash Param)• retval LinkQuote (scalar Self, hash Param)• retval Safety (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 183: doxygen of OTRS cvs Ref Man

5.302 LWP::Protocol::http Class Reference 179

• retval EmbeddedImagesExtract (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/HTMLUtils.pm

5.302 LWP::Protocol::http Class Reference

Inheritance diagram for LWP::Protocol::http:

LWP::Protocol::http

LWP::Protocol

LWP::MemberMixin

Classes

• class Socket

• class SocketMethods

Public Member Functions

Public Object Methods

• retval socket_class ()• retval request (scalar request, scalar proxy, scalar arg, scalar size, scalar time-

out)

Public Functions

• retval socket_type ()• retval hlist_remove (scalar hlist, scalar k)

Protected Object Methods

• protected retval _new_socket (scalar host, scalar port, scalar timeout)• protected retval _get_sock_info (scalar res, scalar sock)• protected retval _fixup_header (scalar h, scalar url, scalar proxy)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 184: doxygen of OTRS cvs Ref Man

180 Class Documentation

Protected Functions

• protected retval _extra_sock_opts ()• protected retval _check_sock ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/http.pm

5.303 HTTP::SOAP::Transport::HTTP Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Transport/HTTP.pm

5.304 URI::http Class Reference

Public Member Functions

Public Object Methods

• retval canonical ()

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/http.pm

5.305 Kernel::System::Auth::HTTPBasicAuth Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Auth/HTTPBasicAuth.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 185: doxygen of OTRS cvs Ref Man

5.306 Kernel::System::CustomerAuth::HTTPBasicAuth Class Reference 181

5.306 Kernel::System::CustomerAuth::HTTPBasicAuth Class Refer-ence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerAuth/HTTPBasicAuth.pm

5.307 URI::https Class Reference

Public Member Functions

Public Functions

• retval default_port ()• retval secure ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/https.pm

5.308 Kernel::System::MailAccount::IMAP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Connect (scalar Self, hash Param)• retval Fetch (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 186: doxygen of OTRS cvs Ref Man

182 Class Documentation

Protected Functions

• protected retval _Fetch (scalar Self, hash Param)• protected retval _ProcessFailed (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/MailAccount/IMAP.pm

5.309 Kernel::System::MailAccount::IMAPS Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Connect (scalar Self, hash Param)• retval Fetch (scalar Self, hash Param)

Protected Functions

• protected retval _Fetch (scalar Self, hash Param)• protected retval _ProcessFailed (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/MailAccount/IMAPS.pm

5.310 Kernel::System::MailAccount::IMAPTLS Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Connect (scalar Self, hash Param)• retval Fetch (scalar Self, hash Param)

Protected Functions

• protected retval _Fetch (scalar Self, hash Param)• protected retval _ProcessFailed (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/MailAccount/IMAPTLS.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 187: doxygen of OTRS cvs Ref Man

5.311 MIME::Body::InCore Class Reference 183

5.311 MIME::Body::InCore Class Reference

Inheritance diagram for MIME::Body::InCore:

MIME::Body::InCore

MIME::Body::Scalar

MIME::Body

Public Member Functions

Public Object Methods

• retval init (scalar data)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Body.pm

5.312 Kernel::System::DB::ingres Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval LoadPreferences (scalar Self, hash Param)• retval Quote (scalar Self, scalar Text)• retval DatabaseCreate (scalar Self, hash Param)• retval DatabaseDrop (scalar Self, hash Param)• retval TableCreate (scalar Self, list Param)• retval TableDrop (scalar Self, list Param)• retval TableAlter (scalar Self, list Param)• retval IndexCreate (scalar Self, hash Param)• retval IndexDrop (scalar Self, hash Param)• retval SequenceCreate (scalar Self, hash Param)• retval SequenceDrop (scalar Self, hash Param)• retval ForeignKeyCreate (scalar Self, hash Param)• retval ForeignKeyDrop (scalar Self, hash Param)• retval UniqueCreate (scalar Self, hash Param)• retval UniqueDrop (scalar Self, hash Param)• retval Insert (scalar Self, list Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 188: doxygen of OTRS cvs Ref Man

184 Class Documentation

Protected Functions

• protected retval _TypeTranslation (scalar Self, scalar Tag)

The documentation for this class was generated from the following file:

• Kernel/System/DB/ingres.pm

5.313 MIME::Parser::InnerFile Class Reference

Public Member Functions

Public Object Methods

• retval print ()

Public Functions

• retval PRINT ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Parser.pm

5.314 Class::Inspector Class Reference

Classes

• class Functions

Public Member Functions

Public Class Methods

• retval installed (scalar class)• retval loaded (scalar class)• retval filename (scalar class)• retval resolved_filename (scalar class)• retval loaded_filename (scalar class)• retval functions (scalar class)• retval function_refs (scalar class)• retval function_exists (scalar class)• retval methods (scalar class)• retval subclasses (scalar class)• retval children (scalar class)• retval recursive_children (scalar class)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 189: doxygen of OTRS cvs Ref Man

5.315 Modules::Installer Class Reference 185

Protected Class Methods

• protected retval _loaded (scalar class, scalar name)• protected retval _subnames (scalar class, scalar name)• protected retval _class (scalar class)• protected retval _inc_filename (scalar class)• protected retval _inc_to_local (scalar class)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Class/Inspector.pm

5.315 Modules::Installer Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval ReConfigure (scalar Self, hash Param)• retval ParseSQLFile (scalar Self, scalar File)• retval ConnectToDB (scalar Self, hash Param)• retval CheckDBRequirements (scalar Self, hash Param)• retval CheckMailConfiguration (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/Installer.pm

5.316 Kernel::System::Web::InterfaceAgent Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Web/InterfaceAgent.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 190: doxygen of OTRS cvs Ref Man

186 Class Documentation

5.317 Kernel::System::Web::InterfaceCustomer Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Web/InterfaceCustomer.pm

5.318 Kernel::System::Web::InterfaceInstaller Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Web/InterfaceInstaller.pm

5.319 Kernel::System::Web::InterfacePublic Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Web/InterfacePublic.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 191: doxygen of OTRS cvs Ref Man

5.320 Kernel::GenericInterface::Invoker Class Reference 187

5.320 Kernel::GenericInterface::Invoker Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval PrepareRequest (scalar Self, hash Param)• retval HandleResponse (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Invoker.pm

5.321 URI::IRI Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar uri, scalar scheme)

Public Object Methods

• retval clone ()• retval as_string ()

Public Functions

• retval AUTOLOAD ()• retval DESTROY ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/IRI.pm

5.322 urn::isbn Class Reference

Public Member Functions

Public Object Methods

• retval isbn ()• retval canonical ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 192: doxygen of OTRS cvs Ref Man

188 Class Documentation

Public Functions

• retval isbn_publisher_code ()• retval isbn_group_code ()• retval isbn_country_code ()• retval isbn13 ()• retval isbn_as_ean ()

Protected Object Methods

• protected retval _nss_isbn ()

Protected Functions

• protected retval _isbn (scalar nss)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/urn/isbn.pm

5.323 MIME::WordDecoder::ISO 8859 Class Reference

Inheritance diagram for MIME::WordDecoder::ISO_8859:

MIME::WordDecoder::ISO_8859

MIME::WordDecoder

MIME::WordDecoder::US_ASCII

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar num)

Public Object Methods

• retval guess_handler (scalar charset)• retval unknown ()• retval collapse ()• retval decode ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 193: doxygen of OTRS cvs Ref Man

5.324 XML::FeedPP::Item Class Reference 189

Public Functions

• retval h_keep7bit (scalar _)• retval h_utf8 (scalar _)• retval h_utf16 (scalar _)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/WordDecoder.pm

5.324 XML::FeedPP::Item Class Reference

Public Member Functions

Public Object Methods

• retval elements ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/XML/FeedPP.pm

5.325 Kernel::System::JSON Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Encode (scalar Self, hash Param)• retval Decode (scalar Self, hash Param)• retval True ()• retval False ()

The documentation for this class was generated from the following file:

• Kernel/System/JSON.pm

5.326 JSON Class Reference

Classes

• class Boolean

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 194: doxygen of OTRS cvs Ref Man

190 Class Documentation

Public Member Functions

Public Object Methods

• retval property (scalar name, scalar value)

Public Functions

• retval import (scalar pkg)• retval jsonToObj ()• retval objToJson ()• retval to_json (scalar_or_list)• retval from_json (scalar_or_list)• retval true ()• retval false ()• retval null ()• retval require_xs_version ()• retval backend (scalar proto)• retval is_xs ()• retval is_pp ()• retval pureperl_only_methods ()

Protected Functions

• protected retval _load_xs (scalar opt)• protected retval _load_pp (scalar opt)• protected retval _set_module (scalar module)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/JSON.pm

5.327 Kernel::Language Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Get (scalar Self, scalar What)• retval FormatTimeString (scalar Self, scalar String, scalar Config, scalar Short)

• retval GetRecommendedCharset (scalar Self)• retval GetPossibleCharsets (scalar Self)• retval Time (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Language.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 195: doxygen of OTRS cvs Ref Man

5.328 Output::HTML::Layout Class Reference 191

5.328 Output::HTML::Layout Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SetEnv (scalar Self, hash Param)• retval Block (scalar Self, hash Param)• retval Output (scalar Self, hash Param)• retval JSONEncode (scalar Self, hash Param)• retval Redirect (scalar Self, hash Param)• retval Login (scalar Self, hash Param)• retval ChallengeTokenCheck (scalar Self, hash Param)• retval FatalError (scalar Self, hash Param)• retval SecureMode (scalar Self, hash Param)• retval FatalDie (scalar Self, hash Param)• retval ErrorScreen (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Warning (scalar Self, hash Param)• retval Notify (scalar Self, hash Param)• retval Header (scalar Self, hash Param)• retval Footer (scalar Self, hash Param)• retval Print (scalar Self, hash Param)• retval PrintHeader (scalar Self, hash Param)• retval PrintFooter (scalar Self, hash Param)• retval Ascii2Html (scalar Self, hash Param)• retval LinkQuote (scalar Self, hash Param)• retval HTMLLinkQuote (scalar Self, hash Param)• retval LinkEncode (scalar Self, scalar Link)• retval CustomerAgeInHours (scalar Self, hash Param)• retval CustomerAge (scalar Self, hash Param)• retval BuildSelection (scalar Self, hash Param)• retval NoPermission (scalar Self, hash Param)• retval Permission (scalar Self, hash Param)• retval CheckCharset (scalar Self, hash Param)• retval CheckMimeType (scalar Self, hash Param)• retval ReturnValue (scalar Self, scalar What)• retval Attachment (scalar Self, hash Param)• retval PageNavBar (scalar Self, hash Param)• retval NavigationBar (scalar Self, hash Param)• retval TransformDateSelection (scalar Self, hash Param)• retval BuildDateSelection (scalar Self, hash Param)• retval CustomerLogin (scalar Self, hash Param)• retval CustomerHeader (scalar Self, hash Param)• retval CustomerFooter (scalar Self, hash Param)• retval CustomerFatalError (scalar Self, hash Param)• retval CustomerNavigationBar (scalar Self, hash Param)• retval CustomerError (scalar Self, hash Param)• retval CustomerWarning (scalar Self, hash Param)• retval CustomerNoPermission (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 196: doxygen of OTRS cvs Ref Man

192 Class Documentation

• retval Ascii2RichText (scalar Self, hash Param)• retval RichText2Ascii (scalar Self, hash Param)• retval RichTextDocumentComplete (scalar Self, hash Param)• retval RichTextDocumentSafetyCheck (scalar Self, hash Param)• retval RichTextDocumentServe (scalar Self, hash Param)• retval RichTextDocumentCleanup (scalar Self, hash Param)• retval TransfromDateSelection (scalar Self)

Protected Functions

• protected retval _RichTextReplaceLinkOfInlineContent (scalar Self, hash Param)

• protected retval _BlockTemplatePreferences (scalar Self, hash Param)• protected retval _BlockTemplatesReplace (scalar Self, hash Param)• protected retval _Output (scalar Self, hash Param)• protected retval _BuildSelectionOptionRefCreate (scalar Self, hash Param)• protected retval _BuildSelectionAttributeRefCreate (scalar Self, hash Param)

• protected retval _BuildSelectionDataRefCreate (scalar Self, hash Param)• protected retval _BuildSelectionOutput (scalar Self, hash Param)• protected retval _DisableBannerCheck (scalar Self, hash Param)• protected retval _RemoveScriptTags (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/Layout.pm

5.329 Output::HTML::LayoutAJAX Class Reference

Public Member Functions

Public Functions

• retval BuildSelectionJSON (scalar Self, scalar Array)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/LayoutAJAX.pm

5.330 Output::HTML::LayoutDatepicker Class Reference

Public Member Functions

Public Functions

• retval DatepickerGetVacationDays (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/LayoutDatepicker.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 197: doxygen of OTRS cvs Ref Man

5.331 Output::HTML::LayoutLoader Class Reference 193

5.331 Output::HTML::LayoutLoader Class Reference

Public Member Functions

Public Functions

• retval LoaderCreateAgentCSSCalls (scalar Self, hash Param)• retval LoaderCreateAgentJSCalls (scalar Self, hash Param)• retval LoaderCreateCustomerCSSCalls (scalar Self, hash Param)• retval LoaderCreateCustomerJSCalls (scalar Self, hash Param)• retval SkinValidate (scalar Self, hash Param)

Protected Functions

• protected retval _HandleCSSList (scalar Self, hash Param)• protected retval _HandleJSList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/LayoutLoader.pm

5.332 Output::HTML::LayoutPopup Class Reference

Public Member Functions

Public Functions

• retval PopupClose (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/LayoutPopup.pm

5.333 Output::HTML::LayoutTicket Class Reference

Public Member Functions

Public Functions

• retval AgentCustomerViewTable (scalar Self, hash Param)• retval AgentQueueListOption (scalar Self, hash Param)• retval ArticleQuote (scalar Self, hash Param)• retval TicketListShow (scalar Self, hash Param)• retval TicketMetaItemsCount (scalar Self, hash Param)• retval TicketMetaItems (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/LayoutTicket.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 198: doxygen of OTRS cvs Ref Man

194 Class Documentation

5.334 URI::ldap Class Reference

Public Member Functions

Public Functions

• retval default_port ()

Protected Object Methods

• protected retval _nonldap_canonical ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/ldap.pm

5.335 Kernel::System::Auth::LDAP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

Protected Functions

• protected retval _ConvertTo (scalar Self, scalar Text, scalar Charset)• protected retval _ConvertFrom (scalar Self, scalar Text, scalar Charset)

The documentation for this class was generated from the following file:

• Kernel/System/Auth/LDAP.pm

5.336 Kernel::System::Auth::Sync::LDAP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 199: doxygen of OTRS cvs Ref Man

5.337 Kernel::System::CustomerAuth::LDAP Class Reference 195

Public Functions

• retval Sync (scalar Self, hash Param)

Protected Functions

• protected retval _ConvertTo (scalar Self, scalar Text, scalar Charset)• protected retval _ConvertFrom (scalar Self, scalar Text, scalar Charset)

The documentation for this class was generated from the following file:

• Kernel/System/Auth/Sync/LDAP.pm

5.337 Kernel::System::CustomerAuth::LDAP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

Protected Functions

• protected retval _ConvertTo (scalar Self, scalar Text, scalar Charset)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerAuth/LDAP.pm

5.338 Kernel::System::CustomerUser::LDAP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval CustomerName (scalar Self, hash Param)• retval CustomerSearch (scalar Self, hash Param)• retval CustomerUserList (scalar Self, hash Param)• retval CustomerIDs (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 200: doxygen of OTRS cvs Ref Man

196 Class Documentation

• retval CustomerUserDataGet (scalar Self, hash Param)• retval CustomerUserAdd (scalar Self, hash Param)• retval CustomerUserUpdate (scalar Self, hash Param)• retval SetPassword (scalar Self, hash Param)• retval GenerateRandomPassword (scalar Self, hash Param)• retval SetPreferences (scalar Self, hash Param)• retval GetPreferences (scalar Self, hash Param)• retval SearchPreferences (scalar Self, hash Param)• retval DESTROY (scalar Self, hash Param)

Protected Functions

• protected retval _Connect (scalar Self, hash Param)• protected retval _ConvertFrom (scalar Self, scalar Text)• protected retval _ConvertTo (scalar Self, scalar Text)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerUser/LDAP.pm

5.339 URI::ldapi Class Reference

Public Member Functions

Public Object Methods

• retval un_path (scalar p)

Protected Object Methods

• protected retval _nonldap_canonical ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/ldapi.pm

5.340 URI::ldaps Class Reference

Public Member Functions

Public Functions

• retval default_port ()• retval secure ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/ldaps.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 201: doxygen of OTRS cvs Ref Man

5.341 IO::Lines Class Reference 197

5.341 IO::Lines Class Reference

Inheritance diagram for IO::Lines:

IO::Lines

IO::ScalarArray

Public Member Functions

Public Object Methods

• retval getline ()• retval getlines ()

Public Functions

• retval print ()

Protected Object Methods

• protected retval _getlines_for_newlines ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/IO/Lines.pm

5.342 Kernel::System::LinkObject Class Reference

Classes

• class Dummy

• class Ticket

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 202: doxygen of OTRS cvs Ref Man

198 Class Documentation

Public Functions

• retval PossibleTypesList (scalar Self, hash Param)• retval PossibleObjectsList (scalar Self, hash Param)• retval PossibleLinkList (scalar Self, hash Param)• retval LinkAdd (scalar Self, hash Param)• retval LinkCleanup (scalar Self, hash Param)• retval LinkDelete (scalar Self, hash Param)• retval LinkDeleteAll (scalar Self, hash Param)• retval LinkList (scalar Self, hash Param)• retval LinkListWithData (scalar Self, hash Param)• retval LinkKeyList (scalar Self, hash Param)• retval LinkKeyListWithData (scalar Self, hash Param)• retval ObjectLookup (scalar Self, hash Param)• retval TypeLookup (scalar Self, hash Param)• retval TypeGet (scalar Self, hash Param)• retval TypeList (scalar Self, hash Param)• retval TypeGroupList (scalar Self, hash Param)• retval PossibleType (scalar Self, hash Param)• retval StateLookup (scalar Self, hash Param)• retval StateList (scalar Self, hash Param)• retval ObjectDescriptionGet (scalar Self, hash Param)• retval ObjectSearch (scalar Self, hash Param)

Protected Functions

• protected retval _LoadBackend (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/LinkObject.pm

5.343 Output::HTML::LinkObjectTicket Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval TableCreateComplex (scalar Self, hash Param)• retval TableCreateSimple (scalar Self, hash Param)• retval ContentStringCreate (scalar Self, hash Param)• retval SelectableObjectList (scalar Self, hash Param)• retval SearchOptionList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/LinkObjectTicket.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 203: doxygen of OTRS cvs Ref Man

5.344 HTTP::SOAP::Lite Class Reference 199

5.344 HTTP::SOAP::Lite Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite.pm

5.345 XML::Parser::Lite Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval setHandlers ()

Public Functions

• retval parse ()• retval comment ()• retval end ()

Protected Functions

• protected retval _regexp ()• protected retval _parse_re ()• protected retval _init ()• protected retval _final ()• protected retval _start ()• protected retval _char ()• protected retval _end ()• protected retval _doctype ()• protected retval _xmldecl ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/XML/Parser/Lite.pm

5.346 Kernel::System::Loader Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 204: doxygen of OTRS cvs Ref Man

200 Class Documentation

Public Functions

• retval MinifyFiles (scalar Self, hash Param)• retval GetMinifiedFile (scalar Self, hash Param)• retval MinifyCSS (scalar Self, hash Param)• retval MinifyJavaScript (scalar Self, hash Param)• retval CacheDelete (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Loader.pm

5.347 YAML::Loader Class Reference

Classes

• class Base

Public Member Functions

Public Object Methods

• retval load ()

Protected Object Methods

• protected retval _parse ()• protected retval _parse_node ()• protected retval _parse_inline ()• protected retval _parse_inline_double_quoted ()• protected retval _parse_inline_single_quoted ()• protected retval _parse_inline_simple ()• protected retval _parse_throwaway_comments ()

Protected Functions

• protected retval _parse_qualifiers (scalar preface)• protected retval _parse_explicit (scalar node, scalar explicit)• protected retval _parse_mapping (scalar anchor)• protected retval _parse_seq (scalar anchor)• protected retval _parse_inline_mapping (scalar anchor)• protected retval _parse_inline_seq (scalar anchor)• protected retval _parse_implicit (scalar value)• protected retval _parse_unfold (scalar chomp)• protected retval _parse_block (scalar chomp)• protected retval _parse_next_line (scalar type)• protected retval _unescape (scalar node)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Loader.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 205: doxygen of OTRS cvs Ref Man

5.348 Encode::Locale Class Reference 201

5.348 Encode::Locale Class Reference

Public Member Functions

Public Functions

• retval DEBUG ()• retval reinit ()• retval decode_argv ()• retval env ()

Protected Functions

• protected retval _init ()• protected retval _flush_aliases ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Encode/Locale.pm

5.349 Kernel::System::Lock Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval LockViewableLock (scalar Self, hash Param)• retval LockLookup (scalar Self, hash Param)• retval LockList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Lock.pm

5.350 Kernel::System::Log Class Reference

Classes

• class File

• class SysLog

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 206: doxygen of OTRS cvs Ref Man

202 Class Documentation

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Log (scalar Self, hash Param)• retval GetLogEntry (scalar Self, hash Param)• retval GetLog (scalar Self, hash Param)• retval CleanUp (scalar Self, hash Param)• retval Dumper (scalar Self, list Data)

The documentation for this class was generated from the following file:

• Kernel/System/Log.pm

5.351 Authen::SASL::Perl::LOGIN Class Reference

Public Member Functions

Public Object Methods

• retval client_start ()• retval client_step (scalar string)• retval server_start (scalar response)• retval server_step (scalar response)

Public Functions

• retval mechanism ()

Protected Functions

• protected retval _order ()• protected retval _secflags ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/Perl/LOGIN.pm

5.352 LWP::Protocol::loopback Class Reference

Inheritance diagram for LWP::Protocol::loopback:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 207: doxygen of OTRS cvs Ref Man

5.353 Kernel::System::PostMaster::LoopProtection Class Reference 203

LWP::Protocol::loopback

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size, scalar time-out)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/loopback.pm

5.353 Kernel::System::PostMaster::LoopProtection Class Reference

Classes

• class DB

• class FS

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SendEmail (scalar Self, hash Param)• retval Check (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/LoopProtection.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 208: doxygen of OTRS cvs Ref Man

204 Class Documentation

5.354 file::Mac Class Reference

Public Member Functions

Public Class Methods

• retval file (scalar class, scalar uri)• retval dir (scalar class)

Protected Class Methods

• protected retval _file_extract_path (scalar class, scalar path)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/file/Mac.pm

5.355 Kernel::System::MailAccount Class Reference

Classes

• class IMAP• class IMAPS• class IMAPTLS• class POP3• class POP3S

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval MailAccountAdd (scalar Self, hash Param)• retval MailAccountGet (scalar Self, hash Param)• retval MailAccountUpdate (scalar Self, hash Param)• retval MailAccountDelete (scalar Self, hash Param)• retval MailAccountList (scalar Self, hash Param)• retval MailAccountBackendList (scalar Self, hash Param)• retval MailAccountFetch (scalar Self, hash Param)• retval MailAccountCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/MailAccount.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 209: doxygen of OTRS cvs Ref Man

5.356 Mail::Mailer Class Reference 205

5.356 Mail::Mailer Class Reference

Inheritance diagram for Mail::Mailer:

Mail::Mailer

Mail::Mailer::rfc822

Mail::Mailer::qmail Mail::Mailer::sendmail Mail::Mailer::smtp Mail::Mailer::smtps Mail::Mailer::testfile

Classes

• class qmail

• class rfc822

• class sendmail

• class smtp

• class smtp

• class smtps

• class smtps

• class testfile

• class testfile

Public Member Functions

Public Class Methods

• retval new ()

Public Functions

• retval is_exe ()• retval Version ()• retval import (scalar type)• retval to_array ()• retval is_exe ()• retval open ()• retval exec ()• retval can_cc ()• retval who_to ()• retval who_sender ()• retval epilogue ()• retval close ()• retval DESTROY ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 210: doxygen of OTRS cvs Ref Man

206 Class Documentation

Protected Functions

• protected retval _cleanup_hdrs ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer.pm

5.357 LWP::Protocol::mailto Class Reference

Inheritance diagram for LWP::Protocol::mailto:

LWP::Protocol::mailto

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/mailto.pm

5.358 URI::mailto Class Reference

Public Member Functions

Public Object Methods

• retval to ()• retval headers ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/mailto.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 211: doxygen of OTRS cvs Ref Man

5.360 Manages Class Reference 207

5.359 Kernel::System::Main Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Require (scalar Self, scalar Module)• retval Die (scalar Self, scalar Message)• retval FilenameCleanUp (scalar Self, hash Param)• retval FileRead (scalar Self, hash Param)• retval FileWrite (scalar Self, hash Param)• retval FileDelete (scalar Self, hash Param)• retval FileGetMTime (scalar Self, hash Param)• retval MD5sum (scalar Self, hash Param)• retval Dump (scalar Self, scalar Data, scalar Type)• retval DirectoryRead (scalar Self, hash Param)

Protected Functions

• protected retval _Dump (scalar Self, scalar Data)

The documentation for this class was generated from the following file:

• Kernel/System/Main.pm

5.360 Manages Class Reference

5.360.1 Detailed Description

Defines the CKEDITOR.focusManager class, which is used to handle the focus on editorinstances.. Creates a focusManager class instance. activity in an editor instance. Thisclass is to be used mainly by UI elements coders when adding interface elements thatneed to set the focus state of the editor.

Parameters{CKEDI-

TOR.editor}editor The editor instance.

The documentation for this class was generated from the following file:

• var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/focusmanager.js

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 212: doxygen of OTRS cvs Ref Man

208 Class Documentation

5.361 Kernel::GenericInterface::Mapping Class Reference

Classes

• class Simple

• class Test

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Map (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Mapping.pm

5.362 YAML::Marshall Class Reference

Public Member Functions

Public Class Methods

• retval import (scalar class)• retval yaml_load (scalar class, scalar node)

Public Object Methods

• retval yaml_dump ()

Public Functions

• retval yaml_node ()• retval yaml_ynode ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Marshall.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 213: doxygen of OTRS cvs Ref Man

5.363 IO::WrapTie::Master Class Reference 209

5.363 IO::WrapTie::Master Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar master, scalar slave)• retval PRELOAD (scalar class)

Public Object Methods

• retval AUTOLOAD ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/IO/WrapTie.pm

5.364 Kernel::System::PostMaster::Filter::Match Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/Filter/Match.pm

5.365 Kernel::System::PostMaster::Filter::MatchDBSource Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/Filter/MatchDBSource.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 214: doxygen of OTRS cvs Ref Man

210 Class Documentation

5.366 LWP::MemberMixin Class Reference

Inheritance diagram for LWP::MemberMixin:

LWP::MemberMixin

LWP::Protocol LWP::UserAgent

Kernel::GenericInterface::Transport::HTTP::Test::CustomHTTPProtocol

LWP::Protocol::cpan

LWP::Protocol::data

LWP::Protocol::file

LWP::Protocol::ftp

LWP::Protocol::gopher

LWP::Protocol::http

LWP::Protocol::loopback

LWP::Protocol::mailto

LWP::Protocol::nntp

LWP::Protocol::nogo

LWP::RobotUA

Public Member Functions

Protected Object Methods

• protected retval _elem (scalar elem)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/MemberMixin.pm

5.367 HTTP::Message Class Reference

Inheritance diagram for HTTP::Message:

HTTP::Message

HTTP::Request

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar header, scalar content)• retval parse (scalar class, scalar str)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 215: doxygen of OTRS cvs Ref Man

5.368 HTTP::SOAP::Lite::Packager::MIME Class Reference 211

Public Object Methods

• retval clone ()• retval clear ()• retval protocol ()• retval headers ()• retval content ()• retval add_content ()• retval add_content_utf8 (scalar buf)• retval content_ref ()• retval content_charset ()• retval decoded_content (hash opt)• retval decodable ()• retval decode ()• retval encode (list enc)• retval as_string (scalar eol)• retval dump (hash opt)• retval parts ()• retval add_part ()

Public Functions

• retval headers_as_string ()• retval AUTOLOAD ()• retval DESTROY ()

Protected Object Methods

• protected retval _set_content ()• protected retval _stale_content ()• protected retval _elem (scalar elem)• protected retval _parts ()• protected retval _content ()

Protected Functions

• protected retval _boundary ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/HTTP/Message.pm

5.368 HTTP::SOAP::Lite::Packager::MIME Class Reference

Inheritance diagram for HTTP::SOAP::Lite::Packager::MIME:

HTTP::SOAP::Lite::Packager::MIME

HTTP::SOAP::Lite::Packager

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 216: doxygen of OTRS cvs Ref Man

212 Class Documentation

Public Member Functions

Public Class Methods

• retval new (scalar classname)

Public Object Methods

• retval initialize_parser ()• retval generate_random_string (scalar len)• retval process_form_data (scalar entity)

Public Functions

• retval BEGIN ()• retval get_multipart_id ((scalar id))• retval package (scalar envelope, scalar context)• retval unpackage (scalar raw_input, scalar context)• retval process_related (scalar entity)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite/Packager.pm

5.369 HTTP::SOAP::Packager::MIME Class Reference

Inheritance diagram for HTTP::SOAP::Packager::MIME:

HTTP::SOAP::Packager::MIME

HTTP::SOAP::Packager

Public Member Functions

Public Class Methods

• retval new (scalar classname)

Public Object Methods

• retval initialize_parser ()• retval generate_random_string (scalar len)• retval process_form_data (scalar entity)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 217: doxygen of OTRS cvs Ref Man

5.370 CSS::Minifier Class Reference 213

Public Functions

• retval BEGIN ()• retval get_multipart_id ((scalar id))• retval package (scalar envelope, scalar context)• retval unpackage (scalar raw_input, scalar context)• retval process_related (scalar entity)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Packager.pm

5.370 CSS::Minifier Class Reference

Public Member Functions

Public Functions

• retval isSpace (scalar x)• retval isEndspace (scalar x)• retval isWhitespace (scalar x)• retval isInfix (scalar x)• retval isPrefix (scalar x)• retval isPostfix (scalar x)• retval action1 (scalar s)• retval action2 (scalar s)• retval putLiteral (scalar s)• retval collapseWhitespace (scalar s)• retval skipWhitespace (scalar s)• retval preserveWhitespace (scalar s)• retval minify ()

Protected Functions

• protected retval _get (scalar s)• protected retval _put (scalar s, scalar x)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CSS/Minifier.pm

5.371 JavaScript::Minifier Class Reference

Public Member Functions

Public Functions

• retval isAlphanum (scalar x)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 218: doxygen of OTRS cvs Ref Man

214 Class Documentation

• retval isSpace (scalar x)• retval isEndspace (scalar x)• retval isWhitespace (scalar x)• retval isInfix (scalar x)• retval isPrefix (scalar x)• retval isPostfix (scalar x)• retval action1 (scalar s)• retval action2 (scalar s)• retval action3 (scalar s)• retval action4 (scalar s)• retval putLiteral (scalar s)• retval collapseWhitespace (scalar s)• retval skipWhitespace (scalar s)• retval preserveEndspace (scalar s)• retval onWhitespaceConditionalComment (scalar s)• retval minify ()

Protected Functions

• protected retval _get (scalar s)• protected retval _put (scalar s, scalar x)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/JavaScript/Minifier.pm

5.372 URI::mms Class Reference

Public Member Functions

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/mms.pm

5.373 YAML::Mo Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Mo.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 219: doxygen of OTRS cvs Ref Man

5.374 Kernel::System::DB::mssql Class Reference 215

5.374 Kernel::System::DB::mssql Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval LoadPreferences (scalar Self, hash Param)• retval Quote (scalar Self, scalar Text, scalar Type)• retval DatabaseCreate (scalar Self, hash Param)• retval DatabaseDrop (scalar Self, hash Param)• retval TableCreate (scalar Self, list Param)• retval TableDrop (scalar Self, list Param)• retval TableAlter (scalar Self, list Param)• retval IndexCreate (scalar Self, hash Param)• retval IndexDrop (scalar Self, hash Param)• retval ForeignKeyCreate (scalar Self, hash Param)• retval ForeignKeyDrop (scalar Self, hash Param)• retval UniqueCreate (scalar Self, hash Param)• retval UniqueDrop (scalar Self, hash Param)• retval Insert (scalar Self, list Param)

Protected Functions

• protected retval _TypeTranslation (scalar Self, scalar Tag)

The documentation for this class was generated from the following file:

• Kernel/System/DB/mssql.pm

5.375 MultipartBuffer Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar package, scalar interface, scalar boundary, scalar length)

Public Object Methods

• retval readHeader ()• retval readBody ()• retval read (scalar bytes)• retval fillBuffer (scalar bytes)• retval eof ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 220: doxygen of OTRS cvs Ref Man

216 Class Documentation

Public Functions

• retval DESTROY ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI.pm

5.376 Kernel::System::DynamicField::Backend::Multiselect Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ValueGet (scalar Self, hash Param)• retval ValueSet (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval SearchSQLGet (scalar Self, hash Param)• retval SearchSQLOrderFieldGet (scalar Self, hash Param)• retval EditFieldRender (scalar Self, hash Param)• retval EditFieldValueGet (scalar Self, hash Param)• retval EditFieldValueValidate (scalar Self, hash Param)• retval DisplayValueRender (scalar Self, hash Param)• retval IsSortable (scalar Self, hash Param)• retval SearchFieldRender (scalar Self, hash Param)• retval SearchFieldValueGet (scalar Self, hash Param)• retval SearchFieldParameterBuild (scalar Self, hash Param)• retval StatsFieldParameterBuild (scalar Self, hash Param)• retval CommonSearchFieldParameterBuild (scalar Self, hash Param)• retval ReadableValueRender (scalar Self, hash Param)• retval TemplateValueTypeGet (scalar Self, hash Param)• retval IsAJAXUpdateable (scalar Self, hash Param)• retval RandomValueSet (scalar Self, hash Param)• retval IsMatchable (scalar Self, hash Param)• retval ObjectMatch (scalar Self, hash Param)• retval AJAXPossibleValuesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend/Multiselect.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 221: doxygen of OTRS cvs Ref Man

5.377 Kernel::System::DB::mysql Class Reference 217

5.377 Kernel::System::DB::mysql Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval LoadPreferences (scalar Self, hash Param)• retval Quote (scalar Self, scalar Text, scalar Type)• retval DatabaseCreate (scalar Self, hash Param)• retval DatabaseDrop (scalar Self, hash Param)• retval TableCreate (scalar Self, list Param)• retval TableDrop (scalar Self, list Param)• retval TableAlter (scalar Self, list Param)• retval IndexCreate (scalar Self, hash Param)• retval IndexDrop (scalar Self, hash Param)• retval ForeignKeyCreate (scalar Self, hash Param)• retval ForeignKeyDrop (scalar Self, hash Param)• retval UniqueCreate (scalar Self, hash Param)• retval UniqueDrop (scalar Self, hash Param)• retval Insert (scalar Self, list Param)

Protected Functions

• protected retval _TypeTranslation (scalar Self, scalar Tag)

The documentation for this class was generated from the following file:

• Kernel/System/DB/mysql.pm

5.378 Kernel::System::Ticket::Event::NagiosAcknowledge Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 222: doxygen of OTRS cvs Ref Man

218 Class Documentation

Protected Functions

• protected retval _Pipe (scalar Self, hash Param)• protected retval _HTTP (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/NagiosAcknowledge.pm

5.379 Output::HTML::NavBarCustomerCompany Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NavBarCustomerCompany.pm

5.380 Output::HTML::NavBarModuleAdmin Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NavBarModuleAdmin.pm

5.381 MIME::Decoder::NBit Class Reference

Inheritance diagram for MIME::Decoder::NBit:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 223: doxygen of OTRS cvs Ref Man

5.382 URI::news Class Reference 219

MIME::Decoder::NBit

MIME::Decoder

Public Member Functions

Public Object Methods

• retval decode_it (scalar in, scalar out)• retval encode_it (scalar in, scalar out)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Decoder/NBit.pm

5.382 URI::news Class Reference

Public Member Functions

Public Object Methods

• retval group ()• retval message ()

Public Functions

• retval default_port ()

Protected Functions

• protected retval _group (scalar group, scalar from, scalar to)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/news.pm

5.383 Kernel::System::PostMaster::NewTicket Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 224: doxygen of OTRS cvs Ref Man

220 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/NewTicket.pm

5.384 Kernel::System::PostMaster::Filter::NewTicketReject Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/Filter/NewTicketReject.pm

5.385 LWP::Protocol::nntp Class Reference

Inheritance diagram for LWP::Protocol::nntp:

LWP::Protocol::nntp

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size, scalar time-out)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/nntp.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 225: doxygen of OTRS cvs Ref Man

5.386 URI::nntp Class Reference 221

5.386 URI::nntp Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/nntp.pm

5.387 LWP::Protocol::nogo Class Reference

Inheritance diagram for LWP::Protocol::nogo:

LWP::Protocol::nogo

LWP::Protocol

LWP::MemberMixin

Public Member Functions

Public Object Methods

• retval request (scalar request)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/nogo.pm

5.388 Kernel::System::Notification Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval NotificationGet (scalar Self, hash Param)• retval NotificationList (scalar Self, hash Param)• retval NotificationUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Notification.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 226: doxygen of OTRS cvs Ref Man

222 Class Documentation

5.389 Output::HTML::NotificationAgentOnline Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NotificationAgentOnline.pm

5.390 Output::HTML::NotificationAgentTicketEscalation Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NotificationAgentTicketEscalation.pm

5.391 Output::HTML::NotificationCustomerOnline Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NotificationCustomerOnline.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 227: doxygen of OTRS cvs Ref Man

5.392 Kernel::System::NotificationEvent Class Reference 223

5.392 Kernel::System::NotificationEvent Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval NotificationList (scalar Self, hash Param)• retval NotificationGet (scalar Self, hash Param)• retval NotificationAdd (scalar Self, hash Param)• retval NotificationUpdate (scalar Self, hash Param)• retval NotificationDelete (scalar Self, hash Param)• retval NotificationEventCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/NotificationEvent.pm

5.393 Kernel::System::Ticket::Event::NotificationEvent Class Refer-ence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _SendNotificationToRecipients (scalar Self, hash Param)• protected retval _SendNotification (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/NotificationEvent.pm

5.394 Output::HTML::NotificationGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 228: doxygen of OTRS cvs Ref Man

224 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NotificationGeneric.pm

5.395 Output::HTML::NotificationOutofOfficeCheck Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NotificationOutofOfficeCheck.pm

5.396 Output::HTML::NotificationSchedulerCheck Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NotificationSchedulerCheck.pm

5.397 Output::HTML::NotificationUIDCheck Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 229: doxygen of OTRS cvs Ref Man

5.398 Kernel::System::GenericAgent::NotifyAgentGroupOfCustomQueue ClassReference 225

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/NotificationUIDCheck.pm

5.398 Kernel::System::GenericAgent::NotifyAgentGroupOfCustomQueueClass Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericAgent/NotifyAgentGroupOfCustomQueue.pm

5.399 Kernel::System::GenericAgent::NotifyAgentGroupWithWritePermissionClass Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericAgent/NotifyAgentGroupWithWritePermission.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 230: doxygen of OTRS cvs Ref Man

226 Class Documentation

5.400 Kernel::System::GenericInterface::ObjectLockState Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar ObjectLockState, hash Param)

Public Functions

• retval ObjectLockStateSet (scalar Self, hash Param)• retval ObjectLockStateGet (scalar Self, hash Param)• retval ObjectLockStateDelete (scalar Self, hash Param)• retval ObjectLockStatePurge (scalar Self, hash Param)• retval ObjectLockStateList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericInterface/ObjectLockState.pm

5.401 urn::oid Class Reference

Public Member Functions

Public Object Methods

• retval oid ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/urn/oid.pm

5.402 Kernel::GenericInterface::Operation Class Reference

Classes

• class Common

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 231: doxygen of OTRS cvs Ref Man

5.403 Kernel::System::DB::oracle Class Reference 227

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation.pm

5.403 Kernel::System::DB::oracle Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval LoadPreferences (scalar Self, hash Param)• retval Quote (scalar Self, scalar Text, scalar Type)• retval DatabaseCreate (scalar Self, hash Param)• retval DatabaseDrop (scalar Self, hash Param)• retval TableCreate (scalar Self, list Param)• retval TableDrop (scalar Self, list Param)• retval TableAlter (scalar Self, list Param)• retval IndexCreate (scalar Self, hash Param)• retval IndexDrop (scalar Self, hash Param)• retval ForeignKeyCreate (scalar Self, hash Param)• retval ForeignKeyDrop (scalar Self, hash Param)• retval UniqueCreate (scalar Self, hash Param)• retval UniqueDrop (scalar Self, hash Param)• retval Insert (scalar Self, list Param)

Protected Functions

• protected retval _TypeTranslation (scalar Self, scalar Tag)

The documentation for this class was generated from the following file:

• Kernel/System/DB/oracle.pm

5.404 file::OS2 Class Reference

Public Member Functions

Public Functions

• retval file ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 232: doxygen of OTRS cvs Ref Man

228 Class Documentation

Protected Class Methods

• protected retval _file_extract_authority (scalar class)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/file/OS2.pm

5.405 Output::HTML::OutputFilterTextAutoLink Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Pre (scalar Self, hash Param)• retval Post (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/OutputFilterTextAutoLink.pm

5.406 Output::HTML::OutputFilterTextURL Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Pre (scalar Self, hash Param)• retval Post (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/OutputFilterTextURL.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 233: doxygen of OTRS cvs Ref Man

5.407 Kernel::System::Ticket::Permission::OwnerCheck Class Reference 229

5.407 Kernel::System::Ticket::Permission::OwnerCheck Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Permission/OwnerCheck.pm

5.408 Kernel::System::Package Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval RepositoryList (scalar Self, hash Param)• retval RepositoryGet (scalar Self, hash Param)• retval RepositoryAdd (scalar Self, hash Param)• retval RepositoryRemove (scalar Self, hash Param)• retval PackageInstall (scalar Self, hash Param)• retval PackageReinstall (scalar Self, hash Param)• retval PackageUpgrade (scalar Self, hash Param)• retval PackageUninstall (scalar Self, hash Param)• retval PackageOnlineRepositories (scalar Self, hash Param)• retval PackageOnlineList (scalar Self, hash Param)• retval PackageOnlineGet (scalar Self, hash Param)• retval DeployCheck (scalar Self, hash Param)• retval DeployCheckInfo (scalar Self, hash Param)• retval PackageVerify (scalar Self, hash Param)• retval PackageVerifyInfo (scalar Self, hash Param)• retval PackageBuild (scalar Self, hash Param)• retval PackageParse (scalar Self, hash Param)• retval PackageExport (scalar Self, hash Param)• retval PackageIsInstalled (scalar Self, hash Param)• retval PackageInstallDefaultFiles (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 234: doxygen of OTRS cvs Ref Man

230 Class Documentation

Protected Functions

• protected retval _Download (scalar Self, hash Param)• protected retval _Database (scalar Self, hash Param)• protected retval _Code (scalar Self, hash Param)• protected retval _OSCheck (scalar Self, hash Param)• protected retval _CheckFramework (scalar Self, hash Param)• protected retval _CheckVersion (scalar Self, hash Param)• protected retval _CheckPackageRequired (scalar Self, hash Param)• protected retval _CheckModuleRequired (scalar Self, hash Param)• protected retval _CheckPackageDepends (scalar Self, hash Param)• protected retval _PackageFileCheck (scalar Self, hash Param)• protected retval _FileInstall (scalar Self, hash Param)• protected retval _FileRemove (scalar Self, hash Param)• protected retval _ReadDistArchive (scalar Self, hash Param)• protected retval _FileSystemCheck (scalar Self, hash Param)• protected retval _Encode (scalar Self, scalar Text)

The documentation for this class was generated from the following file:

• Kernel/System/Package.pm

5.409 HTTP::SOAP::Lite::Packager Class Reference

Inheritance diagram for HTTP::SOAP::Lite::Packager:

HTTP::SOAP::Lite::Packager

HTTP::SOAP::Lite::Packager::MIME

Public Member Functions

Public Class Methods

• retval new (hash params)

Public Object Methods

• retval is_supported_part ()• retval parts ()• retval unpackage ()

Public Functions

• retval BEGIN ()• retval find_packager ()• retval push_part (scalar part)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 235: doxygen of OTRS cvs Ref Man

5.410 HTTP::SOAP::Packager Class Reference 231

• retval package ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite/Packager.pm

5.410 HTTP::SOAP::Packager Class Reference

Inheritance diagram for HTTP::SOAP::Packager:

HTTP::SOAP::Packager

HTTP::SOAP::Packager::MIME

Public Member Functions

Public Class Methods

• retval new (hash params)

Public Object Methods

• retval is_supported_part ()• retval parts ()• retval unpackage ()

Public Functions

• retval BEGIN ()• retval find_packager ()• retval push_part (scalar part)• retval package ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Packager.pm

5.411 MIME::Field::ParamVal Class Reference

Inheritance diagram for MIME::Field::ParamVal:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 236: doxygen of OTRS cvs Ref Man

232 Class Documentation

MIME::Field::ParamVal

Mail::Field

MIME::Field::ContDisp MIME::Field::ConTraEnc MIME::Field::ContType

Public Member Functions

Public Object Methods

• retval set ()• retval parse_params (scalar raw)• retval parse (scalar string)• retval param (scalar paramname, scalar value)• retval paramstr ()• retval stringify ()

Public Functions

• retval rfc2231decode (scalar val)• retval rfc2231percent (scalar str)• retval tag ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Field/ParamVal.pm

5.412 parent Class Reference

Public Member Functions

Public Class Methods

• retval import (scalar class)

Public Functions

• retval exclaim ()• retval exclaim ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/parent.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 237: doxygen of OTRS cvs Ref Man

5.413 MIME::Parser Class Reference 233

5.413 MIME::Parser Class Reference

Classes

• class FileInto• class Filer• class FileUnder• class InnerFile• class Reader• class Results

Public Member Functions

Public Class Methods

• retval new ()

Public Object Methods

• retval init ()• retval init_parse ()• retval decode_headers (scalar yesno)• retval extract_nested_messages (scalar option)• retval parse_nested_messages ()• retval extract_uuencode (scalar yesno)• retval ignore_errors (scalar yesno)• retval decode_bodies (scalar yesno)• retval debug ()• retval whine ()• retval error ()• retval process_preamble (scalar in, scalar rdr, scalar ent)• retval process_epilogue (scalar in, scalar rdr, scalar ent)• retval process_to_bound (scalar in, scalar rdr, scalar out)• retval process_header (scalar in, scalar rdr)• retval process_multipart (scalar in, scalar rdr, scalar ent)• retval process_singlepart (scalar in, scalar rdr, scalar ent)• retval hunt_for_uuencode (scalar ENCODED, scalar ent)• retval process_message (scalar in, scalar rdr, scalar ent)• retval process_part (scalar in, scalar rdr, hash p)• retval parse_data (scalar data)• retval parse (scalar in)• retval read ()• retval parse_FH ()• retval parse_open (scalar expr)• retval parse_in ()• retval parse_two (scalar headfile, scalar bodyfile)• retval filer (scalar filer)• retval output_dir (list init)• retval output_under (list init)• retval output_path ()• retval output_prefix ()• retval evil_filename ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 238: doxygen of OTRS cvs Ref Man

234 Class Documentation

• retval max_parts (scalar num)• retval output_to_core (scalar yesno)• retval tmp_to_core (scalar yesno)• retval use_inner_files (scalar yesno)• retval init ()• retval interface (scalar role, scalar value)• retval new_body_for (scalar head)• retval tmp_dir (scalar dirname)• retval new_tmpfile ()

Public Functions

• retval tmp_recycling ()• retval last_error ()• retval last_head ()• retval results ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Parser.pm

5.414 Crypt::PasswdMD5 Class Reference

Public Member Functions

Public Functions

• retval to64 (scalar v, scalar n)• retval apache_md5_crypt ()• retval unix_md5_crypt (scalar pw, scalar salt)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Crypt/PasswdMD5.pm

5.415 Date::Pcalc Class Reference

Public Member Functions

Public Functions

• retval DATECALC_ERROR (scalar name, scalar err)• retval DATECALC_DATE_ERROR (scalar name)• retval DATECALC_TIME_ERROR (scalar name)• retval DATECALC_YEAR_ERROR (scalar name)• retval DATECALC_MONTH_ERROR (scalar name)• retval DATECALC_WEEK_ERROR (scalar name)• retval DATECALC_DAYOFWEEK_ERROR (scalar name)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 239: doxygen of OTRS cvs Ref Man

5.415 Date::Pcalc Class Reference 235

• retval DATECALC_FACTOR_ERROR (scalar name)• retval DATECALC_LANGUAGE_ERROR (scalar name)• retval DATECALC_SYSTEM_ERROR (scalar name)• retval DATECALC_MEMORY_ERROR (scalar name)• retval Year_to_Days (scalar year)• retval leap_year (scalar year)• retval Days_in_Year (scalar year, scalar month)• retval Days_in_Month (scalar year, scalar month)• retval Weeks_in_Year (scalar year)• retval check_date (scalar year, scalar month, scalar day)• retval check_date_leap (scalar year, scalar month, scalar day)• retval check_business_date (scalar year, scalar week, scalar dow)• retval Day_of_Year (scalar year, scalar month, scalar day)• retval Date_to_Days (scalar year, scalar month, scalar day)• retval Day_of_Week (scalar year, scalar month, scalar day)• retval Week_Number (scalar year, scalar month, scalar day)• retval Week_of_Year (scalar year, scalar month, scalar day)• retval core_Week_of_Year (scalar year, scalar month, scalar day)• retval Monday_of_Week (scalar week, scalar year)• retval Nth_Weekday_of_Month_Year (scalar year, scalar month, scalar dow,

scalar n)• retval Standard_to_Business (scalar year, scalar month, scalar day)• retval Business_to_Standard (scalar year, scalar week, scalar dow)• retval Delta_Days (scalar year1, scalar month1, scalar day1, scalar year2,

scalar month2, scalar day2)• retval core_delta_days (scalar year1, scalar month1, scalar day1, scalar year2,

scalar month2, scalar day2)• retval Delta_DHMS ()• retval Add_Delta_Days (scalar year, scalar month, scalar day, scalar Dd)• retval core_add_delta_days (scalar year, scalar month, scalar day, scalar Dd)

• retval Add_Delta_DHMS (scalar year, scalar month, scalar day, scalar hour,scalar min, scalar sec, scalar Dd, scalar Dh, scalar Dm, scalar Ds)

• retval Add_Delta_YMD (scalar year, scalar month, scalar day, scalar Dy, scalarDm, scalar Dd)

• retval System_Clock ()• retval core_system_clock ()• retval Today ()• retval Now ()• retval Today_and_Now ()• retval Easter_Sunday (scalar year)• retval Decode_Month (scalar month_str)• retval Decode_Day_of_Week (scalar day_str)• retval Decode_Language (scalar lang_str)• retval Compress (scalar year, scalar month, scalar day)• retval Uncompress (scalar date)• retval check_compressed (scalar date)• retval Compressed_to_Text (scalar date)• retval Date_to_Text (scalar year, scalar month, scalar day)• retval Date_to_Text_Long (scalar year, scalar month, scalar day)• retval English_Ordinal (scalar n)• retval Center (scalar str, scalar width)• retval Calendar (scalar year, scalar month)• retval Month_to_Text (scalar month)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 240: doxygen of OTRS cvs Ref Man

236 Class Documentation

• retval Day_of_Week_to_Text (scalar dow)• retval Day_of_Week_Abbreviation (scalar dow)• retval Language_to_Text (scalar lang)• retval Language (scalar lang)• retval Languages ()• retval Decode_Date_EU (scalar date)• retval Decode_Date_EU2 (scalar buffer)• retval Decode_Date_US (scalar date)• retval Decode_Date_US2 (scalar buffer)• retval Parse_Date (scalar date)• retval Version ()• retval date_range ()• retval Delta_Business_Days ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Date/Pcalc.pm

5.416 Kernel::System::PDF Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval DocumentNew (scalar Self, hash Param)• retval PageBlankNew (scalar Self, hash Param)• retval PageNew (scalar Self, hash Param)• retval DocumentOutput (scalar Self, hash Param)• retval Table (scalar Self, hash Param)• retval Text (scalar Self, hash Param)• retval Image (scalar Self, hash Param)• retval HLine (scalar Self, hash Param)• retval PositionSet (scalar Self, hash Param)• retval PositionGet (scalar Self, hash Param)• retval DimSet (scalar Self, hash Param)• retval DimGet (scalar Self, hash Param)

Protected Functions

• protected retval _TableCalculate (scalar Self, hash Param)• protected retval _TableBlockNextCalculate (scalar Self, hash Param)• protected retval _TableRowCalculate (scalar Self, hash Param)• protected retval _TableCellOutput (scalar Self, hash Param)• protected retval _TableCellOnCount (scalar Self, hash Param)• protected retval _TextCalculate (scalar Self, hash Param)• protected retval _StringWidth (scalar Self, hash Param)• protected retval _PrepareText (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 241: doxygen of OTRS cvs Ref Man

5.417 Modules::PictureUpload Class Reference 237

• protected retval _CurPageNumberSet (scalar Self, hash Param)• protected retval _CurPageDimSet (scalar Self, hash Param)• protected retval _CurPageDimGet (scalar Self, hash Param)• protected retval _CurPageDimCheck (scalar Self, hash Param)• protected retval _CurPrintableDimSet (scalar Self, hash Param)• protected retval _CurPrintableDimGet (scalar Self, hash Param)• protected retval _CurPrintableDimCheck (scalar Self, hash Param)• protected retval _CurContentDimSet (scalar Self, hash Param)• protected retval _CurContentDimGet (scalar Self, hash Param)• protected retval _CurContentDimCheck (scalar Self, hash Param)• protected retval _CurPositionSet (scalar Self, hash Param)• protected retval _CurPositionGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PDF.pm

5.417 Modules::PictureUpload Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/PictureUpload.pm

5.418 Kernel::System::PID Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval PIDCreate (scalar Self, hash Param)• retval PIDGet (scalar Self, hash Param)• retval PIDDelete (scalar Self, hash Param)• retval PIDUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PID.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 242: doxygen of OTRS cvs Ref Man

238 Class Documentation

5.419 Mail::Mailer::smtp::pipe Class Reference

Public Member Functions

Public Functions

• retval TIEHANDLE ()• retval PRINT ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/smtp.pm

5.420 Mail::Mailer::smtps::pipe Class Reference

Public Member Functions

Public Functions

• retval TIEHANDLE ()• retval PRINT ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/smtps.pm

5.421 Mail::Mailer::testfile::pipe Class Reference

Public Member Functions

Public Functions

• retval TIEHANDLE ()• retval PRINT ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/testfile.pm

5.422 Net::IMAP::Simple::PipeSocket Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)• retval TIEHANDLE (scalar class)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 243: doxygen of OTRS cvs Ref Man

5.423 Authen::SASL::Perl::PLAIN Class Reference 239

Public Functions

• retval UNTIE ()• retval DESTROY ()• retval FILENO (scalar this)• retval PRINT (scalar this)• retval READLINE (scalar this)• retval CLOSE (scalar this)

Protected Functions

• protected retval _chkerr (scalar this)• protected retval _waitpid (scalar this)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Net/IMAP/Simple/PipeSocket.pm

5.423 Authen::SASL::Perl::PLAIN Class Reference

Public Member Functions

Public Object Methods

• retval client_start ()• retval server_start (scalar response)

Public Functions

• retval mechanism ()

Protected Functions

• protected retval _order ()• protected retval _secflags ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL/Perl/PLAIN.pm

5.424 XML::FeedPP::Plugin Class Reference

Public Member Functions

Public Class Methods

• retval run (scalar class, scalar feed)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/XML/FeedPP.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 244: doxygen of OTRS cvs Ref Man

240 Class Documentation

5.425 URI::pop Class Reference

Public Member Functions

Public Object Methods

• retval user ()• retval auth ()

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/pop.pm

5.426 Kernel::System::MailAccount::POP3 Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Connect (scalar Self, hash Param)• retval Fetch (scalar Self, hash Param)

Protected Functions

• protected retval _Fetch (scalar Self, hash Param)• protected retval _ProcessFailed (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/MailAccount/POP3.pm

5.427 Mail::POP3Client Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar classname)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 245: doxygen of OTRS cvs Ref Man

5.427 Mail::POP3Client Class Reference 241

Public Functions

• retval Version ()• retval Alive (scalar me)• retval State (scalar me)• retval Message (scalar me)• retval Debug (scalar me)• retval Port (scalar me)• retval Host (scalar me)• retval LocalAddr (scalar me)• retval Socket (scalar me)• retval AuthMode (scalar me, scalar mode)• retval User (scalar me)• retval Pass (scalar me)• retval Password ()• retval Count (scalar me, scalar c)• retval Size (scalar me, scalar c)• retval EOL (scalar me)• retval Close (scalar me)• retval close ()• retval logout ()• retval DESTROY (scalar me)• retval Connect (scalar me, scalar host, scalar port)• retval connect ()• retval Login (scalar me)• retval login ()• retval Login_APOP (scalar me)• retval Login_CRAM_MD5 (scalar me)• retval Login_Pass (scalar me)• retval Head (scalar me, scalar num, scalar lines)• retval HeadAndBody (scalar me, scalar num)• retval message_string ()• retval HeadAndBodyToFile (scalar me, scalar fh, scalar num)• retval Body (scalar me, scalar num)• retval BodyToFile (scalar me, scalar fh, scalar num)• retval POPStat (scalar me)• retval List (scalar me)• retval ListArray (scalar me)• retval Retrieve ()• retval RetrieveToFile ()• retval Last (scalar me)• retval Reset (scalar me)• retval Delete (scalar me)• retval delete_message ()• retval Uidl (scalar me)• retval Capa (scalar me)• retval Xtnd (scalar me)• retval NOOP (scalar me)• retval Peek ()• retval Uid ()• retval folders ()• retval Folder ()• retval select ()• retval unseen (scalar me)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 246: doxygen of OTRS cvs Ref Man

242 Class Documentation

Protected Object Methods

• protected retval _init ()• protected retval _initOldStyle (scalar host, scalar port)

Protected Functions

• protected retval _checkstate (scalar me, scalar state, scalar cmd)• protected retval _sockprint (scalar me)• protected retval _sockread (scalar me)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/POP3Client.pm

5.428 Kernel::System::MailAccount::POP3S Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Connect (scalar Self, hash Param)• retval Fetch (scalar Self, hash Param)

Protected Functions

• protected retval _Fetch (scalar Self, hash Param)• protected retval _ProcessFailed (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/MailAccount/POP3S.pm

5.429 Kernel::System::DB::postgresql Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 247: doxygen of OTRS cvs Ref Man

5.430 Kernel::System::DB::postgresql_before_8_2 Class Reference 243

Public Functions

• retval LoadPreferences (scalar Self, hash Param)• retval Quote (scalar Self, scalar Text, scalar Type)• retval DatabaseCreate (scalar Self, hash Param)• retval DatabaseDrop (scalar Self, hash Param)• retval TableCreate (scalar Self, list Param)• retval TableDrop (scalar Self, list Param)• retval TableAlter (scalar Self, list Param)• retval IndexCreate (scalar Self, hash Param)• retval IndexDrop (scalar Self, hash Param)• retval ForeignKeyCreate (scalar Self, hash Param)• retval ForeignKeyDrop (scalar Self, hash Param)• retval UniqueCreate (scalar Self, hash Param)• retval UniqueDrop (scalar Self, hash Param)• retval Insert (scalar Self, list Param)

Protected Functions

• protected retval _TypeTranslation (scalar Self, scalar Tag)

The documentation for this class was generated from the following file:

• Kernel/System/DB/postgresql.pm

5.430 Kernel::System::DB::postgresql before 8 2 Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval LoadPreferences (scalar Self, hash Param)• retval Quote (scalar Self, scalar Text, scalar Type)• retval DatabaseCreate (scalar Self, hash Param)• retval DatabaseDrop (scalar Self, hash Param)• retval TableCreate (scalar Self, list Param)• retval TableDrop (scalar Self, list Param)• retval TableAlter (scalar Self, list Param)• retval IndexCreate (scalar Self, hash Param)• retval IndexDrop (scalar Self, hash Param)• retval ForeignKeyCreate (scalar Self, hash Param)• retval ForeignKeyDrop (scalar Self, hash Param)• retval UniqueCreate (scalar Self, hash Param)• retval UniqueDrop (scalar Self, hash Param)• retval Insert (scalar Self, list Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 248: doxygen of OTRS cvs Ref Man

244 Class Documentation

Protected Functions

• protected retval _TypeTranslation (scalar Self, scalar Tag)

The documentation for this class was generated from the following file:

• Kernel/System/DB/postgresql_before_8_2.pm

5.431 Kernel::System::PostMaster Class Reference

Classes

• class DestQueue

• class Filter

• class Filter

• class Filter

• class Filter

• class Filter

• class Filter

• class Filter

• class FollowUp

• class LoopProtection

• class LoopProtection

• class LoopProtection

• class NewTicket

• class Reject

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval CheckFollowUp (scalar Self, hash Param)• retval GetEmailParams (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 249: doxygen of OTRS cvs Ref Man

5.432 JSON::Backend::PP Class Reference 245

5.432 JSON::Backend::PP Class Reference

Public Member Functions

Public Functions

• retval init ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/JSON.pm

5.433 Output::HTML::PreferencesCustomQueue Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesCustomQueue.pm

5.434 Kernel::System::Service::PreferencesDB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ServicePreferencesSet (scalar Self, hash Param)• retval ServicePreferencesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Service/PreferencesDB.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 250: doxygen of OTRS cvs Ref Man

246 Class Documentation

5.435 Kernel::System::SLA::PreferencesDB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SLAPreferencesSet (scalar Self, hash Param)• retval SLAPreferencesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/SLA/PreferencesDB.pm

5.436 Kernel::System::Queue::PreferencesDB Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval QueuePreferencesSet (scalar Self, hash Param)• retval QueuePreferencesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Queue/PreferencesDB.pm

5.437 Output::HTML::PreferencesGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 251: doxygen of OTRS cvs Ref Man

5.438 Output::HTML::PreferencesLanguage Class Reference 247

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesGeneric.pm

5.438 Output::HTML::PreferencesLanguage Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesLanguage.pm

5.439 Output::HTML::PreferencesOutOfOffice Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesOutOfOffice.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 252: doxygen of OTRS cvs Ref Man

248 Class Documentation

5.440 Output::HTML::PreferencesPassword Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesPassword.pm

5.441 Output::HTML::PreferencesPGP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Download (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesPGP.pm

5.442 Output::HTML::PreferencesSkin Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 253: doxygen of OTRS cvs Ref Man

5.443 Output::HTML::PreferencesSMIME Class Reference 249

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesSkin.pm

5.443 Output::HTML::PreferencesSMIME Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Download (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesSMIME.pm

5.444 Output::HTML::PreferencesTheme Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesTheme.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 254: doxygen of OTRS cvs Ref Man

250 Class Documentation

5.445 Output::HTML::PreferencesTicketWatcher Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesTicketWatcher.pm

5.446 Output::HTML::PreferencesTimeZone Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/PreferencesTimeZone.pm

5.447 CGI::Pretty Class Reference

Inheritance diagram for CGI::Pretty:

CGI::Pretty

CGI

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 255: doxygen of OTRS cvs Ref Man

5.448 Kernel::System::Priority Class Reference 251

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval import ()

Public Functions

• retval comment ()• retval start_html ()• retval end_html ()• retval initialize_globals ()

Protected Object Methods

• protected retval _make_tag_func (scalar tagname)

Protected Functions

• protected retval _prettyPrint (scalar input)• protected retval _reset_globals ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI/Pretty.pm

5.448 Kernel::System::Priority Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval PriorityList (scalar Self, hash Param)• retval PriorityGet (scalar Self, hash Param)• retval PriorityAdd (scalar Self, hash Param)• retval PriorityUpdate (scalar Self, hash Param)• retval PriorityLookup (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Priority.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 256: doxygen of OTRS cvs Ref Man

252 Class Documentation

5.449 Kernel::System::SysConfig::PriorityValidate Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Validate (scalar Self, hash Param)• retval GetAutoCorrectValue (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/SysConfig/PriorityValidate.pm

5.450 LWP::Protocol Class Reference

Inheritance diagram for LWP::Protocol:

LWP::Protocol

LWP::MemberMixin

Kernel::GenericInterface::Transport::HTTP::Test::CustomHTTPProtocol

LWP::Protocol::cpan

LWP::Protocol::data

LWP::Protocol::file

LWP::Protocol::ftp

LWP::Protocol::gopher

LWP::Protocol::http

LWP::Protocol::loopback

LWP::Protocol::mailto

LWP::Protocol::nntp

LWP::Protocol::nogo

Classes

• class cpan

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 257: doxygen of OTRS cvs Ref Man

5.451 Kernel::GenericInterface::Provider Class Reference 253

• class data• class file• class ftp• class GHTTP• class gopher• class http• class http• class http• class loopback• class mailto• class nntp• class nogo

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar scheme, scalar ua)

Public Object Methods

• retval request (scalar request, scalar proxy, scalar arg, scalar size, scalar time-out)

• retval timeout (scalar arg, scalar response, scalar collector)• retval max_size (scalar arg, scalar response, scalar collector)• retval collect (scalar arg, scalar response, scalar collector)• retval collect_once (scalar arg, scalar response)

Public Functions

• retval create (scalar scheme, scalar ua)• retval implementor (scalar scheme, scalar impclass)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol.pm

5.451 Kernel::GenericInterface::Provider Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 258: doxygen of OTRS cvs Ref Man

254 Class Documentation

Protected Functions

• protected retval _GenerateErrorResponse (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Provider.pm

5.452 Provides Class Reference

5.452.1 Detailed Description

Creates a CKEDITOR.htmlParser class instance. system to parse strings of HTML data.

The documentation for this class was generated from the following file:

• var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/htmlparser.js

5.453 Modules::PublicDefault Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/PublicDefault.pm

5.454 Modules::PublicRepository Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 259: doxygen of OTRS cvs Ref Man

5.455 CGI::Push Class Reference 255

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/PublicRepository.pm

5.455 CGI::Push Class Reference

Inheritance diagram for CGI::Push:

CGI::Push

CGI

Public Member Functions

Public Object Methods

• retval simple_counter (scalar count)

Public Functions

• retval do_push ()• retval do_sleep (scalar delay)• retval push_delay ()• retval next_page (scalar q, scalar counter)• retval last_page (scalar q, scalar counter)• retval my_draw_routine (scalar q, scalar counter)• retval my_draw_routine (scalar q, scalar counter)• retval my_draw_routine (scalar q, scalar counter)• retval my_last_page ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI/Push.pm

5.456 Mail::Mailer::qmail Class Reference

Inheritance diagram for Mail::Mailer::qmail:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 260: doxygen of OTRS cvs Ref Man

256 Class Documentation

Mail::Mailer::qmail

Mail::Mailer::rfc822

Mail::Mailer

Public Member Functions

Public Functions

• retval exec ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/qmail.pm

5.457 file::QNX Class Reference

Public Member Functions

Protected Class Methods

• protected retval _file_extract_path (scalar class, scalar path)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/file/QNX.pm

5.458 URI::QueryParam Class Reference

Public Member Functions

Public Object Methods

• retval URI::_query::query_param ()• retval URI::_query::query_param_append (scalar key)• retval URI::_query::query_param_delete (scalar key)• retval URI::_query::query_form_hash ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/QueryParam.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 261: doxygen of OTRS cvs Ref Man

5.459 Kernel::System::Queue Class Reference 257

5.459 Kernel::System::Queue Class Reference

Classes

• class PreferencesDB

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetSystemAddress (scalar Self, hash Param)• retval GetSignature (scalar Self, hash Param)• retval SetQueueStandardResponse (scalar Self, hash Param)• retval GetStandardResponses (scalar Self, hash Param)• retval GetAllQueues (scalar Self, hash Param)• retval GetAllCustomQueues (scalar Self, hash Param)• retval QueueLookup (scalar Self, hash Param)• retval GetFollowUpOption (scalar Self, hash Param)• retval GetFollowUpLockOption (scalar Self, hash Param)• retval GetQueueGroupID (scalar Self, hash Param)• retval QueueAdd (scalar Self, hash Param)• retval QueueGet (scalar Self, hash Param)• retval QueueUpdate (scalar Self, hash Param)• retval QueueList (scalar Self, hash Param)• retval QueuePreferencesSet (scalar Self, hash Param)• retval QueuePreferencesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Queue.pm

5.460 Output::HTML::QueuePreferencesGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 262: doxygen of OTRS cvs Ref Man

258 Class Documentation

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/QueuePreferencesGeneric.pm

5.461 Kernel::System::SysConfig::QueueValidate Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Validate (scalar Self, hash Param)• retval GetAutoCorrectValue (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/SysConfig/QueueValidate.pm

5.462 MIME::Decoder::QuotedPrint Class Reference

Inheritance diagram for MIME::Decoder::QuotedPrint:

MIME::Decoder::QuotedPrint

MIME::Decoder

Public Member Functions

Public Object Methods

• retval decode_it (scalar in, scalar out)• retval encode_it (scalar in, scalar out, scalar textual_type)

Public Functions

• retval encode_qp_really ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Decoder/QuotedPrint.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 263: doxygen of OTRS cvs Ref Man

5.463 Kernel::System::Auth::Radius Class Reference 259

5.463 Kernel::System::Auth::Radius Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Auth/Radius.pm

5.464 Kernel::System::CustomerAuth::Radius Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetOption (scalar Self, hash Param)• retval Auth (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/CustomerAuth/Radius.pm

5.465 MIME::Parser::Reader Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval spawn ()• retval add_boundary (scalar bound)• retval add_terminator (scalar line)• retval eos ()• retval eos_type (scalar eos)• retval read_chunk (scalar in, scalar out)• retval read_lines (scalar in, scalar outlines)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 264: doxygen of OTRS cvs Ref Man

260 Class Documentation

Public Functions

• retval has_bounds ()• retval depth ()• retval native_handle (scalar fh)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Parser/Reader.pm

5.466 Type::ref Class Reference

Public Member Functions

Public Object Methods

• retval yaml_dump ()

Public Functions

• retval yaml_load (scalar node, scalar class, scalar loader)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Types.pm

5.467 Kernel::System::ReferenceData Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval CountryList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/ReferenceData.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 265: doxygen of OTRS cvs Ref Man

5.468 Type::regexp Class Reference 261

5.468 Type::regexp Class Reference

Public Member Functions

Public Functions

• retval yaml_dump ()• retval yaml_load (scalar node, scalar class)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Types.pm

5.469 Kernel::System::PostMaster::Reject Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/Reject.pm

5.470 Apache2::Reload Class Reference

Public Member Functions

Public Class Methods

• retval import (scalar class)• retval register_module (scalar class, scalar package, scalar file)• retval unregister_module (scalar class, scalar package)

Public Functions

• retval package_to_module (scalar package)• retval module_to_package (scalar module)• retval handler (scalar o)• retval handler ()• retval colour ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Apache2/Reload.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 266: doxygen of OTRS cvs Ref Man

262 Class Documentation

5.471 Represents Class Reference

5.471.1 Detailed Description

Creates a command class instance. that can be executed on an editor instance.

Parameters{CKEDI-

TOR.editor}editor The editor instance this command will be related to.

{CKEDI-TOR.commandDefinition}

commandDefinition The command definition. CKEDITOR.event

processor, which is responsible to translate and transform the editor data on input andoutput.

Creates a CKEDITOR.dom.range instance that can be used inside a specific DOM Doc-ument. piece of content in a DOM Document. It is contiguous in the sense that it canbe characterized as selecting all of the content between a pair of boundary-points.

This class shares much of the W3C Document Object Model Range ideas andfeatures, adding several range manipulation tools to it, but it’s not intended to be com-patible with it.

Parameters{CKEDI-

TOR.dom.document}document The document into which the range features will be available.

The documentation for this class was generated from the following file:

• var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/command.js

5.472 Kernel::System::Web::Request Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Error (scalar Self, hash Param)• retval GetParam (scalar Self, hash Param)• retval GetParamNames (scalar Self)• retval GetArray (scalar Self, hash Param)• retval GetUploadAll (scalar Self, hash Param)• retval SetCookie (scalar Self, hash Param)• retval GetCookie (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 267: doxygen of OTRS cvs Ref Man

5.473 HTTP::Request Class Reference 263

Protected Functions

• protected retval _GetUploadInfo (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Web/Request.pm

5.473 HTTP::Request Class Reference

Inheritance diagram for HTTP::Request:

HTTP::Request

HTTP::Message

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar method, scalar uri, scalar header, scalar con-tent)

• retval parse (scalar class, scalar str)

Public Object Methods

• retval clone ()• retval method ()• retval uri ()• retval uri_canonical ()• retval accept_decodable ()• retval dump ()

Public Functions

• retval as_string (scalar eol)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/HTTP/Request.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 268: doxygen of OTRS cvs Ref Man

264 Class Documentation

5.474 Kernel::GenericInterface::Requester Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Requester.pm

5.475 Kernel::System::Ticket::Event::ResponsibleAutoSet Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/ResponsibleAutoSet.pm

5.476 Kernel::System::Ticket::Permission::ResponsibleCheck ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Permission/ResponsibleCheck.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 269: doxygen of OTRS cvs Ref Man

5.477 Kernel::System::Ticket::Event::ResponsibleForQueue Class Reference 265

5.477 Kernel::System::Ticket::Event::ResponsibleForQueue Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type)

Public Functions

• retval Run (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/ResponsibleForQueue.pm

5.478 Kernel::GenericInterface::Transport::HTTP::REST Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ProviderProcessRequest (scalar Self, hash Param)• retval ProviderGenerateResponse (scalar Self, hash Param)• retval RequesterPerformRequest (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Transport/HTTP/REST.pm

5.479 MIME::Parser::Results Class Reference

Public Member Functions

Public Class Methods

• retval new ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 270: doxygen of OTRS cvs Ref Man

266 Class Documentation

Public Object Methods

• retval top_head (scalar head)• retval msg (scalar type)• retval level (scalar lvl)• retval indent ()

Public Functions

• retval msgs ()• retval errors ()• retval warnings ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Parser/Results.pm

5.480 Mail::Mailer::rfc822 Class Reference

Inheritance diagram for Mail::Mailer::rfc822:

Mail::Mailer::rfc822

Mail::Mailer

Mail::Mailer::qmail Mail::Mailer::sendmail Mail::Mailer::smtp Mail::Mailer::smtps Mail::Mailer::testfile

Public Member Functions

Public Functions

• retval set_headers ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/rfc822.pm

5.481 URI::rlogin Class Reference

Inheritance diagram for URI::rlogin:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 271: doxygen of OTRS cvs Ref Man

5.482 LWP::RobotUA Class Reference 267

URI::rlogin

URI::_login

URI::_server URI::_userpass

Public Member Functions

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/rlogin.pm

5.482 LWP::RobotUA Class Reference

Inheritance diagram for LWP::RobotUA:

LWP::RobotUA

LWP::UserAgent

LWP::MemberMixin

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval delay (scalar self, scalar self)• retval use_sleep (scalar self)• retval agent ()• retval rules ()• retval no_visits (scalar netloc)• retval host_wait (scalar netloc)• retval simple_request (scalar request, scalar arg, scalar size)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 272: doxygen of OTRS cvs Ref Man

268 Class Documentation

• retval as_string ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/RobotUA.pm

5.483 URI::rsync Class Reference

Public Member Functions

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/rsync.pm

5.484 URI::rtsp Class Reference

Public Member Functions

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/rtsp.pm

5.485 URI::rtspu Class Reference

Public Member Functions

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/rtspu.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 273: doxygen of OTRS cvs Ref Man

5.486 Kernel::System::Salutation Class Reference 269

5.486 Kernel::System::Salutation Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SalutationAdd (scalar Self, hash Param)• retval SalutationGet (scalar Self, hash Param)• retval SalutationUpdate (scalar Self, hash Param)• retval SalutationList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Salutation.pm

5.487 Authen::SASL Class Reference

Classes

• class CRAM_MD5• class EXTERNAL

Public Member Functions

Public Class Methods

• retval new (scalar pkg)

Public Object Methods

• retval mechanism ()• retval callback ()• retval client_new ()• retval server_new ()• retval error ()• retval user ()• retval challenge ()• retval initial ()• retval name ()

Public Functions

• retval import ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Authen/SASL.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 274: doxygen of OTRS cvs Ref Man

270 Class Documentation

5.488 MIME::Body::Scalar Class Reference

Inheritance diagram for MIME::Body::Scalar:

MIME::Body::Scalar

MIME::Body

MIME::Body::InCore

Public Member Functions

Public Object Methods

• retval init (scalar data)• retval open (scalar mode)

Public Functions

• retval as_string ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Body.pm

5.489 IO::ScalarArray Class Reference

Inheritance diagram for IO::ScalarArray:

IO::ScalarArray

IO::Lines

Public Member Functions

Public Class Methods

• retval new (scalar proto)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 275: doxygen of OTRS cvs Ref Man

5.489 IO::ScalarArray Class Reference 271

Public Object Methods

• retval open (scalar aref)• retval close ()• retval getline ()• retval getlines ()• retval print ()• retval read (, scalar n, scalar off)• retval write (, scalar n, scalar off)• retval seek (scalar pos, scalar whence)• retval tell ()• retval setpos (scalar pos)• retval TIEHANDLE (scalar self, scalar self, scalar self, scalar self, scalar self,

scalar self, scalar self, scalar self, scalar self, scalar self)• retval GETC (scalar self, scalar self, scalar self, scalar self, scalar self, scalar

self, scalar self, scalar self, scalar self)• retval PRINT (scalar self, scalar self, scalar self, scalar self, scalar self, scalar

self, scalar self, scalar self)• retval PRINTF (scalar self, scalar self, scalar self, scalar self, scalar self, scalar

self, scalar self)• retval READ (scalar self, scalar self, scalar self, scalar self, scalar self, scalar

self)• retval READLINE (scalar self, scalar self, scalar self, scalar self, scalar self)• retval WRITE (scalar self, scalar self, scalar self, scalar self)• retval CLOSE (scalar self, scalar self, scalar self)• retval SEEK (scalar self, scalar self)• retval TELL (scalar self)• retval EOF ()

Public Functions

• retval DESTROY ()• retval opened ()• retval flush ()• retval getc ()• retval autoflush ()• retval binmode ()• retval clearerr ()• retval eof ()• retval getpos ()• retval aref ()

Protected Object Methods

• protected retval _seek_set (scalar pos)• protected retval _seek_cur (scalar pos)• protected retval _seek_end (scalar pos)• protected retval _tell_eof ()• protected retval _setpos_to_eof ()

Protected Functions

• protected retval _eos ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/IO/ScalarArray.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 276: doxygen of OTRS cvs Ref Man

272 Class Documentation

5.490 Kernel::Scheduler Class Reference

Classes

• class TaskHandler

• class TaskHandler

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval TaskRegister (scalar Self, hash Param)

Protected Functions

• protected retval _PIDChangedTimeUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Scheduler.pm

5.491 Kernel::System::SearchProfile Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SearchProfileAdd (scalar Self, hash Param)• retval SearchProfileGet (scalar Self, hash Param)• retval SearchProfileDelete (scalar Self, hash Param)• retval SearchProfileList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/SearchProfile.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 277: doxygen of OTRS cvs Ref Man

5.492 Kernel::System::UnitTest::Selenium Class Reference 273

5.492 Kernel::System::UnitTest::Selenium Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Class, hash Param)

Public Functions

• retval AUTOLOAD (scalar Self)• retval Login (scalar Self, hash Param)• retval DESTROY (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/UnitTest/Selenium.pm

5.493 Mail::Send Class Reference

Public Member Functions

Public Class Methods

• retval new ()

Public Functions

• retval Version ()• retval set ()• retval add ()• retval delete ()• retval to ()• retval cc ()• retval bcc ()• retval subject ()• retval open ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Send.pm

5.494 Mail::Mailer::sendmail Class Reference

Inheritance diagram for Mail::Mailer::sendmail:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 278: doxygen of OTRS cvs Ref Man

274 Class Documentation

Mail::Mailer::sendmail

Mail::Mailer::rfc822

Mail::Mailer

Public Member Functions

Public Functions

• retval exec ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/sendmail.pm

5.495 Kernel::System::Email::Sendmail Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Send (scalar Self, hash Param)• retval Check (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Email/Sendmail.pm

5.496 HTTP::SOAP::XMLSchema1999::Serializer Class Reference

Public Member Functions

Public Object Methods

• retval as_base64 (scalar value, scalar name, scalar type, scalar attr)• retval as_hex (scalar value, scalar name, scalar type, scalar attr)• retval as_long (scalar value, scalar name, scalar type, scalar attr)• retval as_dateTime (scalar value, scalar name, scalar type, scalar attr)• retval as_string (scalar value, scalar name, scalar type, scalar attr)• retval as_anyURI (scalar value, scalar name, scalar type, scalar attr)• retval as_float (scalar value, scalar name, scalar type, scalar attr)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 279: doxygen of OTRS cvs Ref Man

5.497 HTTP::SOAP::XMLSchema::Serializer Class Reference 275

Public Functions

• retval AUTOLOAD ()• retval nilValue ()• retval anyTypeValue ()• retval as_undef ()• retval as_boolean (scalar value, scalar name, scalar type, scalar attr)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite.pm

5.497 HTTP::SOAP::XMLSchema::Serializer Class Reference

Public Member Functions

Public Object Methods

• retval xmlschemaclass ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite.pm

5.498 HTTP::SOAP::XMLSchema2001::Serializer Class Reference

Public Member Functions

Public Object Methods

• retval as_hexBinary (scalar value, scalar name, scalar type, scalar attr)• retval as_base64Binary (scalar value, scalar name, scalar type, scalar attr)• retval as_boolean (scalar value, scalar name, scalar type, scalar attr)

Public Functions

• retval nilValue ()• retval anyTypeValue ()• retval as_long ()• retval as_float ()• retval as_string ()• retval as_anyURI ()• retval as_QName ()• retval as_hex ()• retval as_base64 ()• retval as_timeInstant ()• retval as_undef ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 280: doxygen of OTRS cvs Ref Man

276 Class Documentation

5.499 HTTP::SOAP::Transport::HTTP::Server Class Reference

Inheritance diagram for HTTP::SOAP::Transport::HTTP::Server:

HTTP::SOAP::Transport::HTTP::Server

HTTP::SOAP::Transport::HTTP::Apache HTTP::SOAP::Transport::HTTP::CGI HTTP::SOAP::Transport::HTTP::Daemon

HTTP::SOAP::Transport::HTTP::FCGI

Public Member Functions

Public Object Methods

• retval new ()• retval make_fault ()• retval make_response (scalar code, scalar response)

Public Functions

• retval DESTROY ()• retval BEGIN ()• retval handle ()• retval product_tokens ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Transport/HTTP.pm

5.500 Kernel::System::Service Class Reference

Classes

• class PreferencesDB

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 281: doxygen of OTRS cvs Ref Man

5.501 Output::HTML::ServicePreferencesGeneric Class Reference 277

Public Functions

• retval ServiceList (scalar Self, hash Param)• retval ServiceListGet (scalar Self, hash Param)• retval ServiceGet (scalar Self, hash Param)• retval ServiceLookup (scalar Self, hash Param)• retval ServiceAdd (scalar Self, hash Param)• retval ServiceUpdate (scalar Self, hash Param)• retval ServiceSearch (scalar Self, hash Param)• retval CustomerUserServiceMemberList (scalar Self, hash Param)• retval CustomerUserServiceMemberAdd (scalar Self, hash Param)• retval ServicePreferencesSet (scalar Self)• retval ServicePreferencesGet (scalar Self)• retval ServiceParentsGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Service.pm

5.501 Output::HTML::ServicePreferencesGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ServicePreferencesGeneric.pm

5.502 Kernel::GenericInterface::Operation::Session::SessionIDGet ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 282: doxygen of OTRS cvs Ref Man

278 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation/Session/SessionIDGet.pm

5.503 Kernel::System::Signature Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SignatureAdd (scalar Self, hash Param)• retval SignatureGet (scalar Self, hash Param)• retval SignatureUpdate (scalar Self, hash Param)• retval SignatureList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Signature.pm

5.504 Kernel::GenericInterface::Mapping::Simple Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Map (scalar Self, hash Param)

Protected Functions

• protected retval _ConfigCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Mapping/Simple.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 283: doxygen of OTRS cvs Ref Man

5.505 URI::sip Class Reference 279

5.505 URI::sip Class Reference

Public Member Functions

Public Object Methods

• retval authority ()• retval params_form ()• retval params ()

Public Functions

• retval default_port ()• retval path ()• retval path_query ()• retval path_segments ()• retval abs ()• retval rel ()• retval query_keywords ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/sip.pm

5.506 URI::sips Class Reference

Public Member Functions

Public Functions

• retval default_port ()• retval secure ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/sips.pm

5.507 Kernel::System::SLA Class Reference

Classes

• class PreferencesDB

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 284: doxygen of OTRS cvs Ref Man

280 Class Documentation

Public Functions

• retval SLAList (scalar Self, hash Param)• retval SLAGet (scalar Self, hash Param)• retval SLALookup (scalar Self, hash Param)• retval SLAAdd (scalar Self, hash Param)• retval SLAUpdate (scalar Self, hash Param)• retval SLAPreferencesSet (scalar Self)• retval SLAPreferencesGet (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/SLA.pm

5.508 Output::HTML::SLAPreferencesGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self, hash Param)• retval Run (scalar Self, hash Param)• retval Error (scalar Self, hash Param)• retval Message (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/SLAPreferencesGeneric.pm

5.509 IO::WrapTie::Slave Class Reference

Inheritance diagram for IO::WrapTie::Slave:

IO::WrapTie::Slave

IO::WrapTie

Public Member Functions

Public Object Methods

• retval new_tie ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 285: doxygen of OTRS cvs Ref Man

5.510 Mail::Mailer::smtp Class Reference 281

Public Functions

• retval TIE_MASTER ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/IO/WrapTie.pm

5.510 Mail::Mailer::smtp Class Reference

Inheritance diagram for Mail::Mailer::smtp:

Mail::Mailer::smtp

Mail::Mailer::rfc822

Mail::Mailer

Classes

• class pipe

Public Member Functions

Public Object Methods

• retval exec (scalar exe, scalar args, scalar to)

Public Functions

• retval can_cc ()• retval set_headers ()• retval epilogue ()• retval close ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/smtp.pm

5.511 Kernel::System::Email::SMTP Class Reference

Public Member Functions

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 286: doxygen of OTRS cvs Ref Man

282 Class Documentation

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Check (scalar Self, hash Param)• retval Send (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Email/SMTP.pm

5.512 Kernel::System::Email::SMTPS Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Check (scalar Self, hash Param)• retval Send (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Email/SMTPS.pm

5.513 Mail::Mailer::smtps Class Reference

Inheritance diagram for Mail::Mailer::smtps:

Mail::Mailer::smtps

Mail::Mailer::rfc822

Mail::Mailer

Classes

• class pipe

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 287: doxygen of OTRS cvs Ref Man

5.514 Kernel::System::Email::SMTPTLS Class Reference 283

Public Member Functions

Public Object Methods

• retval exec (scalar exe, scalar args, scalar to)

Public Functions

• retval can_cc ()• retval set_headers ()• retval epilogue ()• retval close ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/smtps.pm

5.514 Kernel::System::Email::SMTPTLS Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Check (scalar Self, hash Param)• retval Send (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Email/SMTPTLS.pm

5.515 URI::snews Class Reference

Public Member Functions

Public Functions

• retval default_port ()• retval secure ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/snews.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 288: doxygen of OTRS cvs Ref Man

284 Class Documentation

5.516 Kernel::GenericInterface::Transport::HTTP::SOAP Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ProviderProcessRequest (scalar Self, hash Param)• retval ProviderGenerateResponse (scalar Self, hash Param)• retval RequesterPerformRequest (scalar Self, hash Param)

Protected Functions

• protected retval _Error (scalar Self, hash Param)• protected retval _Output (scalar Self, hash Param)• protected retval _SOAPOutputRecursion (scalar Self, hash Param)• protected retval _SOAPOutputHashRecursion (scalar Self, hash Param)• protected retval _SOAPOutputProcessString (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Transport/HTTP/SOAP.pm

5.517 LWP::Protocol::http::Socket Class Reference

Inheritance diagram for LWP::Protocol::http::Socket:

LWP::Protocol::http::Socket

LWP::Protocol::http::SocketMethods

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/http.pm

5.518 LWP::Protocol::http::SocketMethods Class Reference

Inheritance diagram for LWP::Protocol::http::SocketMethods:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 289: doxygen of OTRS cvs Ref Man

5.519 Kernel::System::Spelling Class Reference 285

LWP::Protocol::http::SocketMethods

LWP::Protocol::http::Socket

Public Member Functions

Public Object Methods

• retval sysread ()• retval can_read (scalar timeout)• retval ping ()• retval increment_response_count ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/Protocol/http.pm

5.519 Kernel::System::Spelling Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Check (scalar Self, hash Param)• retval Error (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Spelling.pm

5.520 Modules::SpellingInline Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 290: doxygen of OTRS cvs Ref Man

286 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/SpellingInline.pm

5.521 URI::Split Class Reference

Public Member Functions

Public Functions

• retval uri_split ()• retval uri_join (scalar scheme, scalar auth, scalar path, scalar query, scalar

frag)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/Split.pm

5.522 URI::ssh Class Reference

Public Member Functions

Public Functions

• retval default_port ()• retval secure ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/ssh.pm

5.523 Net::IMAP::Simple::SSL Class Reference

Public Member Functions

Protected Functions

• protected retval _port ()• protected retval _sock_from ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Net/IMAP/Simple/SSL.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 291: doxygen of OTRS cvs Ref Man

5.524 Net::SMTP::SSL Class Reference 287

5.524 Net::SMTP::SSL Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Net/SMTP/SSL.pm

5.525 Net::POP3::SSLWrapper Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Net/POP3/SSLWrapper.pm

5.526 Kernel::System::StandardResponse Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval StandardResponseAdd (scalar Self, hash Param)• retval StandardResponseGet (scalar Self, hash Param)• retval StandardResponseDelete (scalar Self, hash Param)• retval StandardResponseUpdate (scalar Self, hash Param)• retval StandardResponseLookup (scalar Self, hash Param)• retval StandardResponseList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/StandardResponse.pm

5.527 Kernel::System::State Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 292: doxygen of OTRS cvs Ref Man

288 Class Documentation

Public Functions

• retval StateAdd (scalar Self, hash Param)• retval StateGet (scalar Self, hash Param)• retval StateUpdate (scalar Self, hash Param)• retval StateGetStatesByType (scalar Self, hash Param)• retval StateList (scalar Self, hash Param)• retval StateLookup (scalar Self, hash Param)• retval StateTypeList (scalar Self, hash Param)• retval StateTypeLookup (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/State.pm

5.528 Kernel::System::Stats::Static::StateAction Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Param (scalar Self)• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _GetHistoryTypes (scalar Self)• protected retval _GetDBDataPerDay (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Stats/Static/StateAction.pm

5.529 Kernel::System::SysConfig::StateValidate Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Validate (scalar Self, hash Param)• retval GetAutoCorrectValue (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 293: doxygen of OTRS cvs Ref Man

5.530 Kernel::System::Stats Class Reference 289

Protected Functions

• protected retval _GetAutoCorrectValue (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/SysConfig/StateValidate.pm

5.530 Kernel::System::Stats Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval StatsAdd (scalar Self)• retval StatsGet (scalar Self, hash Param)• retval StatsUpdate (scalar Self, hash Param)• retval StatsDelete (scalar Self, hash Param)• retval GetStatsList (scalar Self, hash Param)• retval SumBuild (scalar Self, hash Param)• retval GenerateGraph (scalar Self, hash Param)• retval CompletenessCheck (scalar Self, hash Param)• retval GetStatsObjectAttributes (scalar Self, hash Param)• retval GetStaticFiles (scalar Self, hash Param)• retval GetDynamicFiles (scalar Self)• retval GetObjectName (scalar Self, hash Param)• retval ObjectFileCheck (scalar Self, hash Param)• retval Export (scalar Self, hash Param)• retval Import (scalar Self, hash Param)• retval GetParams (scalar Self, hash Param)• retval StatsRun (scalar Self, hash Param)• retval StringAndTimestamp2Filename (scalar Self, hash Param)• retval StatNumber2StatID (scalar Self, hash Param)• retval StatsInstall (scalar Self, hash Param)• retval StatsUninstall (scalar Self, hash Param)• retval StatsCleanUp (scalar Self)

Protected Functions

• protected retval _GenerateStaticStats (scalar Self, hash Param)• protected retval _GenerateDynamicStats (scalar Self, hash Param)• protected retval _WriteResultCache (scalar Self, hash Param)• protected retval _CreateStaticResultCacheFilename (scalar Self, hash Param)

• protected retval _SetResultCache (scalar Self, hash Param)• protected retval _GetResultCache (scalar Self, hash Param)• protected retval _DeleteCache (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 294: doxygen of OTRS cvs Ref Man

290 Class Documentation

• protected retval _MonthArray ()• protected retval _AutomaticSampleImport (scalar Self, hash Param)• protected retval _GetCacheString (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Stats.pm

5.531 HTTP::Status Class Reference

Public Member Functions

Public Functions

• retval status_message (scalar)• retval is_info (scalar)• retval is_success (scalar)• retval is_redirect (scalar)• retval is_error (scalar)• retval is_client_error (scalar)• retval is_server_error (scalar)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/HTTP/Status.pm

5.532 Kernel::System::StdAttachment Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval StdAttachmentAdd (scalar Self, hash Param)• retval StdAttachmentGet (scalar Self, hash Param)• retval StdAttachmentUpdate (scalar Self, hash Param)• retval StdAttachmentDelete (scalar Self, hash Param)• retval StdAttachmentLookup (scalar Self, hash Param)• retval StdAttachmentsByResponseID (scalar Self, hash Param)• retval StdAttachmentList (scalar Self, hash Param)• retval StdAttachmentSetResponses (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/StdAttachment.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 295: doxygen of OTRS cvs Ref Man

5.533 JSON::Backend::XS::Supportable Class Reference 291

5.533 JSON::Backend::XS::Supportable Class Reference

Public Member Functions

Public Object Methods

• retval WidgetBase::TO_JSON ()

Public Functions

• retval decode_prefix ()• retval get_indent_length ()• retval indent_length (, scalar length)• retval JSON::PP::own_sort ()

Protected Functions

• protected retval _make_unsupported_method (scalar pkg, scalar method,scalar type)

• protected retval _set_for_pp (scalar prop)• protected retval _encode ()• protected retval _decode ()• protected retval _incr_parse ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/JSON.pm

5.534 Kernel::System::SysConfig Class Reference

Classes

• class PriorityValidate• class QueueValidate• class StateValidate

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval WriteDefault (scalar Self, hash Param)• retval Download (scalar Self, hash Param)• retval Upload (scalar Self, hash Param)• retval CreateConfig (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 296: doxygen of OTRS cvs Ref Man

292 Class Documentation

• retval ConfigItemUpdate (scalar Self, hash Param)• retval ConfigItemGet (scalar Self, hash Param)• retval ConfigItemReset (scalar Self, hash Param)• retval ConfigGroupList (scalar Self, hash Param)• retval ConfigSubGroupList (scalar Self, hash Param)• retval ConfigSubGroupConfigItemList (scalar Self, hash Param)• retval ConfigItemSearch (scalar Self, hash Param)• retval ConfigItemTranslatableStrings (scalar Self, hash Param)• retval ConfigItemValidate (scalar Self, hash Param)• retval ConfigItemCheckAll (scalar Self, hash Param)• retval DESTROY (scalar Self, hash Param)

Protected Functions

• protected retval _Init (scalar Self, hash Param)• protected retval _DataDiff (scalar Self, hash Param)• protected retval _FileWriteAtomic (scalar Self, hash Param)• protected retval _ConfigItemTranslatableStrings (scalar Self, hash Param)• protected retval _ModGet (scalar Self, hash Param)• protected retval _XML2Perl (scalar Self, hash Param)• protected retval _LoadBackend (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/SysConfig.pm

5.535 Kernel::System::Log::SysLog Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Log (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Log/SysLog.pm

5.536 Kernel::System::SystemAddress Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 297: doxygen of OTRS cvs Ref Man

5.537 var::packagesetup::SystemMonitoring Class Reference 293

Public Functions

• retval SystemAddressAdd (scalar Self, hash Param)• retval SystemAddressGet (scalar Self, hash Param)• retval SystemAddressUpdate (scalar Self, hash Param)• retval SystemAddressList (scalar Self, hash Param)• retval SystemAddressIsLocalAddress (scalar Self, hash Param)• retval SystemAddressQueueID (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/SystemAddress.pm

5.537 var::packagesetup::SystemMonitoring Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval CodeInstall (scalar Self, hash Param)• retval CodeReinstall (scalar Self, hash Param)• retval CodeUpgrade (scalar Self, hash Param)• retval CodeUpgradeFromLowerThan_2_2_92 (scalar Self, hash Param)• retval CodeUninstall (scalar Self, hash Param)

Protected Functions

• protected retval _CreateDynamicFields (scalar Self, hash Param)• protected retval _GetDynamicFieldsDefinition (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• var/packagesetup/SystemMonitoring.pm

5.538 Kernel::System::PostMaster::Filter::SystemMonitoring ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)• retval GetDynamicFieldsDefinition (scalar class, scalar Self)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 298: doxygen of OTRS cvs Ref Man

294 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _GetDynamicFieldDefinition (scalar Self, scalar Config, scalarKey, scalar Default, scalar Base, scalar Name, scalar ObjectType)

• protected retval _IncidentStateIncident ()• protected retval _IncidentStateOperational ()• protected retval _IncidentStateNew ()• protected retval _MailParse ()• protected retval _LogMessage (scalar Self, scalar MessageText)• protected retval _TicketSearch ()• protected retval _TicketUpdate ()• protected retval _TicketCreate ()• protected retval _TicketDrop ()• protected retval _SetIncidentState (scalar Self, hash Param)• protected retval _LinkTicketWithCI (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/PostMaster/Filter/SystemMonitoring.pm

5.539 Modules::SystemStatsGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• scripts/SystemStatsGeneric.pm

5.540 Text::Diff::Table Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar proto)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 299: doxygen of OTRS cvs Ref Man

5.541 YAML::Tag Class Reference 295

Public Object Methods

• retval hunk (scalar ops, scalar options)• retval file_footer ()

Public Functions

• retval expand_tabs (scalar)• retval trim_trailing_line_ends (scalar)• retval escape ()• retval escape (scalar)

Protected Object Methods

• protected retval _glean_formats ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Text/Diff/Table.pm

5.541 YAML::Tag Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar self)

Public Functions

• retval short ()• retval canonical ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Tag.pm

5.542 Kernel::Scheduler::TaskHandler Class Reference

Classes

• class GenericInterface• class Test

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 300: doxygen of OTRS cvs Ref Man

296 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Scheduler/TaskHandler.pm

5.543 Kernel::System::Scheduler::TaskManager Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar TaskManager, hash Param)

Public Functions

• retval TaskAdd (scalar Self, hash Param)• retval TaskGet (scalar Self, hash Param)• retval TaskDelete (scalar Self, hash Param)• retval TaskList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Scheduler/TaskManager.pm

5.544 URI::telnet Class Reference

Inheritance diagram for URI::telnet:

URI::telnet

URI::_login

URI::_server URI::_userpass

Public Member Functions

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/telnet.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 301: doxygen of OTRS cvs Ref Man

5.545 Proc::PID::File::Temp Class Reference 297

5.545 Proc::PID::File::Temp Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar proto)

Public Object Methods

• retval newdir ()• retval filename ()• retval STRINGIFY ()• retval unlink_on_destroy ()• retval DESTROY ()• retval safe_level (scalar level)• retval top_system_uid (scalar newuid)

Public Functions

• retval cleanup ()• retval tempfile ()• retval tempdir ()• retval mkstemp (scalar template)• retval mkstemps (scalar template, scalar suffix)• retval mkdtemp (scalar template)• retval mktemp (scalar template)• retval tmpnam ()• retval tmpfile ()• retval tempnam (scalar dir, scalar prefix)• retval unlink0 (scalar fh, scalar path)• retval cmpstat (scalar fh, scalar path)• retval unlink1 (scalar fh, scalar path)

Protected Functions

• protected retval _gettemp ()• protected retval _replace_XX (scalar path, scalar ignore)• protected retval _force_writable (scalar file)• protected retval _is_safe (scalar path, scalar err_ref)• protected retval _is_verysafe (scalar path, scalar err_ref)• protected retval _can_unlink_opened_file ()• protected retval _can_do_level (scalar level)• protected retval _deferred_unlink (scalar fh, scalar fname, scalar isdir)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/File/Temp.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 302: doxygen of OTRS cvs Ref Man

298 Class Documentation

5.546 Kernel::System::TemplateGenerator Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Salutation (scalar Self, hash Param)• retval Signature (scalar Self, hash Param)• retval Sender (scalar Self, hash Param)• retval Response (scalar Self, hash Param)• retval Attributes (scalar Self, hash Param)• retval AutoResponse (scalar Self, hash Param)• retval NotificationAgent (scalar Self, hash Param)• retval NotificationCustomer (scalar Self, hash Param)

Protected Functions

• protected retval _Replace (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/TemplateGenerator.pm

5.547 Kernel::GenericInterface::Invoker::Test::Test Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval PrepareRequest (scalar Self, hash Param)• retval HandleResponse (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Invoker/Test/Test.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 303: doxygen of OTRS cvs Ref Man

5.548 Kernel::GenericInterface::Operation::Test::Test Class Reference 299

5.548 Kernel::GenericInterface::Operation::Test::Test Class Refer-ence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation/Test/Test.pm

5.549 Modules::Test Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Modules/Test.pm

5.550 Kernel::Scheduler::TaskHandler::Test Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Scheduler/TaskHandler/Test.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 304: doxygen of OTRS cvs Ref Man

300 Class Documentation

5.551 Kernel::System::Ticket::Event::Test Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/Test.pm

5.552 Kernel::GenericInterface::Mapping::Test Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Map (scalar Self, hash Param)

Protected Functions

• protected retval _ToUpper (scalar Self, hash Param)• protected retval _ToLower (scalar Self, hash Param)• protected retval _Empty (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Mapping/Test.pm

5.553 Kernel::GenericInterface::Transport::HTTP::Test Class Refer-ence

Classes

• class CustomHTTPProtocol

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 305: doxygen of OTRS cvs Ref Man

5.554 TestFieldTypeModule Class Reference 301

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ProviderProcessRequest (scalar Self, hash Param)• retval ProviderGenerateResponse (scalar Self, hash Param)• retval RequesterPerformRequest (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Transport/HTTP/Test.pm

5.554 TestFieldTypeModule Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

The documentation for this class was generated from the following file:

• TestFieldTypeModule.pm

5.555 Mail::Mailer::testfile Class Reference

Inheritance diagram for Mail::Mailer::testfile:

Mail::Mailer::testfile

Mail::Mailer::rfc822

Mail::Mailer

Classes

• class pipe

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 306: doxygen of OTRS cvs Ref Man

302 Class Documentation

Public Member Functions

Public Functions

• retval can_cc ()• retval exec ()• retval close ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Mailer/testfile.pm

5.556 TestPostEventModule Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Functions

• retval Run ()

The documentation for this class was generated from the following file:

• TestPostEventModule.pm

5.557 Kernel::GenericInterface::Invoker::Test::TestSimple Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval PrepareRequest (scalar Self, hash Param)• retval HandleResponse (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Invoker/Test/TestSimple.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 307: doxygen of OTRS cvs Ref Man

5.558 Kernel::System::DynamicField::Backend::Text Class Reference 303

5.558 Kernel::System::DynamicField::Backend::Text Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ValueGet (scalar Self, hash Param)• retval ValueSet (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval SearchSQLGet (scalar Self, hash Param)• retval SearchSQLOrderFieldGet (scalar Self, hash Param)• retval EditFieldRender (scalar Self, hash Param)• retval EditFieldValueGet (scalar Self, hash Param)• retval EditFieldValueValidate (scalar Self, hash Param)• retval DisplayValueRender (scalar Self, hash Param)• retval IsSortable (scalar Self, hash Param)• retval SearchFieldRender (scalar Self, hash Param)• retval SearchFieldValueGet (scalar Self, hash Param)• retval SearchFieldParameterBuild (scalar Self, hash Param)• retval StatsFieldParameterBuild (scalar Self, hash Param)• retval CommonSearchFieldParameterBuild (scalar Self, hash Param)• retval ReadableValueRender (scalar Self, hash Param)• retval TemplateValueTypeGet (scalar Self, hash Param)• retval IsAJAXUpdateable (scalar Self, hash Param)• retval RandomValueSet (scalar Self, hash Param)• retval IsMatchable (scalar Self, hash Param)• retval ObjectMatch (scalar Self, hash Param)• retval AJAXPossibleValuesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend/Text.pm

5.559 Kernel::System::DynamicField::Backend::TextArea Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 308: doxygen of OTRS cvs Ref Man

304 Class Documentation

Public Functions

• retval ValueGet (scalar Self, hash Param)• retval ValueSet (scalar Self, hash Param)• retval ValueValidate (scalar Self, hash Param)• retval SearchSQLGet (scalar Self, hash Param)• retval SearchSQLOrderFieldGet (scalar Self, hash Param)• retval EditFieldRender (scalar Self, hash Param)• retval EditFieldValueGet (scalar Self, hash Param)• retval EditFieldValueValidate (scalar Self, hash Param)• retval DisplayValueRender (scalar Self, hash Param)• retval IsSortable (scalar Self, hash Param)• retval SearchFieldRender (scalar Self, hash Param)• retval SearchFieldValueGet (scalar Self, hash Param)• retval SearchFieldParameterBuild (scalar Self, hash Param)• retval StatsFieldParameterBuild (scalar Self, hash Param)• retval CommonSearchFieldParameterBuild (scalar Self, hash Param)• retval ReadableValueRender (scalar Self, hash Param)• retval TemplateValueTypeGet (scalar Self, hash Param)• retval IsAJAXUpdateable (scalar Self, hash Param)• retval RandomValueSet (scalar Self, hash Param)• retval IsMatchable (scalar Self, hash Param)• retval ObjectMatch (scalar Self, hash Param)• retval AJAXPossibleValuesGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/Backend/TextArea.pm

5.560 TextPatch Class Reference

Public Member Functions

Public Functions

• retval patch (scalar text, scalar diff)• retval patch_unified (scalar text, scalar diff, scalar sep)• retval patch_oldstyle (scalar text, scalar diff, scalar sep)• retval patch_context (scalar text, scalar diff, scalar sep)• retval DUMP ()• retval TRACE ()

Protected Functions

• protected retval _range (scalar range)• protected retval _patch (scalar text, scalar hunks, scalar sep)• protected retval _chomp (scalar text, scalar sep)

The documentation for this class was generated from the following file:

• TextPatch.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 309: doxygen of OTRS cvs Ref Man

5.561 This Class Reference 305

5.561 This Class Reference

5.561.1 Detailed Description

Defines the CKEDITOR.event class, which serves as the base for classes and objectsthat require event handling features.

The documentation for this class was generated from the following file:

• var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/event.js

5.562 Kernel::System::Ticket Class Reference

Inheritance diagram for Kernel::System::Ticket:

Kernel::System::Ticket

Kernel::System::TicketSearch

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval TicketCheckNumber (scalar Self, hash Param)• retval TicketCreate (scalar Self, hash Param)• retval TicketDelete (scalar Self, hash Param)• retval TicketIDLookup (scalar Self, hash Param)• retval TicketNumberLookup (scalar Self, hash Param)• retval TicketSubjectBuild (scalar Self, hash Param)• retval TicketSubjectClean (scalar Self, hash Param)• retval TicketGet (scalar Self, hash Param)• retval TicketTitleUpdate (scalar Self, hash Param)• retval TicketUnlockTimeoutUpdate (scalar Self, hash Param)• retval TicketQueueID (scalar Self, hash Param)• retval TicketMoveList (scalar Self, hash Param)• retval TicketQueueSet (scalar Self, hash Param)• retval TicketMoveQueueList (scalar Self, hash Param)• retval TicketTypeList (scalar Self, hash Param)• retval TicketTypeSet (scalar Self, hash Param)• retval TicketServiceList (scalar Self, hash Param)• retval TicketServiceSet (scalar Self, hash Param)• retval TicketEscalationPreferences (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 310: doxygen of OTRS cvs Ref Man

306 Class Documentation

• retval TicketEscalationDateCalculation (scalar Self, hash Param)• retval TicketEscalationIndexBuild (scalar Self, hash Param)• retval TicketSLAList (scalar Self, hash Param)• retval TicketSLASet (scalar Self, hash Param)• retval TicketCustomerSet (scalar Self, hash Param)• retval TicketFreeTextSet (scalar Self, hash Param)• retval TicketFreeTimeSet (scalar Self, hash Param)• retval TicketPermission (scalar Self, hash Param)• retval TicketCustomerPermission (scalar Self, hash Param)• retval GetSubscribedUserIDsByQueueID (scalar Self, hash Param)• retval TicketPendingTimeSet (scalar Self, hash Param)• retval TicketLockGet (scalar Self, hash Param)• retval TicketLockSet (scalar Self, hash Param)• retval TicketArchiveFlagSet (scalar Self, hash Param)• retval TicketStateSet (scalar Self, hash Param)• retval TicketStateList (scalar Self, hash Param)• retval OwnerCheck (scalar Self, hash Param)• retval TicketOwnerSet (scalar Self, hash Param)• retval TicketOwnerList (scalar Self, hash Param)• retval TicketResponsibleSet (scalar Self, hash Param)• retval TicketResponsibleList (scalar Self, hash Param)• retval TicketInvolvedAgentsList (scalar Self, hash Param)• retval TicketPrioritySet (scalar Self, hash Param)• retval TicketPriorityList (scalar Self, hash Param)• retval HistoryTicketStatusGet (scalar Self, hash Param)• retval HistoryTicketGet (scalar Self, hash Param)• retval HistoryTypeLookup (scalar Self, hash Param)• retval HistoryAdd (scalar Self, hash Param)• retval HistoryGet (scalar Self, hash Param)• retval HistoryDelete (scalar Self, hash Param)• retval TicketAccountedTimeGet (scalar Self, hash Param)• retval TicketAccountTime (scalar Self, hash Param)• retval TicketMerge (scalar Self, hash Param)• retval TicketWatchGet (scalar Self, hash Param)• retval TicketWatchSubscribe (scalar Self, hash Param)• retval TicketWatchUnsubscribe (scalar Self, hash Param)• retval TicketFlagSet (scalar Self, hash Param)• retval TicketFlagDelete (scalar Self, hash Param)• retval TicketFlagGet (scalar Self, hash Param)• retval TicketAcl (scalar Self, hash Param)• retval TicketAclData (scalar Self, hash Param)• retval TicketAclActionData (scalar Self, hash Param)• retval TicketArticleStorageSwitch (scalar Self, hash Param)• retval DESTROY (scalar Self)• retval CustomerPermission (scalar Self)• retval InvolvedAgents (scalar Self)• retval LockIsTicketLocked (scalar Self)• retval LockSet (scalar Self)• retval MoveList (scalar Self)• retval MoveTicket (scalar Self)• retval MoveQueueList (scalar Self)• retval OwnerList (scalar Self)• retval OwnerSet (scalar Self)• retval Permission (scalar Self)• retval PriorityList (scalar Self)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 311: doxygen of OTRS cvs Ref Man

5.563 Kernel::System::Stats::Dynamic::Ticket Class Reference 307

• retval PrioritySet (scalar Self)• retval ResponsibleList (scalar Self)• retval ResponsibleSet (scalar Self)• retval SetCustomerData (scalar Self)• retval StateList (scalar Self)• retval StateSet (scalar Self)• retval EventHandlerTransaction ()

Protected Functions

• protected retval _TicketGetExtended (scalar Self, hash Param)• protected retval _TicketGetFirstResponse (scalar Self, hash Param)• protected retval _TicketGetClosed (scalar Self, hash Param)• protected retval _TicketGetFirstLock (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket.pm

5.563 Kernel::System::Stats::Dynamic::Ticket Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetObjectName (scalar Self, hash Param)• retval GetObjectAttributes (scalar Self, hash Param)• retval GetStatElement (scalar Self, hash Param)• retval ExportWrapper (scalar Self, hash Param)• retval ImportWrapper (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Stats/Dynamic/Ticket.pm

5.564 Kernel::System::LinkObject::Ticket Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 312: doxygen of OTRS cvs Ref Man

308 Class Documentation

Public Functions

• retval LinkListWithData (scalar Self, hash Param)• retval ObjectDescriptionGet (scalar Self, hash Param)• retval ObjectSearch (scalar Self, hash Param)• retval LinkAddPre (scalar Self, hash Param)• retval LinkAddPost (scalar Self, hash Param)• retval LinkDeletePre (scalar Self, hash Param)• retval LinkDeletePost (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/LinkObject/Ticket.pm

5.565 Kernel::System::DynamicField::ObjectType::Ticket Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval PostValueSet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/DynamicField/ObjectType/Ticket.pm

5.566 Kernel::System::Ticket::Event::TicketAcceleratorUpdate ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/TicketAcceleratorUpdate.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 313: doxygen of OTRS cvs Ref Man

5.567 Kernel::System::Stats::Dynamic::TicketAccountedTime Class Reference309

5.567 Kernel::System::Stats::Dynamic::TicketAccountedTime ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetObjectName (scalar Self, hash Param)• retval GetObjectAttributes (scalar Self, hash Param)• retval GetStatTable (scalar Self, hash Param)• retval GetHeaderLine (scalar Self, hash Param)• retval ExportWrapper (scalar Self, hash Param)• retval ImportWrapper (scalar Self, hash Param)

Protected Functions

• protected retval _ReportingValues (scalar Self, hash Param)• protected retval _KindsOfReporting (scalar Self)• protected retval _SortedKindsOfReporting (scalar Self)• protected retval _AllowedTicketSearchAttributes (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Stats/Dynamic/TicketAccountedTime.pm

5.568 Kernel::GenericInterface::Operation::Ticket::TicketCreate ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _CheckTicket (scalar Self, hash Param)• protected retval _CheckArticle (scalar Self, hash Param)• protected retval _CheckDynamicField (scalar Self, hash Param)• protected retval _CheckAttachment (scalar Self, hash Param)• protected retval _TicketCreate (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 314: doxygen of OTRS cvs Ref Man

310 Class Documentation

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation/Ticket/TicketCreate.pm

5.569 Kernel::System::Ticket::Event::TicketDynamicFieldDefault ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/TicketDynamicFieldDefault.pm

5.570 Kernel::System::Ticket::Event::TicketEscalationIndex Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/TicketEscalationIndex.pm

5.571 Kernel::GenericInterface::Operation::Ticket::TicketGet ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 315: doxygen of OTRS cvs Ref Man

5.572 Kernel::System::Stats::Dynamic::TicketList Class Reference 311

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation/Ticket/TicketGet.pm

5.572 Kernel::System::Stats::Dynamic::TicketList Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetObjectName (scalar Self, hash Param)• retval GetObjectAttributes (scalar Self, hash Param)• retval GetStatTable (scalar Self, hash Param)• retval GetHeaderLine (scalar Self, hash Param)• retval ExportWrapper (scalar Self, hash Param)• retval ImportWrapper (scalar Self, hash Param)

Protected Functions

• protected retval _TicketAttributes (scalar Self)• protected retval _SortedAttributes (scalar Self)• protected retval _ExtendedAttributesCheck (scalar Self, hash Param)• protected retval _OrderByIsValueOfTicketSearchSort (scalar Self, hash Param)

• protected retval _IndividualResultOrder (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Stats/Dynamic/TicketList.pm

5.573 Output::HTML::TicketMenuGeneric Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 316: doxygen of OTRS cvs Ref Man

312 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/TicketMenuGeneric.pm

5.574 Output::HTML::TicketMenuLock Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/TicketMenuLock.pm

5.575 Output::HTML::TicketMenuMove Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/TicketMenuMove.pm

5.576 Output::HTML::TicketMenuResponsible Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 317: doxygen of OTRS cvs Ref Man

5.577 Output::HTML::TicketMenuTicketWatcher Class Reference 313

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/TicketMenuResponsible.pm

5.577 Output::HTML::TicketMenuTicketWatcher Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/TicketMenuTicketWatcher.pm

5.578 Kernel::System::Ticket::Event::TicketNewMessageUpdate ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/TicketNewMessageUpdate.pm

5.579 Output::HTML::TicketOverviewMedium Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 318: doxygen of OTRS cvs Ref Man

314 Class Documentation

Public Functions

• retval ActionRow (scalar Self, hash Param)• retval SortOrderBar (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Show (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/TicketOverviewMedium.pm

5.580 Output::HTML::TicketOverviewPreview Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ActionRow (scalar Self, hash Param)• retval SortOrderBar (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _Show (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/TicketOverviewPreview.pm

5.581 Output::HTML::TicketOverviewSmall Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 319: doxygen of OTRS cvs Ref Man

5.582 Kernel::System::Ticket::Event::TicketPendingTimeReset Class Reference315

Public Functions

• retval ActionRow (scalar Self, hash Param)• retval SortOrderBar (scalar Self, hash Param)• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/TicketOverviewSmall.pm

5.582 Kernel::System::Ticket::Event::TicketPendingTimeReset ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/TicketPendingTimeReset.pm

5.583 Kernel::GenericInterface::Operation::Ticket::TicketSearch ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _GetParams (scalar Self, hash Param)• protected retval _GetDynamicFields (scalar Self, hash Param)• protected retval _CreateTimeSettings (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation/Ticket/TicketSearch.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 320: doxygen of OTRS cvs Ref Man

316 Class Documentation

5.584 Kernel::System::TicketSearch Class Reference

Inheritance diagram for Kernel::System::TicketSearch:

Kernel::System::TicketSearch

Kernel::System::Ticket

Public Member Functions

Public Functions

• retval TicketSearch (scalar Self, hash Param)

Protected Functions

• protected retval _InConditionGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/TicketSearch.pm

5.585 Kernel::System::Stats::Dynamic::TicketSolutionResponseTimeClass Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetObjectName (scalar Self, hash Param)• retval GetObjectAttributes (scalar Self, hash Param)• retval GetStatTable (scalar Self, hash Param)• retval GetHeaderLine (scalar Self, hash Param)• retval ExportWrapper (scalar Self, hash Param)• retval ImportWrapper (scalar Self, hash Param)

Protected Functions

• protected retval _ReportingValues (scalar Self, hash Param)• protected retval _GetAverage (scalar Self, hash Param)• protected retval _KindsOfReporting (scalar Self)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 321: doxygen of OTRS cvs Ref Man

5.586 Kernel::GenericInterface::Operation::Ticket::TicketUpdate Class Reference317

• protected retval _SortedKindsOfReporting (scalar Self)• protected retval _AllowedTicketSearchAttributes (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Stats/Dynamic/TicketSolutionResponseTime.pm

5.586 Kernel::GenericInterface::Operation::Ticket::TicketUpdate ClassReference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

Protected Functions

• protected retval _CheckTicket (scalar Self, hash Param)• protected retval _CheckArticle (scalar Self, hash Param)• protected retval _CheckDynamicField (scalar Self, hash Param)• protected retval _CheckAttachment (scalar Self, hash Param)• protected retval _CheckUpdatePermissions (scalar Self, hash Param)• protected retval _TicketUpdate (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Operation/Ticket/TicketUpdate.pm

5.587 Kernel::System::Time Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval SystemTime (scalar Self)• retval SystemTime2TimeStamp (scalar Self, hash Param)• retval CurrentTimestamp (scalar Self, hash Param)• retval SystemTime2Date (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 322: doxygen of OTRS cvs Ref Man

318 Class Documentation

• retval TimeStamp2SystemTime (scalar Self, hash Param)• retval Date2SystemTime (scalar Self, hash Param)• retval MailTimeStamp (scalar Self, hash Param)• retval WorkingTime (scalar Self, hash Param)• retval DestinationTime (scalar Self, hash Param)• retval VacationCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Time.pm

5.588 URI::tn3270 Class Reference

Inheritance diagram for URI::tn3270:

URI::tn3270

URI::_login

URI::_server URI::_userpass

Public Member Functions

Public Functions

• retval default_port ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/tn3270.pm

5.589 Output::HTML::ToolBarLink Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 323: doxygen of OTRS cvs Ref Man

5.590 Output::HTML::ToolBarTicketLocked Class Reference 319

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ToolBarLink.pm

5.590 Output::HTML::ToolBarTicketLocked Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ToolBarTicketLocked.pm

5.591 Output::HTML::ToolBarTicketResponsible Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ToolBarTicketResponsible.pm

5.592 Output::HTML::ToolBarTicketSearchFulltext Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 324: doxygen of OTRS cvs Ref Man

320 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ToolBarTicketSearchFulltext.pm

5.593 Output::HTML::ToolBarTicketSearchProfile Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ToolBarTicketSearchProfile.pm

5.594 Output::HTML::ToolBarTicketWatcher Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/Output/HTML/ToolBarTicketWatcher.pm

5.595 MIME::Tools Class Reference

Inheritance diagram for MIME::Tools:

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 325: doxygen of OTRS cvs Ref Man

5.596 MIME::ToolUtils Class Reference 321

MIME::Tools

MIME::ToolUtils

Public Member Functions

Public Class Methods

• retval config (scalar class)• retval debugging (scalar class, scalar value)• retval quiet (scalar class, scalar value)• retval version (scalar class, scalar value)

Public Functions

• retval debug ()• retval whine ()• retval error ()• retval usage ()• retval textual_type ()• retval tmpopen (scalar args)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Tools.pm

5.596 MIME::ToolUtils Class Reference

Inheritance diagram for MIME::ToolUtils:

MIME::ToolUtils

MIME::Tools

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Tools.pm

5.597 Kernel::GenericInterface::Transport Class Reference

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 326: doxygen of OTRS cvs Ref Man

322 Class Documentation

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ProviderProcessRequest (scalar Self, hash Param)• retval ProviderGenerateResponse (scalar Self, hash Param)• retval RequesterPerformRequest (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/GenericInterface/Transport.pm

5.598 XML::TreePP Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar package)

Public Object Methods

• retval die (scalar mess)• retval warn (scalar mess)• retval set (scalar key, scalar val)• retval get (scalar key)• retval writefile (scalar file, scalar encode)• retval write ()• retval parsehttp ()• retval parsehttp_lwp (scalar body, scalar header)• retval parsehttp_lite (scalar body, scalar header)• retval parsefile (scalar file)• retval parse ()• retval xml_to_flat (scalar textref)• retval flat_to_tree (scalar source, scalar parent, scalar class)• retval hash_to_xml (scalar name, scalar hash)• retval array_to_xml (scalar name, scalar array)• retval scalaref_to_cdata (scalar name, scalar ref)• retval scalar_to_xml (scalar name, scalar scalar)• retval write_raw_xml (scalar file)• retval read_raw_xml (scalar file)• retval encode_from_to ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 327: doxygen of OTRS cvs Ref Man

5.599 Kernel::System::GenericAgent::TriggerEscalationStartEvents ClassReference 323

Public Functions

• retval find_http_module ()• retval load_lwp_useragent ()• retval load_http_lite ()• retval load_tie_ixhash ()• retval looks_like_xml (scalar textref)• retval xml_decl_encoding (scalar textref)• retval load_jcode ()• retval load_encode ()• retval latin1_to_utf8 (scalar strref)• retval get_jcode_name (scalar src)• retval xml_escape (scalar str)• retval xml_unescape (scalar str)• retval xml_deref_octet (scalar str)• retval xml_deref_string (scalar str)• retval code_to_ascii (scalar code)• retval code_to_utf8 (scalar code)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/XML/TreePP.pm

5.599 Kernel::System::GenericAgent::TriggerEscalationStartEventsClass Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericAgent/TriggerEscalationStartEvents.pm

5.600 Kernel::System::Ticket::Event::TriggerEscalationStopEventsClass Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 328: doxygen of OTRS cvs Ref Man

324 Class Documentation

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Event/TriggerEscalationStopEvents.pm

5.601 Kernel::System::Type Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval TypeAdd (scalar Self, hash Param)• retval TypeGet (scalar Self, hash Param)• retval TypeUpdate (scalar Self, hash Param)• retval TypeList (scalar Self, hash Param)• retval TypeLookup (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Type.pm

5.602 YAML::Types Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Types.pm

5.603 Type::undef Class Reference

Public Member Functions

Public Object Methods

• retval yaml_dump ()• retval yaml_load ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Types.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 329: doxygen of OTRS cvs Ref Man

5.604 Kernel::System::UnitTest Class Reference 325

5.604 Kernel::System::UnitTest Class Reference

Classes

• class Helper• class Selenium

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)• retval True (scalar Self, scalar True, scalar Name)• retval False (scalar Self, scalar False, scalar Name)• retval Is (scalar Self, scalar Test, scalar ShouldBe, scalar Name)• retval IsNot (scalar Self, scalar Test, scalar ShouldBe, scalar Name)• retval IsDeeply (scalar Self, scalar Test, scalar ShouldBe, scalar Name)• retval IsNotDeeply (scalar Self, scalar Test, scalar ShouldBe, scalar Name)• retval DESTROY (scalar Self)

Protected Functions

• protected retval _DataDiff (scalar Self, hash Param)• protected retval _PrintSummary (scalar Self, hash ResultSummary)• protected retval _PrintHeadlineStart (scalar Self, scalar Name)• protected retval _PrintHeadlineEnd (scalar Self, scalar Name)• protected retval _Print (scalar Self, scalar Test, scalar Name)

The documentation for this class was generated from the following file:

• Kernel/System/UnitTest.pm

5.605 file::Unix Class Reference

Public Member Functions

Public Class Methods

• retval file (scalar class, scalar uri)

Protected Class Methods

• protected retval _file_extract_path (scalar class, scalar path)• protected retval _file_is_absolute (scalar class, scalar path)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/file/Unix.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 330: doxygen of OTRS cvs Ref Man

326 Class Documentation

5.606 Kernel::System::Web::UploadCache Class Reference

Classes

• class DB• class FS

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval FormIDCreate (scalar Self)• retval FormIDRemove (scalar Self)• retval FormIDAddFile (scalar Self)• retval FormIDRemoveFile (scalar Self)• retval FormIDGetAllFilesData (scalar Self)• retval FormIDGetAllFilesMeta (scalar Self)• retval FormIDCleanUp (scalar Self)

The documentation for this class was generated from the following file:

• Kernel/System/Web/UploadCache.pm

5.607 URI Class Reference

Classes

• class _foreign• class _generic• class _ldap• class _login• class _punycode• class _query• class _segment• class _server• class _userpass• class data• class Escape• class file• class ftp• class gopher• class http

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 331: doxygen of OTRS cvs Ref Man

5.607 URI Class Reference 327

• class https

• class IRI

• class ldap

• class ldapi

• class ldaps

• class mailto

• class mms

• class news

• class nntp

• class pop

• class QueryParam

• class rlogin

• class rsync

• class rtsp

• class rtspu

• class sip

• class sips

• class snews

• class Split

• class ssh

• class telnet

• class tn3270

• class URL

• class urn

• class WithBase

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar uri, scalar scheme)• retval new_abs (scalar class, scalar uri, scalar base)

Public Object Methods

• retval clone ()• retval scheme ()• retval opaque ()• retval fragment ()• retval as_string ()• retval as_iri ()• retval canonical ()• retval eq (scalar other)• retval STORABLE_freeze (scalar cloning)• retval STORABLE_thaw (scalar cloning, scalar str)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 332: doxygen of OTRS cvs Ref Man

328 Class Documentation

Public Functions

• retval implementor (scalar scheme, scalar impclass)• retval abs ()• retval rel ()• retval secure ()

Protected Class Methods

• protected retval _uric_escape (scalar class, scalar str)• protected retval _init_implementor (scalar class, scalar scheme)

Protected Object Methods

• protected retval _scheme ()

Protected Functions

• protected retval _obj_eq ()• protected retval _init (scalar str, scalar scheme)• protected retval _no_scheme_ok ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI.pm

5.608 URI::URL Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class)• retval newlocal (scalar class)

Public Object Methods

• retval print_on ()• retval crack ()• retval full_path ()• retval netloc ()• retval eparams ()• retval params (scalar self)• retval path ()• retval path_components ()• retval query ()• retval abs (scalar base, scalar allow_scheme)• retval frag (scalar self)• retval keywords ()• retval unix_path (scalar self, scalar self, scalar self, scalar self, scalar self,

scalar self, scalar self, scalar self)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 333: doxygen of OTRS cvs Ref Man

5.609 URI::urn Class Reference 329

• retval dos_path (scalar self, scalar self, scalar self, scalar self, scalar self,scalar self, scalar self)

• retval mac_path (scalar self, scalar self, scalar self, scalar self, scalar self,scalar self)

• retval vms_path (scalar self, scalar self, scalar self, scalar self, scalar self)• retval address (scalar self, scalar self, scalar self, scalar self)• retval encoded822addr (scalar self, scalar self, scalar self)• retval URI::mailto::authority (scalar self, scalar self)• retval groupart (scalar self)• retval article ()

Public Functions

• retval url (scalar;scalar)• retval strict ()• retval epath ()• retval local_path ()

Protected Class Methods

• protected retval _init (scalar class)

Protected Object Methods

• protected retval _try (scalar method)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/URL.pm

5.609 URI::urn Class Reference

Public Member Functions

Public Object Methods

• retval nid ()• retval nss (scalar new)• retval canonical ()

Protected Class Methods

• protected retval _init (scalar class)• protected retval _urn_init (scalar class, scalar self, scalar nid)

Protected Object Methods

• protected retval _nid (scalar new)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/urn.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 334: doxygen of OTRS cvs Ref Man

330 Class Documentation

5.610 MIME::WordDecoder::US ASCII Class Reference

Inheritance diagram for MIME::WordDecoder::US_ASCII:

MIME::WordDecoder::US_ASCII

MIME::WordDecoder::ISO_8859

MIME::WordDecoder

Public Member Functions

Public Class Methods

• retval new (scalar class)

Public Object Methods

• retval decode ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/WordDecoder.pm

5.611 Kernel::System::User Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval GetUserData (scalar Self, hash Param)• retval UserAdd (scalar Self, hash Param)• retval UserUpdate (scalar Self, hash Param)• retval UserSearch (scalar Self, hash Param)• retval SetPassword (scalar Self, hash Param)• retval UserLookup (scalar Self, hash Param)• retval UserName (scalar Self, hash Param)• retval UserList (scalar Self, hash Param)• retval GenerateRandomPassword (scalar Self, hash Param)• retval SetPreferences (scalar Self, hash Param)• retval GetPreferences (scalar Self, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 335: doxygen of OTRS cvs Ref Man

5.612 LWP::UserAgent Class Reference 331

• retval SearchPreferences (scalar Self)• retval TokenGenerate (scalar Self, hash Param)• retval TokenCheck (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/User.pm

5.612 LWP::UserAgent Class Reference

Inheritance diagram for LWP::UserAgent:

LWP::UserAgent

LWP::MemberMixin

LWP::RobotUA

Public Member Functions

Public Class Methods

• retval new (scalar class, hash cnf)

Public Object Methods

• retval send_request (scalar request, scalar arg, scalar size)• retval prepare_request (scalar request)• retval simple_request (scalar request, scalar arg, scalar size)• retval request (scalar request, scalar arg, scalar size, scalar previous)• retval get (list parameters)• retval post (list parameters)• retval head (list parameters)• retval progress (scalar status, scalar m)• retval is_protocol_supported (scalar scheme)• retval protocols_allowed (scalar new_request, scalar response)• retval protocols_forbidden (scalar new_request, scalar response)• retval requests_redirectable (scalar new_request, scalar response)• retval redirect_ok (scalar new_request, scalar response)• retval credentials ()• retval get_basic_credentials (scalar realm, scalar uri, scalar proxy)• retval timeout (scalar self, scalar self, scalar self, scalar self, scalar self, scalar

k)• retval local_address (scalar self, scalar self, scalar self, scalar self, scalar k)• retval max_size (scalar self, scalar self, scalar self, scalar k)• retval max_redirect (scalar self, scalar self, scalar k)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 336: doxygen of OTRS cvs Ref Man

332 Class Documentation

• retval show_progress (scalar self, scalar k)• retval ssl_opts (scalar k)• retval cookie_jar ()• retval default_headers ()• retval default_header ()• retval agent (scalar agent)• retval from ()• retval conn_cache ()• retval add_handler (scalar phase, scalar cb, hash spec)• retval set_my_handler (scalar phase, scalar cb, hash spec)• retval get_my_handler (scalar phase)• retval remove_handler (scalar phase, hash spec)• retval handlers (scalar phase, scalar o)• retval run_handlers (scalar phase, scalar o)• retval use_eval ()• retval clone ()• retval mirror (scalar url, scalar file)• retval proxy (scalar key)• retval env_proxy ()• retval no_proxy (list no)

Public Functions

• retval parse_head (scalar response, scalar ua)• retval use_alarm ()

Protected Object Methods

• protected retval _process_colonic_headers (scalar args, scalar start_index)

Protected Functions

• protected retval _agent ()• protected retval _need_proxy (scalar req, scalar ua)• protected retval _new_response (scalar request, scalar code, scalar mes-

sage, scalar content)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/LWP/UserAgent.pm

5.613 HTTP::Headers::Util Class Reference

Public Member Functions

Public Functions

• retval split_header_words ()• retval join_header_words ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 337: doxygen of OTRS cvs Ref Man

5.614 CGI::Util Class Reference 333

Protected Functions

• protected retval _split_header_words (list val)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/HTTP/Headers/Util.pm

5.614 CGI::Util Class Reference

Public Member Functions

Public Functions

• retval rearrange (scalar order, list param)• retval rearrange_header (scalar order, list param)• retval make_attributes (scalar attr, scalar do_not_quote)• retval simple_escape ()• retval utf8_chr ()• retval unescape (scalar todecode)• retval escape (scalar toencode)• retval expires (scalar time, scalar format)• retval expire_calc (scalar time)• retval ebcdic2ascii (scalar data)• retval ascii2ebcdic (scalar data)

Protected Functions

• protected retval _rearrange_params (scalar order, list param)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/CGI/Util.pm

5.615 Mail::Util Class Reference

Public Member Functions

Public Functions

• retval Version ()• retval read_mbox ()• retval maildomain ()• retval mailaddress ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/Mail/Util.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 338: doxygen of OTRS cvs Ref Man

334 Class Documentation

5.616 HTTP::SOAP::Lite::Utils Class Reference

Public Member Functions

Public Functions

• retval import ()

Protected Class Methods

• protected retval __mk_accessors (scalar class, list method_from)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/SOAP/Lite/Utils.pm

5.617 MIME::Decoder::UU Class Reference

Inheritance diagram for MIME::Decoder::UU:

MIME::Decoder::UU

MIME::Decoder

Public Member Functions

Public Object Methods

• retval decode_it (scalar in, scalar out)• retval encode_it (scalar in, scalar out)• retval last_preamble ()

Public Functions

• retval last_mode ()• retval last_filename ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Decoder/UU.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 339: doxygen of OTRS cvs Ref Man

5.618 Kernel::System::Valid Class Reference 335

5.618 Kernel::System::Valid Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval ValidList (scalar Self, hash Param)• retval ValidLookup (scalar Self, hash Param)• retval ValidIDsGet (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Valid.pm

5.619 Kernel::System::VariableCheck Class Reference

Public Member Functions

Public Functions

• retval IsString (scalar TestData)• retval IsStringWithData (scalar TestData)• retval IsArrayRefWithData (scalar TestData)• retval IsHashRefWithData (scalar TestData)• retval IsNumber (scalar TestData)• retval IsInteger (scalar TestData)• retval IsPositiveInteger (scalar TestData)• retval IsIPv4Address (scalar TestData)• retval IsIPv6Address (scalar TestData)• retval IsMD5Sum (scalar TestData)• retval DataIsDifferent (hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/VariableCheck.pm

5.620 Virtual Class Reference

5.620.1 Detailed Description

illustrates the features of command objects to be passed to the CKEDITOR.editor.prototype.addCommandfunction.

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 340: doxygen of OTRS cvs Ref Man

336 Class Documentation

Defines the "virtual" CKEDITOR.eventInfo class, which contains the defintions of theevent object passed to event listeners. This file is for documentation purposes only. (Vir-tual Class) Do not call this constructor. This class is not really part of the API. illustratesthe features of the event object to be passed to event listeners by a CKEDITOR.eventbased object.

The documentation for this class was generated from the following file:

• var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/commanddefinition.js

5.621 Kernel::System::VirtualFS Class Reference

Classes

• class DB

• class FS

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Read (scalar Self, hash Param)• retval Write (scalar Self, hash Param)• retval Delete (scalar Self, hash Param)• retval Find (scalar Self, hash Param)

Protected Functions

• protected retval _FileLookup (scalar Self, scalar Filename)

The documentation for this class was generated from the following file:

• Kernel/System/VirtualFS.pm

5.622 YAML::Warning Class Reference

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML/Error.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 341: doxygen of OTRS cvs Ref Man

5.623 Kernel::System::Ticket::Permission::WatcherCheck Class Reference 337

5.623 Kernel::System::Ticket::Permission::WatcherCheck Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/Ticket/Permission/WatcherCheck.pm

5.624 Kernel::System::GenericInterface::Webservice Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Webservice, hash Param)

Public Functions

• retval WebserviceAdd (scalar Self, hash Param)• retval WebserviceGet (scalar Self, hash Param)• retval WebserviceUpdate (scalar Self, hash Param)• retval WebserviceDelete (scalar Self, hash Param)• retval WebserviceList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericInterface/Webservice.pm

5.625 Kernel::System::GenericInterface::WebserviceHistory Class Ref-erence

Public Member Functions

Public Class Methods

• retval new (scalar WebserviceHistory, hash Param)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 342: doxygen of OTRS cvs Ref Man

338 Class Documentation

Public Functions

• retval WebserviceHistoryAdd (scalar Self, hash Param)• retval WebserviceHistoryGet (scalar Self, hash Param)• retval WebserviceHistoryUpdate (scalar Self, hash Param)• retval WebserviceHistoryDelete (scalar Self, hash Param)• retval WebserviceHistoryList (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/GenericInterface/WebserviceHistory.pm

5.626 Kernel::System::WebUserAgent Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Request (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/WebUserAgent.pm

5.627 file::Win32 Class Reference

Public Member Functions

Public Class Methods

• retval file (scalar class, scalar uri)

Public Functions

• retval fix_path ()

Protected Class Methods

• protected retval _file_extract_authority (scalar class)• protected retval _file_extract_path (scalar class, scalar path)• protected retval _file_is_absolute (scalar class, scalar path)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/file/Win32.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 343: doxygen of OTRS cvs Ref Man

5.628 URI::WithBase Class Reference 339

5.628 URI::WithBase Class Reference

Public Member Functions

Public Class Methods

• retval as_string (scalar class, scalar uri, scalar base)• retval new (scalar class, scalar uri, scalar base)• retval new_abs (scalar class)

Public Object Methods

• retval eq (scalar other)• retval AUTOLOAD ()• retval can ()• retval base (scalar new_base)• retval clone ()• retval abs ()• retval rel ()

Protected Functions

• protected retval _init (scalar str, scalar scheme)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/URI/WithBase.pm

5.629 MIME::WordDecoder Class Reference

Inheritance diagram for MIME::WordDecoder:

MIME::WordDecoder

MIME::WordDecoder::ISO_8859

MIME::WordDecoder::US_ASCII

Classes

• class ISO_8859

• class US_ASCII

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 344: doxygen of OTRS cvs Ref Man

340 Class Documentation

Public Member Functions

Public Class Methods

• retval default (scalar class)• retval supported (scalar class, scalar charset, scalar decoder)• retval new (scalar class, scalar h)

Public Object Methods

• retval handler (scalar c, scalar sub)• retval decode (scalar str)• retval real_handler (scalar sub)

Public Functions

• retval keep7bit (scalar _)• retval guess_handler ()• retval unmime (scalar)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/WordDecoder.pm

5.630 MIME::Words Class Reference

Public Member Functions

Public Functions

• retval decode_mimewords (scalar encstr)• retval encode_mimeword (scalar word)• retval encode_mimewords (scalar rawstr, hash params)

Protected Functions

• protected retval _decode_Q (scalar str)• protected retval _encode_Q (scalar str)• protected retval _decode_B (scalar str)• protected retval _encode_B (scalar str)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/MIME/Words.pm

5.631 IO::Wrap Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar class, scalar stream)

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 345: doxygen of OTRS cvs Ref Man

5.632 IO::WrapTie Class Reference 341

Public Object Methods

• retval close ()• retval getline ()• retval getlines ()• retval print ()• retval read ()• retval seek ()• retval tell ()

Public Functions

• retval wraphandle (scalar raw)• retval do_stuff (scalar fh)

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/IO/Wrap.pm

5.632 IO::WrapTie Class Reference

Inheritance diagram for IO::WrapTie:

IO::WrapTie

IO::WrapTie::Slave

Classes

• class Master

• class Slave

Public Member Functions

Public Class Methods

• retval new ()

Public Functions

• retval wraptie ()• retval nope ()

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 346: doxygen of OTRS cvs Ref Man

342 Class Documentation

Public Object Methods

• retval nope ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/IO/WrapTie.pm

5.633 Kernel::System::XML Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval XMLHashAdd (scalar Self, hash Param)• retval XMLHashUpdate (scalar Self, hash Param)• retval XMLHashGet (scalar Self, hash Param)• retval XMLHashDelete (scalar Self, hash Param)• retval XMLHashMove (scalar Self, hash Param)• retval XMLHashSearch (scalar Self, hash Param)• retval XMLHashList (scalar Self, hash Param)• retval XMLHash2XML (scalar Self, list XMLHash)• retval XMLParse2XMLHash (scalar Self, hash Param)• retval XMLHash2D (scalar Self, hash Param)• retval XMLStructure2XMLHash (scalar Self, hash Param)• retval XMLParse (scalar Self, hash Param)

Protected Functions

• protected retval _XMLHashAddAutoIncrement (scalar Self, hash Param)• protected retval _ElementBuild (scalar Self, hash Param)• protected retval _XMLHash2D (scalar Self, hash Param)• protected retval _XMLStructure2XMLHash (scalar Self, hash Param)• protected retval _Decode (scalar Self, scalar A)• protected retval _HS (scalar Self, scalar Expat, scalar Element, hash Attr)• protected retval _CS (scalar Self, scalar Expat, scalar Element, scalar I, scalar

II)• protected retval _ES (scalar Self, scalar Expat, scalar Element)

The documentation for this class was generated from the following file:

• Kernel/System/XML.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 347: doxygen of OTRS cvs Ref Man

5.634 Kernel::System::XMLMaster Class Reference 343

5.634 Kernel::System::XMLMaster Class Reference

Public Member Functions

Public Class Methods

• retval new (scalar Type, hash Param)

Public Functions

• retval Run (scalar Self, hash Param)

The documentation for this class was generated from the following file:

• Kernel/System/XMLMaster.pm

5.635 JSON::Backend::XS Class Reference

Classes

• class Supportable

Public Member Functions

Public Class Methods

• retval support_by_pp (scalar class, list methods)

Public Functions

• retval init ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/JSON.pm

5.636 YAML Class Reference

Classes

• class Base• class Dumper• class Error• class Loader• class Marshall

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 348: doxygen of OTRS cvs Ref Man

344 Class Documentation

• class Mo• class Tag• class Types• class Warning

Public Member Functions

Public Object Methods

• retval init_action_object ()

Public Functions

• retval Dump ()• retval Load ()• retval DumpFile (scalar filename)• retval LoadFile (scalar filename)• retval Bless ()• retval Blessed ()• retval global_object ()

The documentation for this class was generated from the following file:

• Kernel/cpan-lib/YAML.pm

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 349: doxygen of OTRS cvs Ref Man

Chapter 6

Example Documentation

6.1 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/adapters/jquery.js

jQuery adapter provides easy use of basic CKEditor functions and access to internalAPI. It also integrates some aspects of CKEditor with jQuery framework.

Every TEXTAREA, DIV and P elements can be converted to working editor.

Plugin exposes some of editor’s event to jQuery event system. All of those are names-paces inside ".ckeditor" namespace and can be binded/listened on supported textarea,div and p nodes.

Available jQuery events:

• instanceReady.ckeditor( editor, rootNode ) Triggered when new instance is ready.

• destroy.ckeditor( editor ) Triggered when instance is destroyed.

• getData.ckeditor( editor, eventData ) Triggered when getData event is fired insideeditor. It can change returned data using eventData reference.

• setData.ckeditor( editor ) Triggered when getData event is fired inside editor.

<script src="jquery.js"></script><script src="ckeditor.js"></script><script src="adapters/jquery/adapter.js"></script>

6.2 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/ bootstrap.js

if ( CKEDITOR.env.hc ) alert( ’You’re running on High Contrast mode. The editor inter-face will get adapted to provide you a better experience.’ );

Page 350: doxygen of OTRS cvs Ref Man

346 Example Documentation

6.3 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/ckeditor.js

Holds references to all editor instances created. The name of the properties in thisobject correspond to instance names, and their values contains the CKEDITOR.editorobject representing them. {Object}

alert( CKEDITOR.instances.editor1.name ); // "editor1"

6.4 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/ckeditor base.js

6.5 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/ckeditor basic.js

Contains the second part of the CKEDITOR object definition, which defines the basiceditor features to be available in the root ckeditor_basic.js file. Forces the full CKEditorcore code, in the case only the basic code has been loaded (ckeditor_basic.js). Thismethod self-destroys (becomes undefined) in the first call or as soon as the full code isavailable.

// Check if the full core code has been loaded and load it. if ( CKEDITOR.loadFullCore) CKEDITOR.loadFullCore();

6.6 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/command.js

var command = new CKEDITOR.command( editor, { exec : function( editor ) { alert(editor.document.getBody().getHtml() ); } });

6.7 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/commanddefinition.js

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 351: doxygen of OTRS cvs Ref Man

6.12/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/dom/domobject.js 3476.8 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/core/config.js

config.useComputedState = false;

6.9 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dataprocessor.js

6.10 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom.js

6.11 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/document.js

Defines the CKEDITOR.dom.document class, which represents a DOM document. Rep-resents a DOM document. CKEDITOR.dom.domObject

Parameters{Object} domDocument A native DOM document.

var document = new CKEDITOR.dom.document( document );

6.12 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/domobject.js

Defines the CKEDITOR.editor class, which is the base for other classes representingDOM objects. Represents a DOM object. This class is not intended to be used directly.It serves as the base class for other classes representing specific DOM objects.

Parameters{Object} nativeDomObject A native DOM object. CKEDITOR.event

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 352: doxygen of OTRS cvs Ref Man

348 Example Documentation

6.13 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/element.js

Defines the CKEDITOR.dom.element class, which represents a DOM element. Repre-sents a DOM element. CKEDITOR.dom.node

Parameters

{Object|String}element A native DOM element or the element name for new elements.

{CKEDI-TOR.dom.document}

[ownerDocument] The document that will contain the element in case of el-ement creation.

// Create a new <span> element. var element = new CKEDITOR.dom.element( ’span’);

6.14 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/event.js

Defines the CKEDITOR.dom.event class, which represents the a native DOM eventobject. Represents a native DOM event object.

Parameters{Object} domEvent A native DOM event object.

6.15 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/node.js

Defines the CKEDITOR.dom.node class which is the base class for classes that repre-sent DOM nodes. Base class for classes representing DOM nodes. This constructormay return an instance of a class that inherits from this class, like CKEDITOR.dom.elementor CKEDITOR.dom.text. CKEDITOR.dom.domObject

Parameters{Object} domNode A native DOM node.

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 353: doxygen of OTRS cvs Ref Man

6.18/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/dom/text.js 349See also

CKEDITOR.dom.elementCKEDITOR.dom.text

6.16 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/range.js

// Create a range for the entire contents of the editor document body. var range = newCKEDITOR.dom.range( editor.document ); range.selectNodeContents( editor.document.getBody()); // Delete the contents. range.deleteContents();

6.17 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/rangelist.js

6.18 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/text.js

Defines the CKEDITOR.dom.text class, which represents a DOM text node. Representsa DOM text node. CKEDITOR.dom.node

Parameters

{Object|String}text A native DOM text node or a string containing the text to use to create anew text node.

{CKEDI-TOR.dom.document}

[ownerDocument] The document that will contain the node in case of newnode creation. Defaults to the current document.

var nativeNode = document.createTextNode( ’Example’ ); var text = CKEDITOR.dom.text(nativeNode );

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 354: doxygen of OTRS cvs Ref Man

350 Example Documentation

6.19 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dom/window.js

Defines the CKEDITOR.dom.document class, which represents a DOM document. Rep-resents a DOM window. CKEDITOR.dom.domObject

Parameters{Object} domWindow A native DOM window.

var document = new CKEDITOR.dom.window( window );

6.20 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/dtd.js

// Check if "div" can be contained in a "p" element. alert( !!CKEDITOR.dtd[ ’p’ ][ ’div’ ] );"false"

6.21 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/editor.js

config.htmlEncodeOutput = true;

6.22 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/editor basic.js

No element is linked to the editor instance.

6.23 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/env.js

CKEDITOR.env

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 355: doxygen of OTRS cvs Ref Man

6.24/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/core/event.js 351Indicates that CKEditor is running on Internet Explorer. Boolean

if ( CKEDITOR.env.ie ) alert( "I’m on IE!" );

6.24 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/event.js

6.25 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/eventInfo.js

// Do not do this. var myEvent = new CKEDITOR.eventInfo(); // Error: CKEDITOR.eventInfois undefined

6.26 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/focusmanager.js

var focusManager = new CKEDITOR.focusManager( editor ); focusManager.focus();

6.27 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/htmlparser.js

var parser = new CKEDITOR.htmlParser(); parser.onTagOpen = function( tagName, at-tributes, selfClosing ) { alert( tagName ); }; parser.parse( ’<p>Some <b>text</b>.</p>’);

6.28 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/htmlparser/comment.js

A lightweight representation of an HTML comment.

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 356: doxygen of OTRS cvs Ref Man

352 Example Documentation

6.29 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/htmlparser/element.js

A lightweight representation of an HTML element.

Parameters{String} name The element name.{Object} attributes And object holding all attributes defined for this element.

6.30 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/htmlparser/fragment.js

A lightweight representation of an HTML DOM structure.

6.31 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/loader.js

6.32 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/plugindefinition.js

6.33 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/plugins.js

6.34 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/resourcemanager.js

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 357: doxygen of OTRS cvs Ref Man

6.39/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/lang/af.js 3536.35 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/core/scriptloader.js

6.36 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/skins.js

6.37 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/themes.js

6.38 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/core/ui.js

Contains UI features related to an editor instance.

Parameters{CKEDI-

TOR.editor}editor The editor instance.

6.39 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/af.js

Defines the CKEDITOR.lang object, for the Afrikaans language.#@+ String

6.40 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/ar.js

Defines the CKEDITOR.lang object, for the Arabic language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 358: doxygen of OTRS cvs Ref Man

354 Example Documentation

6.41 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/bg.js

Defines the CKEDITOR.lang object, for the Bulgarian language.#@+ String

6.42 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/bn.js

Defines the CKEDITOR.lang object, for the Bengali/Bangla language.#@+ String

6.43 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/bs.js

Defines the CKEDITOR.lang object, for the Bosnian language.#@+ String

6.44 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/ca.js

Defines the CKEDITOR.lang object, for the Catalan language.#@+ String

6.45 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/cs.js

Defines the CKEDITOR.lang object, for the Czech language.#@+ String

6.46 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/cy.js

Defines the CKEDITOR.lang object, for the Welsh language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 359: doxygen of OTRS cvs Ref Man

6.47/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/lang/da.js 355

6.47 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/da.js

Defines the CKEDITOR.lang object, for the Danish language.#@+ String

6.48 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/de.js

Defines the CKEDITOR.lang object, for the German language.#@+ String

6.49 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/el.js

Defines the CKEDITOR.lang object, for the Greek language.#@+ String

6.50 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/en-au.js

Defines the CKEDITOR.lang object, for the English (Australia) language.#@+ String

6.51 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/en-ca.js

Defines the CKEDITOR.lang object, for the English (Canadian) language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 360: doxygen of OTRS cvs Ref Man

356 Example Documentation

6.52 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/en-gb.js

Defines the CKEDITOR.lang object, for the English (United Kingdom) language.#@+String

6.53 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/en.js

Defines the CKEDITOR.lang object for the English language. This is the base file for alltranslations.#@+ String

6.54 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/eo.js

Defines the CKEDITOR.lang object, for the Esperanto language.#@+ String

6.55 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/es.js

Defines the CKEDITOR.lang object, for the Spanish language.#@+ String

6.56 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/et.js

Defines the CKEDITOR.lang object, for the Estonian language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 361: doxygen of OTRS cvs Ref Man

6.57/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/lang/eu.js 3576.57 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/lang/eu.js

Defines the CKEDITOR.lang object, for the Basque language.#@+ String

6.58 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/fa.js

Defines the CKEDITOR.lang object for the Persian language.#@+ String

6.59 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/fi.js

Defines the CKEDITOR.lang object for the Finnish language.#@+ String

6.60 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/fo.js

Defines the CKEDITOR.lang object, for the Faroese language.#@+ String

6.61 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/fr-ca.js

Defines the CKEDITOR.lang object, for the Canadian French language.#@+ String

6.62 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/fr.js

Defines the CKEDITOR.lang object, for the French language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 362: doxygen of OTRS cvs Ref Man

358 Example Documentation

6.63 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/gl.js

Defines the CKEDITOR.lang object, for the Galician language.#@+ String

6.64 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/gu.js

Defines the CKEDITOR.lang object, for the Gujarati language.#@+ String

6.65 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/he.js

Defines the CKEDITOR.lang object, for the Hebrew language.#@+ String

6.66 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/hi.js

Defines the CKEDITOR.lang object, for the Hindi language.#@+ String

6.67 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/hr.js

Defines the CKEDITOR.lang object, for the Croatian language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 363: doxygen of OTRS cvs Ref Man

6.68/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/lang/hu.js 3596.68 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/lang/hu.js

Defines the CKEDITOR.lang object, for the Hungarian language.#@+ String

6.69 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/is.js

Defines the CKEDITOR.lang object, for the Icelandic language.#@+ String

6.70 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/it.js

Defines the CKEDITOR.lang object, for the Italian language.#@+ String

6.71 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/ja.js

Defines the CKEDITOR.lang object, for the Japanese language.#@+ String

6.72 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/ka.js

Defines the CKEDITOR.lang object, for the Georgian language.#@+ String

6.73 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/km.js

Defines the CKEDITOR.lang object, for the Khmer language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 364: doxygen of OTRS cvs Ref Man

360 Example Documentation

6.74 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/ko.js

Defines the CKEDITOR.lang object, for the Korean language.#@+ String

6.75 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/lt.js

Defines the CKEDITOR.lang object for the Lithuanian language.#@+ String

6.76 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/lv.js

Defines the CKEDITOR.lang object, for the Latvian language.#@+ String

6.77 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/mn.js

Defines the CKEDITOR.lang object, for the Mongolian language.#@+ String

6.78 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/ms.js

Defines the CKEDITOR.lang object, for the Malay language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 365: doxygen of OTRS cvs Ref Man

6.79/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/lang/nb.js 3616.79 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/lang/nb.js

Defines the CKEDITOR.lang object, for the Norwegian Bokmål language.#@+ String

6.80 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/nl.js

Defines the CKEDITOR.lang object for the Dutch language.#@+ String

6.81 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/no.js

Defines the CKEDITOR.lang object, for the Norwegian language.#@+ String

6.82 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/pl.js

Defines the CKEDITOR.lang object for the Polish language.#@+ String

6.83 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/pt-br.js

#@+ String

6.84 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/pt.js

Defines the CKEDITOR.lang object, for the Portuguese language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 366: doxygen of OTRS cvs Ref Man

362 Example Documentation

6.85 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/ro.js

Defines the CKEDITOR.lang object, for the Romanian language.#@+ String

6.86 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/ru.js

Defines the CKEDITOR.lang object for the Russian language.#@+ String

6.87 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/sk.js

Defines the CKEDITOR.lang object, for the Slovak language.#@+ String

6.88 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/sl.js

Defines the CKEDITOR.lang object, for the Slovenian language.#@+ String

6.89 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/sr-latn.js

Defines the CKEDITOR.lang object, for the Serbian (Latin) language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 367: doxygen of OTRS cvs Ref Man

6.90/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/lang/sr.js 3636.90 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/lang/sr.js

Defines the CKEDITOR.lang object, for the Serbian (Cyrillic) language.#@+ String

6.91 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/sv.js

#@+ String

6.92 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/th.js

Defines the CKEDITOR.lang object, for the Thai language.#@+ String

6.93 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/tr.js

#@+ String

6.94 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/uk.js

Defines the CKEDITOR.lang object, for the Ukrainian language.#@+ String

6.95 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/vi.js

Defines the CKEDITOR.lang object, for the Vietnamese language.#@+ String

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 368: doxygen of OTRS cvs Ref Man

364 Example Documentation

6.96 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/zh-cn.js

Defines the CKEDITOR.lang object, for the Chinese Simplified language.#@+ String

6.97 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/lang/zh.js

Defines the CKEDITOR.lang object, for the Chinese Traditional language.#@+ String

6.98 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/autogrow/plugin.js

config.autoGrow_minHeight = 300;

6.99 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/basicstyles/plugin.js

The style definition that applies the bold style to the text. Object { element :’strong’, overrides : ’b’ }

config.coreStyles_bold = { element : ’b’, overrides : ’strong’ };

6.100 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/button/plugin.js

Button UI element.

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 369: doxygen of OTRS cvs Ref Man

6.101/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/plugins/colorbutton/plugin.js 3656.101 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/plugins/colorbutton/plugin.js

config.colorButton_enableMore = false;

6.102 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/contextmenu/plugin.js

config.browserContextMenuOnCtrl = false;

6.103 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/devtools/plugin.js

// This is actually the default value. // Show dialog window name, tab ID, and ele-ment ID. config.devtools_textCallback = function( editor, dialog, element, tabName ) {var lang = editor.lang.devTools, link = ’’ + ( element ? element.type :’content’ ) + ’’, str = ’

’ + lang.title + ’

’ + ’

+ ’’ + lang.dialogName + ’ : ’ + dialog.getName() + ” + ’’ + lang.tabName + ’ : ’ +tabName + ”;

if ( element ) str += ’’ + lang.elementId + ’ : ’ + element.id + ”;

str += ’’ + lang.elementType + ’ : ’ + link + ”;

return str + ”; }

6.104 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/dialog/dialogDefinition.js

// There is no constructor for this class, the user just has to define an // object with theappropriate properties.

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 370: doxygen of OTRS cvs Ref Man

366 Example Documentation

CKEDITOR.dialog.add( ’testOnly’, function( editor ) { return { title : ’Test Dialog’, resiz-able : CKEDITOR.DIALOG_RESIZE_BOTH, minWidth : 500, minHeight : 400, contents: [ { id : ’tab1’, label : ’First Tab’, title : ’First Tab Title’, accessKey : ’Q’, elements : [ {type : ’text’, label : ’Test Text 1’, id : ’testText1’, ’default’ : ’hello world!’ } ] } ] }; });

6.105 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/dialog/plugin.js

config.dialog_backgroundCoverColor = ’rgb(255, 254, 253)’;

6.106 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/editingblock/plugin.js

The default editing block plugin, which holds the editing area and source view. Themode to load at the editor startup. It depends on the plugins loaded. By default, the"wysiwyg" and "source" modes are available. String ’wysiwyg’

config.startupMode = ’source’;

6.107 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/entities/plugin.js

Whether to escape basic HTML entities in the document, including:

• nbsp

• gt

• lt

• amp

Note: It should not be subject to change unless when outputting a non-HTML dataformat like BBCode. Boolean true

config.basicEntities = false;

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 371: doxygen of OTRS cvs Ref Man

6.108/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/plugins/filebrowser/plugin.js 3676.108 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/plugins/filebrowser/plugin.js

config.filebrowserBrowseUrl = ’/browser/browse.php’;

6.109 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/find/plugin.js

Defines the style to be used to highlight results with the find dialog. Object { element :’span’, styles : { ’background-color’ : ’#004’, ’color’ : ’#fff’ } }

// Highlight search results with blue on yellow. config.find_highlight = { element : ’span’,styles : { ’background-color’ : ’#ff0’, ’color’ : ’#00f’ } };

6.110 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/font/plugin.js

The list of fonts names to be displayed in the Font combo in the toolbar. Entries areseparated by semi-colons (;), while it’s possible to have more than one font for eachentry, in the HTML way (separated by comma).

A display name may be optionally defined by prefixing the entries with the name andthe slash character. For example, "Arial/Arial, Helvetica, sans-serif" will be displayed as"Arial" in the list, but will be outputted as "Arial, Helvetica, sans-serif". String

config.font_names = ’Arial/Arial, Helvetica, sans-serif;’ + ’Times New Roman/TimesNew Roman, Times, serif;’ + ’Verdana’;

6.111 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/format/plugin.js

A list of semi colon separated style names (by default tags) representing the style defini-tion for each entry to be displayed in the Format combo in the toolbar. Each entry musthave its relative definition configuration in a setting named "format_(tagName)". For ex-ample, the "p" entry has its definition taken from config.format_p. String ’p;h1;h2;h3;h4;h5;h6;pre;address;div’

config.format_tags = ’p;h2;h3;pre’

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 372: doxygen of OTRS cvs Ref Man

368 Example Documentation

6.112 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/htmldataprocessor/plugin.js

config.forceSimpleAmpersand = false;

6.113 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/htmlwriter/plugin.js

Class used to write HTML data.

var writer = new CKEDITOR.htmlWriter(); writer.openTag( ’p’ ); writer.attribute( ’class’,’MyClass’ ); writer.openTagClose( ’p’ ); writer.text( ’Hello’ ); writer.closeTag( ’p’ ); alert(writer.getHtml() ); "&lt;p class="MyClass"&gt;Hello&lt;/p&gt;"

6.114 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/image/plugin.js

Whether to remove links when emptying the link URL field in the image dialog. Booleantrue

config.image_removeLinkByEmptyURL = false;

6.115 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/indent/plugin.js

config.indentOffset = 4;

6.116 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/justify/plugin.js

// Use the classes ’AlignLeft’, ’AlignCenter’, ’AlignRight’, ’AlignJustify’ config.justifyClasses= [ ’AlignLeft’, ’AlignCenter’, ’AlignRight’, ’AlignJustify’ ];

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 373: doxygen of OTRS cvs Ref Man

6.118/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/plugins/link/dialogs/link.js 3696.117 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/plugins/keystrokes/plugin.js

Controls keystrokes typing in an editor instance.

Parameters{CKEDI-

TOR.editor}editor The editor instance.

6.118 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/link/dialogs/link.js

// href="mailto:[email protected]?subject=subject&body=body" config.emailProtection= ”;

6.119 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/menu/plugin.js

The amount of time, in milliseconds, the editor waits before displaying submenu optionswhen moving the mouse over options that contain submenus, like the "Cell Properties"entry for tables. Number 400

// Remove the submenu delay. config.menu_subMenuDelay = 0;

6.120 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/menubutton/plugin.js

Button UI element.

6.121 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/newpage/plugin.js

config.newpage_html = ’<p>Type your text here.</p>’;

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 374: doxygen of OTRS cvs Ref Man

370 Example Documentation

6.122 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/panel/plugin.js

Panel UI element.

6.123 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/panelbutton/plugin.js

Button UI element.

6.124 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/pastefromword/filter/default.js

config.pasteFromWordRemoveFontStyles = false;

6.125 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/pastefromword/plugin.js

config.pasteFromWordPromptCleanup = true;

6.126 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/pastetext/plugin.js

config.forcePasteAsPlainText = true;

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 375: doxygen of OTRS cvs Ref Man

6.128/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/plugins/resize/plugin.js 3716.127 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/plugins/removeformat/plugin.js

Add to a collection of functions to decide whether a specific element should be con-sidered as formatting element and thus could be removed during removeFormat com-mand, Note: Only available with the existence of ’removeformat’ plugin.

Since

3.3

Parameters{Function} func The function to be called, which will be passed a {CKEDI-

TOR.dom.element} element to test.

// Don’t remove empty span editor.addRemoveFormatFilter.push( function( element ) {return !( element.is( ’span’ ) && CKEDITOR.tools.isEmpty( element.getAttributes() ) );});

6.128 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/resize/plugin.js

config.resize_minWidth = 500;

6.129 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/richcombo/plugin.js

Button UI element.

6.130 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/scayt/plugin.js

config.scayt_autoStartup = true;

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 376: doxygen of OTRS cvs Ref Man

372 Example Documentation

6.131 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/showblocks/plugin.js

config.startupOutlineBlocks = true;

6.132 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/showborders/plugin.js

config.startupShowBorders = false;

6.133 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/smiley/plugin.js

config.smiley_path = ’http://www.example.com/images/smileys/’;

6.134 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/sourcearea/plugin.js

Holds the definition of commands an UI elements included with the sourcearea plugin.

6.135 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/specialchar/plugin.js

The list of special characters visible in the Special Character dialog window. Array

config.specialChars = [ ’"’, ”’, [ ”, ’Custom label’ ] ]; config.specialChars = config.specialChars.concat([ ’"’, [ ”’, ’Custom label’ ] ] );

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 377: doxygen of OTRS cvs Ref Man

6.137/home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/_source/plugins/stylesheetparser/plugin.js 3736.136 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-

3.6.2/ source/plugins/styles/plugin.js

Registers a function to be called whenever the selection position changes in the editingarea. The current state is passed to the function. The possible states are CKEDITOR.TRISTATE_-ON and CKEDITOR.TRISTATE_OFF.

Parameters{CKEDI-

TOR.style}style The style to be watched.

{Function} callback The function to be called.

// Create a style object for the <b> element. var style = new CKEDITOR.style( { element: ’b’ } ); var editor = CKEDITOR.instances.editor1; editor.attachStyleStateChange( style,function( state ) { if ( state == CKEDITOR.TRISTATE_ON ) alert( ’The current state forthe B element is ON’ ); else alert( ’The current state for the B element is OFF’ ); });

6.137 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/stylesheetparser/plugin.js

// Ignore rules for body and caption elements, classes starting with "high", and any classdefined for no specific element. config.stylesheetParser_skipSelectors = /(∧body\.|∧caption\.|\.high|∧\.)/i;

6.138 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/tab/plugin.js

Moves the UI focus to the element following this element in the tabindex order.

var element = CKEDITOR.document.getById( ’example’ ); element.focusNext();

6.139 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/templates/plugin.js

The templates definition set to use. It accepts a list of names separated by comma. Itmust match definitions loaded with the templates_files setting. String ’default’

config.templates = ’my_templates’;

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 378: doxygen of OTRS cvs Ref Man

374 Example Documentation

6.140 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/toolbar/plugin.js

The "theme space" to which rendering the toolbar. For the default theme, the recom-mended options are "top" and "bottom". String ’top’

See also

CKEDITOR.config.theme

config.toolbarLocation = ’bottom’;

6.141 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/undo/plugin.js

config.undoStackSize = 50;

6.142 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/plugins/wysiwygarea/plugin.js

The "wysiwygarea" plugin. It registers the "wysiwyg" editing mode, which handles themain editing area space. Disables the ability of resize objects (image and tables) in theediting area. Boolean false

config.disableObjectResizing = true;

6.143 /home/mdupont/projects/otrs/git/public/otrs/var/httpd/htdocs/js/thirdparty/ckeditor-3.6.2/ source/skins/kama/skin.js

// Using a color code. config.uiColor = ’#AADC6E’;

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen

Page 379: doxygen of OTRS cvs Ref Man

6.144 table 375

6.144 table

Create a sortable table with multi-column sorting capabilitys

’).tablesorter(); Create a simple tablesorter interface.

Generated on Wed Feb 8 2012 11:24:04 for OTRS by Doxygen