Added new interfaces for file i/o classes.
[core.git] / docs / TODOs.txt
index 8e647c7..e4c3b81 100644 (file)
@@ -3,15 +3,16 @@
 ./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/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:1131:  * @todo        Write a logging mechanism for productive mode
-./inc/classes/main/class_BaseFrameworkSystem.php:1145:                 // @TODO Finish this part!
-./inc/classes/main/class_BaseFrameworkSystem.php:154:  // @todo Try to clean these constants up
-./inc/classes/main/class_BaseFrameworkSystem.php:235:   * @todo        This is old code. Do we still need this old lost code?
-./inc/classes/main/class_BaseFrameworkSystem.php:303:   * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
+./inc/classes/main/class_BaseFrameworkSystem.php:1301:  * @todo        Write a logging mechanism for productive mode
+./inc/classes/main/class_BaseFrameworkSystem.php:1315:                 // @TODO Finish this part!
+./inc/classes/main/class_BaseFrameworkSystem.php:195:  // @todo Try to clean these constants up
+./inc/classes/main/class_BaseFrameworkSystem.php:465:   * @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/commands/web/class_WebProblemCommand.php:58:         * @todo        0% done
 ./inc/classes/main/commands/web/class_WebStatusCommand.php:58:  * @todo        0% done
 ./inc/classes/main/commands/web/class_WebLoginAreaCommand.php:64:       * @todo        Add some stuff here: Some personal data, app/game related data
 ./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:147:  * @todo        This should be moved out to an external class, e.g. HttpClient
+./inc/classes/main/console/class_ConsoleTools.php:150:  * @todo        This should be moved out to an external class, e.g. HttpClient
+./inc/classes/main/console/class_ConsoleTools.php:151:  * @todo        Make IP, host name, port and script name configurable
+./inc/classes/main/console/class_ConsoleTools.php:158:         // @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/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
@@ -24,9 +25,9 @@
 ./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/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/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:331:  * @todo        Do some checks on the database directory and files here
 ./inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php:426:       * @todo        Find something useful with this!
 ./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/decorator/template/class_XmlRewriterTemplateDecorator.php:426:       * @todo        Find something useful with this!
 ./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/mailer/debug/class_DebugMailer.php:124:      * @todo        0% done
 ./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/mailer/debug/class_DebugMailer.php:124:      * @todo        0% done
 ./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:76:                  // @TODO We need to find a fallback solution here
+./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/points/class_UserPoints.php:100:     * @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/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/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/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/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: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/result/class_DatabaseResult.php:229:         * @todo        0% done
+./inc/classes/main/result/class_DatabaseResult.php:382:4        * @todo        Find a caching way without modifying the result array
+./inc/classes/main/rng/class_RandomNumberGenerator.php:161:     * @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/rng/class_RandomNumberGenerator.php:83:      * @todo        Add site key for stronger salt!
-./inc/classes/main/template/class_BaseTemplateEngine.php:1049:                 // @TODO This silent abort should be logged, maybe.
-./inc/classes/main/template/class_BaseTemplateEngine.php:1057:                 // @TODO Old behaviour, will become obsolete!
-./inc/classes/main/template/class_BaseTemplateEngine.php:1060:                 // @TODO Yet another old way
-./inc/classes/main/template/class_BaseTemplateEngine.php:1126:                 // @TODO This silent abort should be logged, maybe.
-./inc/classes/main/template/class_BaseTemplateEngine.php:1147:  * @todo        Make this code some nicer...
-./inc/classes/main/template/class_BaseTemplateEngine.php:955:   * @todo        Unfinished work or don't die here.
-./inc/classes/main/template/class_BaseTemplateEngine.php:972:                          // @TODO Non-string found so we need some deeper analysis...
+./inc/classes/main/template/class_BaseTemplateEngine.php:1055:                 // @TODO This silent abort should be logged, maybe.
+./inc/classes/main/template/class_BaseTemplateEngine.php:1063:                 // @TODO Old behaviour, will become obsolete!
+./inc/classes/main/template/class_BaseTemplateEngine.php:1066:                 // @TODO Yet another old way
+./inc/classes/main/template/class_BaseTemplateEngine.php:1132:                 // @TODO This silent abort should be logged, maybe.
+./inc/classes/main/template/class_BaseTemplateEngine.php:1153:  * @todo        Make this code some nicer...
+./inc/classes/main/template/class_BaseTemplateEngine.php:961:   * @todo        Unfinished work or don't die here.
+./inc/classes/main/template/class_BaseTemplateEngine.php:978:                          // @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/console/class_ConsoleTemplateEngine.php:10: * @todo                This template engine does not make use of setTemplateType()
-./inc/classes/main/template/image/class_ImageTemplateEngine.php:221:    * @todo        Find something usefull with this!
-./inc/classes/main/template/image/class_ImageTemplateEngine.php:241:    * @todo        Add cache creation here
+./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:10: * @todo              This template engine does not make use of setTemplateType()
-./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/template/menu/class_MenuTemplateEngine.php:273:      * @todo        Find something useful with this!
-./inc/classes/main/template/menu/class_MenuTemplateEngine.php:319:      * @todo        Add cache creation here
+./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/classes.php:10: * @todo          We should minimize these includes
 ./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/classes.php:10: * @todo          We should minimize these includes
