Continued with rewrites:
[core.git] / docs / TODOs.txt
1 ### WARNING: THIS FILE IS AUTO-GENERATED BY ./contrib/todo-builder.sh ###
2 ### DO NOT EDIT THIS FILE. ###
3 ./application/tests/class_ApplicationHelper.php:237:     * @todo        Nothing to add?
4 ./inc/config/class_FrameworkConfiguration.php:116:       * @todo        This method encapsulates a deprecated PHP function and should be deprecated, too.
5 ./inc/config/class_FrameworkConfiguration.php:227:       * @todo        We have to add some more entries from $_SERVER here
6 ./inc/database.php:11: * @todo          Minimize these includes
7 ./inc/database.php:51:// @TODO Rewrite this
8 ./inc/includes.php:11: * @todo          Minimize these includes
9 ./inc/includes.php:37:// @TODO This makes the core depending on the SPL. But it should be installed anyway.
10 ./inc/includes.php:41:// @TODO Find a nicer OOP-ed way for this
11 ./inc/loader/class_ClassLoader.php:319:                 /* @TODO: Do not exit here. */
12 ./inc/main/classes/class_BaseFrameworkSystem.php:2133:                  // @TODO Move the constant to e.g. BaseDatabaseResult when there is a non-cached database result available
13 ./inc/main/classes/class_BaseFrameworkSystem.php:2248:   * @todo        Write a logging mechanism for productive mode
14 ./inc/main/classes/class_BaseFrameworkSystem.php:2263:                  // @TODO Finish this part!
15 ./inc/main/classes/class_BaseFrameworkSystem.php:308:   // @todo Try to clean these constants up
16 ./inc/main/classes/class_BaseFrameworkSystem.php:3291:   * @todo        Improve documentation
17 ./inc/main/classes/class_BaseFrameworkSystem.php:3453:   * @todo        Move all this socket-related stuff into own class, most of it resides in BaseListener
18 ./inc/main/classes/class_BaseFrameworkSystem.php:550:           // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
19 ./inc/main/classes/class_BaseFrameworkSystem.php:654:    * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
20 ./inc/main/classes/commands/console/class_ConsoleFuseCommand.php:72:            // @TODO Unfinished
21 ./inc/main/classes/commands/html/class_HtmlLoginAreaCommand.php:64:      * @todo        Add some stuff here: Some personal data, app/game related data
22 ./inc/main/classes/commands/html/class_HtmlProblemCommand.php:58:        * @todo        0% done
23 ./inc/main/classes/commands/html/class_HtmlStatusCommand.php:58:         * @todo        0% done
24 ./inc/main/classes/console/class_ConsoleTools.php:268:   * @todo        This should be moved out to an external class, e.g. HttpClient
25 ./inc/main/classes/console/class_ConsoleTools.php:269:   * @todo        Make IP, host name, port and script name configurable
26 ./inc/main/classes/console/class_ConsoleTools.php:276:          // @TODO Add some DNS caching here
27 ./inc/main/classes/console/class_ConsoleTools.php:45:    * @todo        We should connect this to a caching class to cache DNS requests
28 ./inc/main/classes/console/class_ConsoleTools.php:58:           // @TODO Here should the cacher be implemented
29 ./inc/main/classes/controller/console/class_ConsoleDefaultController.php:10: * @todo            This controller shall still provide some headlines for sidebars
30 ./inc/main/classes/controller/html/class_HtmlConfirmController.php:40:   * @todo        Add some filters to this controller
31 ./inc/main/classes/controller/html/class_HtmlDefaultController.php:10: * @todo          This controller shall still provide some headlines for sidebars
32 ./inc/main/classes/controller/html/class_HtmlLoginController.php:41:     * @todo        Add some filters to this controller
33 ./inc/main/classes/controller/html/class_HtmlLogoutController.php:10: * @todo           This controller shall still provide some headlines for sidebars
34 ./inc/main/classes/controller/html/class_HtmlLogoutDoneController.php:40:        * @todo        Add some filters to this controller
35 ./inc/main/classes/controller/html/class_HtmlProblemController.php:40:   * @todo        Add some filters to this controller
36 ./inc/main/classes/controller/html/class_HtmlRegisterController.php:40:  * @todo        Add some filters to this controller
37 ./inc/main/classes/controller/html/class_HtmlStatusController.php:10: * @todo           This controller shall still provide some headlines for sidebars
38 ./inc/main/classes/controller/html/login/class_HtmlLoginAreaController.php:40:   * @todo        Add some morer filters to this controller
39 ./inc/main/classes/criteria/dataset/class_DataSetCriteria.php:150:                      // @TODO Issue a warning
40 ./inc/main/classes/criteria/search/class_SearchCriteria.php:102:         * @todo        Find a nice casting here. (int) allows until and including 32766.
41 ./inc/main/classes/criteria/search/class_SearchCriteria.php:70:  * @todo        Find a nice casting here. (int) allows until and including 32766.
42 ./inc/main/classes/database/backend/class_CachedLocalFileDatabase.php:327:       * @todo        Do some checks on the database directory and files here
43 ./inc/main/classes/database/backend/class_CachedLocalFileDatabase.php:616:       * @todo        Add more generic non-public data for removal
44 ./inc/main/classes/database/class_BaseDatabaseWrapper.php:204:          // @TODO Minor: Update above comment to e.g. BaseDatabaseResult
45 ./inc/main/classes/database/frontend/class_NewsDatabaseWrapper.php:10: * @todo          Add missing own interface for public methods
46 ./inc/main/classes/database/frontend/class_PaymentsDatabaseWrapper.php:10: * @todo              Add missing own interface for public methods
47 ./inc/main/classes/database/result/class_CachedDatabaseResult.php:244:   * @todo        0% done
48 ./inc/main/classes/database/result/class_CachedDatabaseResult.php:398:   * @todo        Find a caching way without modifying the result array
49 ./inc/main/classes/decorator/template/class_XmlRewriterTemplateDecorator.php:407:        * @todo        Find something useful with this!
50 ./inc/main/classes/discovery/payment/class_LocalPaymentDiscovery.php:85:         * @todo        0% done
51 ./inc/main/classes/factories/logger/class_LoggerFactory.php:46:         // @TODO Unfinished work
52 ./inc/main/classes/factories/login/class_LoginFactory.php:39:    * @return      $loginInstance          An instance of a login helper (@TODO Use actual interface name)
53 ./inc/main/classes/factories/user/class_UserFactory.php:39:      * @return      $userInstance           An instance of a user class (@TODO use actual interface name)
54 ./inc/main/classes/feature/fuse/class_FuseFeature.php:52:        * @todo        0% done
55 ./inc/main/classes/file_directories/binary/class_BaseBinaryFile.php:848:                // @TODO Unfinished
56 ./inc/main/classes/file_directories/class_BaseAbstractFile.php:154:      * @todo        Handle seekStatus
57 ./inc/main/classes/file_directories/class_BaseFileIo.php:171:    * @todo        Handle seekStatus
58 ./inc/main/classes/file_directories/directory/class_FrameworkDirectoryPointer.php:68:    * @todo        Get rid of inConstructor, could be old-lost code.
59 ./inc/main/classes/file_directories/io_stream/class_FileIoStream.php:264:        * @todo        0% done
60 ./inc/main/classes/file_directories/io_stream/class_FileIoStream.php:74:         * @todo        This method needs heavy rewrite
61 ./inc/main/classes/filter/change/class_EmailChangeFilter.php:55:         * @todo        Implement email change of the user here. HINT: Use the User class!
62 ./inc/main/classes/filter/change/class_PasswordChangeFilter.php:55:      * @todo        Finished updating user password hash here. HINT: Use the User class again.
63 ./inc/main/classes/filter/news/class_NewsProcessFilter.php:55:   * @todo        Unfinished stub, add functionality here
64 ./inc/main/classes/filter/payment/class_PaymentDiscoveryFilter.php:97:   * @todo        0% done
65 ./inc/main/classes/filter/update/class_UserUpdateFilter.php:55:  * @todo        Add more user updates here
66 ./inc/main/classes/filter/verifier/class_AccountPasswordVerifierFilter.php:57:   * @todo        Rewrite handling of different password fields
67 ./inc/main/classes/handler/class_BaseHandler.php:66:     * @todo        Rewrite this to use DHT
68 ./inc/main/classes/handler/raw_data/network/class_BaseRawDataHandler.php:149:    * @todo        This method will be moved to a better place
69 ./inc/main/classes/handler/tasks/class_TaskHandler.php:142:             // @TODO Messurement can be added around this call
70 ./inc/main/classes/helper/class_BaseHelper.php:183:      * @todo        Rewrite this method using a helper class for filtering data
71 ./inc/main/classes/helper/class_BaseHelper.php:212:                     // @TODO Try to log it here
72 ./inc/main/classes/helper/class_BaseHelper.php:478:                     $this->debugOutput('[' . __METHOD__ . ':' . __LINE__ . '] fieldName=' . $fieldName . ' is not set! - @TODO');
73 ./inc/main/classes/helper/html/forms/class_HtmlFormHelper.php:102:       * @todo        Add some unique PIN here to bypass problems with some browser and/or extensions
74 ./inc/main/classes/helper/html/forms/class_HtmlFormHelper.php:621:       * @todo        Add checking if sub option is already added
75 ./inc/main/classes/helper/html/forms/class_HtmlFormHelper.php:649:       * @todo        Add checking if sub option is already added
76 ./inc/main/classes/helper/html/forms/class_HtmlFormHelper.php:683:                      // @TODO We need to log this later
77 ./inc/main/classes/helper/html/forms/class_HtmlFormHelper.php:852:       * @todo        Implement check if rules have been changed
78 ./inc/main/classes/helper/html/links/class_HtmlLinkHelper.php:184:       * @todo        Completely unimplemented
79 ./inc/main/classes/images/class_BaseImage.php:172:       * @todo        Find something usefull for this method.
80 ./inc/main/classes/images/class_BaseImage.php:182:       * @todo        Find something usefull for this method.
81 ./inc/main/classes/images/class_BaseImage.php:192:       * @todo        Find something usefull for this method.
82 ./inc/main/classes/images/class_BaseImage.php:202:       * @todo        Find something usefull for this method.
83 ./inc/main/classes/images/class_BaseImage.php:212:       * @todo        Find something usefull for this method.
84 ./inc/main/classes/images/class_BaseImage.php:231:       * @todo        Find something usefull for this method.
85 ./inc/main/classes/images/class_BaseImage.php:250:       * @todo        Find something usefull for this method.
86 ./inc/main/classes/images/class_BaseImage.php:261:       * @todo        Find something usefull for this method.
87 ./inc/main/classes/images/class_BaseImage.php:271:       * @todo        Find something usefull for this method.
88 ./inc/main/classes/index/class_BaseIndex.php:150:        * @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.
89 ./inc/main/classes/listener/class_BaseListener.php:346:                         // @TODO On some systems it is 134, on some 107?
90 ./inc/main/classes/listener/class_BaseListener.php:519:                 // @TODO Does this work on Windozer boxes???
91 ./inc/main/classes/lists/class_BaseList.php:305:                        // @TODO Extend this somehow?
92 ./inc/main/classes/lists/groups/class_ListGroupList.php:61:      * @todo        0% done
93 ./inc/main/classes/mailer/debug/class_DebugMailer.php:124:       * @todo        0% done
94 ./inc/main/classes/menu/class_BaseMenu.php:65:                  // Log exception @TODO Maybe to intrusive?
95 ./inc/main/classes/output/console/class_ConsoleOutput.php:56:           // @TODO Need to rewrite this to $requestInstance->addHeader()
96 ./inc/main/classes/parser/xml/class_XmlParser.php:79:                   // @TODO We need to find a fallback solution here
97 ./inc/main/classes/points/class_UserPoints.php:100:      * @todo        Finish loading part of points
98 ./inc/main/classes/request/console/class_ConsoleRequest.php:112:                // @TODO Can't this be 'CONSOLE' ?
99 ./inc/main/classes/request/html/class_HtmlRequest.php:10: * @todo               Move out the cookie part to a seperate class, e.g. Cookie
100 ./inc/main/classes/response/html/class_HtmlResponse.php:83:      * @todo        Encryption of cookie data not yet supported.
101 ./inc/main/classes/response/html/class_HtmlResponse.php:84:      * @todo        Why are these parameters conflicting?
102 ./inc/main/classes/response/html/class_HtmlResponse.php:85:      * @todo        If the return statement is removed and setcookie() commented out,
103 ./inc/main/classes/response/html/class_HtmlResponse.php:86:      * @todo        this will send only one cookie out, the first one.
104 ./inc/main/classes/response/image/class_ImageResponse.php:79:           // @TODO Please fix this
105 ./inc/main/classes/response/image/class_ImageResponse.php:95:    * @todo        Encryption of cookie data not yet supported.
106 ./inc/main/classes/response/image/class_ImageResponse.php:96:    * @todo        Why are these parameters conflicting?
107 ./inc/main/classes/response/image/class_ImageResponse.php:97:    * @todo        If the return statement is removed and setcookie() commented out,
108 ./inc/main/classes/response/image/class_ImageResponse.php:98:    * @todo        this will send only one cookie out, the first one.
109 ./inc/main/classes/rng/class_RandomNumberGenerator.php:175:      * @todo        I had a better random number generator here but now it is somewhere lost :(
110 ./inc/main/classes/rng/class_RandomNumberGenerator.php:97:       * @todo        Add site key for stronger salt!
111 ./inc/main/classes/stacker/file/class_BaseFileStack.php:162:     * @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.
112 ./inc/main/classes/stacker/file/class_BaseFileStack.php:337:            // @TODO Please implement this, returning FALSE
113 ./inc/main/classes/stacker/file/class_BaseFileStack.php:60:      * @todo        To hard assertions here, better rewrite them to exceptions
114 ./inc/main/classes/template/class_BaseTemplateEngine.php:1064:                  // @TODO This silent abort should be logged, maybe.
115 ./inc/main/classes/template/class_BaseTemplateEngine.php:1072:                  // @TODO Old behaviour, will become obsolete!
116 ./inc/main/classes/template/class_BaseTemplateEngine.php:1075:                  // @TODO Yet another old way
117 ./inc/main/classes/template/class_BaseTemplateEngine.php:1298:   * @todo        Make this code some nicer...
118 ./inc/main/classes/template/class_BaseTemplateEngine.php:961:    * @todo        Unfinished work or don't die here.
119 ./inc/main/classes/template/class_BaseTemplateEngine.php:986:                           // @TODO Non-string found so we need some deeper analysis...
120 ./inc/main/classes/template/console/class_ConsoleTemplateEngine.php:10: * @todo         This template engine does not make use of setTemplateType()
121 ./inc/main/classes/template/image/class_ImageTemplateEngine.php:215:     * @todo        Find something usefull with this!
122 ./inc/main/classes/template/image/class_ImageTemplateEngine.php:235:     * @todo        Add cache creation here
123 ./inc/main/classes/template/mail/class_MailTemplateEngine.php:10: * @todo               This template engine does not make use of setTemplateType()
124 ./inc/main/classes/template/mail/class_MailTemplateEngine.php:228:       * @todo        Add cache creation here
125 ./inc/main/classes/template/mail/class_MailTemplateEngine.php:238:       * @todo        Should we call back the mailer class here?
126 ./inc/main/classes/template/mail/class_MailTemplateEngine.php:317:       * @todo        0% done
127 ./inc/main/classes/template/menu/class_MenuTemplateEngine.php:305:       * @todo        Find something useful with this!
128 ./inc/main/classes/template/menu/class_MenuTemplateEngine.php:351:       * @todo        Add cache creation here
129 ./inc/main/classes/user/class_BaseUser.php:309:  * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
130 ./inc/main/classes/user/class_BaseUser.php:81:   * @todo        Find a way of casting here. "(int)" might destroy the user id > 32766
131 ./inc/main/classes/user/guest/class_Guest.php:46:        * @todo        Add more ways over creating user classes
132 ./inc/main/classes/user/member/class_Member.php:88:      * @todo        Add more ways over creating user classes
133 ./inc/main/exceptions/config/class_NoConfigEntryException.php:10: * @todo               Rename this class to NoFoundEntryException
134 ./inc/main/exceptions/main/class_MissingMethodException.php:13: * @todo         Try to rewrite user/guest login classes and mark this exception as deprecated
135 ./inc/main/interfaces/application/class_ManageableApplication.php:58:    * @todo        Nothing to add?
136 ./inc/main/interfaces/class_FrameworkInterface.php:11: * @todo          Find a better name for this interface
137 ./inc/main/interfaces/criteria/extended/class_LocalSearchCriteria.php:30:        * @todo        Find a nice casting here. (int) allows until and including 32766.
138 ./inc/main/interfaces/criteria/extended/class_LocalSearchCriteria.php:54:        * @todo        Find a nice casting here. (int) allows until and including 32766.
139 ./inc/main/interfaces/database/backend/class_DatabaseBackend.php:109:    * @todo        Add more generic non-data for removal
140 ./inc/main/interfaces/database/backend/class_DatabaseBackend.php:61:     * @todo        Do some checks on the database directory and files here
141 ./inc/main/interfaces/handler/task/class_HandleableTask.php:10: * @todo         HandleableDataSet looks strange here
142 ./inc/main/middleware/compressor/class_CompressorChannel.php:103:                       // @TODO Is there a configurable fall-back compressor needed, or is NullCompressor okay?
143 ./inc/main/middleware/debug/class_DebugMiddleware.php:118:                      // @TODO Initialization phase
144 ./inc/main/middleware/io/class_FileIoHandler.php:174:    * @todo        0% done
145 ./inc/main/third_party/api/wernisportal/class_WernisApi.php:10: * @todo         Out-dated since 0.6-BETA
146 ./inc/selector.php:11: * @todo          Minimize these includes
147 ./index.php:43:  * @todo        This method is old code and needs heavy rewrite and should be moved to ApplicationHelper
148 ### ### DEPRECATION FOLLOWS: ### ###
149 ./inc/classes.php:2:// @DEPRECATED
150 ./inc/database.php:10: * @deprecated
151 ./inc/includes.php:10: * @deprecated
152 ./inc/main/classes/class_BaseFrameworkSystem.php:1882:   * @deprecated  Not fully, as the new Logger facilities are not finished yet.
153 ./inc/main/exceptions/main/class_MissingMethodException.php:14: * @deprecated   Please do no longer use this exception
154 ./inc/main/middleware/debug/class_DebugMiddleware.php:12: * @deprecated See LoggerFactory for a more flexible approach
155 ./inc/selector.php:10: * @deprecated