Changeset 2769

Timestamp:

07/14/08 19:56:22 (17 months ago)

Author:

bchoate

Message:

Updated POD.

Location:

branches/release-41/lib/MT

Files:

• TheSchwartz.pm (modified) (1 diff)
• Touch.pm (modified) (1 diff)

branches/release-41/lib/MT/TheSchwartz.pm

@@ -255 +255 @@
 
 1;
+__END__
+
+=head1 NAME
+
+MT::TheSchwartz - Movable Type
+
+=head1 SYNOPSIS
+
+    use MT;
+    use MT::TheSchwartz;
+    my $mt = MT->new;
+    my $schwartz = MT::TheSchwartz->new(%cfg);
+    $schwartz->work_until_done;
+
+=head1 DESCRIPTION
+
+A subclass of C<TheSchwartz>, a job queue system. The MT subclass is
+responsible for configuring TheSchwartz to work with the MT database
+configuration and supplies TheSchwartz worker classes from the MT
+registry.
+
+=head1 METHODS
+
+=head2 MT::TheSchwartz->instance
+
+Returns the singleton instance for the C<MT::TheSchwartz> class.
+
+=head2 MT::TheSchwartz->debug
+
+Static (or instance) method that simply forwards the parameters given on
+to the singleton instance.
+
+=head2 MT::TheSchwartz->insert
+
+Static (or instance) method that simply forwards the parameters given on
+to the singleton instance.
+
+=head2 $schwartz->default_logger($msg, $job)
+
+Handles logging messages for C<TheSchwartz>. When a log message is issued,
+this method takes over. In this case, this subclass suppresses the
+"job completed" messages issued by C<TheSchwartz>.
+
+=head2 $schwartz->work_periodically([$delay])
+
+Invokes C<TheSchwartz> to process available jobs, then queries the MT
+session table for available MT registered tasks that may be ready to
+run. MT tasks such as publishing scheduled posts, expiration of
+spam comments and trackbacks, etc. This routine runs in an infinite
+loop-- after scheduled tasks are run, it will delay C<$delay> seconds
+(default of 5 seconds), then checks for more Schwartz jobs to process.
+
+=cut

branches/release-41/lib/MT/Touch.pm

@@ -63 +63 @@
 
 1;
+__END__
+
+=head1 NAME
+
+MT::Touch - Object class for recording object type modification times
+
+=head1 SYNOPSIS
+
+    # record that an entry object was modified for blog # $blog_id
+    use MT::Touch;
+    MT::Touch->touch( $blog_id, 'entry');
+
+    my $ts = MT::Touch->latest_touch($blog_id, 'entry');
+
+=head1 DESCRIPTION
+
+This module is used to store and retrieve the last modification timestamp
+for any registered object type. This is primarily utilized by the
+module caching layer of Movable Type, where caches can expire based on
+changes to entries, pages, categories, etc. Timestamps stored to the
+'modified_on' column are in UTC time.
+
+=head1 METHODS
+
+=head2 MT::Touch->touch( $blog_id, @types )
+
+Records a MT::Touch object for each type given, for the blog ID specified.
+For non-blog objects, feel free to pass a '0' for blog_id.
+
+=head2 MT::Touch->latest_touch( $blog_id, @types )
+
+Returns the ltest timestamp recorded for any of the object types requested
+for the blog ID specified. The timestamp is returned (YYYYMMDDHHMISS format),
+in UTC time. If no touches exist, C<undef> is the return value.
+
+=cut