Changeset 1301

Show
Ignore:
Timestamp:
01/25/08 20:09:22 (4 months ago)
Author:
richi
Message:

coding standards: fixed coding standards issues (function docblock)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/src/main/php/net/stubbles/auth/storage/stubAuthAbstractStorage.php

    r1209 r1301  
    7878     * 
    7979     * @param  stubAuthResult  $result 
    80      * @param  int             $storetime 
     80     * @param  int             $storeTime 
    8181     */ 
    8282    protected abstract function doSetResult(stubAuthResult $result, $storeTime); 

  • trunk/src/main/php/net/stubbles/auth/storage/stubAuthSessionStorage.php

    r1245 r1301  
    5858     * 
    5959     * @param  stubAuthResult  $result 
    60      * @param  int             $storetime 
     60     * @param  int             $storeTime 
    6161     */ 
    6262    protected function doSetResult(stubAuthResult $result, $storeTime) 

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

    r1209 r1301  
    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 
    7474     */ 
    7575    public static function createInstance(stubAuthStrategy $strategy, stubAuthStorage $storage, $id = self::ID_DEFAULT) 
    …… 
    134134     * add an authentificator 
    135135     * 
    136      * @param stubAuthenticator $authentificator 
     136     * @param stubAuthenticator $authentificator 
    137137     */ 
    138138    public function addAuthenticator(stubAuthenticator $authentificator) 

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

    r1281 r1301  
    9393     * handles an event 
    9494     * 
    95      * @param   stubEvent  $event  event that triggered this event action 
     95     * @param   stubEvent  $event  event that triggered this event action 
    9696     * @throws  stubCallbackException 
    9797     */ 

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

    r1281 r1301  
    7272     * get the instance of the event dispatcher with the given name 
    7373     * 
    74      * @param   string           $name  optional  name of the event dispatcher 
     74     * @param   string  $name  optional  name of the event dispatcher 
    7575     * @return  stubEventDispatcher 
    7676     */ 
    …… 
    244244     * @param   string  $eventName  name of event that occured 
    245245     * @param   mixed   $context    optional  context for the event 
    246      * @param   array   $data       optional  data to notify action with 
     246     * @param   array   $info       optional  data to notify action with 
    247247     * @param   bool    $queue      optional  true if event should be queued, default false 
    248248     * @param   bool    $bubble     optional  false if event should not bubble, default true 

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

    r1209 r1301  
    2626     * constructor 
    2727     * 
    28      * @param  string  $fqClassName  full qualified name of the class to execute 
     28     * @param  string  $fqClassName  full qualified name of the class to execute 
    2929     */ 
    3030    public function __construct($fqClassName) 

  • trunk/src/main/php/net/stubbles/ioc/annotations/stubInjectAnnotation.php

    r1222 r1301  
    4646     * Checks, whether the injection is optional 
    4747     * 
    48      * @return boolean 
     48     * @return boolean 
    4949     */ 
    5050    public function isOptional() 

  • trunk/src/main/php/net/stubbles/ioc/stubAbstractIOCPreInterceptor.php

    r1222 r1301  
    3939     * Configure the binder 
    4040     * 
    41      * @param stubBinder $binder 
     41     * @param stubBinder $binder 
    4242     */ 
    4343    abstract protected function configure(stubBinder $binder); 

  • trunk/src/main/php/net/stubbles/ioc/stubBinder.php

    r1296 r1301  
    4747     * Create a new binder 
    4848     * 
    49      * @param stubInjector $injector 
     49     * @param stubInjector $injector 
    5050     */ 
    5151    public function __construct(stubInjector $injector = null) 
    …… 
    6161     * Bind a new interface to a class 
    6262     * 
    63      * @param string $interface 
    64      * @return stubClassBinding 
     63     * @param   string $interface 
     64     * @return stubClassBinding 
    6565     */ 
    6666    public function bind($interface) 
    …… 
    7474     * Bind a new constant 
    7575     * 
    76      * @return stubConstantBinding 
     76     * @return stubConstantBinding 
    7777     */ 
    7878    public function bindConstant() 
    …… 
    8686     * Get an injector for this binder 
    8787     * 
    88      * @return stubInjector 
     88     * @return stubInjector 
    8989     */ 
    9090    public function getInjector() 

  • trunk/src/main/php/net/stubbles/ioc/stubBindingModule.php

    r1222 r1301  
    1919     * Configure the binder 
    2020     * 
    21      * @param stubBinder $binder 
     21     * @param stubBinder $binder 
    2222     */ 
    2323    public function configure(stubBinder $binder); 

  • trunk/src/main/php/net/stubbles/ioc/stubConstantBinding.php

    r1222 r1301  
    5252     * set the constant value 
    5353     * 
    54      * @param   mixed 
     54     * @param   mixed  $value 
    5555     * @return  stubBinding 
    5656     */ 

  • trunk/src/main/php/net/stubbles/ioc/stubInjector.php

    r1296 r1301  
    4343     * 
    4444     * @param   string  $type 
     45     * @param   string  $name 
    4546     * @return  object 
    4647     * @throws  stubBindingException 

  • trunk/src/main/php/net/stubbles/ipo/request/broker/annotations/stubPasswordFilterAnnotation.php

    r1223 r1301  
    4949     * sets the encoder class to be used 
    5050     * 
    51      * @param  stubReflectionClass  $encoder 
     51     * @param  stubReflectionClass  $encoderClass 
    5252     */ 
    5353    public function setEncoder(stubReflectionClass $encoderClass) 

  • trunk/src/main/php/net/stubbles/ipo/request/broker/annotations/stubStringFilterAnnotation.php

    r1282 r1301  
    103103     * sets the encoder class to be used 
    104104     * 
    105      * @param  stubReflectionClass  $encoder 
     105     * @param  stubReflectionClass  $encoderClass 
    106106     */ 
    107107    public function setEncoder(stubReflectionClass $encoderClass) 

  • trunk/src/main/php/net/stubbles/ipo/request/broker/annotations/stubTextFilterAnnotation.php

    r1223 r1301  
    102102     * sets the encoder class to be used 
    103103     * 
    104      * @param  stubReflectionClass  $encoder 
     104     * @param  stubReflectionClass  $encoderClass 
    105105     */ 
    106106    public function setEncoder(stubReflectionClass $encoderClass) 

  • trunk/src/main/php/net/stubbles/ipo/request/filters/stubAbstractFilterDecorator.php

    r1296 r1301  
    2828     * setter method 
    2929     * 
    30      * @param unknown_type $decoratedFilter 
     30     * @param stubFilter $decoratedFilter 
    3131     */ 
    3232    public function setDecoratedFilter($decoratedFilter) 
    …… 
    3535    } 
    3636 
     37    /** 
     38     * getter method 
     39     * 
     40     * @return  stubFilter 
     41     */ 
    3742    public function getDecoratedFilter() 
    3843    { 

  • trunk/src/main/php/net/stubbles/ipo/request/filters/stubFilterException.php

    r142 r1301  
    2727     * Constructor for this class. 
    2828     * 
    29      * @param  stubRequestValueError $error    error 
     29     * @param  stubRequestValueError  $error  error 
    3030     */ 
    3131    public function __construct(stubRequestValueError $error) 

  • trunk/src/main/php/net/stubbles/ipo/request/filters/stubIntegerFilter.php

    r1223 r1301  
    2424     * 
    2525     * @param  stubRequestValueErrorFactory  $rveFactory  factory to create RequestValueErrors 
    26      * @param  stubValidator                 $min  validator for minimum values 
    27      * @param  stubValidator                 $max  validator for maximum values 
     26     * @param  stubValidator                 $min         validator for minimum values 
     27     * @param  stubValidator                 $max         validator for maximum values 
    2828     */ 
    2929    public function __construct(stubRequestValueErrorFactory $rveFactory, stubValidator $min = null, stubValidator $max = null) 

  • trunk/src/main/php/net/stubbles/ipo/request/filters/stubMailFilter.php

    r1223 r1301  
    2727     * constructor 
    2828     * 
    29      * @param  stubRequestValueErrorFactory  $rveFactory    factory to create stubRequestValueErrors 
     29     * @param  stubRequestValueErrorFactory  $rveFactory    factory to create stubRequestValueErrors 
    3030     * @param  stubValidator                 $mailValidator  validator to check the mail address 
    3131     */ 

  • trunk/src/main/php/net/stubbles/ipo/request/filters/stubNumberFilter.php

    r1232 r1301  
    4040     * 
    4141     * @param  stubRequestValueErrorFactory  $rveFactory  factory to create RequestValueErrors 
    42      * @param  stubValidator                 $min  validator for minimum values 
    43      * @param  stubValidator                 $max  validator for maximum values 
     42     * @param  stubValidator                 $min         validator for minimum values 
     43     * @param  stubValidator                 $max         validator for maximum values 
    4444     */ 
    4545    public function __construct(stubRequestValueErrorFactory $rveFactory, stubValidator $min = null, stubValidator $max = null) 

  • trunk/src/main/php/net/stubbles/ipo/request/filters/stubRegexFilterDecorator.php

    r1296 r1301  
    5757     * constructor 
    5858     * 
    59      * @param   stubFilter  $filter      decorated filter 
    60      * @param   string      $regex       regex to apply 
    61      * @param   int         $strategy    decrorator strategy 
     59     * @param   stubFilter  $filter    decorated filter 
     60     * @param   string      $regex     regex to apply 
     61     * @param   int         $strategy  decrorator strategy 
    6262     * @throws  stubIllegalArgumentException 
    6363     */ 
    …… 
    7676     * specialized filtering 
    7777     * 
    78      * @param   string                         $value 
     78     * @param   string                     $value 
     79     * @return  string 
    7980     * @throws  stubRuntimeException 
    8081     * @throws  stubIllegalStateException 

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

    r1281 r1301  
    370370     * 
    371371     * @param   stubFilter  $filter     filter to use 
    372      * @param   string      $paramName  name of request value 
     372     * @param   string      $valueName  name of request value 
    373373     * @param   int         $source     optional  source type: cookie, header, param 
    374374     * @return  mixed 
    …… 
    399399     * return an array of all keys registered in this request 
    400400     * 
     401     * @param   int            $source  optional  source type: cookie, header, param 
    401402     * @return  array<string> 
    402403     */ 

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

    r1281 r1301  
    208208     * 
    209209     * @param   stubFilter  $filter     filter to use 
    210      * @param   string      $paramName  name of request value 
     210     * @param   string      $valueName  name of request value 
    211211     * @param   int         $source     optional  source type: cookie, header, param 
    212212     * @return  mixed 
    …… 
    218218     * return an array of all keys registered in this request 
    219219     * 
     220     * @param   int            $source     optional  source type: cookie, header, param 
    220221     * @return  array<string> 
    221222     */ 

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

    r1281 r1301  
    330330     * 
    331331     * @param   stubFilter  $filter     filter to use 
    332      * @param   string      $paramName  name of request value 
     332     * @param   string      $valueName  name of request value 
    333333     * @param   int         $source     optional  source type: cookie, header, param 
    334334     * @return  mixed 
    …… 
    347347     * return an array of all keys registered in this request 
    348348     * 
     349     * @param   int            $source  optional  source type: cookie, header, param 
    349350     * @return  array<string> 
    350351     */ 
    …… 
    370371     * check whether the prefix has to be applied for requested source 
    371372     * 
    372      * @param  int  $sources  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) 
    373374     */ 
    374375    protected function applyPrefix($source) 

  • trunk/src/main/php/net/stubbles/ipo/session/stubSession.php

    r1242 r1301  
    144144     * removes a value from the session 
    145145     * 
    146      * @param   string  $key  key where value is stored under 
     146     * @param   string  $name  key where value is stored under 
    147147     * @return  bool    true if value existed and was removed, else false 
    148148     * @throws  stubSessionException 

  • trunk/src/main/php/net/stubbles/lang/errorhandler/stubAbstractExceptionHandler.php

    r1209 r1301  
    5252     * sets the target of the log data 
    5353     * 
    54      * @param  string  $logName 
     54     * @param  string  $logTarget 
    5555     */ 
    5656    public function setLogTarget($logTarget) 

  • trunk/src/main/php/net/stubbles/lang/errorhandler/stubLogErrorHandler.php

    r1281 r1301  
    7171     * sets the target of the log data 
    7272     * 
    73      * @param  string  $logName 
     73     * @param  string  $logTarget 
    7474     */ 
    7575    public function setLogTarget($logTarget) 

  • trunk/src/main/php/net/stubbles/lang/serialize/stubSerializableObject.php

    r1281 r1301  
    7474     * takes care of serializing the value 
    7575     * 
    76      * @param  array   $propertiesToSerialize  list of properties to serialize 
    77      * @param  string  $name                   name of the property to serialize 
    78      * @param  mixed   $value                  value to serialize 
     76     * @param  array   &$propertiesToSerialize  list of properties to serialize 
     77     * @param  string  $name                    name of the property to serialize 
     78     * @param  mixed   $value                  value to serialize 
    7979     */ 
    8080    protected function __doSerialize(&$propertiesToSerialize, $name, $value) 

  • trunk/src/main/php/net/stubbles/lang/stubBaseObject.php

    r1209 r1301  
    122122     * See http://stubbles.org/archives/32-Subtle-BC-break-in-PHP-5.2.4.html. 
    123123     * 
     124     * @param   mixed  $object 
    124125     * @return  array<string,mixed> 
    125126     */ 

  • trunk/src/main/php/net/stubbles/lang/stubEnum.php

    r1209 r1301  
    100100     * 
    101101     * @param   ReflectionClass  $enum 
    102      * @param   string           $name 
     102     * @param   string           $value 
    103103     * @return  stubEnum 
    104104     * @throws  stubIllegalArgumentException 

  • trunk/src/main/php/net/stubbles/lang/stubMode.php

    r1209 r1301  
    259259     * helper method to create the callback from the handler data 
    260260     * 
    261      * @param   array     $handler  handler data 
     261     * @param   array     &$handler  handler data 
    262262     * @return  callback 
    263263     * @throws  stubIllegalArgumentException 

  • trunk/src/main/php/net/stubbles/php/serializer/stubUnknownObject.php

    r1224 r1301  
    7878     * member get interceptor 
    7979     * 
    80      * @param   string name 
    81      * @param   mixed value 
     80     * @param   string  $name 
    8281     * @throws  stubIllegalAccessException 
    8382     */ 

  • trunk/src/main/php/net/stubbles/rdbms/pdo/stubDatabasePDOStatement.php

    r1298 r1301  
    5656     * bind a result column to a variable 
    5757     * 
    58      * @param   int|string  $column  column number or name to bind the variable to 
    59      * @param   mixed       $param   the variable to bind to the column 
    60      * @param   int|string  $type    optional  type of the binded variable 
     58     * @param   int|string  $column     column number or name to bind the variable to 
     59     * @param   mixed       &$variable  the variable to bind to the column 
     60     * @param   int|string  $type       optional  type of the binded variable 
    6161     * @return  bool        true on success, false on failure 
    6262     * @throws  stubDatabaseException 
    …… 
    8181     * used, not the value at the time when this method is called. 
    8282     * 
    83      * @param   int|string  $param     the order number of the parameter or its name 
    84      * @param   mixed       $variable  the variable to bind to the parameter 
    85      * @param   int|string  $type      optional  type of the parameter 
    86      * @param   int         $length    optional  length of the data type 
     83     * @param   int|string  $param      the order number of the parameter or its name 
     84     * @param   mixed       &$variable  the variable to bind to the parameter 
     85     * @param   int|string  $type      optional  type of the parameter 
     86     * @param   int         $length    optional  length of the data type 
    8787     * @return  bool        true on success, false on failure 
    8888     * @throws  stubDatabaseException 
    …… 
    125125     * executes a prepared statement 
    126126     * 
    127      * @param  array  $values  optional  specifies all necessary information for bindParam() 
    128      *                                   the array elements must use keys corresponding to the 
    129      *                                   number of the position or name of the parameter 
     127     * @param  array  $values  optional  specifies all necessary information for bindParam() 
     128     *                                    the array elements must use keys corresponding to the 
     129     *                                    number of the position or name of the parameter 
    130130     * @return  stubDatabaseResult 
    131131     * @throws  stubDatabaseException 

  • trunk/src/main/php/net/stubbles/rdbms/persistence/annotations/stubDBColumnAnnotation.php

    r1225 r1301  
    8787     * sets the size of the column 
    8888     * 
    89      * @param  int|string  $type 
     89     * @param  int|string  $size 
    9090     */ 
    9191    public function setSize($size) 
    …… 
    127127     * set whether the column is a primary key or not 
    128128     * 
    129      * @param  bool  $isPrimaryKey 
     129     * @param  bool  $isKey 
    130130     */ 
    131131    public function setIsKey($isKey) 

  • trunk/src/main/php/net/stubbles/rdbms/persistence/annotations/stubDBJoinAnnotation.php

    r1225 r1301  
    7878     * sets the join condition 
    7979     * 
    80      * @param   string  $condition 
     80     * @param   string  $conditionType 
    8181     * @throws  stubIllegalArgumentException 
    8282     */ 

  • trunk/src/main/php/net/stubbles/rdbms/persistence/stubPersistenceHelper.php

    r1225 r1301  
    4141     * helper method to create the correct table definition 
    4242     * 
    43      * @param    stubBaseReflectionClass  $entityClass 
    44      * @return  stubDBTableDescription 
     43     * @param   stubBaseReflectionClass  $entityClass 
     44     * @return  stubDBTableDescription 
    4545     */ 
    4646    protected function getTableDescription(stubBaseReflectionClass $entityClass) 

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

    <
    r1225 r1301  
    9898     * setsan instantiated query builder to use for the given database type 
    9999     * 
    100      * @param string                    $database      type of the database (e.g. MySQL, PostgrSQL) 
    101      * @param stubDatabaseQueryBuilder  $queryBuilder  the querybuilder to use 
     100     * @param string                    $database      type of the database (e.g. MySQL, PostgrSQL) 
     101     * @param stubDatabaseQueryBuilder  $queryBuilder  the querybuilder to use 
    102102     */