Coding Standards for PHP

Document Name: Coding Standards for PHP Document Number: ST-PM-001

Author: Effective Date:

Document History

Version No Date Nature of Modification

1.0 22-Dec-08 Coding standards for PHP

Page 1 of 20 First Page Software Services.

Coding Standards for PHP
Contents

1. OVERVIEW

2. SCOPE

3. GLOSSARY OF TERMS

4. STANDARDS

4.1 Folder Structure

4.1.1 Definition
4.1.2 Rules To Follow
4.1.3 Description
4.1.4 Example
4.1.5 Warning

4.2 Indenting and Line Length

4.2.1 Definition
4.2.2 Rules To Follow
4.2.3 Description
4.2.4 Example

4.3 Control Structures

4.3.1 Definition
4.3.2 Rules To Follow
4.3.3 Example
4.3.4 Warning

4.4 Function Calls and Declaration

4.4.1 Definition
4.4.2 Rules To Follow
4.4.3 Example
4.4.4 Warning

4.5 Comments
4.5.1 Definition
4.5.2 Rules To Follow
4.5.3 Description
4.5.4 Example
4.5.5 Warning

4.6 Include Statements

4.6.1 Definition
4.6.2 Rules To Follow
4.6.3 Description
4.6.4 Example
4.6.5 Warning

4.7 Naming Conventions

Page 2 of 20 First Page Software Services.

Coding Standards for PHP
4.7.1 Definition
4.7.2 Rules To Follow
4.7.3 Description
4.7.4 Example
4.7.5 Warning

4.8 Database Standards and Conventions

4.8.1 Definition
4.8.2 Rules To Follow
4.8.3 Description
4.8.4 Example
4.8.5 Warning

5. ASSOCIATED PROCESS ELEMENTS

6. ANNEXURE

Page 3 of 20 First Page Software Services.

Coding Standards for PHP

1. Overview

This document basically describes the coding standards and conventions to be followed when
developing a PHP code.

2. Scope

The scope of this document extends to all the projects developed in iProgrammer using PHP as
the web programming language and to all the developers who are going to develop those
projects. Some of the standards defined this document are generic and may imply to any
programming language.

3. Glossary of Terms

Term/Abbreviation Description
CL Client
PM Project Manager
DB Database
CS Coding Standards
CC Coding Conventions
FS Folder Structure
NC Naming Conventions

4. Standards

4.1 Folder Structure

4.1.1 Definition

• Folder structures refer to different kinds of directories to be maintained while

developing any kind of project where each specific directory contains similar files.
• It is very important to maintain a decent FS to keep the maintenance and usage of
project files easy.

4.1.2 Rules to Follow

The following folders have been identified as part of the web development process:
• includes
• js
• css
• images
• cron
• functions
• process
• admin
• others

Page 4 of 20 First Page Software Services.

Coding Standards for PHP
4.1.3 Description

• includes: This folder will include all the configuration files, error handling class,
database class and any other classes if at all required. There will also be a
config.inc.php file that will hold all the configuration constants of the site. This file
should not be uploaded directly but rather a continuous effort should be made to re-
modify it every time we need to change its contents so that we don’t overwrite the
previous data contained in it.
• js: All the java script files will be stored here
• css: All style sheets will be a part of this folder
• images: As the name suggests all the site images should be in this folder including
flash
• cron: A cron is a program that is scheduled to run periodically. Any cron script should
get into this folder. The folder should be protected by htaccess so that no one can
directly run the scripts contained in that folder. This folder is optional.
• functions: All the common PHP functions file, user defined functions file etc should
come into this folder.
• process: All the business logic of all the form contained pages should be stored in the
files contained in this folder. Example. Suppose you have a login.php page in the
member folder. Then the business logic to validate the user name and password will be
written in a different file called login.inc.php (assuming that you are submitting the
form to the same page) but stored in the folder named process. Refer the example
part of an actual example.
• admin: All the administrative files will be stored in the admin folder. This folder also in
turn can have sub-folders i.e. the above 7 folders.
• others: The others folder is a general term for many other folders which can be a part
of your project.
Example:
1. registration: All the registration related files and pages should be stored in this
folder.
2. member: If the site contains a member section or any other general public section
then those files should be kept here. This folder in turn can contain other folders
like reports, accounts, billing, payment etc depending on the project
requirement.

