Also getSeekPosition() belongs here ... + TODOs.txt updated (--amend rocks!)
[core.git] / docs / TODOs.txt
index 280d1d25a8db4d7af3484cd400141b80c560ab14..790159c1f505b198cceb66be938b5d38a6f89260 100644 (file)
@@ -1,18 +1,23 @@
 ### WARNING: THIS FILE IS AUTO-GENERATED BY ./todo-builder.sh ###
 ### DO NOT EDIT THIS FILE. ###
-./inc/classes/exceptions/io/class_FileNotFoundException.php:10: * @todo                Rename this class to FileIoException
-./inc/classes/exceptions/main/class_ClassNotFoundException.php:10: * @todo             Rename this class to NoClassException
-./inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php:10: * @todo               Rename this class to NoFoundEntryException
 ./inc/classes/exceptions/main/class_MissingMethodException.php:13: * @todo             Try to rewrite user/guest login classes and mark this exception as deprecated
+./inc/classes/exceptions/main/class_NoConfigEntryException.php:10: * @todo             Rename this class to NoFoundEntryException
 ./inc/classes/interfaces/class_FrameworkInterface.php:11: * @todo              Find a better name for this interface
-./inc/classes/main/class_BaseFrameworkSystem.php:1040:  * @todo        Write a logging mechanism for productive mode
-./inc/classes/main/class_BaseFrameworkSystem.php:104:  // @todo Try to clean these constants up
-./inc/classes/main/class_BaseFrameworkSystem.php:1054:                 // @TODO Finish this part!
-./inc/classes/main/class_BaseFrameworkSystem.php:185:   * @todo        This is old code. Do we still need this old lost code?
-./inc/classes/main/class_BaseFrameworkSystem.php:253:   * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
+./inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php:30:    * @todo        Find a nice casting here. (int) allows until and including 32766.
+./inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php:54:    * @todo        Find a nice casting here. (int) allows until and including 32766.
+./inc/classes/main/class_BaseFrameworkSystem.php:1855:  * @todo        Write a logging mechanism for productive mode
+./inc/classes/main/class_BaseFrameworkSystem.php:1870:                 // @TODO Finish this part!
+./inc/classes/main/class_BaseFrameworkSystem.php:225:  // @todo Try to clean these constants up
+./inc/classes/main/class_BaseFrameworkSystem.php:450:          // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
+./inc/classes/main/class_BaseFrameworkSystem.php:524:   * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
 ./inc/classes/main/commands/web/class_WebLoginAreaCommand.php:64:       * @todo        Add some stuff here: Some personal data, app/game related data
-./inc/classes/main/console/class_ConsoleTools.php:41:   * @todo        We should connect this to a caching class to cache DNS requests
-./inc/classes/main/console/class_ConsoleTools.php:54:          // @TODO Here should the cacher be implemented
+./inc/classes/main/commands/web/class_WebProblemCommand.php:58:         * @todo        0% done
+./inc/classes/main/commands/web/class_WebStatusCommand.php:58:  * @todo        0% done
+./inc/classes/main/console/class_ConsoleTools.php:268:  * @todo        This should be moved out to an external class, e.g. HttpClient
+./inc/classes/main/console/class_ConsoleTools.php:269:  * @todo        Make IP, host name, port and script name configurable
+./inc/classes/main/console/class_ConsoleTools.php:276:         // @TODO Add some DNS caching here
+./inc/classes/main/console/class_ConsoleTools.php:45:   * @todo        We should connect this to a caching class to cache DNS requests
+./inc/classes/main/console/class_ConsoleTools.php:58:          // @TODO Here should the cacher be implemented
 ./inc/classes/main/controller/console/class_ConsoleDefaultController.php:10: * @todo           This controller shall still provide some headlines for sidebars
 ./inc/classes/main/controller/login/class_WebLoginAreaController.php:40:        * @todo        Add some morer filters to this controller
 ./inc/classes/main/controller/web/class_WebConfirmController.php:40:    * @todo        Add some filters to this controller
 ./inc/classes/main/controller/web/class_WebLoginController.php:41:      * @todo        Add some filters to this controller
 ./inc/classes/main/controller/web/class_WebLogoutController.php:10: * @todo            This controller shall still provide some headlines for sidebars
 ./inc/classes/main/controller/web/class_WebLogoutDoneController.php:40:         * @todo        Add some filters to this controller
