Login   Register  
PHP Classes
elePHPant
Icontem

File: README

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Robert Peake  >  webring 1.0  >  README  >  Download  
File: README
Role: Documentation
Content type: text/plain
Description: README for webring 1.0
Class: webring 1.0
webring provides an easy-to-configure solution
Author: By
Last change:
Date: 13 years ago
Size: 1,940 bytes
 

Contents

Class file image Download
webring - a scalable webring library
Copyright 2000 Robert Peake

Released under the GNU Lesser Public License 

ABOUT

webring provides an easy-to-configure solution for creating a webring. All URLs are stored in one file (webring.urls), and each link in the webring references
one of three functions: next (next.php), previous (prev.php), or random (rand.php) at this site. 

REQUIREMENTS

webring requires PHP>3 (tested on 3.015) with support for $HTTP_REFERER, and depends upon the loopedArray class (included). webring links will only
work on browsers that allow redirects using the http-equiv meta tag. 

ARCHITECTURE

webring uses the loopedArray object, which simulates a "looped" array data type with a number of basic functions. See "loopedArray.api" for an outline of how
to use this class. See "webring.api" for an outline of the webring class. 

CONFIGURATION

Simply add urls, one per line, to the file webring.urls. Then reference next.php, prev.php, and rand.php from the pages in your webring. 

IMPORTANT SIDE EFFECTS

Note that if next.php or prev.php are referenced from URLs outside the web ring (not in the webring.urls file) the following behavior will occur: 

       prev.php will redirect the last URL in webrings.url, or the root directory if webrings.url is empty 
       next.php will redirect to the second URL in webrings.url, or the first URL in webrings.url if webrings.url only contains one URL, or the root directory if
       webrings.url is empty. 

	CURRENT CODE DESIGNED TO SUPPORT TOP-LEVEL URLS.
	SEE webring.inc FOR EXPLANATION OF (QUICK AND EASY) 
	MODIFICATION TO ALLOW FOR FULL-URL MATCHES IN YOUR WEBRING.

ADDENDUM

This software is released as-is, with no implications of warranty or fiteness to a particular use. The author implies no obligation to provide techincal support for
this software on the part of himself or his company. 

Robert@MSIA.org