4.1.4 Example

Example of the usage of the process folder

So the login.php file in the member folder would like this:

<?php
####################################
# File Name: member/login.php
# Created By: XYZ
# Created On: June 21, 2005
# This file will contain the login form.
####################################

Page 5 of 20 First Page Software Services.

Coding Standards for PHP
//File to process the business logic
include(“../process/login.inc.php”);
?>
<html>
<body>
<form name=frmLogin method=POST action=login.php>
Username: <input name=txtUser value=’’>
Password: <input type=password name=txtPass value=’’>
<input type=submit name=btnSubmit value=Go>
</form>
</body>
</html>

And the actual validation file login.inc.php but in process folder would look like this:

<?php
####################################
# File Name: process/login.inc.php
# Created By: XYZ
# Created On: June 21, 2005
# This file will contain the business logic to validate the
# username and password submitted from form contained
# in member/login.php file.
####################################

//Database connectivity file

include(“../includes/dataconn.php”);

if ($_POST[‘btnSubmit’] != “”)
{
//Your validation code
}
?>

4.1.5 Warning

• When creating any ‘other’ folder apart from the standard (1-7) folders, it is required
that you consult your TL or PM before doing so

4.2 Indenting and Line Length

4.2.1 Definition

• Indentation refers to the spacing of the code syntax, which makes it easier to read and
understand the code.

• Line length refers to the length of the code statement in a single row/line.

Page 6 of 20 First Page Software Services.

Coding Standards for PHP

4.2.2 Rules to Follow

• Begin writing your code with an indent of a single tab (i.e. nth column of any row
depending on the editor. In case of Zend, the 5th column. Always use tabs wherever
and whenever needed. Do not use white spaces). But the opening php tag “<?php”
should begin on the first column itself and the closing php tag “?>” should end on the
first column itself.
• All the control structures’, functions’, classes’ etc opening and closing braces should
start and end on the same column number.
• It is recommended that you break lines at approximately 75-85 characters. There is no
standard rule for the best way to break a line.

4.2.3 Description

• Your code should be well intended so that it looks neat and tidy. Anybody who sees
your code should be able to easily identify the placing of various blocks. Even when
you review the code after few days it will be easy for you to identify things within the
code. Some standard editors like Zend have built in facility to indent your code. You
just need to select your entire code and choose the option to intend your code from
the menu options

4.2.4 Example

Row/Column 1 2 3 4 5 6 7 8 9 10 11 12 13 14……………..
1 <?php //starts at 1st column
2
3 //starts at 5th column i.e. an indent of single tab (Zend editor).
4 For ($I=1; $I <= 5; $I++)
5 {
6 For ($j=1; $j <= $I; $j++)
7 {
8 Print “*”;
9 }//notice where the braces start and where they end.
10
11 echo “<br>”;
12
13 } //notice where the braces start and where they end.
14
15 if ($I == 6)
16 {
17 echo “The design is complete” .”<br><br>”;
18 }
19 echo “Bye! Have a good day.”;
20
21 ?> //ends on 1st column

Page 7 of 20 First Page Software Services.

Coding Standards for PHP

4.3 Control Structures

4.3.1 Definition

• For controlling the logic of any application we require control structures which includes
statements like “if”, ”for”, ”while”, “switch” etc.

4.3.2 Rules to Follow