+./inc/classes/main/controller/web/class_WebProblemController.php:40:    * @todo        Add some filters to this controller
 ./inc/classes/main/controller/web/class_WebRegisterController.php:40:   * @todo        Add some filters to this controller
 ./inc/classes/main/controller/web/class_WebStatusController.php:10: * @todo            This controller shall still provide some headlines for sidebars
-./inc/classes/main/criteria/search/class_SearchCriteria.php:114:        * @todo        Find a nice casting here. (int) allows until and including 32766.
-./inc/classes/main/criteria/search/class_SearchCriteria.php:94:         * @todo        Find a nice casting here. (int) allows until and including 32766.
-./inc/classes/main/database/databases/class_LocalFileDatabase.php:363:  * @todo        Do some checks on the database directory and files here
-./inc/classes/main/discovery/payment/class_LocalPaymentDiscovery.php:82:        * @todo        0% done
-./inc/classes/main/filter/change/class_EmailChangeFilter.php:54:        * @todo        Implement email change of the user here. HINT: Use the User class!
+./inc/classes/main/criteria/search/class_SearchCriteria.php:102:        * @todo        Find a nice casting here. (int) allows until and including 32766.
+./inc/classes/main/criteria/search/class_SearchCriteria.php:70:         * @todo        Find a nice casting here. (int) allows until and including 32766.
+./inc/classes/main/database/databases/class_LocalFileDatabase.php:327:  * @todo        Do some checks on the database directory and files here
+./inc/classes/main/database/databases/class_LocalFileDatabase.php:605:  * @todo        Add more generic non-public data for removal
+./inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php:427:       * @todo        Find something useful with this!
+./inc/classes/main/discovery/payment/class_LocalPaymentDiscovery.php:85:        * @todo        0% done
+./inc/classes/main/file_directories/class_BaseFileIo.php:162:   * @todo        Handle seekStatus
+./inc/classes/main/file_directories/class_BaseFile.php:135:     * @todo        ~10% done?
+./inc/classes/main/file_directories/class_BaseFile.php:148:     * @todo        Handle seekStatus
+./inc/classes/main/file_directories/directory/class_FrameworkDirectoryPointer.php:68:   * @todo        Get rid of inConstructor, could be old-lost code.
+./inc/classes/main/file_directories/io_stream/class_FileIoStream.php:270:       * @todo        0% done
+./inc/classes/main/file_directories/io_stream/class_FileIoStream.php:74:        * @todo        This method needs heavy rewrite
+./inc/classes/main/filter/change/class_EmailChangeFilter.php:55:        * @todo        Implement email change of the user here. HINT: Use the User class!
 ./inc/classes/main/filter/change/class_PasswordChangeFilter.php:55:     * @todo        Finished updating user password hash here. HINT: Use the User class again.
 ./inc/classes/main/filter/news/class_NewsProcessFilter.php:55:  * @todo        Unfinished stub, add functionality here
 ./inc/classes/main/filter/payment/class_PaymentDiscoveryFilter.php:97:  * @todo        0% done
 ./inc/classes/main/filter/update/class_UserUpdateFilter.php:55:         * @todo        Add more user updates here
 ./inc/classes/main/filter/verifier/class_AccountPasswordVerifierFilter.php:57:  * @todo        Rewrite handling of different password fields
-./inc/classes/main/helper/class_BaseHelper.php:171:     * @todo        Rewrite this method using a helper class for filtering data
-./inc/classes/main/helper/web/class_BaseWebHelper.php:151:      * @todo        Implement check if rules have been changed
+./inc/classes/main/helper/class_BaseHelper.php:173:     * @todo        Rewrite this method using a helper class for filtering data
+./inc/classes/main/helper/class_BaseHelper.php:202:                    // @TODO Try to log it here
 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:102:        * @todo        Add some unique PIN here to bypass problems with some browser and/or extensions
 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:621:        * @todo        Add checking if sub option is already added
 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:649:        * @todo        Add checking if sub option is already added
