Changeset 1311

Show
Ignore:
Timestamp:
01/29/08 18:44:27 (7 months ago)
Author:
mikey
Message:

fixed doc comments

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/src/main/php/net/stubbles/auth/stubAuth.php

    r1301 r1311  
    6969     * creates and returns an auth instance 
    7070     * 
    71      * @param  stubAuthStrategy  $strategy  strategy to be used for authentification 
    72      * @param  stubAuthStorage   $storage   storage to be used for storing the result 
    73      * @param  string            $id        id of the auth instance to create 
     71     * @param   stubAuthStrategy  $strategy  strategy to be used for authentification 
     72     * @param   stubAuthStorage   $storage   storage to be used for storing the result 
     73     * @param   string            $id        id of the auth instance to create 
     74     * @return  stubAuth 
    7475     */ 
    7576    public static function createInstance(stubAuthStrategy $strategy, stubAuthStorage $storage, $id = self::ID_DEFAULT) 
    …… 
    9091     * If the instance does not exist a stubAuthException will be thrown. 
    9192     * 
    92      * @param   string  $id  id of the auth instance 
     93     * @param   string    $id  id of the auth instance 
     94     * @return  stubAuth 
    9395     * @throws  stubAuthException 
    9496     */ 

  • trunk/src/main/php/net/stubbles/events/stubEventDispatcher.php

    r1301 r1311  
    202202     * checks if an event listener is registered for an event 
    203203     * 
    204      * @param  stubEventListener  $eventListener  listener that should be checked 
    205      * @param  string             $eventName      event for which listener should be checked 
     204     * @param   stubEventListener  $eventListener  listener that should be checked 
     205     * @param   string             $eventName      event for which listener should be checked 
     206     * @return  bool 
    206207     */ 
    207208    public function has(stubEventListener $eventListener, $eventName) 

  • trunk/src/main/php/net/stubbles/ipo/request/stubRequestPrefixDecorator.php

    r1301 r1311  
    371371     * check whether the prefix has to be applied for requested source 
    372372     * 
    373      * @param  int  $source  can be any of stubRequest::SOURCE_* or a combination of them (bit value) 
     373     * @param   int   $source  can be any of stubRequest::SOURCE_* or a combination of them (bit value) 
     374     * @return  bool 
    374375     */ 
    375376    protected function applyPrefix($source) 

  • trunk/src/main/php/net/stubbles/ipo/session/resourcemanager/stubSessionResourceManager.php

    r1296 r1311  
    7272     * are no two interfaces with the same name. 
    7373     * 
    74      * @param  stubBaseReflectionClass  $type 
    75      * @see    net::stubbles::ioc::stubInjectionProvider::get() 
     74     * @param   stubBaseReflectionClass  $type 
     75     * @return  object 
     76     * @see     net::stubbles::ioc::stubInjectionProvider::get() 
    7677     */ 
    7778    public function get(stubBaseReflectionClass $type) 
    …… 
    9495     * 
    9596     * @param   string|stubReflectionClass  $interface 
     97     * @return  object 
    9698     * @throws  stubConfigurationException 
    9799     */ 

  • trunk/src/main/php/net/stubbles/rdbms/persistence/finder/stubDatabaseFinder.php

    r1281 r1311  
    148148     * helper method to retrieve the data for a given select instance 
    149149     * 
    150      * @param   stubDatabaseSelect       $select 
    151150     * @param   stubBaseReflectionClass  $entityClass 
     151     * @param   stubSetterMethodHelper   $setterMethodHelper 
     152     * @param   stubCriterion            $criterion           optional 
     153     * @param   array                    $primaryKeys         optional 
    152154     * @return  array 
    153155     * @throws  stubDatabaseFinderException 
    …… 
    192194     * @param   stubBaseReflectionClass      $entityClass 
    193195     * @param   stubSetterMethodHelper       $setterMethodHelper 
     196     * @param   array                        $primaryKeys         optional 
    194197     * @return  stubDatabaseSelect 
    195198     * @throws  stubDatabaseFinderException 

  • trunk/src/main/php/net/stubbles/rdbms/persistence/finder/stubDatabaseFinderResult.php

    r1225 r1311  
    7171    /** 
    7272     * returns amount of found entities 
     73     * 
     74     * @return  int 
    7375     */ 
    7476    public function count() 

  • trunk/src/main/php/net/stubbles/rdbms/persistence/serializer/stubDatabaseSerializer.php

    r1281 r1311  
    318318     * 
    319319     * @param   array<string,string>   $queries           list of queries to process 
    320      * @param   object                 $entity            the entity to process the queries for 
    321      * @param   array<string,string>   $singlePrimaryKey  optional  information about the single primary key 
    322320     * @throws  stubDatabaseException 
    323321     */ 

  • trunk/src/main/php/net/stubbles/rdbms/querybuilder/stubDatabaseMySQLQueryBuilder.php

    r1225 r1311  
    186186     * 
    187187     * @param   stubDatabaseTableDescription       $tableDescription 
     188     * @return  string 
    188189     * @throws  stubDatabaseQueryBuilderException 
    189190     */ 

  • trunk/src/main/php/net/stubbles/rdbms/stubDatabaseStatement.php

    r1281 r1311  
    2424     * used, not the value at the time when this method is called. 
    2525     * 
    26      * @param   int|string  $param     the order number of the parameter or its name 
    27      * @param   mixed       $variable  the variable to bind to the parameter 
    28      * @param   int|string  $type      optional  type of the parameter 
    29      * @param   int         $length    optional  length of the data type 
     26     * @param   int|string  $param      the order number of the parameter or its name 
     27     * @param   mixed       &$variable  the variable to bind to the parameter 
     28     * @param   int|string  $type      optional  type of the parameter 
     29     * @param   int         $length    optional  length of the data type 
    3030     * @return  bool        true on success, false on failure 
    3131     * @throws  stubDatabaseException 
    …… 
    5050     * executes a prepared statement 
    5151     * 
    52      * @param  array  $values  optional  specifies all necessary information for bindParam() 
    53      *                                   the array elements must use keys corresponding to the 
    54      *                                   number of the position or name of the parameter 
     52     * @param  array  $values  optional  specifies all necessary information for bindParam() 
     53     *                                    the array elements must use keys corresponding to the 
     54     *                                    number of the position or name of the parameter 
    5555     * @return  stubDatabaseResult 
    5656     * @throws  stubDatabaseException 

  • trunk/src/main/php/net/stubbles/util/net/http/stubHTTPURL.php

    r1291 r1311  
    3939     * parses an url out of a string 
    4040     * 
    41      * @param   string  $urlString 
     41     * @param   string       $urlString 
     42     * @return  stubHTTPURL 
    4243     * @throws  stubMalformedURLException 
    4344     */ 

  • trunk/src/main/php/net/stubbles/util/net/stubURL.php

    r1230 r1311  
    5656     * parses an url out of a string 
    5757     * 
    58      * @param   string  $urlString 
     58     * @param   string   $urlString 
     59     * @return  stubURL 
    5960     * @throws  stubMalformedURLException 
    6061     */ 

  • trunk/src/main/php/net/stubbles/util/validators/stubExtFilterValidator.php

    r1296 r1311  
    4141     * constructor 
    4242     * 
    43      * @param  int|double  $min  minimum value 
     43     * @param  string  $filter   name of filter to apply 
     44     * @param  array   $options  optional  options for the filter 
     45     * @param  int     $flags    optional  flags for the filter 
    4446     */ 
    45     public function __construct($filter, $options = array(), $flags = FILTER_FLAG_NONE) 
     47    public function __construct($filter, array $options = array(), $flags = FILTER_FLAG_NONE) 
    4648    { 
    4749        $this->filter  = $filter; 
    …… 
    6264            return false; 
    6365        } 
     66         
    6467        return true; 
    6568    } 

  • trunk/src/main/php/net/stubbles/util/xjconf/stubConfigXJConfExtension.php

    r1301 r1311  
    6767     * Process the end element 
    6868     *  
    69      * @param   XmlParser  $parser 
    70      * @param   Tag        $tag 
     69     * @param   XmlParser   $parser 
     70     * @param   Tag         $tag 
     71     * @return  GenericTag 
    7172     * @throws  XJConfException 
    7273     */ 

  • trunk/src/main/php/net/stubbles/util/xjconf/stubXJConfLoader.php

    r1230 r1311  
    7070     * returns short class name 
    7171     * 
    72      * @param  string  $fqClassName  the full qualified class name 
     72     * @param   string  $fqClassName  the full qualified class name 
     73     * @return  string 
    7374     */ 
    7475    public function getType($fqClassName) 

  • trunk/src/main/php/net/stubbles/websites/memphis/stubMemphisTemplate.php

    r1281 r1311  
    136136     * $variables has to be an assotiative array containing variable/value pairs. 
    137137     * 
    138      * @param  string  $template   name of the template 
    139      * @param  array   $variables  assotiative array of the variables 
    140      * @param  string  $prefix     optional  prefix for all variable names 
     138     * @param   string  $template   name of the template 
     139     * @param   array   $variables  assotiative array of the variables 
     140     * @param   string  $prefix     optional  prefix for all variable names 
     141     * @return  bool 
    141142     */ 
    142143    public function addVars($template, $variables, $prefix = '') 

  • trunk/src/main/php/net/stubbles/xml/serializer/annotations/stubXMLMatcherAnnotation.php

    r1307 r1311  
    7676     * @param   stubReflectionMethod  $method 
    7777     * @param   mixed                 $returnValue 
     78     * @return  string|bool 
    7879     * @throws  stubXMLException 
    7980     */ 

  • trunk/src/main/php/net/stubbles/xml/unserializer/stubXMLUnserializer.php

    r1301 r1311  
    248248     * converts it to the correct type. 
    249249     * 
    250      * @param  string  $namespaceURI  namespace of end tag 
    251      * @param  string  $sName         name of end tag 
     250     * @param   string  $namespaceURI  namespace of end tag 
     251     * @param   string  $sName         name of end tag 
     252     * @return  mixed 
    252253     */ 
    253254    protected function endElement($namespaceURI, $sName)