• Control statements should have one space between the control keyword and opening
parenthesis, to distinguish them from function calls.
• Always use curly braces even in situations where they are technically optional. Having
them increases readability and decreases the likelihood of logical errors being
introduced when new lines are added.
• For if statements if there are multiple conditions, then each condition should be
enclosed in round braces.
• If there is a single condition inside an if-else statement then use of ternary operators
(? :) is always recommended. Ternary operators are generally used when you need to
collect a specific integer or float value depending on the if-else condition.
• Switch statements are always preferred over "if elseif elseif else" kind of statements.
• Switch statements should always have a default condition.

4.3.3 Example

<?php //if statement with multiple conditions

$intCnt = 1;
$boolFlag = true;

// each condition itself is bracketed

if (($intCnt == 1) && ($boolFlag == true))
{
echo “The if condition got satisfied”;
} //braces implemented even if one statement inside if
?>

<?php //if statement replaced with ternary operators

if (($intTotalRecCount % $intPageSize) == 0)
{
$intPageCount = $intTotalRecCount / $intPageSize;
}
else
{
$intPageCount = ceil($intTotalRecCount / $intPageSize);
}

//The above if-else statement can be replaced using ternary operators.

Page 8 of 20 First Page Software Services.

Coding Standards for PHP
$intPageCount = ($intTotalRecCount % $intPageSize == 0 ? $intTotalRecCount / $intPageSize :
ceil($intTotalRecCount / $intPageSize));
?>

<?php
//Comparison of “if elseif elseif else” and switch statements

$intCnt = 1;

if ($intCnt == 1)
{
echo “One”;
}
elseif ($intCnt == 2)
{
echo “Two”;
}
elseif ($intCnt == 3)
{
echo “Three”;
}
else
{
echo “None”;
}

//The above example is not a good programming practice.

//A switch statement would be faster and efficient.

Switch ($intCnt)
{
case “1” :
echo “One”;
break;
case “2” :
echo “Two”;
break;
case “3” :
echo “Three”;
break;
default :
echo “None”;
}

//Notice of the placement of the “case” keyword, the colon “:” , the
// “echo” statements and the “break” statements.

?>

4.3.4 Warning

Page 9 of 20 First Page Software Services.

Coding Standards for PHP
• While using looping statements like “for” and “while” make sure the loops have a
definitive terminating condition. This is to escape infinite loops.

4.4 Function Calls and Declarations

4.4.1 Definition

• Function calls and declarations refer to the way of calling a function definition and the
actual declaration of the function.

4.4.2 Rules To Follow

• Functions should be called with no spaces between the function name, the opening
parenthesis, and the first parameter, spaces between commas and each parameter,
and no space between the last parameter, the closing parenthesis, and the semicolon.
Here's an example:
$intRetVal = fnGetName($intCustID, $strEmail, $strZip);
• All function names should begin with “fn” followed by the actual function name with
each breaking work in capital.
• Arguments with default values should always go at the end of the argument list.
• Always attempt to return a meaningful value from a function, the one that is
appropriate.

4.4.3 Example

<?php
//observe the following in the function definition
#####################################################
#1. The function name. Starts with fn and the actual function name with each
# breaking word in capital i.e. Compare,Two,Numbers.
#2. How the function is called. Refer point 1.
#3. Argument with default value at the end of the list.
#4. Value returned if its meaningful or not.
#####################################################

$intVal1 = 3;
$intVal2 = 5;
$intGreater = fnCompareTwoNumbers($intVal1,$intVal2=’8’);
echo “The greater of ” .$intVal1 .” and ” .$intVal2 .“ is ” .$intGreater;

function fnCompareTwoNumbers($intNum1,$intNum2=’0’)
{
if ($intNum1 > $intNum2)
{
$intGreater = $intNum1;
return $intGreater;
}
else
{
$intGreater = $intNum2;
return $intGreater;
}

Page 10 of 20 First Page Software Services.

Coding Standards for PHP
}

?>

4.4.4 Warning

• Make sure the function parameters are explicitly verified in the code, arrays are
checked for out-of-bound indexes, variables are initialized before they are used etc.