+./inc/classes/main/helper/web/forms/class_WebFormHelper.php:683:                       // @TODO We need to log this later
+./inc/classes/main/helper/web/forms/class_WebFormHelper.php:852:        * @todo        Implement check if rules have been changed
 ./inc/classes/main/helper/web/links/class_WebLinkHelper.php:184:        * @todo        Completely unimplemented
 ./inc/classes/main/images/class_BaseImage.php:156:      * @todo        Find something usefull for this method.
 ./inc/classes/main/images/class_BaseImage.php:166:      * @todo        Find something usefull for this method.
 ./inc/classes/main/images/class_BaseImage.php:234:      * @todo        Find something usefull for this method.
 ./inc/classes/main/images/class_BaseImage.php:245:      * @todo        Find something usefull for this method.
 ./inc/classes/main/images/class_BaseImage.php:255:      * @todo        Find something usefull for this method.
-./inc/classes/main/io/class_FileIoStream.php:74:        * @todo        This method needs heavy rewrite
+./inc/classes/main/index/class_BaseIndex.php:135:       * @todo        Currently the index file is not cached, please implement a memory-handling class and if enough RAM is found, cache the whole index file.
+./inc/classes/main/mailer/class_BaseMailer.php:55:             // @TODO This needs testing/fixes because the deprecated method
 ./inc/classes/main/mailer/debug/class_DebugMailer.php:124:      * @todo        0% done
-./inc/classes/main/output/class_ConsoleOutput.php:61:          // @TODO Need to rewrite this to $requestInstance->addHeader()
-./inc/classes/main/output/class_WebOutput.php:55:                      // @TODO Need to rewrite this to $requestInstance->addHeader()
-./inc/classes/main/points/class_UserPoints.php:103:                    // @TODO Load points here
-./inc/classes/main/points/class_UserPoints.php:81:      * @todo        Finish loading part of points
-./inc/classes/main/request/console/class_ConsoleRequest.php:115:               // @TODO There are no cookies on console
-./inc/classes/main/request/console/class_ConsoleRequest.php:55:         * @todo        Needs to be implemented
-./inc/classes/main/resolver/controller/class_BaseControllerResolver.php:137:                   // @TODO Maybe we need to log this?
+./inc/classes/main/menu/class_BaseMenu.php:59:                 // @TODO Should we log it here? We should, because it will be silently ignored.
+./inc/classes/main/output/class_ConsoleOutput.php:56:          // @TODO Need to rewrite this to $requestInstance->addHeader()
+./inc/classes/main/parser/xml/class_XmlParser.php:79:                  // @TODO We need to find a fallback solution here
+./inc/classes/main/points/class_UserPoints.php:100:     * @todo        Finish loading part of points
+./inc/classes/main/request/console/class_ConsoleRequest.php:106:               // @TODO Can't this be 'CONSOLE' ?
+./inc/classes/main/request/web/class_HttpRequest.php:10: * @todo               Move out the cookie part to a seperate class, e.g. Cookie
 ./inc/classes/main/response/http/class_HttpResponse.php:77:     * @todo        Encryption of cookie data not yet supported.
 ./inc/classes/main/response/http/class_HttpResponse.php:78:     * @todo        Why are these parameters conflicting?
 ./inc/classes/main/response/http/class_HttpResponse.php:79:     * @todo        If the return statement is removed and setcookie() commented out,
 ./inc/classes/main/response/http/class_HttpResponse.php:80:     * @todo        this will send only one cookie out, the first one.
