34b2cfb45f121b5b6bc1478faabe14628b5bfccc
[shipsimu.git] / docs / TODOs.txt
1 ### WARNING: THIS FILE IS AUTO-GENERATED BY ./todo-builder.sh ###
2 ### DO NOT EDIT THIS FILE. ###
3 ./application/admin/main/actions/web/class_WebAdminLoginWelcomeAction.php:54:    * @todo        Maybe we need to do something later here
4 ./application/admin/main/actions/web/class_WebAdminLoginWelcomeAction.php:66:    * @todo        0% done
5 ./application/admin/main/commands/web/class_WebAdminUserLoginCommand.php:97:     * @todo        Add more filters
6 ./application/admin/main/login/class_AdminUserLogin.php:63:      * @todo        We need to add something here which will make more than one
7 ./application/admin/main/login/class_AdminUserLogin.php:64:      * @todo        guest logins, users who are online but based on the same
8 ./application/admin/main/login/class_AdminUserLogin.php:65:      * @todo        user account.
9 ./application/install/main/actions/class_BaseInstallAction.php:42:       * @todo        0% done
10 ./application/install/main/actions/class_BaseInstallAction.php:54:       * @todo        Add some filters here
11 ./application/install/main/commands/web/failed/class_WebInstallFailedCommand.php:58:     * @todo        0% done
12 ./application/install/main/controller/web/class_WebInstallFailedController.php:40:       * @todo        Add some filters to this controller
13 ./application/install/main/filter/class_BaseInstallFilter.php:42:        * @todo        0%
14 ./application/selector/class_ApplicationSelector.php:251:        * @todo        Finish handling all applications here
15 ./application/ship-simu/main/actions/class_BaseShipSimuAction.php:42:    * @todo        0% done
16 ./application/ship-simu/main/actions/class_BaseShipSimuAction.php:54:    * @todo        Add some filters here
17 ./application/ship-simu/main/actions/ship-simu/class_ShipSimuLoginAction.php:54:         * @todo        Maybe we need to do something later here
18 ./application/ship-simu/main/actions/ship-simu/class_ShipSimuProfileAction.php:54:       * @todo        Maybe we need to do something later here */
19 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginCompanyAction.php:58:     * @todo        Maybe add fetching company list of current user here?
20 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginCompanyAction.php:73:     * @todo        Add some more filters here
21 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginGovernmentStartupHelpAction.php:58:       * @todo        0% done
22 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginGovernmentStartupHelpAction.php:73:       * @todo        Add some filters here
23 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginGovernmentTrainingAction.php:58:  * @todo        0% done
24 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginGovernmentTrainingAction.php:73:  * @todo        Add some more filters here
25 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginLogoutAction.php:58:      * @todo        0% done
26 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginProfileAction.php:58:     * @todo        0% done
27 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginProfileAction.php:73:     * @todo        Add some filters here
28 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginRefillAction.php:58:      * @todo        0% done
29 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginStatusProblemAction.php:58:       * @todo        0% done
30 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginStatusProblemAction.php:73:       * @todo        Add some filters here
31 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginWelcomeAction.php:58:     * @todo        0% done
32 ./application/ship-simu/main/actions/web/class_WebShipSimuLoginWelcomeAction.php:73:     * @todo        Add some filters here
33 ./application/ship-simu/main/commands/web/class_WebShipsimuGuestLoginCommand.php:97:     * @todo        Add more filters
34 ./application/ship-simu/main/commands/web/class_WebShipsimuProfileCommand.php:117:       * @todo        Add some more pre/post filters to the controller
35 ./application/ship-simu/main/commands/web/class_WebShipsimuProfileCommand.php:82:        * @todo        Add functionality here
36 ./application/ship-simu/main/commands/web/class_WebShipsimuRegisterCommand.php:90:       * @todo        Add some more pre/post filters to the controller
37 ./application/ship-simu/main/commands/web/class_WebShipsimuUserLoginCommand.php:97:      * @todo        Add more filters
38 ./application/ship-simu/main/commands/web/government/class_WebGovernmentFailedStartupCommand.php:132:    * @todo        Maybe we need some filters here?
39 ./application/ship-simu/main/commands/web/government/class_WebGovernmentFailedStartupCommand.php:59:     * @todo        0% done
40 ./application/ship-simu/main/commands/web/government/class_WebGovernmentFailedTrainingCommand.php:132:   * @todo        Maybe we need some filters here?
41 ./application/ship-simu/main/commands/web/government/class_WebGovernmentFailedTrainingCommand.php:59:    * @todo        0% done
42 ./application/ship-simu/main/commands/web/government/class_WebShipsimuGovernmentStartupCommand.php:59:   * @todo        0% done
43 ./application/ship-simu/main/commands/web/government/class_WebShipsimuGovernmentStartupCommand.php:71:   * @todo        Maybe we need some filters here?
44 ./application/ship-simu/main/commands/web/government/class_WebShipsimuGovernmentTrainingCommand.php:57:  * @todo        0% done
45 ./application/ship-simu/main/commands/web/government/class_WebShipsimuGovernmentTrainingCommand.php:69:  * @todo        Maybe we need some filters here?
46 ./application/ship-simu/main/companies/class_ShippingCompany.php:137:    * @todo        Check if user is company founder
47 ./application/ship-simu/main/companies/class_ShippingCompany.php:160:    * @todo        Check if user is company owner
48 ./application/ship-simu/main/companies/class_ShippingCompany.php:209:    * @todo        Maybe we don't need these big lists anymore?! So we can deprecate/remove it
49 ./application/ship-simu/main/companies/class_ShippingCompany.php:634:            * @todo        Maybe do something more here...
50 ./application/ship-simu/main/companies/class_ShippingCompany.php:84:     * @todo        Add functionality if user participates in a company
51 ./application/ship-simu/main/controller/web/class_WebCompanyController.php:40:   * @todo        Add some filters to this controller
52 ./application/ship-simu/main/controller/web/class_WebGovernmentFailedController.php:40:  * @todo        Add some filters to this controller
53 ./application/ship-simu/main/filter/book/refill/class_RefillRequestCurrencyTestBookFilter.php:57:        * @todo        Add code being executed in this filter
54 ./application/ship-simu/main/filter/class_BaseShipSimuFilter.php:42:     * @todo        Add something to do on every filter
55 ./application/ship-simu/main/filter/government/class_ShipSimuGovernmentPaysStartupHelpFilter.php:54:     * @todo        0% done
56 ./application/ship-simu/main/filter/government/class_ShipSimuGovernmentPaysTrainingFilter.php:54:        * @todo        0% done
57 ./application/ship-simu/main/filter/validator/class_RefillRequestValidatorFilter.php:54:         * @todo        Maybe we need to added some more generic tests on the request here?
58 ./application/ship-simu/main/filter/validator/class_ShipSimuUserStatusGuestFilter.php:54:        * @todo        Maybe we need to added some more generic tests on the request here?
59 ./application/ship-simu/main/government/class_SimplifiedGovernment.php:10: * @todo              Find an interface for governments
60 ./application/ship-simu/main/login/class_ShipSimuUserLogin.php:63:       * @todo        We need to add something here which will make more than one
61 ./application/ship-simu/main/login/class_ShipSimuUserLogin.php:64:       * @todo        guest logins, users who are online but based on the same
62 ./application/ship-simu/main/login/class_ShipSimuUserLogin.php:65:       * @todo        user account.
63 ./application/ship-simu/main/registration/class_ShipSimuRegistration.php:104:    * @todo        Maybe add more things to perform
64 ./application/ship-simu/main/registration/class_ShipSimuRegistration.php:116:    * @todo        Maybe add more things to perform
65 ./application/ship-simu/main/registration/class_ShipSimuRegistration.php:130:    * @todo        Maybe add more things to perform
66 ./application/ship-simu/main/user/class_ShipSimuBaseUser.php:117:                       // @TODO We should log this exception later
67 ./application/ship-simu/main/user/class_ShipSimuBaseUser.php:156:                       // @TODO We should log this exception later
68 ./application/ship-simu/main/user/class_ShipSimuBaseUser.php:182:        * @todo        Need to implement MoneyBank::ifBankLendsMoreMoney()
69 ./application/ship-simu/main/user/class_ShipSimuBaseUser.php:196:                       // @TODO We should log this exception later
70 ./application/ship-simu/main/user/class_ShipSimuBaseUser.php:226:        * @todo        Need to check the bank if they can lend more money
71 ./application/ship-simu/main/user/class_ShipSimuBaseUser.php:240:                       // @TODO We should log this exception later
72 ./application/ship-simu/main/user/class_ShipSimuBaseUser.php:81:                        // @TODO We should log this exception later
73 ./application/ship-simu/main/user/extended/class_ShipSimuMember.php:98:  * @todo        Add more ways of creating user instances
74 ./application/ship-simu/main/wrapper/class_CompanyDatabaseWrapper.php:108:       * @todo        Find an interface suitable for all types of companies
75 ./application/ship-simu/main/wrapper/class_CompanyDatabaseWrapper.php:118:       * @todo        Find an interface suitable for all types of companies
76 ./application/ship-simu/main/wrapper/class_CompanyDatabaseWrapper.php:49:        * @todo        Find an interface which is suitable for all companies
77 ./inc/classes/exceptions/io/class_FileNotFoundException.php:10: * @todo         Rename this class to FileIoException
78 ./inc/classes/exceptions/main/class_ClassNotFoundException.php:10: * @todo              Rename this class to NoClassException
79 ./inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php:10: * @todo                Rename this class to NoFoundEntryException
80 ./inc/classes/exceptions/main/class_MissingMethodException.php:13: * @todo              Try to rewrite user/guest login classes and mark this exception as deprecated
81 ./inc/classes/interfaces/class_FrameworkInterface.php:11: * @todo               Find a better name for this interface
82 ./inc/classes/main/class_BaseFrameworkSystem.php:1045:   * @todo        Write a logging mechanism for productive mode
83 ./inc/classes/main/class_BaseFrameworkSystem.php:1059:                  // @TODO Finish this part!
84 ./inc/classes/main/class_BaseFrameworkSystem.php:109:   // @todo Try to clean these constants up
85 ./inc/classes/main/class_BaseFrameworkSystem.php:190:    * @todo        This is old code. Do we still need this old lost code?
86 ./inc/classes/main/class_BaseFrameworkSystem.php:258:    * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
87 ./inc/classes/main/commands/web/class_WebLoginAreaCommand.php:64:        * @todo        Add some stuff here: Some personal data, app/game related data
88 ./inc/classes/main/commands/web/class_WebStatusCommand.php:58:   * @todo        0% done
89 ./inc/classes/main/console/class_ConsoleTools.php:41:    * @todo        We should connect this to a caching class to cache DNS requests
90 ./inc/classes/main/console/class_ConsoleTools.php:54:           // @TODO Here should the cacher be implemented
91 ./inc/classes/main/controller/console/class_ConsoleDefaultController.php:10: * @todo            This controller shall still provide some headlines for sidebars
92 ./inc/classes/main/controller/login/class_WebLoginAreaController.php:40:         * @todo        Add some morer filters to this controller
93 ./inc/classes/main/controller/web/class_WebConfirmController.php:40:     * @todo        Add some filters to this controller
94 ./inc/classes/main/controller/web/class_WebDefaultController.php:10: * @todo            This controller shall still provide some headlines for sidebars
95 ./inc/classes/main/controller/web/class_WebLoginController.php:41:       * @todo        Add some filters to this controller
96 ./inc/classes/main/controller/web/class_WebLogoutController.php:10: * @todo             This controller shall still provide some headlines for sidebars
97 ./inc/classes/main/controller/web/class_WebLogoutDoneController.php:40:  * @todo        Add some filters to this controller
98 ./inc/classes/main/controller/web/class_WebRegisterController.php:40:    * @todo        Add some filters to this controller
99 ./inc/classes/main/controller/web/class_WebStatusController.php:10: * @todo             This controller shall still provide some headlines for sidebars
100 ./inc/classes/main/criteria/search/class_SearchCriteria.php:114:         * @todo        Find a nice casting here. (int) allows until and including 32766.
101 ./inc/classes/main/criteria/search/class_SearchCriteria.php:94:  * @todo        Find a nice casting here. (int) allows until and including 32766.
102 ./inc/classes/main/database/databases/class_LocalFileDatabase.php:363:   * @todo        Do some checks on the database directory and files here
103 ./inc/classes/main/discovery/payment/class_LocalPaymentDiscovery.php:82:         * @todo        0% done
104 ./inc/classes/main/filter/change/class_EmailChangeFilter.php:54:         * @todo        Implement email change of the user here. HINT: Use the User class!
105 ./inc/classes/main/filter/change/class_PasswordChangeFilter.php:55:      * @todo        Finished updating user password hash here. HINT: Use the User class again.
106 ./inc/classes/main/filter/news/class_NewsProcessFilter.php:55:   * @todo        Unfinished stub, add functionality here
107 ./inc/classes/main/filter/payment/class_PaymentDiscoveryFilter.php:97:   * @todo        0% done
108 ./inc/classes/main/filter/update/class_UserUpdateFilter.php:55:  * @todo        Add more user updates here
109 ./inc/classes/main/filter/verifier/class_AccountPasswordVerifierFilter.php:57:   * @todo        Rewrite handling of different password fields
110 ./inc/classes/main/helper/class_BaseHelper.php:171:      * @todo        Rewrite this method using a helper class for filtering data
111 ./inc/classes/main/helper/class_BaseHelper.php:198:                     // @TODO Try to log it here
112 ./inc/classes/main/helper/web/class_BaseWebHelper.php:151:       * @todo        Implement check if rules have been changed
113 ./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
114 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:621:         * @todo        Add checking if sub option is already added
115 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:649:         * @todo        Add checking if sub option is already added
116 ./inc/classes/main/helper/web/forms/class_WebFormHelper.php:683:                        // @TODO We need to log this later
117 ./inc/classes/main/helper/web/links/class_WebLinkHelper.php:184:         * @todo        Completely unimplemented
118 ./inc/classes/main/images/class_BaseImage.php:156:       * @todo        Find something usefull for this method.
119 ./inc/classes/main/images/class_BaseImage.php:166:       * @todo        Find something usefull for this method.
120 ./inc/classes/main/images/class_BaseImage.php:176:       * @todo        Find something usefull for this method.
121 ./inc/classes/main/images/class_BaseImage.php:186:       * @todo        Find something usefull for this method.
122 ./inc/classes/main/images/class_BaseImage.php:196:       * @todo        Find something usefull for this method.
123 ./inc/classes/main/images/class_BaseImage.php:215:       * @todo        Find something usefull for this method.
124 ./inc/classes/main/images/class_BaseImage.php:234:       * @todo        Find something usefull for this method.
125 ./inc/classes/main/images/class_BaseImage.php:245:       * @todo        Find something usefull for this method.
126 ./inc/classes/main/images/class_BaseImage.php:255:       * @todo        Find something usefull for this method.
127 ./inc/classes/main/io/class_FileIoStream.php:74:         * @todo        This method needs heavy rewrite
128 ./inc/classes/main/mailer/debug/class_DebugMailer.php:124:       * @todo        0% done
129 ./inc/classes/main/output/class_ConsoleOutput.php:56:           // @TODO Need to rewrite this to $requestInstance->addHeader()
130 ./inc/classes/main/points/class_UserPoints.php:103:                     // @TODO Load points here
131 ./inc/classes/main/points/class_UserPoints.php:81:       * @todo        Finish loading part of points
132 ./inc/classes/main/request/console/class_ConsoleRequest.php:115:                // @TODO There are no cookies on console
133 ./inc/classes/main/request/console/class_ConsoleRequest.php:55:  * @todo        Needs to be implemented
134 ./inc/classes/main/resolver/controller/class_BaseControllerResolver.php:137:                    // @TODO Maybe we need to log this?
135 ./inc/classes/main/response/http/class_HttpResponse.php:77:      * @todo        Encryption of cookie data not yet supported.
136 ./inc/classes/main/response/http/class_HttpResponse.php:78:      * @todo        Why are these parameters conflicting?
137 ./inc/classes/main/response/http/class_HttpResponse.php:79:      * @todo        If the return statement is removed and setcookie() commented out,
138 ./inc/classes/main/response/http/class_HttpResponse.php:80:      * @todo        this will send only one cookie out, the first one.
139 ./inc/classes/main/response/image/class_ImageResponse.php:93:    * @todo        Encryption of cookie data not yet supported.
140 ./inc/classes/main/response/image/class_ImageResponse.php:94:    * @todo        Why are these parameters conflicting?
141 ./inc/classes/main/response/image/class_ImageResponse.php:95:    * @todo        If the return statement is removed and setcookie() commented out,
142 ./inc/classes/main/response/image/class_ImageResponse.php:96:    * @todo        this will send only one cookie out, the first one.
143 ./inc/classes/main/result/class_DatabaseResult.php:226:  * @todo        0% done
144 ./inc/classes/main/result/class_DatabaseResult.php:379:4         * @todo        Find a caching way without modifying the result array
145 ./inc/classes/main/rng/class_RandomNumberGenerator.php:150:      * @todo        I had a better random number generator here but now it is somewhere lost :(
146 ./inc/classes/main/rng/class_RandomNumberGenerator.php:83:       * @todo        Add site key for stronger salt!
147 ./inc/classes/main/template/class_BaseTemplateEngine.php:1303:                  // @TODO We need to find a fallback solution here
148 ./inc/classes/main/template/class_BaseTemplateEngine.php:810:    * @todo        Unfinished work or don't die here.
149 ./inc/classes/main/template/class_BaseTemplateEngine.php:827:                           // @TODO Non-string found so we need some deeper analysis...
150 ./inc/classes/main/template/class_BaseTemplateEngine.php:904:                   // @TODO Old behaviour, will become obsolete!
151 ./inc/classes/main/template/class_BaseTemplateEngine.php:907:                   // @TODO Yet another old way
152 ./inc/classes/main/template/class_BaseTemplateEngine.php:981:    * @todo        Make this code some nicer...
153 ./inc/classes/main/template/image/class_ImageTemplateEngine.php:229:     * @todo        Find something usefull with this!
154 ./inc/classes/main/template/image/class_ImageTemplateEngine.php:249:     * @todo        Add cache creation here
155 ./inc/classes/main/template/mail/class_MailTemplateEngine.php:234:       * @todo        Add cache creation here
156 ./inc/classes/main/template/mail/class_MailTemplateEngine.php:244:       * @todo        Should we call back the mailer class here?
157 ./inc/classes/main/template/mail/class_MailTemplateEngine.php:325:       * @todo        0% done
158 ./inc/classes/main/user/class_BaseUser.php:305:  * @todo        Try to make this method more generic so we can move it in BaseFrameworkSystem
159 ./inc/classes/main/user/class_BaseUser.php:80:   * @todo        Find a way of casting here. "(int)" might destroy the user id > 32766
160 ./inc/classes/main/user/member/class_Member.php:84:      * @todo        Add more ways over creating user classes
161 ./inc/classes/middleware/debug/class_DebugMiddleware.php:112:                   // @TODO Initialization phase
162 ./inc/config/class_FrameworkConfiguration.php:172:       * @todo        We have to add some more entries from $_SERVER here
163 ./inc/database.php:49:// @TODO Rewrite this
164 ./inc/hooks.php:26:// @TODO This makes the core depending on the SPL. But it should be installed anyway.
165 ./inc/includes.php:36:// @TODO Find a nicer OOP-ed way for this
166 ./inc/language.php:31:// @TODO Rewrite this
167 ./inc/loader/class_ClassLoader.php:262:                 /* @todo: Do not die here. */
168 ### ### DEPRECATION FOLLOWS: ### ###
169 ./application/ship-simu/main/personell/class_SimulatorPersonell.php:118:         * @deprecated
170 ./application/ship-simu/main/personell/class_SimulatorPersonell.php:319:         * @deprecated
171 ./inc/classes/exceptions/io/class_FileNotFoundException.php:11: * @deprecated
172 ./inc/classes/exceptions/io/class_InvalidDirectoryResourceException.php:10: * @deprecated
173 ./inc/classes/exceptions/main/class_ClassNotFoundException.php:11: * @deprecated
174 ./inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php:11: * @deprecated
175 ./inc/classes/main/template/class_BaseTemplateEngine.php:1131:   * @deprecated