4.5 Comments

4.5.1 Definition

• Comments form one of the most important aspects of the software development
process. It should be a must to comment your code at regular steps and stages.
Consider your comments a story describing the system. Page description, loop
comments, class comments are one part of the story, method signature comments are
another part of the story, method arguments another part, and method
implementation yet another part. All these parts should weave together and inform
someone else at another point of time just exactly what you did and why

4.5.2 Rules To Follow

• Commenting PHP page

• Commenting Functions

4.5.3 Description

• Commenting PHP page - Each php page should have the following information
header comment at the very start. The name of the page, its author, creation date,
last modified by person’s name, last modified date and a brief description of what logic
the page contains.
• Commenting Functions - Even functions should be well commented with details like
who created the function, when was it created, why was it created, what are the
parameters and their data types and what is the return value of the function. If the
function is big and complex then it should internally contain inline or block comments.
• Internally your page/function can have two types of comments:
a) Inline Comments - These are single line comments describing the current
line.
Syntax: // this is a single line comment
b) Block Comments - These are used to describe the next 4-5 lines of code (or
may be even more) that logically go together.
Syntax: /*-----------------------------------------------------------------
Description of the code block goes here…
-------------------------------------------------------------------*/

4.5.4 Example

• Commenting a PHP Page

Page 11 of 20 First Page Software Services.

Coding Standards for PHP
<?php
#####################################################
# File Name: login.php
# Created By: ABC XYZ
# Created On: 24th June 2005
# Last Modified By: ABC XYZ
# Last modified On: 24th June 2005
#
# This page will contain a login form.
# After the form is submitted, the login details will be validated. If valid, the user will
# be redirected to the member.php page else error message will de displayed.
#####################################################
?>

• Commenting Functions

<?php
#####################################################
# Function Name: void fnLogin($strUserName = 'nobody', $strUserPass = 'nobody')
# Created By: ABC XYZ
# Created on: 24th June 2005
# Purpose: Member function to validate the user login process
# Parameters: string $strUserName: User’s login name
# string $strUserPass: User’s Password
# ON SUCCESS: Sets the session variable $_SESSION[‘IsLoggedIn’] to a value of 1
# and returns 1
# ON FAILURE: Returns 0 on failure.
#####################################################
?>

• Inline Comment

<?php

//Good inline comment on the right

if (is_int($intPosition/2)) // if this is an odd record, we load the green table row

//Bad inline comment on the right (bad description of the problem)

if (is_int($intPosition/2)) // load row
?>

• Block Comment

<?php
//Good block comment (describes the problem well)
/*---------------------------------------------------------------------------------------

Page 12 of 20 First Page Software Services.

Coding Standards for PHP
Fetch the user records from the database in descending order.
If the user is active then show the subscription details in a green colored
table. If the user is inactive show the subscription details in a red colored
table . And so on…………………………..
--------------------------------------------------------------------------------------*/

//Bad block comment. (Too short)

/*---------------------------------------------------------------------------------------
Fetch the user records and show in different tables.
--------------------------------------------------------------------------------------*/
?>

4.5.5 Warning

• When to use Inline and Block comments?

Imagine you have to edit someone else code. Do you think it will be easy to understand it
without good and detailed comments?
You should use block comment when you want to explain more complex or important
operation, which is not really obvious for someone else than you. You can use inline
comment if you want to explain the purpose of these or/and next 1 or 2 lines.

You are forced to use block comment to describe any logical block of the script
• Don't use block comment every 2 lines of code - TOO OFTEN
• Don't use block comment every 200 lines - NOT ENOUGH

Of course, you should use comments where it really makes sense.

Lots of comments like this one:
$x = $x + 1; // I incremented $x
just doesn’t add any useful information to the code.

4.6 Include Statements

4.6.1 Definition

• This standard explains how to use PHP tags and include statements.

4.6.2 Rules To Follow

