Changeset 142

Show
Ignore:
Timestamp:
01/23/07 18:41:38 (2 years ago)
Author:
mikey
Message:

added some more documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/src/main/php/net/stubbles/ipo/interceptors/stubPostInterceptor.php

    r80 r142  
    33 * interface for postinterceptors 
    44 * 
    5  * @author  Frank Kleine <mikey@stubbles.net> 
     5 * @author      Frank Kleine <mikey@stubbles.net> 
     6 * @package     stubbles 
     7 * @subpackage  ipo_interceptors 
    68 */ 
    79/** 
    810 * interface for postinterceptors 
     11 *  
     12 * Postinterceptors are called after all data processing is done. They can change 
     13 * the response or add additional data to the response. 
    914 * 
    1015 * @package     stubbles 
    11  * @subpackage  ipo 
     16 * @subpackage  ipo_interceptors 
    1217 */ 
    1318interface stubPostInterceptor 

  • trunk/src/main/php/net/stubbles/ipo/interceptors/stubPreInterceptor.php

    r80 r142  
    33 * interface for preinterceptors 
    44 * 
    5  * @author  Frank Kleine <mikey@stubbles.net> 
     5 * @author      Frank Kleine <mikey@stubbles.net> 
     6 * @package     stubbles 
     7 * @subpackage  ipo_interceptors 
    68 */ 
    79/** 
    810 * interface for preinterceptors 
     11 *  
     12 * Preinterceptors are called after all initializations have been done and  
     13 * before processing of data starts. 
    914 * 
    1015 * @package     stubbles 
    11  * @subpackage  ipo 
     16 * @subpackage  ipo_interceptors 
    1217 */ 
    1318interface stubPreInterceptor 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubFilter'); 
    1010/** 
    1111 * Basic class for filters. 
     12 *  
     13 * This class offers a basic implementation for the stubFilter interface. 
    1214 * 
    1315 * @package     stubbles 
    14  * @subpackage  ipo 
     16 * @subpackage  ipo_request_filters 
    1517 */ 
    1618abstract class stubAbstractFilter extends stubBaseObject implements stubFilter 

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

    r140 r142  
    11<?php 
    22/** 
    3  * Class for filtering strings. 
     3 * Base class for filtering strings. 
    44 *  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubAbstractFilter'); 
    1010/** 
    11  * Class for filtering strings. 
     11 * Base class for filtering strings. 
     12 *  
     13 * This is a base class for string filtering. It provides methods to check the  
     14 * minimum and maximum length of a string using validators, but both are  
     15 * optional checks. 
    1216 * 
    1317 * @package     stubbles 
    14  * @subpackage  ipo 
     18 * @subpackage  ipo_request_filters 
     19 * @uses        net.stubbles.helper.validators 
    1520 */ 
    1621abstract class stubAbstractStringFilter extends stubAbstractFilter 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubFilterException'); 
    1010/** 
    1111 * Interface for filters. 
     12 *  
     13 * Filters can be used to take request values, validate them and change them 
     14 * into any other value. 
    1215 * 
    1316 * @package     stubbles 
    14  * @subpackage  ipo 
     17 * @subpackage  ipo_request_filters 
    1518 */ 
    1619interface stubFilter 

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

    r75 r142  
    66 * @author      Frank Kleine <mikey@stubbles.net> 
    77 * @package     stubbles 
    8  * @subpackage  ipo 
     8 * @subpackage  ipo_request_filters 
    99 */ 
    1010/** 
    …… 
    1313 * 
    1414 * @package     stubbles 
    15  * @subpackage  ipo 
     15 * @subpackage  ipo_request_filters 
    1616 */ 
    1717class stubFilterException extends stubException 

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

    r97 r142  
    11<?php 
    22/** 
    3  * Basic class for filters on request variables of type double / float. 
     3 * Filters on request variables of type double / float. 
    44 *  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubNumberFilter', 
    …… 
    1111); 
    1212/** 
    13  * Basic class for filters on request variables of type double / float. 
     13 * Filters on request variables of type double / float. 
     14 *  
     15 * This filter takes any value, casts it to float and checks if it complies  
     16 * with the min and/or the max validator. Afterwards its multiplied with 10^x 
     17 * (x is configureable via the registry) to get an integer value that can be 
     18 * used for mathematical operations for accuracy. 
    1419 * 
    1520 * @package     stubbles 
    16  * @subpackage  ipo 
     21 * @subpackage  ipo_request_filters 
     22 * @uses        net.stubbles.helper.validators 
    1723 */ 
    1824class stubFloatFilter extends stubNumberFilter 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubFilter'); 
    …… 
    1212 * 
    1313 * @package     stubbles 
    14  * @subpackage  ipo 
     14 * @subpackage  ipo_request_filters 
     15 * @see         http://php.net/htmlspecialchars 
    1516 */ 
    1617class stubHtmlOutputFilter extends stubBaseObject implements stubFilter 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubNumberFilter'); 
    1010/** 
    1111 * Basic class for filters on request variables of type integer. 
     12 *  
     13 * This filter takes any value, casts it to int and checks if it complies  
     14 * with the min and/or the max validator. 
    1215 * 
    1316 * @package     stubbles 
    14  * @subpackage  ipo 
     17 * @subpackage  ipo_request_filters 
     18 * @uses        net.stubbles.helper.validators 
    1519 */ 
    1620class stubIntegerFilter extends stubNumberFilter 

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

    r140 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubAbstractFilter', 
    …… 
    1313/** 
    1414 * Basic class for filters on variables of type number. 
     15 *  
     16 * This filter takes any value, casts it to float and checks if it complies  
     17 * with the min and/or the max validator. 
    1518 * 
    1619 * @package     stubbles 
    17  * @subpackage  ipo 
     20 * @subpackage  ipo_request_filters 
     21 * @uses        net.stubbles.helper.validators 
    1822 */ 
    1923class stubNumberFilter extends stubAbstractFilter 

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

    r140 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubAbstractFilter'); 
    1010/** 
    1111 * Class for filtering passwords. 
     12 *  
     13 * This filter allows to check password inputs and if they comply with the rules  
     14 * for a password. A minimum length validator can check the length of the password. 
     15 * Additionally its possible to check against a list of non-allowed passwords  
     16 * (e.g. the username or the login name). The returned value is a md5- 
     17 * representation of the password. 
     18 * If the value is an array the fields with key 0 and 1 are compared. If they are 
     19 * not equal the password is not allowed (can be used to prevent mistyped  
     20 * passwords in register or password change forms). 
    1221 * 
    1322 * @package     stubbles 
    14  * @subpackage  ipo 
     23 * @subpackage  ipo_request_filters 
     24 * @uses        net.stubbles.helper.validators 
    1525 */ 
    1626class stubPasswordFilter extends stubAbstractFilter 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubAbstractStringFilter'); 
    1010/** 
    1111 * Class for filtering strings (singe line). 
     12 *  
     13 * This filter removes all line breaks. With a regex validator the contents of the 
     14 * string can be checked (applied after all line breaks have been removed). 
    1215 * 
    1316 * @package     stubbles 
    14  * @subpackage  ipo 
     17 * @subpackage  ipo_request_filters 
     18 * @uses        net.stubbles.helper.validators 
    1519 */ 
    1620class stubStringFilter extends stubAbstractStringFilter 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request_filters 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.filters.stubAbstractStringFilter'); 
    …… 
    1111 * Class for filtering texts (strings containing line feeds). 
    1212 * 
    13  * Use the allowed tags option very careful. It does not protect you against 
    14  * possible XSS attacks! 
     13 * This filter removes windows line breaks and html tags from the value. Via 
     14 * setAllowedTags() a list of allowed tags that will not be removed can be 
     15 * specified. Use the allowed tags option very careful. It does not protect 
     16 * you against possible XSS attacks! 
    1517 * 
    1618 * @package     stubbles 
    17  * @subpackage  ipo 
     19 * @subpackage  ipo_request_filters 
     20 * @uses        net.stubbles.helper.validators 
    1821 */ 
    1922class stubTextFilter extends stubAbstractStringFilter 

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

    r139 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.stubRequest'); 
    1010/** 
    1111 * Class for access to request data. 
     12 *  
     13 * This class offers a basic implementation for the stubRequest interface 
     14 * from which any specialized request classes can be inherited. 
    1215 * 
    1316 * @package     stubbles 
    14  * @subpackage  ipo 
     17 * @subpackage  ipo_request 
    1518 */ 
    1619abstract class stubBaseRequest extends stubBaseObject implements stubRequest 

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

    r139 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request 
    88 */ 
    99stubClassLoader::load('net.stubbles.events.stubEventDispatcher', 
    …… 
    1313/** 
    1414 * Interface for handling request variables. 
     15 *  
     16 * The request contains all data send by the user-agent: parameters, 
     17 * headers and cookies. It allows to retrieve this values via validators 
     18 * and filters. Errors that occurred during filtering are collected as well. 
    1519 * 
    1620 * @package     stubbles 
    17  * @subpackage  ipo 
     21 * @subpackage  ipo_request 
     22 * @see         http://stubbles.net/wiki/Docs/Validators 
    1823 */ 
    1924interface stubRequest 

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

    r139 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.stubRequest'); 
    1010/** 
    1111 * Class for handling request variables with a special prefix. 
     12 *  
     13 * This acts as a decorator around a stubRequest instance and allows to restrict 
     14 * access to request values starting with a prefix. Via param $sources from the 
     15 * constructor it is controlled for which source the prefix should be applied. As 
     16 * it is a bit switch you may not only use the stubRequest::SOURCE_* constansts 
     17 * but any combination of them as well: e.g. stubRequest::SOURCE_COOKIE + 
     18 * stubRequest::SOURCE_PARAM applies prefixes on cookies and parameters, but not 
     19 * on headers. 
    1220 * 
    1321 * @package     stubbles 
    14  * @subpackage  ipo 
     22 * @subpackage  ipo_request 
    1523 */ 
    1624class stubRequestPrefixDecorator extends stubBaseObject implements stubRequest 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.stubRequestValueErrorException'); 
    1010/** 
    1111 * Class containing error messages for request values. 
     12 *  
     13 * This is mainly an internal class for the request package, a container for  
     14 * error messages. The messages itself can contain value keys. These value 
     15 * keys are thought to be replaced with concrete values to customize the error  
     16 * message. 
    1217 * 
    1318 * @package     stubbles 
    14  * @subpackage  ipo 
     19 * @subpackage  ipo_request 
    1520 */ 
    1621class stubRequestValueError extends stubBaseObject 
    …… 
    131136     
    132137    /** 
    133      * sets the values 
     138     * Sets the values that should replace the value keys within the messages. 
    134139     *  
    135      * Returns itself for easy use in conjunction with the factory. 
     140     * This method could be used in conjunction with the getCriteria() method  
     141     * of a validator: the return values of these mostly fit well to the  
     142     * required value keys. Returns itself for easy use in conjunction with  
     143     * the factory. 
    136144     * 
    137145     * @param   array<string,mixed>  $values 

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

    r66 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request 
    88 */ 
    99/** 
    …… 
    1111 * 
    1212 * @package     stubbles 
    13  * @subpackage  ipo 
     13 * @subpackage  ipo_request 
    1414 */ 
    1515class stubRequestValueErrorException extends stubException 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.stubRequestValueError'); 
    …… 
    1212 * 
    1313 * @package     stubbles 
    14  * @subpackage  ipo 
     14 * @subpackage  ipo_request 
    1515 */ 
    1616interface stubRequestValueErrorFactory 
    …… 
    1919     * creates the  RequestValueError with the id from the given source 
    2020     * 
    21      * @param   string                $id      id of RequestValueError to create 
    22      * @param   string                $source  optional  source where RequestValueError is defined 
     21     * @param   string                $id      id of RequestValueError to create 
     22     * @param   string                $source  optional  source where RequestValueError is defined 
    2323     * @return  stubRequestValueError 
    2424     * @throws  stubRequestValueErrorException 

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

    r134 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.stubBaseRequest'); 
    1010/** 
    1111 * Specialized class for access to web request data. 
     12 *  
     13 * Please be aware that GET and POST values are merged to param values. There 
     14 * is no possibility to detect if a param value is originally from GET or POST. 
     15 * The headers contain all stuff from $_SERVER that starts with HTTP_ or REMOTE_ 
    1216 * 
    1317 * @package     stubbles 
    14  * @subpackage  ipo 
     18 * @subpackage  ipo_request 
    1519 */ 
    1620class stubWebRequest extends stubBaseRequest 

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

    r97 r142  
    55 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    7  * @subpackage  ipo 
     7 * @subpackage  ipo_request 
    88 */ 
    99stubClassLoader::load('net.stubbles.ipo.request.stubRequestValueErrorFactory', 
    …… 
    1919 * 
    2020 * @package     stubbles 
    21  * @subpackage  ipo 
     21 * @subpackage  ipo_request 
     22 * @uses        http://php.xjconf.net/ 
    2223 */ 
    2324class stubXmlRequestValueErrorFactory extends stubBaseObject implements stubRequestValueErrorFactory 

  • trunk/src/main/php/net/stubbles/ipo/response/stubBaseResponse.php

    r136 r142  
    11<?php 
    22/** 
    3  * interface for a response to a request 
     3 * Base class for a response to a request. 
    44 * 
    5  * @author  Frank Kleine <mikey@stubbles.net> 
     5 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    77 * @subpackage  ipo_response 
    …… 
    99stubClassLoader::load('net.stubbles.ipo.response.stubResponse'); 
    1010/** 
    11  * interface for a response to a request 
     11 * Base class for a response to a request. 
     12 *  
     13 * This class can be used for responses in web environments. It 
     14 * collects all data of the response and is able to send it back 
     15 * to the source that initiated the request. 
    1216 * 
    1317 * @package     stubbles 

  • trunk/src/main/php/net/stubbles/ipo/response/stubCookie.php

    r136 r142  
    11<?php 
    22/** 
    3  * Container for cookies. 
     3 * Container for cookies to be send out to the user. 
    44 * 
    5  * @author  Frank Kleine <mikey@stubbles.net> 
     5 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    77 * @subpackage  ipo_response 
    88 */ 
    99/** 
    10  * Container for cookies. 
     10 * Container for cookies to be send out to the user. 
     11 *  
     12 * Cookies are used to store user-related data within the user-agent 
     13 * e.g. to help detecting that requests are done by the same user. 
     14 * Common applications are session cookies or low-level signon help. 
    1115 * 
    1216 * @package     stubbles 
    1317 * @subpackage  ipo_response 
     18 * @see         http://wp.netscape.com/newsref/std/cookie_spec.html 
     19 * @see         http://www.faqs.org/rfcs/rfc2109.html 
    1420 */ 
    1521class stubCookie extends stubBaseObject 

  • trunk/src/main/php/net/stubbles/ipo/response/stubResponse.php

    r136 r142  
    33 * interface for a response to a request 
    44 * 
    5  * @author  Frank Kleine <mikey@stubbles.net> 
     5 * @author      Frank Kleine <mikey@stubbles.net> 
    66 * @package     stubbles 
    77 * @subpackage  ipo_response 
    …… 
    1010/** 
    1111 * interface for a response to a request 
     12 *  
     13 * The response collects all data that should be send to the source 
     14 * that initiated the request. 
    1215 * 
    1316 * @package     stubbles