X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FBackgroundJob%2FBase.pm;h=27f608129bf062a91fcac858e6ac77743243416e;hb=c7ad671d22e558e157797af7d787c8df499be1b4;hp=44702d84d666cbc2f7ef32d096620b7a0dd07beb;hpb=ee71ba3372b47b7de1e30d56db92c1315ae1e104;p=kivitendo-erp.git

diff --git a/SL/BackgroundJob/Base.pm b/SL/BackgroundJob/Base.pm
index 44702d84d..27f608129 100644
--- a/SL/BackgroundJob/Base.pm
+++ b/SL/BackgroundJob/Base.pm
@@ -29,3 +29,45 @@ sub create_standard_job {
 }
 
 1;
+
+__END__
+
+=encoding utf8
+
+=head1 NAME
+
+SL::BackgroundJob::Base - Base class for all background jobs
+
+=head1 SYNOPSIS
+
+All background jobs are derived from this class. Each job gets its own
+class which must implement the C<run> method.
+
+There are two types of background jobs: periodic jobs and jobs that
+are run once. Periodic jobs have a CRON spec associated with them that
+determines the points in time when the job is supposed to be run.
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<create_standard_job $cron_spec>
+
+Creates or updates an entry in the database for the current job. If
+the C<background_jobs> table contains an entry for the current class
+(as determined by C<ref($self)>) then that entry is updated and
+re-activated if it was disabled. Otherwise a new entry is created.
+
+This function can be called both as a member or as a class function.
+
+=back
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
+
+=cut