• PHP tags
• Other Include Statements

4.6.3 Description

• Always use <?php ?> to delimit the PHP code and not the <??> shorthand. This is
required for PEAR compliance and is also the most portable way to include PHP code
on differing operating systems and setups.

Page 13 of 20 First Page Software Services.

Coding Standards for PHP
• Anywhere you are unconditionally including a class or library file, use
require_once().
• Anywhere you are conditionally including a class or library file, use
include_once().
• Either of these will ensure that the class or library files are included only once.
They share the same file list, so you don't need to worry about mixing them - a file
included with require_once() will not be included again by include_once().
• Additionally it is recommended that all of your project includes have the fully
qualified path to the include the file instead of assuming that the user has the current
directory in the search path. Many PHP implementations don't include the current
directory in the path and statements such as include('myfunctions.php') may fail. Use
the $_CONF['PATH'] variable in the include statement.

4.6.4 Example

• include($_CONF['PATH'] . "includes/myfunctions.php");

4.6.5 Warning

• include_once() and require_once() are statements, not functions.

4.7 Naming Conventions

4.7.1 Definition

• We should always follow the Hungarian (also called Camel Case) naming
convention.

4.7.2 Rules To Follow

• Naming a Class
• Naming Functions and Methods
• Naming Constants
• Predefined Variables
• Variables
• File Naming Conventions
• Form Elements

4.7.3 Description

• Naming a Class - Classes should be given descriptive names. Avoid using

abbreviations wherever possible. Class names should always begin with an uppercase
letter prefixed by the word “cls”.
• Naming Functions and Methods – Functions and method names should begin
with the prefix “fn” followed by the actual function name with the first letter of each
breaking word in capital. Functions should in addition have the package name as a
prefix, to avoid name collisions between packages. Private class members (meaning
class members that are intended to be used only from within the same class in which
they are declared; PHP does not yet support truly-enforceable private namespaces)
are preceded by ‘pfn’.

Page 14 of 20 First Page Software Services.

Coding Standards for PHP
• Naming Constants - Constants should always be all uppercase, with underscores
to separate words. Prefix constant names with the uppercased name of the
class/package they are used in. Usually there should be no need to define any
constants in PHP include files. All constants used in the project must be defined in
config.inc.php file.
• Predefined Variables - When accessing pre defined variables like form elements,
session variables, cookies, environment variables, global variables etc do NOT use
regular global variables (register_globals=on) but ALWAYS use the super global
variables listed in the below table. Never access any of these mentioned variables
directly by their name. Assume that register_globals is off and then access the
predefined variables using super global variables.

Variable Type Access Using Comments

Server $_SERVER To access any information related to your hosting
server
Environment $_ENV To access any environment variables
HTTP Cookies $_COOKIE To set and access cookies
HTTP Get $_GET Any name element passed as a query string should
be accessed using $_GET
HTTP Post $_POST Any name element passed using the POST method
of a form should be accessed using $_POST
HTTP File Upload $_FILES All the variables created out of the file tag should be
accessed using $_FILES
Session $_SESSION All the session variables should be set and accessed
using $_SESSION
Global variables $GLOBALS To access any global variables

• Variables –
• All the variable names must be in bumpy or camel case as mentioned
above.
• Separate words and parts of variable name with capitalizing first letter of
each word i.e. simply capitalizing the first alphabet of each breaking word.
• Loop variables should be denoted by $i, $j, $k and so on.
• $sqlQuery1,$sqlQuery2 etc. and $resResult1, $resResult2 etc. are used for
sql-query string and resource identifier respectively.
• The chart below explains naming variables based on different data types:

Type Prefix Example

Integer/Long int $intVariableName
String str $strVariableName
Boolean bool $boolVariableName
Array arr $arrVariableName
Double/Float dbl $dblVariableName
Object obj $objClassName
Query sql $sqlQueryName
Result Set res $resVariableName
Handle hdl $hdlHandleName

