[pLog-svn] r1644 - in plog/trunk/class: . net

[oscar at devel.plogworld.net]

Author: oscar
Date: 2005-03-30 16:24:56 +0000 (Wed, 30 Mar 2005)
New Revision: 1644

Modified:
   plog/trunk/class/Doxyfile
   plog/trunk/class/net/customurlhandler.class.php
   plog/trunk/class/net/linkformatmatcher.class.php
   plog/trunk/class/net/linkparser.class.php
Log:
finished the Net module


Modified: plog/trunk/class/Doxyfile
===================================================================
--- plog/trunk/class/Doxyfile	2005-03-30 16:17:33 UTC (rev 1643)
+++ plog/trunk/class/Doxyfile	2005-03-30 16:24:56 UTC (rev 1644)
@@ -416,7 +416,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = object/ dao/ logger/ gallery/ locale/ config/ file/ database/ data/forms security/ xml/ controller/ mail/ bayesian/ misc/
+INPUT                  = object/ dao/ logger/ gallery/ locale/ config/ file/ database/ data/forms security/ xml/ controller/ mail/ bayesian/ misc/ net/
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

Modified: plog/trunk/class/net/customurlhandler.class.php
===================================================================
--- plog/trunk/class/net/customurlhandler.class.php	2005-03-30 16:17:33 UTC (rev 1643)
+++ plog/trunk/class/net/customurlhandler.class.php	2005-03-30 16:24:56 UTC (rev 1644)
@@ -8,7 +8,14 @@
 	/**
 	 * \ingroup Net
 	 *
-	 * Parses incoming URLs when "custom URLs" are enabled
+	 * Parses incoming URLs when "custom URLs" are enabled. It uses the LinkFormatMatcher
+	 * to determine which *_link_format configuration setting matches the incoming URL, extracts
+	 * the information from the URL according to the specified format and puts it back to the
+	 * request so that the core classes can fetch the parameters.
+	 *
+	 * The use of this class is very specific and it should not be be called directly anyway.
+	 *
+	 * @see LinkFormatMatcher
 	 */	
 	class CustomUrlHandler extends Object
 	{

Modified: plog/trunk/class/net/linkformatmatcher.class.php
===================================================================
--- plog/trunk/class/net/linkformatmatcher.class.php	2005-03-30 16:17:33 UTC (rev 1643)
+++ plog/trunk/class/net/linkformatmatcher.class.php	2005-03-30 16:24:56 UTC (rev 1644)
@@ -6,7 +6,19 @@
     /**
      * \ingroup Net
      *
-     * identifies the right kind of url, based on the format of our links
+     * Identifies the right kind of url, based on the format of our links. This class is only taken
+     * into use when custom urls are enabled, and it basically loops through all provided regular expressions
+     * and a given HTTP request to check which one of them is the matching one. The matching engine (converting
+     * from *_link_format format to a valid regexp) is provided by the LinkParser class.
+     *
+     * Once ready, it will call the LinkFormatMatcher::getParameters() to retrieve the right parameters
+     * for the request (the core does not understand this kind of requests, and this class acts as some sort
+     * of a filter that parses an incoming nicer link, gets the information based on a regexp and puts it back to
+     * the request in a more "normal" format)
+     *
+     * Users or plugin developers should never need to use this class directly. 
+     *
+     * @see LinkParser     
      */
     class LinkFormatMatcher extends Object
     {

Modified: plog/trunk/class/net/linkparser.class.php
===================================================================
--- plog/trunk/class/net/linkparser.class.php	2005-03-30 16:17:33 UTC (rev 1643)
+++ plog/trunk/class/net/linkparser.class.php	2005-03-30 16:24:56 UTC (rev 1644)
@@ -32,6 +32,15 @@
 
     /**
      * \ingroup Net
+     *
+     * Given a link format (like all the *_link_format configuration settings) and a valid incoming
+     * request, determine if the URL matches the format and if so, fill in an array with the information
+     * extracted from the link (according to the format)
+     *
+     * This class is used by LinkFormatMatched and generally there is no need to use this class
+     * by plugin developers.
+     *
+     * @see LinkFormatMatcher
      */
     class LinkParser extends Object
     {