Changeset 2747

Timestamp:

07/10/08 17:16:23 (17 months ago)

Author:

bchoate

Message:

Updated POD.

Location:

branches/release-41/lib/MT

Files:

• Blocklist.pm (modified) (1 diff)
• Core.pm (modified) (1 diff)
• DateTime.pm (modified) (1 diff)
• FileMgr.pm (modified) (1 diff)
• Image.pm (modified) (4 diffs)
• Tool.pm (modified) (1 diff)

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

@@ -42 +42 @@
 
 1;
+
+__END__
+
+=head1 NAME
+
+MT::Blocklist - MT object class for storing rules for filtering content.
+
+=head1 METHODS
+
+=head2 MT::Blocklist->block_these($blog_id, $action, @urls)
+
+Adds the specified URLs to the blocklist table with the specified I<$action>
+and for the specified I<$blog_id>.
+
+=head1 LICENSE
+
+The license that applies is the one you agreed to when downloading
+Movable Type.
+
+=head1 AUTHOR & COPYRIGHT
+
+Except where otherwise noted, MT is Copyright 2001-2008 Six Apart.
+All rights reserved.
+
+=cut

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

@@ -1003 +1003 @@
 
 1;
+__END__
+
+=head1 NAME
+
+MT::Core - Core component for Movable Type functionality.
+
+=head1 METHODS
+
+=head2 MT::Core::trans($phrase)
+
+Stub method that returns the phrase it is given.
+
+=head2 MT::Core->name()
+
+Returns a string identifying this component.
+
+=head2 MT::Core->id()
+
+Returns the identifier for this component.
+
+=head2 MT::Core::load_junk_filters()
+
+Routine that returns the core junk filter registry elements (these
+live in the L<MT::JunkFilter> package).
+
+=head2 MT::Core::load_core_tasks()
+
+Routine that returns the core L<MT::TaskMgr> registry elements.
+
+=head2 MT::Core->remove_temporary_files()
+
+Utility method for removing any temporary files that MT generates.
+
+=head2 MT::Core->remove_expired_sessions()
+
+Utility method for clearing expired MT user session records.
+
+=head2 MT::Core->remove_expired_search_caches()
+
+Utility method for removing expired search cache records.
+
+=head2 MT::Core::load_default_templates()
+
+Routine that returns the default template set registry elements.
+
+=head2 MT::Core::load_captcha_providers()
+
+Routine that returns the CAPTCHA provider registry elements.
+
+=head2 MT::Core::load_core_commenter_auth()
+
+Routine that returns the core registry elements for commenter
+authentication methods.
+
+=head2 MT::Core::load_core_tags()
+
+Routine that returns the core registry elements for the MT
+template tags are enabled for the entire system (excludes
+application-specific tags).
+
+=head2 MT::Core::load_upgrade_fns()
+
+Routine that returns the core registry elements for the MT
+schema upgrade framework.
+
+=head2 MT::Core::load_backup_instructions
+
+Routine that returns the core registry elements for the MT
+Backup/Restore framework.
+
+=head2 MT::Core->l10n_class
+
+Returns the localization package for the core component.
+
+=head2 $core->init_registry()
+
+=head2 MT::Core::load_archive_types()
+
+Routine that returns the core registry elements for the
+publishable archive types. See L<MT::ArchiveType>.
+
+=head2 MT::Core::PerformanceLoggingPath
+
+A L<MT::ConfigMgr> get/set method for the C<PerformanceLoggingPath>
+configuration setting. If the user has not designated a path, this
+will return a default location, which is programatically determined.
+
+=head2 MT::Core::ProcessMemoryCommand
+
+A L<MT::ConfigMgr> get/set method for the C<ProcessMemoryCommand>
+configuration setting. If the user has not assigned this themselves,
+it will return a default command, determined by the operating system
+Movable Type is running on.
+
+=head2 MT::Core::SecretToken
+
+A L<MT::ConfigMgr> get/set method for the C<SecretToken>
+configuration setting. If the user has not assigned this themselves,
+it will return a random token value, and save it to the database for
+future use.
+
+=head2 MT::Core::DefaultUserTagDelimiter
+
+A L<MT::ConfigMgr> get/set method for the C<DefaultUserTagDelimiter>
+configuration setting. Translates the keyword values 'comma' and
+'space' to the ASCII code for those characters.
+
+=head2 MT::Core::NewUserAutoProvisioning
+
+A L<MT::ConfigMgr> get/set method for the C<NewUserAutoProvisioning>
+configuration setting. Even if the user has enabled this setting,
+it will force a value of '0' unless the C<DefaultSiteRoot> and
+C<DefaultSiteURL> configuration settings are also assigned.
+
+=head2 MT::Core::UserSessionCookieName
+
+A L<MT::ConfigMgr> get/set method for the C<UserSessionCookieName>
+configuration setting. If the user has not specifically assigned
+this setting, a default value is returned, affected by the
+C<SingleCommunity> setting. If C<SingleCommunity> is enabled, it
+returns a cookie name that is the same for all blogs. If it is
+off, it returns a cookie name that is blog-specific (contains the
+blog id in the cookie name).
+
+=head2 UserSessionCookiePath
+
+A L<MT::ConfigMgr> get/set method for the C<UserSessionCookiePath>
+configuration setting. If the user has not specifically assigned
+this setting, a default value is returned, affected by the
+C<SingleCommunity> setting. If C<SingleCommunity> is enabled, it
+returns a path that is the same for all blogs ('/'). If it is
+off, it returns a value that will yield the blog's relative
+URL path.
+
+=head1 LICENSE
+
+The license that applies is the one you agreed to when downloading
+Movable Type.
+
+=head1 AUTHOR & COPYRIGHT
+
+Except where otherwise noted, MT is Copyright 2001-2008 Six Apart.
+All rights reserved.
+
+=cut

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