• File Naming Conventions –

Page 15 of 20 First Page Software Services.

Coding Standards for PHP
1.All letters must be in lowercase.
2.Words are separated by underscores (_).
3.No matter what use ".php" extension.
4.Include file extensions: “.inc.php”.
5.Class extensions: “.class.php”.
6.Keep your file names under 32 chars.
7. Name PHP script after what it does and keep important part of the name as
prefix followed by _ and suffix. You can also use indexes if there are actions
that require more steps. Be sure names represent a group they belong to.
8. Good names are: user_add1.php, user_add2.php, user_delete.php,
report_monthly.php.
9. Bad names are: adduser.php, userdel.php, mntrep.php.
10. adduser.php and userdel.php does not tell that both scripts belong to the same
logical group, while point 8) shows the relation between them. It is also
important to use a prefix for the same group because this way files in the
directory listing will be placed together. Using indexes you can show the flow of
the action.
• Form Elements - Forms are an integral part of any web development process. So
giving meaningful names to each and every form element is important. Please refer
the below table on how to name form elements. The naming convention used will be
Hungarian (camel case).

Form Elements Prefix Example

Textbox/Password txt txtFirstName, txtPassword
Hidden hid hidCustID, hidBillID
Text Area ta taAddress, taMessage
Drop down/List Box lst lstState, lstCategory
File fl FlPath
Button/Reset/Submit/Image btn btnCancel, btnReset, btnSubmit, btnImage
Radio Buttons rd rdPayMode, rdSex
Check Boxes chk chkDelete[], chkInActive

4.7.4 Example

1. Naming a Class –
Examples of good class names are:
• clsStudent
• clsError
• clsMail

2. Naming Functions and Methods –

• fnConnect()
• fnGetData()
• fnBuildSomeWidget()
• fnXML_RPC_serializeData()
• pfnSort()
• pfnInitTree()
• $this->pfnStatus()

Page 16 of 20 First Page Software Services.

Coding Standards for PHP
3. Naming Constants -
• PAGE_COUNTER
• PAGE_SIZE

4.7.5 Warning

• The true, false and null constants are exempted from the all-uppercase rule, and
must always be lowercase.
• For a detailed description and usage of the pre defined variables please refer the
PHP manual.

4.8 Database Standards and Conventions

4.8.1 Definition

• This section explains all the database standards and conventions to be followed
while designing a database and using that database in your application.

4.8.2 Rules To Follow

• General Rules for Database Objects

• Tables
• Table Fields
• Documenting Tables
• Stored Procedures
• Views
• Indexes
• Constraints
• Triggers
• Queries

4.8.3 Description

• General Rules for Database Objects

1. Limit the name to 30 characters.
2. Use only letters and underscores.
3. Do not use spaces in names.
4. First letter of the name should start with an alphabet
5. Avoid abbreviations. Try to use full nouns. For example, instead of tblCust, use
tblCustomer
6. Use Hungarian notation. E.g. tblCustomer, spCheckLogin, trWithdrawal
• Tables
1. Use “tbl“ prefix for table names.
2. A table is a collection. Its name should be the entity it represents. For example
a. Incorrect: tblCustomers | Correct: tblCustomer
b. Incorrect: tblOrders | Correct: tblOrder
c. Correct: tblOrderDetails

• Table Fields
1. Field names should be all UPPER CASE and each word should be separated by
underscore.

Page 17 of 20 First Page Software Services.

