A9-Single-Page Form

On This Page

Overview

During this assignment, you will write a page for your project that includes a form, and the code to process the form, on the same page. The main points of this assignment are to:

  1. Organize pages using functions
  2. Check user input for data entry errors
  3. Stay on the same page when a data entry error is detected
  4. Redirect to another page if the data was entered correctly

Note to Mac Users: PHP does not seem to like Mac end of lines character ("\r"). So make sure you choose the option that uses the *nix end of line character ("\n") in your text editor before turning in an assignment. For instructions on settings for various text editors, see John Govsky's page: Text Editors for HTML and Script Editing

^ top

Specifications

This assignment has several parts and you must complete all parts for full credit.

  1. First make sure you have completed the exercises from lesson 9 and have saved the files using the specified names exactly. Using the specified file names makes for easier grading.
  2. Write a page for your project that includes a form and the code to process the user input from the form on the same page. If an error is made, stay on the form page and display an error message. Follow the outline for the page shown in lesson 9.3.4. Thus, the page must include the following functions:
    1. A main() function that controls the logic of the page and calls the checkForm(), processData() and showContent() functions.
    2. A checkForm() function that verifies the values entered by the user and creates error messages for any problems found.
    3. A processData() function that does something with the form data including accessing the database using the form data as part of a SQL query.
    4. A showContent() function that displays the form.

    You may have as many additional functions as you like, either embedded in the page or in an include file. However, you may NOT change the names of the above functions or move them to another file.

  3. You must make a query on your database using mysql_query() with the form data and one or more of the following SQL statements:
    • SELECT data from the database
    • INSERT data into your database
    • UPDATE data in your database

  4. The name of the single-page-form file must be form.php.

    Using the specified name makes grading easier. After you turn in the assignment, you can change the name of the page for your final project.

  5. In addition to the above functions, define at least two more functions of use in your project, place them in file named util.php and include the file in your form.php file.

    Place the file in the webapp root directory or in the includes subdirectory.

  6. Use the included file includes/dbconvars.php for all database connections in your code.

    Even though you do not need to submit your dbconvars.php file, the instructor will use one to test your work. Failure to use a dbconvars.php file will result in a poor grade.

  7. Export (dump) your database as SQL statements to a text file using the technique we discussed in lesson 2.1.5. Name your file after your database name and add the extension .sql to the name (dbname.sql). For example, the artzy database export file would be named artzy.sql.

    Make sure that your dbname.sql file:

    1. Does not contain a SQL 'USE' or 'CREATE DATABASE' statement anywhere in the file
    2. Includes DROP TABLE IF EXISTS statements for all tables

    Note that phpMyAdmin supports all these behaviors if you select the correct export settings.

  8. Create a PHP comment at the top of all your PHP pages formatted like the following: 
    /**
* CIS-165PH  Asn 9
* form.php
* Purpose: Collects user input
*
* @author Ed Parrish
* @version 1.2 04/19/08
*/

    Remember that PHP comments must be enclosed within PHP tags. You will get no credit for this part of the assignment if you use HTML comments. For more information on documenting PHP code, see: How To Document PHP Code.

  9. In your README.txt file provide instructions on using this assignment. For example, if a password is required, please include a password. For all your form fields, provide at least one set of valid values that I can copy into or select for your form.
  10. Zip your files and submit the zipped archive file to Blackboard as explained in the section of this document: What to Turn In.

    Note: Please do not turn in more than one *.sql file or I may grade using the wrong file.

^ top

Extra Credit

The following are worth extra credit points:

  1. Write one or more date calculation functions that are useful for your project and include them in another library file named datelib.php file. (1 point)
  2. Write one or more functions that print HTML form controls (elements) and include them in another library file named formlib.php file. (1 point)
  3. Show previously-entered data in the form field when errors are found in the page. (2 points)
  4. Highlight the specific form field which contains an error by changing colors, fonts or some other visual technique. (1-2 points)

Make certain that your README.txt file lists any extra credit attempted.

