Todo tags added to documentation
authorRoland Häder <roland@mxchange.org>
Mon, 25 Aug 2008 19:17:41 +0000 (19:17 +0000)
committerRoland Häder <roland@mxchange.org>
Mon, 25 Aug 2008 19:17:41 +0000 (19:17 +0000)
14 files changed:
application/ship-simu/main/commands/web/class_WebMoneyRefillFormCommand.php
application/ship-simu/main/companies/class_ShippingCompany.php
application/ship-simu/main/filter/class_MoneyRefillRequestValidatorFilter.php
application/ship-simu/main/personell/class_SimulatorPersonell.php
application/ship-simu/main/user/extended/class_ShipSimuMember.php
inc/classes/main/actions/class_
inc/classes/main/filter/class_
inc/classes/main/helper/captcha/class_
inc/classes/main/helper/class_
inc/classes/main/helper/web/class_
inc/classes/main/mailer/class_
inc/classes/main/points/class_UserPoints.php
inc/classes/main/response/class_ImageResponse.php
inc/classes/main/user/member/class_Member.php

index dc25f25..9039d56 100644 (file)
@@ -59,6 +59,7 @@ class WebMoneyRefillFormCommand extends BaseCommand implements Commandable {
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
+        * @todo        0% done
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("Please implement this method.");
index 7a00527..362a801 100644 (file)
@@ -81,6 +81,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         *
         * @param       $userInstance           A user class
         * @return      $companyInstance        Prepared company instance
+        * @todo        Add functionality if user participates in a company
         */
        public final static function createShippingCompany (ManageableAccount $userInstance) {
                // Get new instance
@@ -133,6 +134,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         * Checks wether the current user in registry is the company founder
         *
         * @return      $isFounder      Wether the current user is the company founder
+        * @todo        Check if user is company founder
         */
        public function ifUserIsFounder () {
                // Default is not the founder
@@ -155,6 +157,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         * Checks wether the current user in registry is the company owner
         *
         * @return      $isOwner        Wether the current user is the company owner
+        * @todo        Check if user is company owner
         */
        public function ifUserIsOwner () {
                // Default is not the owner
index cea1ba6..3830938 100644 (file)
@@ -55,6 +55,7 @@ class MoneyRefillRequestValidatorFilter extends BaseFrameworkSystem implements F
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
+        * @todo        0% done
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("Please implement this method.");
index 1569708..6c1e084 100644 (file)
@@ -365,6 +365,7 @@ class SimulatorPersonell extends BasePersonell {
         * @throws      ContainerMaybeDamagedException  If the container item
         *                                                                                      is missing the indexes
         *                                                                                      'name' and/or 'value'
+        * @deprecated
         */
        public function loadPersonellList ($idNumber) {
                // Cleared because old code
index a44718c..acbdb62 100644 (file)
@@ -95,6 +95,7 @@ class ShipSimuMember extends ShipSimuBaseUser implements ManageableMember {
         *
         * @param       $requestInstance        An instance of a Requestable class
         * @return      $userInstance           An instance of this user class
+        * @todo        Add more ways of creating user instances
         */
        public final static function createMemberByRequest (Requestable $requestInstance) {
                // Determine if by email or username
index a34ccda..90ff323 100644 (file)
@@ -51,6 +51,7 @@ class ???Action extends BaseAction implements Commandable {
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
+        * @todo        0% done
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                $this->partialStub("You have to implement me.");
index 9027c5d..4aff513 100644 (file)
@@ -55,6 +55,7 @@ class ???Filter extends BaseFrameworkSystem implements Filterable {
         * @param       $requestInstance        An instance of a class with an Requestable interface
         * @param       $responseInstance       An instance of a class with an Responseable interface
         * @return      void
+        * @todo        0% done
         */
        public function execute (Requestable $requestInstance, Responseable $responseInstance) {
                // Implement this!
index 758b205..5dca7ba 100644 (file)
@@ -57,6 +57,7 @@ class ???Captcha extends BaseCaptcha implements SolveableCaptcha {
         * Initiates the CAPTCHA
         *
         * @return      void
+        * @todo        0% done
         */
        public function initiateCaptcha () {
                $this->partialStub("Please implement this method.");
@@ -66,6 +67,7 @@ class ???Captcha extends BaseCaptcha implements SolveableCaptcha {
         * Render the CAPTCHA code
         *
         * @return      void
+        * @todo        0% done
         */
        public function renderCode () {
                $this->partialStub("Please implement this method.");
index ba6cb0e..94f912f 100644 (file)
@@ -52,6 +52,7 @@ class ???Helper extends BaseHelper {
         * Flush the content out,e g. to a template variable
         *
         * @return      void
+        * @todo        0% done
         */
        public function flushContent () {
                $this->partialStub("Please implement this method.");
index 7c61ec8..635066a 100644 (file)
@@ -65,6 +65,7 @@ class Web???Helper extends BaseWebHelper implements HelpableTemplate {
         * Flush the content out,e g. to a template variable
         *
         * @return      void
+        * @todo        0% done
         */
        public function flushContent () {
                $this->partialStub("Please implement this method.");
index b3181c5..5cf368f 100644 (file)
@@ -49,6 +49,7 @@ class ???Mailer extends BaseMailer implements DeliverableMail {
         * Deliver email to the recipient(s)
         *
         * @return      void
+        * @todo        0% done
         */
        public function deliverEmail() {
                $this->partialStub("You have to implement this method.");
@@ -58,6 +59,7 @@ class ???Mailer extends BaseMailer implements DeliverableMail {
         * Send notification to the admin
         *
         * @return      void
+        * @todo        0% done
         */
        public function sendAdminNotification() {
                $this->partialStub("You have to implement this method.");
index 6a9d88f..17c22e2 100644 (file)
@@ -58,6 +58,7 @@ class UserPoints extends BaseFrameworkSystem implements Registerable {
         *
         * @param       $action                 The action or configuration entry plus prefix the user wants to perform
         * @return      $hasRequired    Wether the user has the required points
+        * @todo        Finish loading part of points
         */
        public function ifUserHasRequiredPoints ($action) {
                // Default is that everyone is poor... ;-)
index 2329af7..71acb35 100644 (file)
@@ -145,6 +145,7 @@ class ImageResponse extends BaseFrameworkSystem implements Responseable {
         * @param       $force  Wether we shall force the output or abort if headers are
         *                                      already sent with an exception
         * @return      void
+        * @todo        Add support for fatal messages in image response
         * @throws      ResponseHeadersAlreadySentException             Thrown if headers are
         *                                                                                                      already sent
         */
index cdb98c1..141f1de 100644 (file)
@@ -94,6 +94,7 @@ class Member extends BaseUser implements ManageableMember, Registerable, Updatea
         *
         * @param       $requestInstance        An instance of a Requestable class
         * @return      $userInstance           An instance of this user class
+        * @todo        Add more ways over creating user classes
         */
        public final static function createMemberByRequest (Requestable $requestInstance) {
                // Determine if by email or username