PHP backend Work- Small application

The purpose for this set of specifications is to layout the design requirements for an online management system to track and document weight loss.

This will be a proprietary development, with al l effort being the property of the client. This development effort shall not be used to supply other clients with the capabilities of the developed software.

1. Executive Summary

1. This software will help clients track and manage their dieting efforts

2. It will be a subscription based system, with multiple levels of membership that will define access to content

3. This system will interface with a shopping cart module to track subscriptions dates

4. Access will be web based, with user data being entered, and reports being generated.

5. (Rev 1) A portion of the development (Maintenance Phase) will be used on a separate website in addition to the main weightloss site.

2. Functional Overview;

1. The client has a weight loss program, but it uses a common treatment. The intent is to create a site where dieters can keep track of their body factors involved in the process, and receive guides and information on how to attain weight loss using this particular methodology.

2. Users will track their weight and enter it for development of trend charts and analysis. They will also have a tool to manage daily food intake, and to help them ensure they don’t miss items allowed, and to keep track of what they eat/drink different from the allowed items.

3. Technical Overview:

1. Client has hosting and domains using Linux based servers.

2. All development will be in compatible software to ensure full compatibility in a Linux environment.

3. cPanel access to database development tools will be made available as needed.

4. FTP access will be set up to allow posting all developed files.

4. Functional Requirements:

1. User Interaction

1. User login

1. Password protected

2. Change password module

3. Forgot password email send

1. Validation of provided email address against user data file

4. (Rev 1) At login, current subscription status will be checked against the shopping cart data (shopping cart software not specified at this time, but may be a module added to the main website using Joomla CMS).

2. User profile (* = Mandatory)

1. Technical: Single record/table

2. Sign up date (system entered)

3. Subscription level at signup (user selected)*

4. Group/Campaign Association (user selected from pre-designated list) (see iii below)

5. Name: First*, Last*, title

6. Gender*

7. Birth date: month, day and year

8. Address

1. Street

2. Apt/Suite

3. City*

4. St/Province*

5. Zip (+4 optional)/Postal Code*

6. Country*

9. eMail*

10. Contact Phone

11. At sign up body statistics:

1. Height (Ht)

2. Weight* (Wt)

3. Body Fat (BF)

4. System sugar (Range 0-10 units)

5. Body Mass Indication (BMI) (computed: formula to be supplied)

6. % of Hydration (%H2O)

7. Size measurements

1. Neck

2. Chest/bust

3. Upper belly

4. Belly

5. Waist

6. Upper Arms (R/L)

7. Thighs (R/L)

12. History of weight loss notes

1. Memo/long text field - freeform

3. Group/Campaign Tracking:

1. A data table will be placed to hold data on any groups participating in the dieting program together.

1. Group/Association/Campaign Name

2. Manager (connected to user database)

3. Begin date

4. End date

5. Total Beginning weight

6. Current weight

7. Total Beginning inches

8. Current inches

9. Number of participants

10. Average weight loss

11. Average inch loss

2. Users will be able to access this table for their group/association/campaign name.

4. Diet tracking

1. Technical: Capable of multiple incidences per client.

2. Begin date

1. Allow for optional three (3) “Loading Days” preceding indicated start date

3. Planned length of dieting

1. Planned weight loss

1. For men: Not to exceed 25 lbs in a 30 day period

2. For women: not to exceed 20 lbs in a 30 day period

2. Weeks or days selectable

3. Minimum of 21 days/3 weeks per event.

4. Not to exceed 120 days total per event.

5. Option to select “Dieting completed”

