home *** CD-ROM | disk | FTP | other *** search
-
- <HTML>
- <HEAD>
- <TITLE>Netscape::HistoryURL - URI::URL subclass with Netscape history information</TITLE>
- <LINK REL="stylesheet" HREF="../../../Active.css" TYPE="text/css">
- <LINK REV="made" HREF="mailto:">
- </HEAD>
-
- <BODY>
- <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
- <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
- <STRONG><P CLASS=block> Netscape::HistoryURL - URI::URL subclass with Netscape history information</P></STRONG>
- </TD></TR>
- </TABLE>
-
- <A NAME="__index__"></A>
- <!-- INDEX BEGIN -->
-
- <UL>
-
- <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
-
- <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
- <LI><A HREF="#description">DESCRIPTION</A></LI>
- <LI><A HREF="#constructor">CONSTRUCTOR</A></LI>
- <LI><A HREF="#methods">METHODS</A></LI>
- <UL>
-
- <LI><A HREF="#visit_time return the time of last visit">visit_time - return the time of last visit</A></LI>
- <LI><A HREF="#first_visit_time the time you first visited the url">first_visit_time - the time you first visited the URL</A></LI>
- <LI><A HREF="#last_visit_time the time you last visited the url">last_visit_time - the time you last visited the URL</A></LI>
- <LI><A HREF="#title the title of the associated page">title - the title of the associated page</A></LI>
- <LI><A HREF="#visit_count the number of times you have visited the page">visit_count - the number of times you have visited the page</A></LI>
- <LI><A HREF="#expire the expire value for the url">expire - the expire value for the URL</A></LI>
- </UL>
-
- <LI><A HREF="#see also">SEE ALSO</A></LI>
- <LI><A HREF="#author">AUTHOR</A></LI>
- <LI><A HREF="#copyright">COPYRIGHT</A></LI>
- </UL>
- <!-- INDEX END -->
-
- <HR>
- <P>
- <H1><A NAME="name">NAME</A></H1>
- <P>Netscape::HistoryURL - URI::URL subclass with Netscape history information</P>
- <P>
- <HR>
- <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
- <UL>
- <LI>Windows</LI>
- </UL>
- <HR>
- <H1><A NAME="synopsis">SYNOPSIS</A></H1>
- <PRE>
- use Netscape::HistoryURL;
- </PRE>
- <PRE>
-
- $url = new Netscape::HistoryURL('<A HREF="http://foobar.com/">http://foobar.com/</A>',
- LAST, FIRST, COUNT, EXPIRE, TITLE);</PRE>
- <P>
- <HR>
- <H1><A NAME="description">DESCRIPTION</A></H1>
- <P>The <CODE>Netscape::HistoryURL</CODE> module subclasses <A HREF="../../../site/lib/URI/URL.html">the URI::URL manpage</A> to provide
- a URL class with methods for accessing the information which is stored
- in Netscape's <EM>history database</EM>.</P>
- <P>The history database is used to keep track of all URLs you have visited.
- This is used to color previously visited URLs different, for example.
- The information stored in the history database depends on the version
- of Netscape being used.</P>
- <P>
- <HR>
- <H1><A NAME="constructor">CONSTRUCTOR</A></H1>
- <PRE>
- $object = new Netscape::HistoryURL( URL,
- LAST, FIRST, COUNT, EXPIRE, TITLE );</PRE>
- <P>This creates a new instance of the Netscape::HistoryURL object class.
- This supports all the methods supported by the URI::URL class.
- Please see the documentation for that module.</P>
- <P>The first argument passed is a string which contains a valid URL.
- The remaining arguments are information (usually) extracted from Netscape's
- history database.</P>
- <P><STRONG>LAST</STRONG> is the time the URL was last visited, and <STRONG>FIRST</STRONG> is the time
- when the URL was first visited. <STRONG>COUNT</STRONG> is the number of times you
- have visited the URL. We're not really sure what <STRONG>EXPIRE</STRONG> is yet.
- <STRONG>TITLE</STRONG> is the title of the referenced page.</P>
- <P>You will normally not use the constructor yourself;
- it is usually invoked by the <CODE>next_url()</CODE> method of the
- Netscape::History class.</P>
- <P>
- <HR>
- <H1><A NAME="methods">METHODS</A></H1>
- <P>The <STRONG>Netscape::HistoryURL</STRONG> class supports all methods of the URI::URL
- class, and additional methods as described below.
- Please see the documentation for URI::URL for details of
- the other methods supported.</P>
- <P>
- <H2><A NAME="visit_time return the time of last visit">visit_time - return the time of last visit</A></H2>
- <PRE>
- $time = $url->visit_time();</PRE>
- <P>This routine is provided for backwards compatibility with the previous
- versions of this module. You should use <CODE>last_visit_time()</CODE> instead.</P>
- <P>
- <H2><A NAME="first_visit_time the time you first visited the url">first_visit_time - the time you first visited the URL</A></H2>
- <PRE>
- $time = $url->first_visit_time();</PRE>
- <P>This method returns the time you first visited the URL,
- in seconds since the last epoch.
- This can then be used with any of the standard routines for formatting
- as a string.
- The following example uses ctime(), from the Date::Format module:</P>
- <PRE>
- print "Time of last visit for $url : ", ctime($url->first_visit_time);</PRE>
- <P>
- <H2><A NAME="last_visit_time the time you last visited the url">last_visit_time - the time you last visited the URL</A></H2>
- <PRE>
- $time = $url->last_visit_time();</PRE>
- <P>This method returns the time you last (most recently) visited the URL,
- in seconds since the last epoch.</P>
- <P>
- <H2><A NAME="title the title of the associated page">title - the title of the associated page</A></H2>
- <PRE>
- $title = $url->title();</PRE>
- <P>This method returns the title of the referenced page, if one
- was available. The value will be <A HREF="../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> otherwise.</P>
- <P>
- <H2><A NAME="visit_count the number of times you have visited the page">visit_count - the number of times you have visited the page</A></H2>
- <PRE>
- $count = $url->visit_count();</PRE>
- <P>This method returns the number of times you have visited the page.</P>
- <P>
- <H2><A NAME="expire the expire value for the url">expire - the expire value for the URL</A></H2>
- <PRE>
- $expire = $url->expire();</PRE>
- <P>This method returns the expire values which is stored for the URL.
- We don't know what this is for yet, or the right way to interpret it.</P>
- <P>
- <HR>
- <H1><A NAME="see also">SEE ALSO</A></H1>
- <DL>
- <DT><STRONG><A NAME="item_Netscape%3A%3AHistory">Netscape::History</A></STRONG><BR>
- <DD>
- An object class for accessing the Netscape history database.
- <P></P>
- <DT><STRONG><A NAME="item_URI%3A%3AURL">URI::URL</A></STRONG><BR>
- <DD>
- Base-class, which provides heaps of functionality.
- <P></P></DL>
- <P>
- <HR>
- <H1><A NAME="author">AUTHOR</A></H1>
- <P>Neil Bowers <<A HREF="mailto:neilb@cre.canon.co.uk">neilb@cre.canon.co.uk</A>> and
- Richard Taylor <<A HREF="mailto:rit@cre.canon.co.uk">rit@cre.canon.co.uk</A>>.</P>
- <P>
- <HR>
- <H1><A NAME="copyright">COPYRIGHT</A></H1>
- <P>Copyright (c) 1997-1999 Canon Research Centre Europe. All rights reserved.
- This module is free software; you can redistribute it and/or modify
- it under the same terms as Perl itself.</P>
- <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
- <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
- <STRONG><P CLASS=block> Netscape::HistoryURL - URI::URL subclass with Netscape history information</P></STRONG>
- </TD></TR>
- </TABLE>
-
- </BODY>
-
- </HTML>
-