Changeset 1239 for trunk/src/routing/AgaviRouting.class.php

Timestamp:

11/05/06 00:50:01 (2 years ago)

Author:

dominik

Message:

more documentation fixes

Files:

• trunk/src/routing/AgaviRouting.class.php (modified) (4 diffs)

trunk/src/routing/AgaviRouting.class.php

@@ -75 +75 @@
    * Initialize the routing instance.
    *
-   * @param      AgaviContext A Context instance.
-   * @param      array        An array of initialization parameters.
+   * @param      AgaviResponse An AgaviResponse instance.
+   * @param      array         An array of initialization parameters.
    *
    * @author     Dominik del Bondio <ddb@bitxtender.com>
@@ -730 +730 @@
     $bracketCount = 0;
     $hasBrackets = false;
-    // whether the regular expression is clean of any regular expression (\o/)
+    // whether the regular expression is clean of any regular expression 
+    // so we can reverse generate it
     $cleanRx = true;
 
@@ -892 +893 @@
   }
 
+  /**
+   * Parses an argument passed to one of the 'setting attributes' for dynamic 
+   * parts.
+   *
+   * To access variables in the setters one can either use '$variable' (so the 
+   * variable name makes up the entire argument) or 'text${variable}text' to 
+   * add additional text.
+   *
+   * @param      string The definition.
+   *
+   * @return     mixed Either the definition if it didn't contain any dynamic 
+   *                   parts or an array containing the definition prepared for
+   *                   sprintf use and the variables in the right order.
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.11.0
+   */
   protected function parseDynamicSet($definition)
   {
@@ -922 +940 @@
   }
 
+  /**
+   * Resolves all variables in a prepared dynamic set definition.
+   *
+   * @param      array The definition of the dynamic argument.
+   * @param      array The array to search for the variables in the argument.
+   *
+   * @return     string The resulting string.
+   *
+   * @author     Dominik del Bondio <ddb@bitxtender.com>
+   * @since      0.11.0
+   */
   protected function resolveDynamicSet($definition, $parameters)
   {