The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

WWW::Google::SiteMap::URL - URL Helper class for WWW::Google::SiteMap

SYNOPSIS

  use WWW::Google::SiteMap;

DESCRIPTION

This is a helper class that supports WWW::Google::SiteMap and WWW::Google::SiteMap::Index.

METHODS

new()
loc()

Change the URL associated with this object. For a WWW::Google::SiteMap this specifies the URL to add to the sitemap, for a WWW::Google::SiteMap::Index, this is the URL to the sitemap.

changefreq()

Set the change frequency of the object. This field is not used in sitemap indexes, only in sitemaps.

lastmod()

Set the last modified time. You have to provide this as one of the following:

a complete ISO8601 time string

A complete time string will be accepted in exactly this format:

  YYYY-MM-DDTHH:MM:SS+TZ:TZ
  YYYY   - 4-digit year
  MM     - 2-digit month (zero padded)
  DD     - 2-digit year (zero padded)
  T      - literal character 'T'
  HH     - 2-digit hour (24-hour, zero padded)
  SS     - 2-digit second (zero padded)
  +TZ:TZ - Timezone offset (hours and minutes from GMT, 2-digit, zero padded)
epoch time

Seconds since the epoch, such as would be returned from time(). If you provide an epoch time, then an appropriate ISO8601 time will be constructed with gmtime() (which means the timezone offset will be +00:00). If anyone knows of a way to determine the timezone offset of the current host that is cross-platform and doesn't add dozens of dependencies then I might change this.

an ISO8601 date (YYYY-MM-DD)

A simple date in YYYY-MM-DD format. The time will be set to 00:00:00+00:00.

a DateTime object.

If a DateTime object is provided, then an appropriate timestamp will be constructed from it.

a HTTP::Response object.

If given an HTTP::Response object, the last modified time will be calculated from whatever time information is available in the response headers. Currently this means either the Last-Modified header, or tue current time - the current_age() calculated by the response object. This is useful for building web crawlers.

Note that in order to conserve memory, any of these items that you provide will be converted to a complete ISO8601 time string when they are stored. This means that if you pass an object to lastmod(), you can't get it back out. If anyone actually has a need to get the objects back out, then I might make a configuration option to store the objects internally.

If you have suggestions for other types of date/time objects or formats that would be usefule, let me know and I'll consider them.

priority()

Set the priority. This field is not used in sitemap indexes, only in sitemaps.

delete()

Delete this object from the sitemap or the sitemap index.

lenient()

If lenient contains a true value, then errors will not be fatal.

MODULE HOME PAGE

The home page of this module is http://www.jasonkohles.com/software/WWW-Google-SiteMap. This is where you can always find the latest version, development versions, and bug reports. You will also find a link there to report bugs.

SEE ALSO

WWW::Google::SiteMap

WWW::Google::SiteMap::Index

WWW::Google::SiteMap::Ping

http://www.jasonkohles.com/software/WWW-Google-SiteMap/

https://www.google.com/webmasters/sitemaps/docs/en/protocol.html

AUTHOR

Jason Kohles, <email@jasonkohles.com>

COPYRIGHT AND LICENSE

Copyright (C) 2005 by Jason Kohles

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available.