@@ -245 +245 @@
 =head1 NAME
 
-MT::DateTime
+MT::DateTime - A utility package for handling date/time values for Movable
+Type.
 
 =head1 METHODS
 
+=head2 MT::DateTime->new(%attr)
+
+Constructs a new C<MT::DateTime> object using the values in C<%attr>.
+C<%attr> may contain:
+
+=over 4
+
+=item * year
+
+A 4-digit year.
+
+=item * month
+
+Month number, where January is 0.
+
+=item * day
+
+Day number, from 1 to 31.
+
+=item * hour
+
+Hour in 24 hour notation (0-23).
+
+=item * minute
+
+Minutes (0-59).
+
+=item * second
+
+Seconds (0-59).
+
+=item * time_zone
+
+Timezone, in '+HH:MM', '-HH:MM', '+HH', or '-HH' notation.
+
+=back
+
 =head2 compare( a => $a, b => $b, blog => $blog )
 
-Compares two timestamp strings and returns negative valye, 0, or positive value
-depending on whether the "a" argument is less than, equal to, or greater than
-the "b" argument.
-
-You can specify scalar value to "a" and "b".  They are treated as timestamp values
-(e.g. 20080405123456).  You can also specify either epoch string (e.g the string
-returned from time method), or MT::DateTime object.  In those cases, you must
-specify both value and type in a hash, for example:
-
-MT::DateTime->compare( blog => $blog,
-    a => '20041231123456', b => { value => time(), type => 'epoch' } );
+Compares two timestamp strings and returns negative valye, 0, or
+positive value depending on whether the "a" argument is less than,
+equal to, or greater than the "b" argument.
+
+You can specify scalar value to "a" and "b".  They are treated as
+timestamp values (e.g. 20080405123456).  You can also specify either
+epoch string (e.g the string returned from time method), or C<MT::DateTime>
+object.  In those cases, you must specify both value and type in a hash,
+for example:
+
+    MT::DateTime->compare( blog => $blog,
+        a => '20041231123456', b => { value => time(), type => 'epoch' } );
+
+=head2 $datetime->week_year()
+
+Returns the year for the start of the week for the object.
+
+=head2 $datetime->week_number()
+
+Returns the week number calculated for the object.
+
+=head2 $datetime->year()
+
+Returns the year component of the object.
+
+=head2 $datetime->month()
+
+Returns the month component of the object.
+
+=head2 $datetime->day()
+
+Returns the day component of the object.
+
+=head2 $datetime->hour()
+
+Returns the hours component of the object.
+
+=head2 $datetime->minute()
+
+Returns the minutes component of the object.
+
+=head2 $datetime->second()
+
+Returns the seconds component of the object.
+
+=head2 $datetime->time_zone()
+
+Returns the time zone component of the object.
+
+=head2 $datetime->day_of_year()
+
+Returns the day number of the year of the object.
+
+=head2 $datetime->week()
+
+Returns a list containing the year of the week (C<week_year>) and
+the week number (C<week_number>).
+
+=head2 MT::DateTime->weeks_in_year($year)
+
+Returns the number of weeks that are in the specified C<$year>. Returns
+either 52 or 53, depending on the year.
+
+=head2 $datetime->ymd2rd( [ $year, $month, $day ])
+
+Converts the given C<$year>, C<$month>, C<$day> (or, if unspecified,
+uses the year, month, day elements from C<$datetime>) into a 'Rata Die'
+days value.
+
+=head2 $datetime->tz_offset_as_seconds( [$offset] )
+
+Converts the given C<$offset> (or, if absent, uses the time_zone
+component of C<$datetime>) into an expression of seconds. I.e.,
+an C<$offset> of '-1:30' would yield -5400.
 
 =head1 AUTHOR & COPYRIGHT

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