^ top

Grading Criteria

The instructor will evaluate your assignment using the following criteria. Each criteria represents a specific achievement of your assignment and has a scoring guide. The scoring guide explains the possible scores you can receive.

Some scoring guides have a list of indicators. These indicators are a sign of meeting, or a symptom of not meeting, the specific criterion. Note that a single indicator may not always be reliable or appropriate in a given context. However, as a group, they show the condition of meeting the criterion.

For information on grading policies, including interpretation of scores, see the course information page.

Lesson Exercises

  • 2: All lesson exercises attempted and turned in
  • 1: Some lesson exercises completed and turned in
  • 0: No lesson exercises completed or turned in

Database Export

  • 2: Database loads from dbname.sql file with no errors or warnings
  • 1: Database loads from dbname.sql file but has errors, warnings or missing data
  • 0: Does not load or dbname.sql file not submitted

PHP Functionality

  • 10: Demonstrates mastery of the assignment
    • Has extra features or demonstrates techniques beyond the assignment
    • Applies concepts from the lesson(s) appropriately
    • Meets all specifications (see above) with particularly elegant solutions
    • No errors encountered during operation
  • 8: Has all the functionality expected of the assignment
    • Demonstrates many techniques from the lesson
    • Meets all specifications (see above)
    • Implementation seems more complicated than necessary.
    • May have one minor error
  • 6: Has most of the functionality expected of the assignment
    • Demonstrates some techniques from the lesson
    • Meets all but one of the specifications (see above)
    • Implementation seems excessively complicated.
    • May have 2-3 minor errors
  • 4: Has some of the functionality expected of the assignment
    • Demonstrates some techniques from the lesson
    • Meets at least 1/2 of the specifications (see above)
    • Implementation seems excessively complicated.
    • May have more than 3 minor errors
  • 2: Serious functional problems but shows some effort and understanding
    • Meets less than 1/2 of the of the specifications (see above)
    • Has a major error or many minor errors
    • Implementation seems very convoluted
    • Demonstrates few techniques from the lesson
  • 0: Does not execute

Code Organization

  • 4: Code is well organized for clarity and maintainability
    • Page organized into functions with very little duplicated code
    • Functionality and error-checking performed on the same page
    • Uses include files to abstract code that is common between pages
  • 3: Most code is organized for clarity and maintainability
    • Page organized into functions with little duplicated code
    • Functionality and error-checking often performed on separate pages
    • Different pages tend to have the same code duplicated
  • 2: Some code is not well organized and some duplication exists
    • Page organized into functions but has some duplicate code
    • Different pages often have the same code duplicated
  • 1: Code is organized haphazardly and has many duplicated lines
    • Page not organized into functions
  • 0: Required PHP page was not submitted

PHP Documentation

  • 2: Code is well-documented
    • Name, date, and page description in page comment block
    • Follows format for page comment block
    • Proper use of whitespace and indenting
    • Files are correctly zipped
  • 1: Code has minor documentation errors
    • Has 1-2 documentation errors
  • 0: No apparent attempt at documentation

README.txt File

  • 2: README.txt file submitted with specified information included
  • 1: README.txt submitted but some information was not included
  • 0: No README.txt submitted

Maximum Score: 22, plus extra credit

^ top

What to Turn In

Submit your assignment following the instructions for homework. Create a single zip file with at least the following files in the web-application root folder:

  1. README.txt file
  2. All the exercise files from Lesson 9
  3. form.php file
  4. dbname.sql file
  5. Any other file needed to make your form.php page work properly

Note: if you turn in a file with the wrong file name, you may receive no credit.

Your .zip file must include all the files and subdirectories needed to make your assignment function properly and run without errors or warnings. Do not assume that the instructors has any files except dbconvars.php. Your assignment must work as submitted.

^ top

Home | Blackboard | Syllabus | Expectations | Schedule
Project | Help | FAQ's | HowTo's | Links
Last Updated: May 09 2010 @22:29:29