1. Triggers re-computation of end date events (such as beginning of transition phase.

2. Ensures connection to other procedural changes, such as allowed diet food for subsequent phases.

3. (Rev 1) Automatically begins 3 + 21 day/3 Day + 3 week Transition period (non-optional time frame) (see para. 4. V. below).

6. Option to “Extend Dieting”

1. Triggers addition of more dates to be used to extend the diet period.

2. (Rev 1) User selectable, by days or weeks, extension time frame.

3. (Rev 1) Not to exceed 120 total days calculated from start date or diet phase.

4. Recalculates follow on Transition and Maintenance portion of form to fill in data.

7. Beginning body statistics

1. Weight*

2. Body Fat

3. System sugar

4. %H2O

5. BMI (computed: formula to be supplied)

6. Size measurements

1. Biceps (R/L)

2. Above Chest

3. Below Chest

4. Midriff

5. Waist

6. Belly

7. Buttocks

8. Thighs

9. Thighs (R/L)

10. Calf (R/L)

8. Daily Statistics

1. Weight*

2. Body Fat

3. %H2O

4. BMI (computed)

5. Actual Body Weight (computed: (Weight * BF)/100)

6. Fat Weight (computed: Weight – Actual Body Weight)

9. Weekly Statistics

1. System sugar

2. Size measurements

1. Biceps (R/L)

2. Above Chest

3. Below Chest

4. Midriff

5. Waist

6. Belly

7. Buttocks

8. Thighs

9. Thighs (R/L)

10. Calf (R/L)

10. Assessment tools:

1. These are computed

2. “Slope” weight computation to provide standard against actual record weight loss.

1. (Rev 1) Computed on Total Weight Loss Goal/Days – 1 (first day of diet accounts for 0 weight loss) of dieting period for per day planned weight loss standard per day.

2. (Rev 1) Beginning on Day 2, the per day planned weight loss will begin accumulating to define the standard weight loss goal trend/slope. Computed by Beginning weight - (standard per day weight loss * days in diet).

3. (Rev 1) Cumulative actual weight loss.

4. Amount difference between Scale Weight and planned weight.

5. Indication of actual body weight and body fat, computed:

1. Fat Weight: (Indicated Wt * BF)/100

2. Computed non-Fat Weight: Indicated Weight (off scale) – Fat Weight

6. Measurement inches lost

1. Cumulative

2. Per measurement area

3. Percent loss per area

11. Supporting graphical tracking tools:

1. Derived from above data/computations:

1. Weight Data Series:

1. Scale Weight by day

2. Computed weight from beginning weight to goal weight

2. Body Fat/%H2O

1. % BF from scale

2. % Hydration from scale

3. System Sugar

1. By urine test

2. Recorded weekly

4. Diet Menu/Food Intake Management:

1. This dieting process involves two sets of the same four (4) food items per day, plus an indication liquid consumption volume and of extra items consumed.

1. Item 1: Protein – 3 oz – Radio button selection

1. Chicken

2. Fish

1. Tilapia

2. Haddock

3. Cod

3. Turkey

4. Lean beef

2. Item 2: Vegetables – 4 oz – Radio button selection

1. Spinach

2. Broccoli

3. Lettuce

3. Item 3: Fruits – Radio button selection

1. Apple

2. Orange

4. Item 4: Starch – 100 calories – Radio button selection

1. Melba toast

2. Pretzels

5. Item 5: Liquids consumed (in oz/liters) – Text field/integer format

6. Item 6: Other items - Text/memo field

2. User will have two columns per day to record their intake.

3. Premium subscribers will have recipes presented for their choices.

1. Recipe content to be provided by client.

1. (Rev 1) Table for each recipe will indicate which of the intake requirements each recipe satisfies (Protein, Vegetables, Fruit/Starch).

2. (Rev 1) A long text area for the recipe is required for the ingredients/preparation details.

2. When a recipe is selected, the intake charts will be updated based on category items listed in the recipe (Protein, Vegetables, Fruit/Starch).

4. Intake Assessment/Tracking Tools:

1. Software will monitor completion of all items for:

1. Each intake period

2. Each day

3. Software will provide a visual feedback that goals have been met.

4. (Rev 1) If not all items have been recorded in an intake period, the user will be prompted to enter missing items (Protein, Vegetables, Fruit/Starch).

5. (Rev 1) The user will have the option to not make an entry for a food type after one prompting that the intake period was not completely filled out.

2. Software will recommend daily liquid intake based on standardized formula of Body Weight/2 converted to oz, and then to 8 oz portion measurement and provide visual indication of percent of recommended amount consumed. (Rev 1) Both the total ozs and 8 glasses will be display to the user. Example:

1. Body Wt: 200 lbs

2. ½ weight : 100 lbs

3. Intake: 100 oz

4. 8 oz cups: 12.5 glasses

5. Transition Phase:

1. Technical: Capable of multiple incidences per client, directly connected to each diet phase (1 to 1 relationship).

2. Begin date

1. Day after completion of diet phase (Para: 4.iii.).

3. Planned length of transition

1. 24 days total per event

1. First three days require the same diet as above

2. 21 subsequent days will allow more food options

2. No option to select “Reenter Diet”

3. Beginning body statistics

1. Weight*

2. Body Fat

3. System sugar

4. %H2O

5. BMI (computed: formula to be supplied)

6. Size measurements

1. Biceps (R/L)

2. Above Chest

3. Below Chest

4. Midriff

5. Waist

6. Belly

7. Buttocks

8. Thighs

9. Thighs (R/L)

10. Calf (R/L)Daily Statistics

7. Weight*

8. Body Fat

9. %H2O

10. BMI (computed)

4. Weekly Statistics

1. System sugar

2. Size measurements

1. Biceps (R/L)

2. Above Chest

3. Below Chest

4. Midriff

5. Waist

6. Belly

7. Buttocks

8. Thighs

9. Thighs (R/L)

10. Calf (R/L)

5. Assessment tools:

1. These are computed

2. Planned weight loss shown as standard daily weight based on last dieting day actual weight.

3. Cumulative weight loss.

4. Amount difference between Scale Weight and planned weight.

5. Indication of actual body weight and body fat, computed:

1. Fat Weight: (Indicated Wt * BF)/100

2. Computed Weight: Indicated Weight (off scale) – Fat Weight

6. Measurement inches lost

1. Cumulative

2. Per measurement area

3. Percent loss per area

6. Supporting graphical tracking tools:

1. Derived from above data/computations:

1. Weight Data Series:

1. Scale Weight by day

2. Computed weight from beginning weight to goal weight

2. Body Fat/%H2O

1. % BF from scale

2. % Hydration from scale

3. System Sugar

1. By urine test

2. Only recorded weekly

4. Transition Menu/Food Intake Management:

1. This transition process involves two sets of the same four (4) food items per day for the first three (3) days, then an additional list of food items/consumable amounts indicated on the intake lists and also indication liquid consumption volume and of extra items consumed. (* = Additional items foods items after third day of transition)

1. For days 1 to 3, use diet items/recipes as described in paragraph 4.a.

2. Item 1: Protein – 3 oz/12-15 oz* – Radio button selection

1. Chicken

2. Fish

1. Tilapia

2. Haddock

3. Cod

3. Turkey

4. Lean beef

3. Item 2: Vegetables – 4 oz – Radio button selection

1. Spinach

2. Broccoli

3. Lettuce

4. Item 3: Fruits – Radio button selection

1. Apple

2. Orange

3. Kiwi Fruit

5. Item 4: Starch – 100 calories – Radio button selection

1. Melba toast

2. Pretzel

6. Item 5: Liquids consumed (in oz/liters) – Text field/integer format

7. Item 6: Other items - Text/memo field

2. User will have two columns per day to record their intake.

3. Premium subscribers will have recipes presented for their choices.

1. Recipe content to be provided by client.

1. (Rev 1) Table for each recipe will indicate which of the intake requirements each recipe satisfies (Protein, Vegetables, Fruit/Starch).

2. (Rev 1) A long text area for the recipe is required for the ingredients/preparation details.

2. When a recipe is selected, the intake charts will be updated based on category items listed in the recipe (Protein, Vegetables, Fruit/Starch).

4. Intake Assessment/Tracking Tools:

1. Software will monitor completion of all items for:

1. Each intake period

2. Each day

3. Software will provide a visual feedback that goals have been met.

4. (Rev 1) If not all items have been recorded in an intake period, the user will be prompted to enter missing items (Protein, Vegetables, Fruit/Starch).

5. (Rev 1) The user will have the option to not make an entry for a food type after one prompting that the intake period was not completely filled out.

2. Software will recommend daily liquid intake based on standardized formula of Body Weight/2 converted to oz, and then to 8 oz portion measurement and provide visual indication of percent of recommended amount consumed. (Rev 1) Both the total ozs and 8 glasses will be display to the user. Example:

1. Body Wt: 200 lbs

2. ½ weight : 100 lbs

3. Intake: 100 oz

4. 8 oz cups: 12.5 glasses

6. Maintenance Phase:

1. Technical:

1. Capable of multiple incidences per client, directly connected to each transition phase (1 to 1 relationship).

2. (Rev 1) This capability will be written to be use as a standalone tracking function on a second website.

1. Additional items required for the standalone module per 4.a.i. – iii. above to define the user who is signing in.

2. Begin date

1. Day after completion of Transition Phase (Para 4.iv.).

3. Length will continue as long as the user continues to enter data.

1. Option to select “Reenter Diet”

1. Not active until 21 days later than completion of prior transition period.

2. Triggers re-computation of new diet phase events on the user’s record.

3. Ensures connection to other procedural changes, such as allowed diet food for subsequent phases.

2. Beginning body statistics

1. Weight *

2. Body Fat

3. System sugar

4. %H2O

5. BMI (computed: formula to be supplied)

6. Size measurements

1. Biceps (R/L)

2. Above Chest

3. Below Chest

4. Midriff

5. Waist

6. Belly

7. Buttocks

8. Thighs

9. Thighs (R/L)

10. Calf (R/L)

3. Daily Statistics

1. Weight*

2. Body Fat

3. %H2O

4. BMI (computed)

4. Weekly Statistics

1. System sugar

2. Size measurements

1. Biceps (R/L)

2. Above Chest

3. Below Chest

4. Midriff

5. Waist

6. Belly

7. Buttocks

8. Thighs

9. Thighs (R/L)

10. Calf (R/L)

5. Assessment tools:

1. These are computed

2. Amount difference between Scale Weight and planned weight.

3. Indication of actual body weight and body fat, computed:

1. Fat Weight: (Indicated Wt * BF)/100

2. Computed Weight: Indicated Weight (off scale) – Fat Weight

4. Measurement inches lost

1. Cumulative

2. Per measurement area

3. Percent loss per area

6. Supporting graphical tracking tools:

1. Derived from above data/computations:

1. Weight Data Series:

1. Scale Weight by day

2. Computed weight from beginning weight to goal weight

2. Body Fat/%H2O

1. % BF from scale

2. % Hydration from scale

3. System Sugar

1. By urine test

2. Only recorded weekly

4. Maintenance Menu/Food Intake Management:

1. This maintenance process involves tracking scale weight and making recommendations on diet only if a plus or minus 2 lb difference is indicated from the baseline weight (maintenance phase beginning weight)

2. If the scale weight is above 2 lbs difference from the baseline weight indicated, then the software will place a visual indicator in the weight table and on the chart next to the day’s measurement stating “Steak Day recommended.”

3. If the scale weight is below 2 lbs difference from the baseline weight indicated, then the software will pace a visual indicator in the weight loss table and on the chart next to the day’s measurement stating “Increase your food intake today!”

2. Data Analysis Functions (At this stage, the below specifications are to ensure design is compatible with a follow on statistical analysis management function to be connected to the user entered data, to include an administrator’s “control panel” to perform basic database management functions):

1. User entered data will be exportable in a CSV format on demand.

2. User entered data shall be searchable and able to be merged to perform analysis of the collected information.

3. (Rev 1) Basic statistical information reports will show average, minimum and maximum weight loss/inches lost per day/week/month for all current users, shown as by day and cummulative.

4. Reports will be configurable to review by any combination of user attributes in the user profile.

Java PHP SQL

Projektazonosító: #654342

A projektről