Changeset 1239

Show
Ignore:
Timestamp:
11/05/06 00:50:01 (2 years ago)
Author:
dominik
Message:

more documentation fixes

Location:
trunk/src
Files:
8 modified

Legend:

Unmodified
Added
Removed

  • trunk/src/request/AgaviRequest.class.php

    r1117 r1239  
    6363 
    6464  /** 
    65    * @var        bool A boolean value indicating whether or not the request is locked. 
     65   * @var        bool A boolean value indicating whether or not the request is  
     66   *                  locked. 
    6667   */ 
    6768  private $locked = false; 

  • trunk/src/request/AgaviWebRequest.class.php

    r1096 r1239  
    421421  public function hasFileErrors() 
    422422  { 
    423     foreach($_FILES as &$file) { 
     423    foreach($_FILES as $file) { 
    424424      if($file['error'] != UPLOAD_ERR_OK) { 
    425425        return true; 

  • trunk/src/response/AgaviResponse.class.php

    r1096 r1239  
    163163   * output information can be set. 
    164164   * 
    165    * @return     bool 
     165   * @return     bool Whether the response is locked. 
    166166   * 
    167167   * @author     David Zuelke <dz@bitxtender.com> 

  • trunk/src/response/AgaviWebResponse.class.php

    r1075 r1239  
    367367   * @param      string A HTTP header field name. 
    368368   * 
    369    * @return     array All values set for that header, or null if no headers set 
     369   * @return     bool true if the header exists, false otherwise. 
    370370   * 
    371371   * @author     David Zuelke <dz@bitxtender.com> 
    … …  
    412412   * @param      mixed Data to store into a cookie. If null or empty cookie 
    413413   *                   will be tried to be removed. 
    414    * @param      array Cookie parameters (parameters from config or defaults 
    415    *                   are used for any missing parameters). 
     414   * @param      int    The lifetime of the cookie in seconds. When you pass 0  
     415   *                    the cookie will be valid until the  browser gets closed. 
     416   * @param      string The path on the server the cookie will be available on. 
     417   * @param      string The domain the cookie is available on. 
     418   * @param      bool   Indicates that the cookie should only be transmitted  
     419   *                    over a secure HTTPS connection. 
     420   * @param      bool   Whether the cookie will be made accessible only through 
     421   *                    the HTTP protocol. 
    416422   * 
    417423   * @author     Veikko Makinen <mail@veikkomakinen.com> 

  • trunk/src/response/AgaviXmlrpcepiphpResponse.class.php

    r1098 r1239  
    5454   * Prepend content to the existing content for this Response. 
    5555   * 
    56    * @param      mixed The content to be prepended to this Response. 
     56   * @param      array The content to be prepended to this Response. 
    5757   * 
    5858   * @return     bool Whether or not the operation was successful. 
    … …  
    6969   * Append content to the existing content for this Response. 
    7070   * 
    71    * @param      mixed The content to be appended to this Response. 
     71   * @param      array The content to be appended to this Response. 
    7272   * 
    7373   * @return     bool Whether or not the operation was successful. 

  • trunk/src/routing/AgaviRouting.class.php

    r1131 r1239  
    7575   * Initialize the routing instance. 
    7676   * 
    77    * @param      AgaviContext A Context instance. 
    78    * @param      array        An array of initialization parameters. 
     77   * @param      AgaviResponse An AgaviResponse instance. 
     78   * @param      array         An array of initialization parameters. 
    7979   * 
    8080   * @author     Dominik del Bondio <ddb@bitxtender.com> 
    … …  
    730730    $bracketCount = 0; 
    731731    $hasBrackets = false; 
    732     // whether the regular expression is clean of any regular expression (\o/) 
     732    // whether the regular expression is clean of any regular expression  
     733    // so we can reverse generate it 
    733734    $cleanRx = true; 
    734735 
    … …  
    892893  } 
    893894 
     895  /** 
     896   * Parses an argument passed to one of the 'setting attributes' for dynamic  
     897   * parts. 
     898   * 
     899   * To access variables in the setters one can either use '$variable' (so the  
     900   * variable name makes up the entire argument) or 'text${variable}text' to  
     901   * add additional text. 
     902   * 
     903   * @param      string The definition. 
     904   * 
     905   * @return     mixed Either the definition if it didn't contain any dynamic  
     906   *                   parts or an array containing the definition prepared for 
     907   *                   sprintf use and the variables in the right order. 
     908   * 
     909   * @author     Dominik del Bondio <ddb@bitxtender.com> 
     910   * @since      0.11.0 
     911   */ 
    894912  protected function parseDynamicSet($definition) 
    895913  { 
    … …  
    922940  } 
    923941 
     942  /** 
     943   * Resolves all variables in a prepared dynamic set definition. 
     944   * 
     945   * @param      array The definition of the dynamic argument. 
     946   * @param      array The array to search for the variables in the argument. 
     947   * 
     948   * @return     string The resulting string. 
     949   * 
     950   * @author     Dominik del Bondio <ddb@bitxtender.com> 
     951   * @since      0.11.0 
     952   */ 
    924953  protected function resolveDynamicSet($definition, $parameters) 
    925954  { 

  • trunk/src/routing/AgaviRoutingCallback.class.php

    r1131 r1239  
    4646   * Initialize the callback instance. 
    4747   * 
    48    * @param      AgaviContext A Context instance. 
    49    * @param      array        An array with information about the route. 
     48   * @param      AgaviResponse An AgaviResponse instance. 
     49   * @param      array         An array with information about the route. 
    5050   * 
    5151   * @author     Dominik del Bondio <ddb@bitxtender.com> 
    … …  
    6464   * @return     AgaviContext An AgaviContext instance. 
    6565   * 
    66    * @since      0.10.0 
     66   * @author     Dominik del Bondio <ddb@bitxtender.com> 
     67   * @since      0.11.0 
    6768   */ 
    6869  public final function getContext() 
    … …  
    7172  } 
    7273 
     74  /** 
     75   * Gets executed when the route of this callback route matched. 
     76   * 
     77   * @param      array The parameters generated by this route. 
     78   * 
     79   * @return     bool Whether the routing should handle the route as matched. 
     80   * 
     81   * @author     Dominik del Bondio <ddb@bitxtender.com> 
     82   * @since      0.11.0 
     83   */ 
    7384  public function onMatched(array &$parameters) 
    7485  { 
    … …  
    7687  } 
    7788 
     89  /** 
     90   * Gets executed when the route of this callback route did not match. 
     91   * 
     92   * @author     Dominik del Bondio <ddb@bitxtender.com> 
     93   * @since      0.11.0 
     94   */ 
    7895  public function onNotMatched() 
    7996  { 
    … …  
    8198  } 
    8299 
     100  /** 
     101   * Gets executed when the route of this callback is about to be reverse  
     102   * generated into an URL. 
     103   * 
     104   * @param      array The default parameters stored in the route. 
     105   * @param      array The parameters the user supplied to AgaviRouting::gen(). 
     106   * 
     107   * @return     array The default parameters which should be used for  
     108   *                   generating the URL. 
     109   * 
     110   * @author     Dominik del Bondio <ddb@bitxtender.com> 
     111   * @since      0.11.0 
     112   */ 
    83113  public function onGenerate(array $defaultParameters, array &$userParameters) 
    84114  { 

  • trunk/src/routing/AgaviWebRouting.class.php

    r1134 r1239  
    5656   * Initialize the routing instance. 
    5757   * 
    58    * @param      AgaviContext A Context instance. 
    59    * @param      array        An array of initialization parameters. 
     58   * @param      AgaviResponse An AgaviResponse instance. 
     59   * @param      array         An array of initialization parameters. 
    6060   * 
    6161   * @author     Dominik del Bondio <ddb@bitxtender.com> 
    … …  
    165165   * @param      array  An array of options. 
    166166   * 
    167    * @return     string 
     167   * @return     string The generated URL. 
    168168   * 
    169169   * @author     Sean Kerr <skerr@mojavi.org>