-./inc/config/class_FrameworkConfiguration.php:172:      * @todo        We have to add some more entries from $_SERVER here
+./inc/config/class_FrameworkConfiguration.php:175:      * @todo        We have to add some more entries from $_SERVER here
 ./inc/database.php:11: * @todo         We should minimize these includes
 ./inc/database.php:51:// @TODO Rewrite this
 ./inc/database.php:11: * @todo         We should minimize these includes
 ./inc/database.php:51:// @TODO Rewrite this
-./inc/file_io.php:13: * @todo          We should minimize these includes
 ./inc/hooks.php:11: * @todo            We should minimize these includes
 ./inc/hooks.php:28:// @TODO This makes the core depending on the SPL. But it should be installed anyway.
 ./inc/includes.php:11: * @todo         We should minimize these includes
 ./inc/includes.php:38:// @TODO Find a nicer OOP-ed way for this
 ./inc/hooks.php:11: * @todo            We should minimize these includes
 ./inc/hooks.php:28:// @TODO This makes the core depending on the SPL. But it should be installed anyway.
 ./inc/includes.php:11: * @todo         We should minimize these includes
 ./inc/includes.php:38:// @TODO Find a nicer OOP-ed way for this
-./inc/language.php:10: * @todo         We should minimize these includes
-./inc/language.php:33:// @TODO Rewrite this
-./inc/loader/class_ClassLoader.php:262:                        /* @todo: Do not die here. */
+./inc/loader/class_ClassLoader.php:273:                        /* @todo: Do not die here. */
 ./inc/output.php:11: * @todo           We should minimize these includes
 ./inc/selector.php:11: * @todo         We should minimize these includes
 ### ### DEPRECATION FOLLOWS: ### ###
 ./inc/output.php:11: * @todo           We should minimize these includes
 ./inc/selector.php:11: * @todo         We should minimize these includes
 ### ### DEPRECATION FOLLOWS: ### ###
-./inc/classes/exceptions/io/class_FileNotFoundException.php:2:// @DEPRECATED
-./inc/classes/exceptions/io/class_FilePointerNotOpenedException.php:2:// @DEPRECATED
-./inc/classes/exceptions/io/class_InvalidDirectoryResourceException.php:2:// @DEPRECATED
-./inc/classes/exceptions/main/class_ClassNotFoundException.php:2:// @DEPRECATED
-./inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php:2:// @DEPRECATED
+./inc/classes/exceptions/main/class_MissingMethodException.php:14: * @deprecated       Please do no longer use this exception
 ./inc/classes.php:9: * @deprecated
 ./inc/database.php:10: * @deprecated
 ./inc/classes.php:9: * @deprecated
 ./inc/database.php:10: * @deprecated
-./inc/file_io.php:12: * @deprecated
 ./inc/hooks.php:10: * @deprecated
 ./inc/includes.php:10: * @deprecated
 ./inc/hooks.php:10: * @deprecated
 ./inc/includes.php:10: * @deprecated
-./inc/language.php:9: * @deprecated
 ./inc/output.php:10: * @deprecated
 ./inc/selector.php:10: * @deprecated
 ./inc/output.php:10: * @deprecated
 ./inc/selector.php:10: * @deprecated