@@ -152 +152 @@
 On error, returns C<undef>; see L<ERROR HANDLING>, below.
 
-=head2 content_is_updated()
+=head2 content_is_updated($file, $content)
 
-Return one (1).
+Returns true if the contents of I<$file> differs from the value in
+I<$content>.
+
+=head2 $fmgr->file_mod_time($file)
+
+Returns the modification timestamp for I<$file>.
 
 =head2 $fmgr->is_handle($file)

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

@@ -466 +466 @@
 =head1 USAGE
 
-=head2 MT::Image->new(%arg)
+=head2 MT::Image->new( %arg )
 
 Constructs a new I<MT::Image> object. Returns the new object on success; on
@@ -491 +491 @@
 =back
 
-=head2 $img->scale(%arg)
+=head2 $img->scale( %arg )
 
 Creates a thumbnail from the image represented by I<$img>; on success, returns
@@ -519 +519 @@
 
 =back
+
+=head2 MT::Image->inscribe_square( %arg )
+
+Calculates a square of dimensions that are capable of holding an image
+of the height and width indicated. This method receives I<%arg>, which
+may contain:
+
+=over 4
+
+=item * Height
+
+=item * Width
+
+=back
+
+The square will be the smaller value of the Height and Width parameter.
+
+The method returns a hash containing the following information:
+
+=over 4
+
+=item * Size
+
+The size of the calculated square, in pixels.
+
+=item * X
+
+The horizontal space to crop from the image, in pixels.
+
+=item * Y
+
+The vertical space to crop from the image, in pixels.
+
+=back
+
+This information is suited for the L<crop> method.
+
+=head2 $img->make_square()
+
+Takes an image which may or may not be a square in dimension and forces
+it into a square shape (trimming the longer side, as necesary).
 
 =head2 $img->get_dimensions(%arg)
@@ -529 +570 @@
 between 1 to 100).
 
+=head2 MT::Image->check_upload( %arg )
+
+Utility method used to handle image upload and storage, along with some
+constraining factors. The I<%arg> hash may contain the following elements:
+
+=over 4
+
+=item * Fh
+
+A filehandle for the uploaded file.
+
+=item * Fmgr
+
+A handle to a L<MT::FileMgr> object that will be used for writing the
+file into place.
+
+=item * Local
+
+A path and filename for the location to write the uploaded file.
+
+=item * Max (optional)
+
+A number that specifies the maximum physical file size for the uploaded
+image (specified in bytes).
+
+=item * MaxDim (optional)
+
+A number that specifies the maximum dimension allowed for the uploaded
+image (specified in pixels).
+
+=back
+
+If the uploaded image is valid and passes the file size and image
+dimension requirements (assuming those parameters are given),
+the return value is a list consisting of the following elements:
+
+=over 4
+
+=item * $width
+
+The width of the uploaded image, in pixels.
+
+=item * $height
+
+The height of the uploaded image, in pixels.
+
+=item * $id
+
+A string identifying the type of image file (returned by L<Image::Size>,
+so typically "GIF", "JPG", "PNG").
+
+=item * $write_coderef
+
+A Perl coderef that, when invoked writes the image to the specified
+location.
+
+=back
+
+If any error occurs from this routine, it will return 'undef', and
+assign the error message, accessible using the L<errstr> class method.
+
 =head1 AUTHOR & COPYRIGHT
 

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

@@ -178 +178 @@
 requested by the user (that is, how many times the C<-v> option was used).
 
+=head2 $tool-E<gt>set_up_app()
+
+This helper method creates a MT instance and configures it to look like
+a L<MT::App> instance (although, it isn't), and invokes the 'init_app'
+callback using this instance.
+
+=head2 $class-E<gt>show_help
+
+Displays command-line help provided by the C<MT::Tool> subclass L<help>
+method.
+
+=head2 $class-E<gt>show_usage
+
+Displays commnad-line usage instructions provided by the C<MT::Tool>
+subclass L<usage> method.
+
 =head1 SEE ALSO