getCompiledData() must be public for e.g. mailer classes such as DebugMailer.
[core.git] / docs / TODOs.txt
1 ### WARNING: THIS FILE IS AUTO-GENERATED BY ./todo-builder.sh ###
2 ### DO NOT EDIT THIS FILE. ###
3 ./inc/classes.php:10: * @todo           Minimize these includes
4 ./inc/classes/exceptions/main/class_MissingMethodException.php:13: * @todo              Try to rewrite user/guest login classes and mark this exception as deprecated
5 ./inc/classes/exceptions/main/class_NoConfigEntryException.php:10: * @todo              Rename this class to NoFoundEntryException
6 ./inc/classes/interfaces/class_FrameworkInterface.php:11: * @todo               Find a better name for this interface
7 ./inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php:30:     * @todo        Find a nice casting here. (int) allows until and including 32766.
8 ./inc/classes/interfaces/criteria/extended/class_LocalSearchCriteria.php:54:     * @todo        Find a nice casting here. (int) allows until and including 32766.
9 ./inc/classes/main/class_BaseFrameworkSystem.php:1953:   * @todo        Write a logging mechanism for productive mode
10 ./inc/classes/main/class_BaseFrameworkSystem.php:1968:                  // @TODO Finish this part!
11 ./inc/classes/main/class_BaseFrameworkSystem.php:245:   // @todo Try to clean these constants up
12 ./inc/classes/main/class_BaseFrameworkSystem.php:470:           // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
13 ./inc/classes/main/class_BaseFrameworkSystem.php:544:    * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
14 ./inc/classes/main/commands/web/class_WebLoginAreaCommand.php:64:        * @todo        Add some stuff here: Some personal data, app/game related data
15 ./inc/classes/main/commands/web/class_WebProblemCommand.php:58:  * @todo        0% done
16 ./inc/classes/main/commands/web/class_WebStatusCommand.php:58:   * @todo        0% done
17 ./inc/classes/main/console/class_ConsoleTools.php:268:   * @todo        This should be moved out to an external class, e.g. HttpClient
18 ./inc/classes/main/console/class_ConsoleTools.php:269:   * @todo        Make IP, host name, port and script name configurable
19 ./inc/classes/main/console/class_ConsoleTools.php:276:          // @TODO Add some DNS caching here
20 ./inc/classes/main/console/class_ConsoleTools.php:45:    * @todo        We should connect this to a caching class to cache DNS requests
21 ./inc/classes/main/console/class_ConsoleTools.php:58:           // @TODO Here should the cacher be implemented
22 ./inc/classes/main/controller/console/class_ConsoleDefaultController.php:10: * @todo            This controller shall still provide some headlines for sidebars
23 ./inc/classes/main/controller/login/class_WebLoginAreaController.php:40:         * @todo        Add some morer filters to this controller
24 ./inc/classes/main/controller/web/class_WebConfirmController.php:40:     * @todo        Add some filters to this controller
25 ./inc/classes/main/controller/web/class_WebDefaultController.php:10: * @todo            This controller shall still provide some headlines for sidebars
26 ./inc/classes/main/controller/web/class_WebLoginController.php:41:       * @todo        Add some filters to this controller
27 ./inc/classes/main/controller/web/class_WebLogoutController.php:10: * @todo             This controller shall still provide some headlines for sidebars
28 ./inc/classes/main/controller/web/class_WebLogoutDoneController.php:40:  * @todo        Add some filters to this controller
29 ./inc/classes/main/controller/web/class_WebProblemController.php:40:     * @todo        Add some filters to this controller
30 ./inc/classes/main/controller/web/class_WebRegisterController.php:40:    * @todo        Add some filters to this controller
31 ./inc/classes/main/controller/web/class_WebStatusController.php:10: * @todo             This controller shall still provide some headlines for sidebars
32 ./inc/classes/main/criteria/search/class_SearchCriteria.php:102:         * @todo        Find a nice casting here. (int) allows until and including 32766.
33 ./inc/classes/main/criteria/search/class_SearchCriteria.php:70:  * @todo        Find a nice casting here. (int) allows until and including 32766.
34 ./inc/classes/main/database/backend/class_CachedLocalFileDatabase.php:327:       * @todo        Do some checks on the database directory and files here
35 ./inc/classes/main/database/backend/class_CachedLocalFileDatabase.php:616:       * @todo        Add more generic non-public data for removal
36 ./inc/classes/main/decorator/template/class_XmlRewriterTemplateDecorator.php:427:        * @todo        Find something useful with this!
37 ./inc/classes/main/discovery/payment/class_LocalPaymentDiscovery.php:85:         * @todo        0% done
38 ./inc/classes/main/file_directories/class_BaseFile.php:135:      * @todo        ~10% done?
39 ./inc/classes/main/file_directories/class_BaseFile.php:148:      * @todo        Handle seekStatus
40 ./inc/classes/main/file_directories/class_BaseFileIo.php:162:    * @todo        Handle seekStatus
41 ./inc/classes/main/file_directories/directory/class_FrameworkDirectoryPointer.php:68:    * @todo        Get rid of inConstructor, could be old-lost code.
42 ./inc/classes/main/file_directories/io_stream/class_FileIoStream.php:270:        * @todo        0% done
43 ./inc/classes/main/file_directories/io_stream/class_FileIoStream.php:74:         * @todo        This method needs heavy rewrite
44 ./inc/classes/main/filter/change/class_EmailChangeFilter.php:55:         * @todo        Implement email change of the user here. HINT: Use the User class!
45 ./inc/classes/main/filter/change/class_PasswordChangeFilter.php:55:      * @todo        Finished updating user password hash here. HINT: Use the User class again.
46 ./inc/classes/main/filter/news/class_NewsProcessFilter.php:55:   * @todo        Unfinished stub, add functionality here
47 ./inc/classes/main/filter/payment/class_PaymentDiscoveryFilter.php:97:   * @todo        0% done
48 ./inc/classes/main/filter/update/class_UserUpdateFilter.php:55:  * @todo        Add more user updates here
49 ./inc/classes/main/filter/verifier/class_AccountPasswordVerifierFilter.php:57:   * @todo        Rewrite handling of different password fields
50 ./inc/classes/main/helper/class_BaseHelper.php:173:      * @todo        Rewrite this method using a helper class for filtering data
51 ./inc/classes/main/helper/class_BaseHelper.php:202:                     // @TODO Try to log it here
52 ./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
53 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:621:         * @todo        Add checking if sub option is already added
54 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:649:         * @todo        Add checking if sub option is already added
55 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:683:                        // @TODO We need to log this later
56 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:852:         * @todo        Implement check if rules have been changed
57 ./inc/classes/main/helper/web/links/class_WebLinkHelper.php:184:         * @todo        Completely unimplemented
58 ./inc/classes/main/images/class_BaseImage.php:156:       * @todo        Find something usefull for this method.
59 ./inc/classes/main/images/class_BaseImage.php:166:       * @todo        Find something usefull for this method.
60 ./inc/classes/main/images/class_BaseImage.php:176:       * @todo        Find something usefull for this method.
61 ./inc/classes/main/images/class_BaseImage.php:186:       * @todo        Find something usefull for this method.
62 ./inc/classes/main/images/class_BaseImage.php:196:       * @todo        Find something usefull for this method.
63 ./inc/classes/main/images/class_BaseImage.php:215:       * @todo        Find something usefull for this method.
64 ./inc/classes/main/images/class_BaseImage.php:234:       * @todo        Find something usefull for this method.
65 ./inc/classes/main/images/class_BaseImage.php:245:       * @todo        Find something usefull for this method.
66 ./inc/classes/main/images/class_BaseImage.php:255:       * @todo        Find something usefull for this method.
67 ./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.
68 ./inc/classes/main/mailer/class_BaseMailer.php:55:              // @TODO This needs testing/fixes because the deprecated method
69 ./inc/classes/main/mailer/debug/class_DebugMailer.php:124:       * @todo        0% done
70 ./inc/classes/main/menu/class_BaseMenu.php:59:                  // @TODO Should we log it here? We should, because it will be silently ignored.
71 ./inc/classes/main/output/class_ConsoleOutput.php:56:           // @TODO Need to rewrite this to $requestInstance->addHeader()
72 ./inc/classes/main/parser/xml/class_XmlParser.php:79:                   // @TODO We need to find a fallback solution here
73 ./inc/classes/main/points/class_UserPoints.php:100:      * @todo        Finish loading part of points
74 ./inc/classes/main/request/console/class_ConsoleRequest.php:106:                // @TODO Can't this be 'CONSOLE' ?
75 ./inc/classes/main/request/web/class_HttpRequest.php:10: * @todo                Move out the cookie part to a seperate class, e.g. Cookie
76 ./inc/classes/main/response/http/class_HttpResponse.php:77:      * @todo        Encryption of cookie data not yet supported.
77 ./inc/classes/main/response/http/class_HttpResponse.php:78:      * @todo        Why are these parameters conflicting?
78 ./inc/classes/main/response/http/class_HttpResponse.php:79:      * @todo        If the return statement is removed and setcookie() commented out,
79 ./inc/classes/main/response/http/class_HttpResponse.php:80:      * @todo        this will send only one cookie out, the first one.
80 ./inc/classes/main/response/image/class_ImageResponse.php:88:    * @todo        Encryption of cookie data not yet supported.
81 ./inc/classes/main/response/image/class_ImageResponse.php:89:    * @todo        Why are these parameters conflicting?
82 ./inc/classes/main/response/image/class_ImageResponse.php:90:    * @todo        If the return statement is removed and setcookie() commented out,
83 ./inc/classes/main/response/image/class_ImageResponse.php:91:    * @todo        this will send only one cookie out, the first one.
84 ./inc/classes/main/result/class_DatabaseResult.php:244:  * @todo        0% done
85 ./inc/classes/main/result/class_DatabaseResult.php:398:  * @todo        Find a caching way without modifying the result array
86 ./inc/classes/main/rng/class_RandomNumberGenerator.php:175:      * @todo        I had a better random number generator here but now it is somewhere lost :(
87 ./inc/classes/main/rng/class_RandomNumberGenerator.php:97:       * @todo        Add site key for stronger salt!
88 ./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.
89 ./inc/classes/main/stacker/file/class_BaseFileStack.php:309:            // @TODO Please implement this, returning FALSE
90 ./inc/classes/main/stacker/file/class_BaseFileStack.php:45:      * @todo        To hard assertions here, better rewrite them to exceptions
91 ./inc/classes/main/template/class_BaseTemplateEngine.php:1070:                  // @TODO This silent abort should be logged, maybe.
92 ./inc/classes/main/template/class_BaseTemplateEngine.php:1078:                  // @TODO Old behaviour, will become obsolete!
93 ./inc/classes/main/template/class_BaseTemplateEngine.php:1081:                  // @TODO Yet another old way
94 ./inc/classes/main/template/class_BaseTemplateEngine.php:1289:   * @todo        Make this code some nicer...
95 ./inc/classes/main/template/class_BaseTemplateEngine.php:967:    * @todo        Unfinished work or don't die here.
96 ./inc/classes/main/template/class_BaseTemplateEngine.php:992:                           // @TODO Non-string found so we need some deeper analysis...
97 ./inc/classes/main/template/console/class_ConsoleTemplateEngine.php:10: * @todo         This template engine does not make use of setTemplateType()
98 ./inc/classes/main/template/image/class_ImageTemplateEngine.php:215:     * @todo        Find something usefull with this!
99 ./inc/classes/main/template/image/class_ImageTemplateEngine.php:235:     * @todo        Add cache creation here
100 ./inc/classes/main/template/mail/class_MailTemplateEngine.php:10: * @todo               This template engine does not make use of setTemplateType()
101 ./inc/classes/main/template/mail/class_MailTemplateEngine.php:228:       * @todo        Add cache creation here
102 ./inc/classes/main/template/mail/class_MailTemplateEngine.php:238:       * @todo        Should we call back the mailer class here?
103 ./inc/classes/main/template/mail/class_MailTemplateEngine.php:319:       * @todo        0% done
104 ./inc/classes/main/template/menu/class_MenuTemplateEngine.php:267:       * @todo        Find something useful with this!
105 ./inc/classes/main/template/menu/class_MenuTemplateEngine.php:313:       * @todo        Add cache creation here
106 ./inc/classes/main/user/class_BaseUser.php:308:  * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
107 ./inc/classes/main/user/class_BaseUser.php:80:   * @todo        Find a way of casting here. "(int)" might destroy the user id > 32766
108 ./inc/classes/main/user/member/class_Member.php:84:      * @todo        Add more ways over creating user classes
109 ./inc/classes/middleware/compressor/class_CompressorChannel.php:103:                    // @TODO Is there a configurable fall-back compressor needed, or is NullCompressor okay?
110 ./inc/classes/middleware/debug/class_DebugMiddleware.php:113:                   // @TODO Initialization phase
111 ./inc/classes/middleware/io/class_FileIoHandler.php:174:         * @todo        0% done
112 ./inc/classes/third_party/api/wernisportal/class_WernisApi.php:10: * @todo              Out-dated since 0.6-BETA
113 ./inc/config/class_FrameworkConfiguration.php:115:       * @todo        This method encapsulates a deprecated PHP function and should be deprecated, too.
114 ./inc/config/class_FrameworkConfiguration.php:223:       * @todo        We have to add some more entries from $_SERVER here
115 ./inc/database.php:11: * @todo          Minimize these includes
116 ./inc/database.php:51:// @TODO Rewrite this
117 ./inc/includes.php:11: * @todo          Minimize these includes
118 ./inc/includes.php:37:// @TODO This makes the core depending on the SPL. But it should be installed anyway.
119 ./inc/includes.php:41:// @TODO Find a nicer OOP-ed way for this
120 ./inc/loader/class_ClassLoader.php:319:                 /* @TODO: Do not exit here. */
121 ./inc/output.php:11: * @todo            Minimize these includes
122 ./inc/selector.php:11: * @todo          Minimize these includes
123 ./index.php:43:  * @todo        This method is old code and needs heavy rewrite and should be moved to ApplicationHelper
124 ### ### DEPRECATION FOLLOWS: ### ###
125 ./inc/classes.php:9: * @deprecated
126 ./inc/classes/exceptions/main/class_MissingMethodException.php:14: * @deprecated        Please do no longer use this exception
127 ./inc/classes/interfaces/database/backend/class_DatabaseFrontendInterface.php:2:// @DEPRECATED
128 ./inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php:2:// @DEPRECATED
129 ./inc/classes/main/database/class_BaseDatabaseFrontend.php:2:// @DEPRECATED
130 ./inc/classes/main/handler/class_BaseHandler.php:2:// @DEPRECATED
131 ./inc/classes/main/handler/raw_data/class_BaseRawDataHandler.php:2:// @DEPRECATED
132 ./inc/database.php:10: * @deprecated
133 ./inc/hooks.php:2:// @DEPRECATED
134 ./inc/includes.php:10: * @deprecated
135 ./inc/output.php:10: * @deprecated
136 ./inc/selector.php:10: * @deprecated