-./inc/classes/main/response/image/class_ImageResponse.php:93:   * @todo        Encryption of cookie data not yet supported.
-./inc/classes/main/response/image/class_ImageResponse.php:94:   * @todo        Why are these parameters conflicting?
-./inc/classes/main/response/image/class_ImageResponse.php:95:   * @todo        If the return statement is removed and setcookie() commented out,
-./inc/classes/main/response/image/class_ImageResponse.php:96:   * @todo        this will send only one cookie out, the first one.
-./inc/classes/main/result/class_DatabaseResult.php:226:         * @todo        0% done
-./inc/classes/main/result/class_DatabaseResult.php:379:4        * @todo        Find a caching way without modifying the result array
-./inc/classes/main/rng/class_RandomNumberGenerator.php:150:     * @todo        I had a better random number generator here but now it is somewhere lost :(
-./inc/classes/main/rng/class_RandomNumberGenerator.php:83:      * @todo        Add site key for stronger salt!
-./inc/classes/main/template/class_BaseTemplateEngine.php:1303:                 // @TODO We need to find a fallback solution here
-./inc/classes/main/template/class_BaseTemplateEngine.php:810:   * @todo        Unfinished work or don't die here.
-./inc/classes/main/template/class_BaseTemplateEngine.php:827:                          // @TODO Non-string found so we need some deeper analysis...
-./inc/classes/main/template/class_BaseTemplateEngine.php:904:                  // @TODO Old behaviour, will become obsolete!
-./inc/classes/main/template/class_BaseTemplateEngine.php:907:                  // @TODO Yet another old way
-./inc/classes/main/template/class_BaseTemplateEngine.php:981:   * @todo        Make this code some nicer...
-./inc/classes/main/template/image/class_ImageTemplateEngine.php:229:    * @todo        Find something usefull with this!
-./inc/classes/main/template/image/class_ImageTemplateEngine.php:249:    * @todo        Add cache creation here
-./inc/classes/main/template/mail/class_MailTemplateEngine.php:234:      * @todo        Add cache creation here
-./inc/classes/main/template/mail/class_MailTemplateEngine.php:244:      * @todo        Should we call back the mailer class here?
-./inc/classes/main/template/mail/class_MailTemplateEngine.php:325:      * @todo        0% done
-./inc/classes/main/user/class_BaseUser.php:305:         * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
+./inc/classes/main/response/image/class_ImageResponse.php:88:   * @todo        Encryption of cookie data not yet supported.
+./inc/classes/main/response/image/class_ImageResponse.php:89:   * @todo        Why are these parameters conflicting?
+./inc/classes/main/response/image/class_ImageResponse.php:90:   * @todo        If the return statement is removed and setcookie() commented out,
+./inc/classes/main/response/image/class_ImageResponse.php:91:   * @todo        this will send only one cookie out, the first one.
+./inc/classes/main/result/class_DatabaseResult.php:239:         * @todo        0% done
+./inc/classes/main/result/class_DatabaseResult.php:393:         * @todo        Find a caching way without modifying the result array
+./inc/classes/main/rng/class_RandomNumberGenerator.php:175:     * @todo        I had a better random number generator here but now it is somewhere lost :(
+./inc/classes/main/rng/class_RandomNumberGenerator.php:97:      * @todo        Add site key for stronger salt!
+./inc/classes/main/stacker/file/class_BaseFileStack.php:147:    * @todo        Currently the stack file is not cached, please implement a memory-handling class and if enough RAM is found, cache the whole stack file.
+./inc/classes/main/stacker/file/class_BaseFileStack.php:309:           // @TODO Please implement this, returning FALSE
+./inc/classes/main/stacker/file/class_BaseFileStack.php:45:     * @todo        To hard assertions here, better rewrite them to exceptions
+./inc/classes/main/template/class_BaseTemplateEngine.php:1070:                 // @TODO This silent abort should be logged, maybe.
+./inc/classes/main/template/class_BaseTemplateEngine.php:1078:                 // @TODO Old behaviour, will become obsolete!
+./inc/classes/main/template/class_BaseTemplateEngine.php:1081:                 // @TODO Yet another old way
+./inc/classes/main/template/class_BaseTemplateEngine.php:1289:  * @todo        Make this code some nicer...
+./inc/classes/main/template/class_BaseTemplateEngine.php:967:   * @todo        Unfinished work or don't die here.
+./inc/classes/main/template/class_BaseTemplateEngine.php:992:                          // @TODO Non-string found so we need some deeper analysis...
+./inc/classes/main/template/console/class_ConsoleTemplateEngine.php:10: * @todo                This template engine does not make use of setTemplateType()
+./inc/classes/main/template/image/class_ImageTemplateEngine.php:215:    * @todo        Find something usefull with this!
+./inc/classes/main/template/image/class_ImageTemplateEngine.php:235:    * @todo        Add cache creation here
+./inc/classes/main/template/mail/class_MailTemplateEngine.php:10: * @todo              This template engine does not make use of setTemplateType()
+./inc/classes/main/template/mail/class_MailTemplateEngine.php:228:      * @todo        Add cache creation here
+./inc/classes/main/template/mail/class_MailTemplateEngine.php:238:      * @todo        Should we call back the mailer class here?
+./inc/classes/main/template/mail/class_MailTemplateEngine.php:319:      * @todo        0% done
+./inc/classes/main/template/menu/class_MenuTemplateEngine.php:267:      * @todo        Find something useful with this!
+./inc/classes/main/template/menu/class_MenuTemplateEngine.php:313:      * @todo        Add cache creation here
+./inc/classes/main/user/class_BaseUser.php:308:         * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
 ./inc/classes/main/user/class_BaseUser.php:80:  * @todo        Find a way of casting here. "(int)" might destroy the user id > 32766
 ./inc/classes/main/user/member/class_Member.php:84:     * @todo        Add more ways over creating user classes
-./inc/classes/middleware/debug/class_DebugMiddleware.php:112:                  // @TODO Initialization phase
-./inc/config/class_FrameworkConfiguration.php:205:      * @todo        We have to add some more entries from $_SERVER here
-./inc/database.php:49:// @TODO Rewrite this
-./inc/hooks.php:26:// @TODO This makes the core depending on the SPL. But it should be installed anyway.
-./inc/includes.php:36:// @TODO Find a nicer OOP-ed way for this
-./inc/language.php:31:// @TODO Rewrite this
-./inc/loader/class_ClassLoader.php:262:                        /* @todo: Do not die here. */
+./inc/classes/middleware/compressor/class_CompressorChannel.php:100:                   // @TODO Is there a configurable fall-back compressor needed, or is NullCompressor okay?
+./inc/classes/middleware/debug/class_DebugMiddleware.php:113:                  // @TODO Initialization phase
+./inc/classes/middleware/io/class_FileIoHandler.php:174:        * @todo        0% done
+./inc/classes.php:10: * @todo          Minimize these includes
+./inc/classes/third_party/api/wernisportal/class_WernisApi.php:10: * @todo             Out-dated since 0.6-BETA
+./inc/config/class_FrameworkConfiguration.php:115:      * @todo        This method encapsulates a deprecated PHP function and should be deprecated, too.
+./inc/config/class_FrameworkConfiguration.php:223:      * @todo        We have to add some more entries from $_SERVER here
+./inc/database.php:11: * @todo         Minimize these includes
+./inc/database.php:51:// @TODO Rewrite this
+./inc/includes.php:11: * @todo         Minimize these includes
+./inc/includes.php:37:// @TODO This makes the core depending on the SPL. But it should be installed anyway.
+./inc/includes.php:41:// @TODO Find a nicer OOP-ed way for this
+./inc/loader/class_ClassLoader.php:321:                        /* @todo: Do not die here. */
+./inc/output.php:11: * @todo           Minimize these includes
+./inc/selector.php:11: * @todo         Minimize these includes
 ### ### DEPRECATION FOLLOWS: ### ###
-./inc/classes/exceptions/database/general/class_DatabaseUpdateSupportException.php:10: * @deprecated
-./inc/classes/exceptions/io/class_FileNotFoundException.php:11: * @deprecated
-./inc/classes/exceptions/io/class_InvalidDirectoryResourceException.php:10: * @deprecated
-./inc/classes/exceptions/main/class_ClassNotFoundException.php:11: * @deprecated
-./inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php:11: * @deprecated
-./inc/classes/main/filter/class_AbstractFilterDecorator.php:2:// @DEPRECATED
-./inc/classes/main/template/class_BaseTemplateEngine.php:1131:  * @deprecated
-./inc/config/class_FrameworkConfiguration.php:107:      * @deprecated
+./inc/classes/exceptions/main/class_MissingMethodException.php:14: * @deprecated       Please do no longer use this exception
+./inc/classes/interfaces/database/backend/class_DatabaseFrontendInterface.php:2:// @DEPRECATED
+./inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php:2:// @DEPRECATED
+./inc/classes/main/database/class_BaseDatabaseFrontend.php:2:// @DEPRECATED
+./inc/classes/main/handler/class_BaseHandler.php:2:// @DEPRECATED
+./inc/classes/main/handler/raw_data/class_BaseRawDataHandler.php:2:// @DEPRECATED
+./inc/classes.php:9: * @deprecated
+./inc/database.php:10: * @deprecated
+./inc/hooks.php:2:// @DEPRECATED
+./inc/includes.php:10: * @deprecated
+./inc/output.php:10: * @deprecated
+./inc/selector.php:10: * @deprecated