Coding Standards for PHP
2. Boolean fields should be given names with prefix “IS” or “HAS” like
"IS_DELETED", "HAS_PERMISSION", or "IS_VALID"
3. Do not use table name as a prefix to each field.
• Documenting Tables
1. Primary Key / Foreign Key
2. Field Name
3. Data Type
4. Comments – Description of the field. Write as much detail as required in this
column. No need to describe a field that is self evident in the “general sense”.
However, some fields might be self-evident to the programmer who makes this
database. But the same field might not be clear to a new programmer who
joins the team. Such fields should be documented.
• Stored Procedures
1. Use “sp” prefix for Stored Procedures names.
2. You can group Stored Procedures within a listing by prefix the name with
operations like "spCreate", "spGet", "spUpdate" and "spDelete". You can get a
list by the parts of an application the stored procedure is used. E.g.
“spPayroll” and “spHR”.
• Views
1. Use “vw” prefix for View names.
2. Naming your views should be different depending on the type or purpose of the
view. For simple views that just join one or more tables with no selection
criteria, combine the names of the tables joined. For example, joining the
"Customers" and "StatesAndProvinces" table to create a view of Customers and
their respective geographical data should be given a name like
"VwCustomersStatesAndProvinces". For a view that is more like a report, a
name like "VwDivisionSalesFor2004" might make more sense.
• Indexes
1. Use “ix” prefix for Index names.
2. The naming convention for indexes follows this structure:
ix{TableName}{ColumnsIndexed}{U/N}{C/N}
where "U/N" is for unique or non-unique and "C/N" is for clustered or non-
clustered. "ixProductsIdUC" indicates a unique, clustered index on the Id
column of the Products table.
• Constraints
1. A prefix gets applied to the constraint name depending on the type
Primary Key: pk
Foreign Key: fk
Check: ck
Unique: un
2. The naming convention syntax for constraints looks like this:
{pk/fk/ck/un}{constraint type}{table name}_{field name}
pkProducts_Id - primary key constraint on the Id field of the Products table.
• Triggers
1. Use “tr” prefix for Index names.
2. The naming convention for triggers follows this structure:
tr{Ins/Upd/Del}{table name}
where Ins for Insert, Upd for Update and Del for Delete operation.
trInsEmp is a trigger fired when Insert operation is performed on Emp table.
• Queries
1. When writing queries in your code, the query keywords should always be all in
uppercase. E.g. SELECT NAME FROM tblCustomer WHERE CUST_ID = ‘1’;
Notice the keywords SELECT, FROM and WHERE are all in uppercase.

Page 18 of 20 First Page Software Services.

Coding Standards for PHP
2. In a SELECT query, try to avoid using * to return all the fields or some of the
table fields. Specify each field name separately to be returned.

4.8.4 Example

• Documenting Tables

tblRestaurant
Field Name Data Type Comments
PK RESTAURANT_ID INT (AUTO)
FK to CUST_ID in
FK CUST_ID INT (4)
tblCustomer
RESTAURANT_NAME VARCHAR (200)
ADDRESS VARCHAR (100)
CITY VARCHAR (50)
FK to STATE_ID in
FK STATE INT (2)
tblState

4.8.5 Warning

Bloopers:
• The best way to learn progressively is from past mistakes. This section discusses
some bloopers from our own past documents.

1. tblUserMaster
Field Name Data Type Remarks
USER_ID INT (Identity)
USER_LOGIN VARCHAR (100) Email id of the user
USER_PWD VARCHAR (8) Combination of characters
USER_TYPE VARCHAR (1) ‘S’ – SHEA users
‘O’ - Others

Remarks:

• Name of the table is incorrect. The use of “Master” is outdated. The correct table
name is “tblUser”.
• In the above table, every field name contains the suffix “USER”. This is a wrong
practice. Here are field equivalents:
a. USER_ID = USER_ID
b. USER_LOGIN = LOGIN_NAME
c. USER_PWD = PWD
d. USER_TYPE = TYPE
• As far as possible, use full nouns. PWD should be PASSWORD
• The remark for the field USER_PWD is not very descriptive. It should read – “User’s
Password. It can contain alphabets, numbers, special characters.”

5. Associated Process Elements

Page 19 of 20 First Page Software Services.

Coding Standards for PHP
Sr. Document Title Document No. Version Author Released
No. Date

6. Annexure
None

Page 20 of 20 First Page Software Services.