Basic PHP Syntax
Basic PHP Syntax
A PHP scripting block always starts with <?php and ends with ?>. A PHP scripting block can be
placed anywhere in the document.
On servers with shorthand support enabled you can start a scripting block with <? and end
with ?>.
<?php
?>
A PHP file normally contains HTML tags, just like an HTML file, and some PHP scripting code.
<html>
<body>
<?php
echo "Hello World";
?>
</body>
</html>
Each code line in PHP must end with a semicolon. The semicolon is a separator and is used to
distinguish one set of instructions from another.
There are two basic statements to output text with PHP: echo and print. In the example above
we have used the echo statement to output the text "Hello World".
Note: The file must have a .php extension. If the file has a .html extension, the PHP code will
not be executed.
Comments in PHP
1
In PHP, we use // to make a single-line comment or /* and */ to
make a large comment block.
<html>
<body>
<?php
//This is a comment
/*
This is
a comment
block
*/
?>
</body>
PHP Variables
Variables in PHP
Variables are used for storing a values, like text strings, numbers or arrays.
When a variable is declared, it can be used over and over again in your script.
$var_name = value;
New PHP programmers often forget the $ sign at the beginning of the variable. In that case it
will not work.
<?php
$txt="Hello World!";
$x=16;
?>
In PHP, a variable does not need to be declared before adding a value to it.
2
In the example above, you see that you do not have to tell PHP which data type the variable is.
PHP automatically converts the variable to the correct data type, depending on its value.
In a strongly typed programming language, you have to declare (define) the type and name of
the variable before using it.
In this chapter we are going to look at the most common functions and operators used to
manipulate strings in PHP.
After we create a string we can manipulate it. A string can be used directly in a function or it
can be stored in a variable.
Below, the PHP script assigns the text "Hello World" to a string
variable called $txt:
<?php
$txt="Hello World";
echo $txt;
?>
Hello World
Now, lets try to use some different functions and operators to manipulate the string.
The concatenation operator (.) is used to put two string values together.
3
To concatenate two string variables together, use the concatenation
operator:
<?php
$txt1="Hello World!";
$txt2="What a nice day!";
echo $txt1 . " " . $txt2;
?>
If we look at the code above you see that we used the concatenation operator two times. This is
because we had to insert a third string (a space character), to separate the two strings.
<?php
echo strlen("Hello world!");
?>
12
The length of a string is often used in loops or other functions, when it is important to know
when the string ends. (i.e. in a loop, we would want to stop the loop after the last character in
the string).
If a match is found, this function will return the position of the first match. If no match is found,
it will return FALSE.
<?php
echo strpos("Hello world!","world");
?>
4
The position of the string "world" in our string is position 6. The reason that it is 6 (and not 7),
is that the first position in the string is 0, and not 1.
For a complete reference of all string functions, go to our complete PHP String Reference.
The reference contains a brief description, and examples of use, for each function!
Installation
The string functions are part of the PHP core. There is no installation needed to use these
functions.
PHP: indicates the earliest version of PHP that supports the function.
Function Description PH
P
addcslashes() Returns a string with backslashes in front of the 4
specified characters
addslashes() Returns a string with backslashes in front of 3
predefined characters
bin2hex() Converts a string of ASCII characters to hexadecimal 3
values
chop() Alias of rtrim() 3
chr() Returns a character from a specified ASCII value 3
chunk_split() Splits a string into a series of smaller parts 3
convert_cyr_string() Converts a string from one Cyrillic character-set to 3
another
convert_uudecode() Decodes a uuencoded string 5
convert_uuencode() Encodes a string using the uuencode algorithm 5
count_chars() Returns how many times an ASCII character occurs 4
within a string and returns the information
crc32() Calculates a 32-bit CRC for a string 4
crypt() One-way string encryption (hashing) 3
echo() Outputs strings 3
explode() Breaks a string into an array 3
5
fprintf() Writes a formatted string to a specified output 5
stream
get_html_translation_table() Returns the translation table used by 4
htmlspecialchars() and htmlentities()
hebrev() Converts Hebrew text to visual text 3
hebrevc() Converts Hebrew text to visual text and new lines (\ 3
n) into <br />
html_entity_decode() Converts HTML entities to characters 4
htmlentities() Converts characters to HTML entities 3
htmlspecialchars_decode() Converts some predefined HTML entities to 5
characters
htmlspecialchars() Converts some predefined characters to HTML 3
entities
implode() Returns a string from the elements of an array 3
join() Alias of implode() 3
levenshtein() Returns the Levenshtein distance between two 3
strings
localeconv() Returns locale numeric and monetary formatting 4
information
ltrim() Strips whitespace from the left side of a string 3
md5() Calculates the MD5 hash of a string 3
md5_file() Calculates the MD5 hash of a file 4
metaphone() Calculates the metaphone key of a string 4
money_format() Returns a string formatted as a currency string 4
nl_langinfo() Returns specific local information 4
nl2br() Inserts HTML line breaks in front of each newline in a 3
string
number_format() Formats a number with grouped thousands 3
ord() Returns the ASCII value of the first character of a 3
string
parse_str() Parses a query string into variables 3
print() Outputs a string 3
printf() Outputs a formatted string 3
quoted_printable_decode() Decodes a quoted-printable string 3
quotemeta() Quotes meta characters 3
rtrim() Strips whitespace from the right side of a string 3
setlocale() Sets locale information 3
sha1() Calculates the SHA-1 hash of a string 4
sha1_file() Calculates the SHA-1 hash of a file 4
similar_text() Calculates the similarity between two strings 3
soundex() Calculates the soundex key of a string 3
sprintf() Writes a formatted string to a variable 3
sscanf() Parses input from a string according to a format 4
str_ireplace() Replaces some characters in a string (case- 5
insensitive)
str_pad() Pads a string to a new length 4
str_repeat() Repeats a string a specified number of times 4
str_replace() Replaces some characters in a string (case-sensitive) 3
6
str_rot13() Performs the ROT13 encoding on a string 4
str_shuffle() Randomly shuffles all characters in a string 4
str_split() Splits a string into an array 5
str_word_count() Count the number of words in a string 4
strcasecmp() Compares two strings (case-insensitive) 3
strchr() Finds the first occurrence of a string inside another 3
string (alias of strstr())
strcmp() Compares two strings (case-sensitive) 3
strcoll() Locale based string comparison 4
strcspn() Returns the number of characters found in a string 3
before any part of some specified characters are
found
strip_tags() Strips HTML and PHP tags from a string 3
stripcslashes() Unquotes a string quoted with addcslashes() 4
stripslashes() Unquotes a string quoted with addslashes() 3
stripos() Returns the position of the first occurrence of a string 5
inside another string (case-insensitive)
stristr() Finds the first occurrence of a string inside another 3
string (case-insensitive)
strlen() Returns the length of a string 3
strnatcasecmp() Compares two strings using a "natural order" 4
algorithm (case-insensitive)
strnatcmp() Compares two strings using a "natural order" 4
algorithm (case-sensitive)
strncasecmp() String comparison of the first n characters (case- 4
insensitive)
strncmp() String comparison of the first n characters (case- 4
sensitive)
strpbrk() Searches a string for any of a set of characters 5
strpos() Returns the position of the first occurrence of a string 3
inside another string (case-sensitive)
strrchr() Finds the last occurrence of a string inside another 3
string
strrev() Reverses a string 3
strripos() Finds the position of the last occurrence of a string 5
inside another string (case-insensitive)
strrpos() Finds the position of the last occurrence of a string 3
inside another string (case-sensitive)
strspn() Returns the number of characters found in a string 3
that contains only characters from a specified charlist
strstr() Finds the first occurrence of a string inside another 3
string (case-sensitive)
strtok() Splits a string into smaller strings 3
strtolower() Converts a string to lowercase letters 3
strtoupper() Converts a string to uppercase letters 3
strtr() Translates certain characters in a string 3
substr() Returns a part of a string 3
substr_compare() Compares two strings from a specified start position 5
(binary safe and optionally case-sensitive)
substr_count() Counts the number of times a substring occurs in a 4
7
string
substr_replace() Replaces a part of a string with another string 4
trim() Strips whitespace from both sides of a string 3
ucfirst() Converts the first character of a string to uppercase 3
ucwords() Converts the first character of each word in a string 3
to uppercase
vfprintf() Writes a formatted string to a specified output 5
stream
vprintf() Outputs a formatted string 4
vsprintf() Writes a formatted string to a variable 4
wordwrap() Wraps a string to a given number of characters 4
PHP: indicates the earliest version of PHP that supports the constant.
PH
Constant Description
P
CRYPT_SALT_LENGTH Contains the length of the default encryption method
for the
system. For standard DES encryption, the length is 2
CRYPT_STD_DES Set to 1 if the standard DES-based encryption with a
2 character salt is supported, 0 otherwise
CRYPT_EXT_DES Set to 1 if the extended DES-based encryption with a
9 character salt is supported, 0 otherwise
CRYPT_MD5 Set to 1 if the MD5 encryption with a 12 character
salt starting with $1$ is supported, 0 otherwise
CRYPT_BLOWFISH Set to 1 if the Blowfish encryption with a 16
character salt starting with $2$ or $2a$ is supported,
0 otherwise0
HTML_SPECIALCHARS
HTML_ENTITIES
ENT_COMPAT
ENT_QUOTES
ENT_NOQUOTES
CHAR_MAX
LC_CTYPE
LC_NUMERIC
LC_TIME
LC_COLLATE
LC_MONETARY
LC_ALL
LC_MESSAGES
STR_PAD_LEFT
STR_PAD_RIGHT
STR_PAD_BOTH
8
PHP Operators
Operators are used to operate on values.
PHP Operators
Arithmetic Operators
Assignment Operators
Comparison Operators
9
Logical Operators
Conditional Statements
Very often when you write code, you want to perform different actions for different decisions.
if statement - use this statement to execute some code only if a specified condition is
true
if...else statement - use this statement to execute some code if a condition is true
and another code if the condition is false
if...elseif....else statement - use this statement to select one of several blocks of
code to be executed
switch statement - use this statement to select one of many blocks of code to be
executed
The if Statement
Use the if statement to execute some code only if a specified condition is true.
Syntax
if (condition) code to be executed if condition is true;
10
<html>
<body>
<?php
$d=date("D");
if ($d=="Fri") echo "Have a nice weekend!";
?>
</body>
</html>
Notice that there is no ..else.. in this syntax. You tell the browser to execute some code only if
the specified condition is true.
Use the if....else statement to execute some code if a condition is true and another code if a
condition is false.
Syntax
if (condition)
code to be executed if condition is true;
else
code to be executed if condition is false;
Example
<html>
<body>
<?php
$d=date("D");
if ($d=="Fri")
echo "Have a nice weekend!";
else
echo "Have a nice day!";
?>
</body>
</html>
<html>
<body>
11
<?php
$d=date("D");
if ($d=="Fri")
{
echo "Hello!<br />";
echo "Have a nice weekend!";
echo "See you on Monday!";
}
?>
</body>
</html>
Use the if....elseif...else statement to select one of several blocks of code to be executed.
Syntax
if (condition)
code to be executed if condition is true;
elseif (condition)
code to be executed if condition is true;
else
code to be executed if condition is false;
Example
The following example will output "Have a nice weekend!" if the current day is Friday, and "Have
a nice Sunday!" if the current day is Sunday. Otherwise it will output "Have a nice day!":
<html>
<body>
<?php
$d=date("D");
if ($d=="Fri")
echo "Have a nice weekend!";
elseif ($d=="Sun")
echo "Have a nice Sunday!";
else
echo "Have a nice day!";
?>
</body>
</html>
12
The PHP Switch Statement
Use the switch statement to select one of many blocks of code to be executed.
Syntax
switch (n)
{
case label1:
code to be executed if n=label1;
break;
case label2:
code to be executed if n=label2;
break;
default:
code to be executed if n is different from both label1 and label2;
}
This is how it works: First we have a single expression n (most often a variable), that is
evaluated once. The value of the expression is then compared with the values for each case in
the structure. If there is a match, the block of code associated with that case is executed. Use
break to prevent the code from running into the next case automatically. The default statement
is used if no match is found.
Example
<html>
<body>
<?php
switch ($x)
{
case 1:
echo "Number 1";
break;
case 2:
echo "Number 2";
break;
case 3:
echo "Number 3";
break;
default:
echo "No number between 1 and 3";
}
?>
</body>
</html>
PHP Arrays
13
An array stores multiple values in a single variable.
What is an Array?
You have already learnt that a variable is a storage area holding numbers and text. The problem
is, a variable will hold only one value.
An array is a special variable, which can hold more than one value, at a time.
If you have a list of items (a list of car names, for example), storing
the cars in single variables could look like this:
$cars1="Saab";
$cars2="Volvo";
$cars3="BMW";
However, what if you want to loop through the cars and find a specific one? And what if you had
not 3 cars, but 300?
An array can hold all your variable values under a single name. And you can access the values
by referring to the array name.
Each element in the array has its own index so that it can be easily accessed.
Numeric Arrays
$cars=array("Saab","Volvo","BMW","Toyota");
$cars[0]="Saab";
$cars[1]="Volvo";
$cars[2]="BMW";
$cars[3]="Toyota";
14
Example
<?php
$cars[0]="Saab";
$cars[1]="Volvo";
$cars[2]="BMW";
$cars[3]="Toyota";
echo $cars[0] . " and " . $cars[1] . " are Swedish cars.";
?>
Associative Arrays
When storing data about specific named values, a numerical array is not always the best way to
do it.
With associative arrays we can use the values as keys and assign values to them.
Example 1
Example 2
$ages['Peter'] = "32";
$ages['Quagmire'] = "30";
$ages['Joe'] = "34";
<?php
$ages['Peter'] = "32";
$ages['Quagmire'] = "30";
$ages['Joe'] = "34";
15
Peter is 32 years old.
Multidimensional Arrays
In a multidimensional array, each element in the main array can also be an array. And each
element in the sub-array can be an array, and so on.
Example
$families = array
(
"Griffin"=>array
(
"Peter",
"Lois",
"Megan"
),
"Quagmire"=>array
(
"Glenn"
),
"Brown"=>array
(
"Cleveland",
"Loretta",
"Junior"
)
);
The array above would look like this if written to the output:
Array
(
[Griffin] => Array
(
[0] => Peter
[1] => Lois
[2] => Megan
)
[Quagmire] => Array
(
[0] => Glenn
)
[Brown] => Array
(
[0] => Cleveland
[1] => Loretta
[2] => Junior
)
)
Example 2
16
echo "Is " . $families['Griffin'][2] .
" a part of the Griffin family?";
For a complete reference of all array functions, go to our complete PHP Array Reference.
The reference contains a brief description, and examples of use, for each function!
PHP Loops
Often when you write code, you want the same block of code to run over and over again in a
row. Instead of adding several almost equal lines in a script we can use loops to perform a task
like this.
Syntax
while (condition)
{
code to be executed;
}
17
Example
The example below defines a loop that starts with i=1. The loop will
continue to run as long as i is less than, or equal to 5. i will increase
by 1 each time the loop runs:
<html>
<body>
<?php
$i=1;
while($i<=5)
{
echo "The number is " . $i . "<br />";
$i++;
}
?>
</body>
</html>
Output:
The number is 1
The number is 2
The number is 3
The number is 4
The number is 5
The do...while statement will always execute the block of code once, it will then check the
condition, and repeat the loop while the condition is true.
Syntax
do
{
code to be executed;
}
while (condition);
Example
The example below defines a loop that starts with i=1. It will then
increment i with 1, and write some output. Then the condition is
checked, and the loop will continue to run as long as i is less than,
or equal to 5:
<html>
<body>
<?php
$i=1;
do
{
18
$i++;
echo "The number is " . $i . "<br />";
}
while ($i<=5);
?>
</body>
</html>
Output:
The number is 2
The number is 3
The number is 4
The number is 5
The number is 6
The for loop and the foreach loop will be explained in the next chapter.
The for loop is used when you know in advance how many times the script should run.
Syntax
for (init; condition; increment)
{
code to be executed;
}
Parameters:
init: Mostly used to set a counter (but can be any code to be executed once at the
beginning of the loop)
condition: Evaluated for each loop iteration. If it evaluates to TRUE, the loop continues.
If it evaluates to FALSE, the loop ends.
increment: Mostly used to increment a counter (but can be any code to be executed at
the end of the loop)
Note: Each of the parameters above can be empty, or have multiple expressions (separated by
commas).
19
Example
The example below defines a loop that starts with i=1. The loop will
continue to run as long as i is less than, or equal to 5. i will increase
by 1 each time the loop runs:
<html>
<body>
<?php
for ($i=1; $i<=5; $i++)
{
echo "The number is " . $i . "<br />";
}
?>
</body>
</html>
Output:
The number is 1
The number is 2
The number is 3
The number is 4
The number is 5
Syntax
foreach ($array as $value)
{
code to be executed;
}
For every loop iteration, the value of the current array element is assigned to $value (and the
array pointer is moved by one) - so on the next loop iteration, you'll be looking at the next
array value.
Example
The following example demonstrates a loop that will print the values
of the given array:
<html>
<body>
<?php
$x=array("one","two","three");
foreach ($x as $value)
{
echo $value . "<br />";
}
20
?>
</body>
</html>
Output:
one
two
three
PHP Functions
For a complete reference and examples of the built-in functions, please visit our PHP Reference.
PHP Functions
In this chapter we will show you how to create your own functions.
To keep the browser from executing a script when the page loads, you can put your script into a
function.
Syntax
function functionName()
{
code to be executed;
}
21
Give the function a name that reflects what the function does
The function name can start with a letter or underscore (not a number)
Example
<html>
<body>
<?php
function writeName()
{
echo "Kai Jim Refsnes";
}
</body>
</html>
Output:
To add more functionality to a function, we can add parameters. A parameter is just like a
variable.
Parameters are specified after the function name, inside the parentheses.
Example 1
The following example will write different first names, but equal last
name:
<html>
<body>
<?php
function writeName($fname)
{
echo $fname . " Refsnes.<br />";
}
</body>
22
</html>
Output:
Example 2
<html>
<body>
<?php
function writeName($fname,$punctuation)
{
echo $fname . " Refsnes" . $punctuation . "<br />";
}
</body>
</html>
Output:
Example
<html>
<body>
<?php
function add($x,$y)
{
$total=$x+$y;
return $total;
}
</body>
23
</html>
Output:
1 + 16 = 17
The PHP $_GET and $_POST variables are used to retrieve information from forms,
like user input.
The most important thing to notice when dealing with HTML forms and PHP is that any form
element in an HTML page will automatically be available to your PHP scripts.
Example
The example below contains an HTML form with two input fields and
a submit button:
<html>
<body>
</body>
</html>
When a user fills out the form above and click on the submit button, the form data is sent to a
PHP file, called "welcome.php":
<html>
<body>
</body>
</html>
24
Welcome John!
You are 28 years old.
The PHP $_GET and $_POST functions will be explained in the next chapters.
Form Validation
User input should be validated on the browser whenever possible (by client scripts). Browser
validation is faster and reduces the server load.
You should consider server validation if the user input will be inserted into a database. A good
way to validate a form on the server is to post the form to itself, instead of jumping to a
different page. The user will then get the error messages on the same page as the form. This
makes it easier to discover the error.
The built-in $_GET function is used to collect values in a form with method="get".
The built-in $_GET function is used to collect values from a form sent with method="get".
Information sent from a form with the GET method is visible to everyone (it will be displayed in
the browser's address bar) and has limits on the amount of information to send (max. 100
characters).
Example
<form action="welcome.php" method="get">
Name: <input type="text" name="fname" />
Age: <input type="text" name="age" />
<input type="submit" />
</form>
When the user clicks the "Submit" button, the URL sent to the
server could look something like this:
http://www.w3schools.com/welcome.php?fname=Peter&age=37
The "welcome.php" file can now use the $_GET function to collect
form data (the names of the form fields will automatically be the
keys in the $_GET array):
25
When to use method="get"?
When using method="get" in HTML forms, all variable names and values are displayed in the
URL.
Note: This method should not be used when sending passwords or other sensitive information!
However, because the variables are displayed in the URL, it is possible to bookmark the page.
This can be useful in some cases.
Note: The get method is not suitable for large variable values; the value cannot exceed 100
characters.
The built-in $_POST function is used to collect values in a form with method="post".
The built-in $_POST function is used to collect values from a form sent with method="post".
Information sent from a form with the POST method is invisible to others and has no limits on
the amount of information to send.
Note: However, there is an 8 Mb max size for the POST method, by default (can be changed by
setting the post_max_size in the php.ini file).
Example
<form action="welcome.php" method="post">
Name: <input type="text" name="fname" />
Age: <input type="text" name="age" />
<input type="submit" />
</form>
When the user clicks the "Submit" button, the URL will look like
this:
http://www.w3schools.com/welcome.php
The "welcome.php" file can now use the $_POST function to collect
form data (the names of the form fields will automatically be the
keys in the $_POST array):
Information sent from a form with the POST method is invisible to others and has no limits on
the amount of information to send.
26
However, because the variables are not displayed in the URL, it is not possible to bookmark the
page.
The PHP built-in $_REQUEST function contains the contents of both $_GET, $_POST, and
$_COOKIE.
The $_REQUEST function can be used to collect form data sent with both the GET and POST
methods.
Example
Welcome <?php echo $_REQUEST["fname"]; ?>!<br />
You are <?php echo $_REQUEST["age"]; ?> years old.
The PHP date() function formats a timestamp to a more readable date and time.
A timestamp is a sequence of characters, denoting the date and/or time at which a certain
event occurred.
Syntax
date(format,timestamp)
Parameter Description
format Required. Specifies the format of the timestamp
timestamp Optional. Specifies a timestamp. Default is the current date and time
The required format parameter in the date() function specifies how to format the date/time.
A list of all the characters that can be used in the format parameter, can be found in our PHP
Date reference.
27
Other characters, like"/", ".", or "-" can also be inserted between
the letters to add additional formatting:
<?php
echo date("Y/m/d") . "<br />";
echo date("Y.m.d") . "<br />";
echo date("Y-m-d")
?>
2009/05/11
2009.05.11
2009-05-11
The optional timestamp parameter in the date() function specifies a timestamp. If you do not
specify a timestamp, the current date and time will be used.
The Unix timestamp contains the number of seconds between the Unix Epoch (January 1 1970
00:00:00 GMT) and the time specified.
To go one day in the future we simply add one to the day argument
of mktime():
<?php
$tomorrow = mktime(0,0,0,date("m"),date("d")+1,date("Y"));
echo "Tomorrow is ".date("Y/m/d", $tomorrow);
?>
Tomorrow is 2009/05/12
For a complete reference of all date functions, go to our complete PHP Date Reference.
The reference contains a brief description, and examples of use, for each function!
28
Server Side Includes (SSI)
You can insert the content of one PHP file into another PHP file before the server executes it,
with the include() or require() function.
The two functions are identical in every way, except how they handle errors:
These two functions are used to create functions, headers, footers, or elements that will be
reused on multiple pages.
Server side includes saves a lot of work. This means that you can create a standard header,
footer, or menu file for all your web pages. When the header needs to be updated, you can only
update the include file, or when you add a new page to your site, you can simply change the
menu file (instead of updating the links on all your web pages).
The include() function takes all the content in a specified file and includes it in the current file.
If an error occurs, the include() function generates a warning, but the script will continue
execution.
Example 1
<html>
<body>
</body>
</html>
Example 2
<a href="/default.php">Home</a>
<a href="/tutorials.php">Tutorials</a>
<a href="/references.php">References</a>
<a href="/examples.php">Examples</a>
<a href="/about.php">About Us</a>
<a href="/contact.php">Contact Us</a>
All pages in the Web site should include this menu file. Here is how
it can be done:
<html>
29
<body>
<div class="leftmenu">
<?php include("menu.php"); ?>
</div>
</body>
</html>
If you look at the source code of the page above (in a browser), it will look like this:
<html>
<body>
<div class="leftmenu">
<a href="/default.php">Home</a>
<a href="/tutorials.php">Tutorials</a>
<a href="/references.php">References</a>
<a href="/examples.php">Examples</a>
<a href="/about.php">About Us</a>
<a href="/contact.php">Contact Us</a>
</div>
</body>
</html>
The require() function is identical to include(), except that it handles errors differently.
If an error occurs, the include() function generates a warning, but the script will continue
execution. The require() generates a fatal error, and the script will stop.
<?php
include("wrongFile.php");
echo "Hello World!";
?>
</body>
</html>
Error message:
30
Warning: include() [function.include]:
Failed opening 'wrongFile.php' for inclusion
(include_path='.;C:\php5\pear')
in C:\home\website\test.php on line 5
Hello World!
Notice that the echo statement is executed! This is because a Warning does not stop the script
execution.
Now, let's run the same example with the require() function.
<html>
<body>
<?php
require("wrongFile.php");
echo "Hello World!";
?>
</body>
</html>
Error message:
The echo statement is not executed, because the script execution stopped after the fatal error.
It is recommended to use the require() function instead of include(), because scripts should not
continue after an error.
Opening a File
The first parameter of this function contains the name of the file to
be opened and the second parameter specifies in which mode the
file should be opened:
31
<html>
<body>
<?php
$file=fopen("welcome.txt","r");
?>
</body>
</html>
Modes Description
r Read only. Starts at the beginning of the file
r+ Read/Write. Starts at the beginning of the file
w Write only. Opens and clears the contents of file; or creates a new file if it
doesn't exist
w+ Read/Write. Opens and clears the contents of file; or creates a new file if it
doesn't exist
a Append. Opens and writes to the end of the file or creates a new file if it
doesn't exist
a+ Read/Append. Preserves file content by writing to the end of the file
x Write only. Creates a new file. Returns FALSE and an error if file already
exists
x+ Read/Write. Creates a new file. Returns FALSE and an error if file already
exists
Note: If the fopen() function is unable to open the specified file, it returns 0 (false).
Example
<html>
<body>
<?php
$file=fopen("welcome.txt","r") or exit("Unable to open file!");
?>
</body>
</html>
Closing a File
<?php
$file = fopen("test.txt","r");
32
fclose($file);
?>
Check End-of-file
The feof() function checks if the "end-of-file" (EOF) has been reached.
The feof() function is useful for looping through data of unknown length.
Note: After a call to this function the file pointer has moved to the next line.
Example
The example below reads a file line by line, until the end of file is
reached:
<?php
$file = fopen("welcome.txt", "r") or exit("Unable to open file!");
//Output a line of the file until the end is reached
while(!feof($file))
{
echo fgets($file). "<br />";
}
fclose($file);
?>
Note: After a call to this function the file pointer moves to the next character.
Example
The example below reads a file character by character, until the end
of file is reached:
<?php
$file=fopen("welcome.txt","r") or exit("Unable to open file!");
while (!feof($file))
{
echo fgetc($file);
}
fclose($file);
33
?>
For a full reference of the PHP filesystem functions, visit our PHP Filesystem Reference.
<html>
<body>
</body>
</html>
The enctype attribute of the <form> tag specifies which content-type to use when
submitting the form. "multipart/form-data" is used when a form requires binary data,
like the contents of a file, to be uploaded
The type="file" attribute of the <input> tag specifies that the input should be processed
as a file. For example, when viewed in a browser, there will be a browse-button next to
the input field
Note: Allowing users to upload files is a big security risk. Only permit trusted users to perform
file uploads.
34
<?php
if ($_FILES["file"]["error"] > 0)
{
echo "Error: " . $_FILES["file"]["error"] . "<br />";
}
else
{
echo "Upload: " . $_FILES["file"]["name"] . "<br />";
echo "Type: " . $_FILES["file"]["type"] . "<br />";
echo "Size: " . ($_FILES["file"]["size"] / 1024) . " Kb<br />";
echo "Stored in: " . $_FILES["file"]["tmp_name"];
}
?>
By using the global PHP $_FILES array you can upload files from a client computer to the
remote server.
The first parameter is the form's input name and the second index can be either "name", "type",
"size", "tmp_name" or "error". Like this:
This is a very simple way of uploading files. For security reasons, you should add restrictions on
what the user is allowed to upload.
Restrictions on Upload
In this script we add some restrictions to the file upload. The user
may only upload .gif or .jpeg files and the file size must be under 20
kb:
<?php
if ((($_FILES["file"]["type"] == "image/gif")
|| ($_FILES["file"]["type"] == "image/jpeg")
|| ($_FILES["file"]["type"] == "image/pjpeg"))
&& ($_FILES["file"]["size"] < 20000))
{
if ($_FILES["file"]["error"] > 0)
{
echo "Error: " . $_FILES["file"]["error"] . "<br />";
}
else
{
echo "Upload: " . $_FILES["file"]["name"] . "<br />";
echo "Type: " . $_FILES["file"]["type"] . "<br />";
echo "Size: " . ($_FILES["file"]["size"] / 1024) . " Kb<br />";
echo "Stored in: " . $_FILES["file"]["tmp_name"];
}
35
}
else
{
echo "Invalid file";
}
?>
Note: For IE to recognize jpg files the type must be pjpeg, for FireFox it must be jpeg.
The examples above create a temporary copy of the uploaded files in the PHP temp folder on
the server.
<?php
if ((($_FILES["file"]["type"] == "image/gif")
|| ($_FILES["file"]["type"] == "image/jpeg")
|| ($_FILES["file"]["type"] == "image/pjpeg"))
&& ($_FILES["file"]["size"] < 20000))
{
if ($_FILES["file"]["error"] > 0)
{
echo "Return Code: " . $_FILES["file"]["error"] . "<br />";
}
else
{
echo "Upload: " . $_FILES["file"]["name"] . "<br />";
echo "Type: " . $_FILES["file"]["type"] . "<br />";
echo "Size: " . ($_FILES["file"]["size"] / 1024) . " Kb<br />";
echo "Temp file: " . $_FILES["file"]["tmp_name"] . "<br />";
if (file_exists("upload/" . $_FILES["file"]["name"]))
{
echo $_FILES["file"]["name"] . " already exists. ";
}
else
{
move_uploaded_file($_FILES["file"]["tmp_name"],
"upload/" . $_FILES["file"]["name"]);
echo "Stored in: " . "upload/" . $_FILES["file"]["name"];
}
}
}
else
{
echo "Invalid file";
}
?>
The script above checks if the file already exists, if it does not, it copies the file to the specified
folder.
Note: This example saves the file to a new folder called "upload"
36
PHP Cookies
A cookie is often used to identify a user.
What is a Cookie?
A cookie is often used to identify a user. A cookie is a small file that the server embeds on the
user's computer. Each time the same computer requests a page with a browser, it will send the
cookie too. With PHP, you can both create and retrieve cookie values.
Note: The setcookie() function must appear BEFORE the <html> tag.
Syntax
setcookie(name, value, expire, path, domain);
Example 1
<?php
setcookie("user", "Alex Porter", time()+3600);
?>
<html>
.....
Note: The value of the cookie is automatically URLencoded when sending the cookie, and
automatically decoded when received (to prevent URLencoding, use setrawcookie() instead).
Example 2
You can also set the expiration time of the cookie in another way. It
may be easier than using seconds.
<?php
$expire=time()+60*60*24*30;
setcookie("user", "Alex Porter", $expire);
?>
<html>
.....
In the example above the expiration time is set to a month (60 sec * 60 min * 24 hours * 30
days).
37
How to Retrieve a Cookie Value?
<?php
// Print a cookie
echo $_COOKIE["user"];
<html>
<body>
<?php
if (isset($_COOKIE["user"]))
echo "Welcome " . $_COOKIE["user"] . "!<br />";
else
echo "Welcome guest!<br />";
?>
</body>
</html>
When deleting a cookie you should assure that the expiration date is in the past.
Delete example:
<?php
// set the expiration date to one hour ago
setcookie("user", "", time()-3600);
?>
If your application deals with browsers that do not support cookies, you will have to use other
methods to pass information from one page to another in your application. One method is to
pass the data through forms (forms and user input are described earlier in this tutorial).
The form below passes the user input to "welcome.php" when the user clicks on the "Submit"
button:
38
<html>
<body>
</body>
</html>
<html>
<body>
</body>
</html>
PHP Sessions
A PHP session variable is used to store information about, or change settings for a
user session. Session variables hold information about one single user, and are
available to all pages in one application.
When you are working with an application, you open it, do some changes and then you close it.
This is much like a Session. The computer knows who you are. It knows when you start the
application and when you end. But on the internet there is one problem: the web server does
not know who you are and what you do because the HTTP address doesn't maintain state.
A PHP session solves this problem by allowing you to store user information on the server for
later use (i.e. username, shopping items, etc). However, session information is temporary and
will be deleted after the user has left the website. If you need a permanent storage you may
want to store the data in a database.
Sessions work by creating a unique id (UID) for each visitor and store variables based on this
UID. The UID is either stored in a cookie or is propagated in the URL.
Before you can store user information in your PHP session, you must first start up the session.
39
<?php session_start(); ?>
<html>
<body>
</body>
</html>
The code above will register the user's session with the server, allow you to start saving user
information, and assign a UID for that user's session.
The correct way to store and retrieve session variables is to use the
PHP $_SESSION variable:
<?php
session_start();
// store session data
$_SESSION['views']=1;
?>
<html>
<body>
<?php
//retrieve session data
echo "Pageviews=". $_SESSION['views'];
?>
</body>
</html>
Output:
Pageviews=1
<?php
session_start();
if(isset($_SESSION['views']))
$_SESSION['views']=$_SESSION['views']+1;
else
$_SESSION['views']=1;
echo "Views=". $_SESSION['views'];
?>
Destroying a Session
40
If you wish to delete some session data, you can use the unset() or the session_destroy()
function.
<?php
unset($_SESSION['views']);
?>
<?php
session_destroy();
?>
Note: session_destroy() will reset your session and you will lose all your stored session data.
The PHP mail() function is used to send emails from inside a script.
Syntax
mail(to,subject,message,headers,parameters)
Parameter Description
to Required. Specifies the receiver / receivers of the email
subject Required. Specifies the subject of the email. Note: This parameter cannot
contain any newline characters
message Required. Defines the message to be sent. Each line should be separated
with a LF (\n). Lines should not exceed 70 characters
headers Optional. Specifies additional headers, like From, Cc, and Bcc. The
additional headers should be separated with a CRLF (\r\n)
parameters Optional. Specifies an additional parameter to the sendmail program
Note: For the mail functions to be available, PHP requires an installed and working email
system. The program to be used is defined by the configuration settings in the php.ini file. Read
more in our PHP Mail reference.
The simplest way to send an email with PHP is to send a text email.
41
In the example below we first declare the variables ($to, $subject,
$message, $from, $headers), then we use the variables in the
mail() function to send an e-mail:
<?php
$to = "[email protected]";
$subject = "Test mail";
$message = "Hello! This is a simple email message.";
$from = "[email protected]";
$headers = "From: $from";
mail($to,$subject,$message,$headers);
echo "Mail Sent.";
?>
<html>
<body>
<?php
if (isset($_REQUEST['email']))
//if "email" is filled out, send email
{
//send email
$email = $_REQUEST['email'] ;
$subject = $_REQUEST['subject'] ;
$message = $_REQUEST['message'] ;
mail( "[email protected]", "Subject: $subject",
$message, "From: $email" );
echo "Thank you for using our mail form";
}
else
//if "email" is not filled out, display the form
{
echo "<form method='post' action='mailform.php'>
Email: <input name='email' type='text' /><br />
Subject: <input name='subject' type='text' /><br />
Message:<br />
<textarea name='message' rows='15' cols='40'>
</textarea><br />
<input type='submit' />
</form>";
}
?>
</body>
</html>
42
Note: This is the simplest way to send e-mail, but it is not secure. In the next chapter of this
tutorial you can read more about vulnerabilities in e-mail scripts, and how to validate user input
to make it more secure.
For more information about the PHP mail() function, visit our PHP Mail Reference.
<html>
<body>
<?php
if (isset($_REQUEST['email']))
//if "email" is filled out, send email
{
//send email
$email = $_REQUEST['email'] ;
$subject = $_REQUEST['subject'] ;
$message = $_REQUEST['message'] ;
mail("[email protected]", "Subject: $subject",
$message, "From: $email" );
echo "Thank you for using our mail form";
}
else
//if "email" is not filled out, display the form
{
echo "<form method='post' action='mailform.php'>
Email: <input name='email' type='text' /><br />
Subject: <input name='subject' type='text' /><br />
Message:<br />
<textarea name='message' rows='15' cols='40'>
</textarea><br />
<input type='submit' />
</form>";
}
?>
</body>
</html>
The problem with the code above is that unauthorized users can insert data into the mail
headers via the input form.
What happens if the user adds the following text to the email input
field in the form?
[email protected]%0ACc:[email protected]
%0ABcc:[email protected],[email protected],
43
[email protected],[email protected]
%0ABTo:[email protected]
The mail() function puts the text above into the mail headers as usual, and now the header has
an extra Cc:, Bcc:, and To: field. When the user clicks the submit button, the e-mail will be sent
to all of the addresses above!
The code below is the same as in the previous chapter, but now we
have added an input validator that checks the email field in the
form:
<html>
<body>
<?php
function spamcheck($field)
{
//filter_var() sanitizes the e-mail
//address using FILTER_SANITIZE_EMAIL
$field=filter_var($field, FILTER_SANITIZE_EMAIL);
if (isset($_REQUEST['email']))
{//if "email" is filled out, proceed
44
Subject: <input name='subject' type='text' /><br />
Message:<br />
<textarea name='message' rows='15' cols='40'>
</textarea><br />
<input type='submit' />
</form>";
}
?>
</body>
</html>
The FILTER_SANITIZE_EMAIL filter removes all illegal e-mail characters from a string
The FILTER_VALIDATE_EMAIL filter validates value as an e-mail address
You can read more about filters in our PHP Filter chapter.
The default error handling in PHP is very simple. An error message with filename, line
number and a message describing the error is sent to the browser.
When creating scripts and web applications, error handling is an important part. If your code
lacks error checking code, your program may look very unprofessional and you may be open to
security risks.
This tutorial contains some of the most common error checking methods in PHP.
The first example shows a simple script that opens a text file:
<?php
$file=fopen("welcome.txt","r");
?>
If the file does not exist you might get an error like this:
45
Warning: fopen(welcome.txt) [function.fopen]: failed to open stream:
No such file or directory in C:\webfolder\test.php on line 2
To avoid that the user gets an error message like the one above, we
test if the file exist before we try to access it:
<?php
if(!file_exists("welcome.txt"))
{
die("File not found");
}
else
{
$file=fopen("welcome.txt","r");
}
?>
Now if the file does not exist you get an error like this:
The code above is more efficient than the earlier code, because it uses a simple error handling
mechanism to stop the script after the error.
However, simply stopping the script is not always the right way to go. Let's take a look at
alternative PHP functions for handling errors.
Creating a custom error handler is quite simple. We simply create a special function that can be
called when an error occurs in PHP.
This function must be able to handle a minimum of two parameters (error level and error
message) but can accept up to five parameters (optionally: file, line-number, and the error
context):
Syntax
error_function(error_level,error_message,
error_file,error_line,error_context)
Parameter Description
error_level Required. Specifies the error report level for the user-defined error. Must be
a value number. See table below for possible error report levels
error_message Required. Specifies the error message for the user-defined error
error_file Optional. Specifies the filename in which the error occurred
error_line Optional. Specifies the line number in which the error occurred
error_context Optional. Specifies an array containing every variable, and their values, in
use when the error occurred
46
These error report levels are the different types of error the user-
defined error handler can be used for:
Valu
Constant Description
e
2 E_WARNING Non-fatal run-time errors. Execution of the script is not
halted
8 E_NOTICE Run-time notices. The script found something that might be
an error, but could also happen when running a script
normally
256 E_USER_ERROR Fatal user-generated error. This is like an E_ERROR set by
the programmer using the PHP function trigger_error()
512 E_USER_WARNING Non-fatal user-generated warning. This is like an
E_WARNING set by the programmer using the PHP function
trigger_error()
1024 E_USER_NOTICE User-generated notice. This is like an E_NOTICE set by the
programmer using the PHP function trigger_error()
4096 E_RECOVERABLE_ERROR Catchable fatal error. This is like an E_ERROR but can be
caught by a user defined handle (see also
set_error_handler())
8191 E_ALL All errors and warnings, except level E_STRICT (E_STRICT
will be part of E_ALL as of PHP 6.0)
The code above is a simple error handling function. When it is triggered, it gets the error level
and an error message. It then outputs the error level and message and terminates the script.
Now that we have created an error handling function we need to decide when it should be
triggered.
The default error handler for PHP is the built in error handler. We are going to make the function
above the default error handler for the duration of the script.
set_error_handler("customError");
Since we want our custom function to handle all errors, the set_error_handler() only needed
one parameter, a second parameter could be added to specify an error level.
47
Example
Testing the error handler by trying to output variable that does not
exist:
<?php
//error handler function
function customError($errno, $errstr)
{
echo "<b>Error:</b> [$errno] $errstr";
}
//trigger error
echo($test);
?>
Trigger an Error
In a script where users can input data it is useful to trigger errors when an illegal input occurs.
In PHP, this is done by the trigger_error() function.
Example
<?php
$test=2;
if ($test>1)
{
trigger_error("Value must be 1 or below");
}
?>
An error can be triggered anywhere you wish in a script, and by adding a second parameter,
you can specify what error level is triggered.
E_USER_ERROR - Fatal user-generated run-time error. Errors that can not be recovered
from. Execution of the script is halted
48
E_USER_WARNING - Non-fatal user-generated run-time warning. Execution of the
script is not halted
E_USER_NOTICE - Default. User-generated run-time notice. The script found something
that might be an error, but could also happen when running a script normally
Example
<?php
//error handler function
function customError($errno, $errstr)
{
echo "<b>Error:</b> [$errno] $errstr<br />";
echo "Ending Script";
die();
}
//trigger error
$test=2;
if ($test>1)
{
trigger_error("Value must be 1 or below",E_USER_WARNING);
}
?>
Now that we have learned to create our own errors and how to trigger them, lets take a look at
error logging.
Error Logging
By default, PHP sends an error log to the servers logging system or a file, depending on how the
error_log configuration is set in the php.ini file. By using the error_log() function you can send
error logs to a specified file or a remote destination.
Sending errors messages to yourself by e-mail can be a good way of getting notified of specific
errors.
<?php
//error handler function
49
function customError($errno, $errstr)
{
echo "<b>Error:</b> [$errno] $errstr<br />";
echo "Webmaster has been notified";
error_log("Error: [$errno] $errstr",1,
"[email protected]","From: [email protected]");
}
//trigger error
$test=2;
if ($test>1)
{
trigger_error("Value must be 1 or below",E_USER_WARNING);
}
?>
And the mail received from the code above looks like this:
This should not be used with all errors. Regular errors should be logged on the server using the
default PHP logging system.
Exceptions are used to change the normal flow of a script if a specified error occurs
What is an Exception
With PHP 5 came a new object oriented way of dealing with errors.
Exception handling is used to change the normal flow of the code execution if a specified error
(exceptional) condition occurs. This condition is called an exception.
50
Basic use of Exceptions
Creating a custom exception handler
Multiple exceptions
Re-throwing an exception
Setting a top level exception handler
Note: Exceptions should only be used with error conditions, and should not be used to jump to
another place in the code at a specified point.
When an exception is thrown, the code following it will not be executed, and PHP will try to find
the matching "catch" block.
If an exception is not caught, a fatal error will be issued with an "Uncaught Exception" message.
<?php
//create function with an exception
function checkNum($number)
{
if($number>1)
{
throw new Exception("Value must be 1 or below");
}
return true;
}
//trigger exception
checkNum(2);
?>
To avoid the error from the example above, we need to create the proper code to handle an
exception.
1. Try - A function using an exception should be in a "try" block. If the exception does not
trigger, the code will continue as normal. However if the exception triggers, an
exception is "thrown"
2. Throw - This is how you trigger an exception. Each "throw" must have at least one
"catch"
3. Catch - A "catch" block retrieves an exception and creates an object containing the
exception information
51
<?php
//create function with an exception
function checkNum($number)
{
if($number>1)
{
throw new Exception("Value must be 1 or below");
}
return true;
}
//catch exception
catch(Exception $e)
{
echo 'Message: ' .$e->getMessage();
}
?>
Example explained:
However, one way to get around the "every throw must have a catch" rule is to set a top level
exception handler to handle errors that slip through.
Creating a custom exception handler is quite simple. We simply create a special class with
functions that can be called when an exception occurs in PHP. The class must be an extension of
the exception class.
The custom exception class inherits the properties from PHP's exception class and you can add
custom functions to it.
<?php
52
class customException extends Exception
{
public function errorMessage()
{
//error message
$errorMsg = 'Error on line '.$this->getLine().' in '.$this-
>getFile()
.': <b>'.$this->getMessage().'</b> is not a valid E-Mail address';
return $errorMsg;
}
}
$email = "[email protected]";
try
{
//check if
if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE)
{
//throw exception if email is not valid
throw new customException($email);
}
}
The new class is a copy of the old exception class with an addition of the errorMessage()
function. Since it is a copy of the old class, and it inherits the properties and methods from the
old class, we can use the exception class methods like getLine() and getFile() and getMessage().
Example explained:
The code above throws an exception and catches it with a custom exception class:
1. The customException() class is created as an extension of the old exception class. This
way it inherits all methods and properties from the old exception class
2. The errorMessage() function is created. This function returns an error message if an e-
mail address is invalid
3. The $email variable is set to a string that is not a valid e-mail address
4. The "try" block is executed and an exception is thrown since the e-mail address is
invalid
5. The "catch" block catches the exception and displays the error message
Multiple Exceptions
It is possible for a script to use multiple exceptions to check for multiple conditions.
<?php
class customException extends Exception
53
{
public function errorMessage()
{
//error message
$errorMsg = 'Error on line '.$this->getLine().' in '.$this->getFile()
.': <b>'.$this->getMessage().'</b> is not a valid E-Mail address';
return $errorMsg;
}
}
$email = "[email protected]";
try
{
//check if
if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE)
{
//throw exception if email is not valid
throw new customException($email);
}
//check for "example" in mail address
if(strpos($email, "example") !== FALSE)
{
throw new Exception("$email is an example e-mail");
}
}
catch(Exception $e)
{
echo $e->getMessage();
}
?>
Example explained:
The code above tests two conditions and throws an exception if any of the conditions are not
met:
1. The customException() class is created as an extension of the old exception class. This
way it inherits all methods and properties from the old exception class
2. The errorMessage() function is created. This function returns an error message if an e-
mail address is invalid
3. The $email variable is set to a string that is a valid e-mail address, but contains the
string "example"
4. The "try" block is executed and an exception is not thrown on the first condition
5. The second condition triggers an exception since the e-mail contains the string
"example"
6. The "catch" block catches the exception and displays the correct error message
If there was no customException catch, only the base exception catch, the exception would be
handled there
Re-throwing Exceptions
Sometimes, when an exception is thrown, you may wish to handle it differently than the
standard way. It is possible to throw an exception a second time within a "catch" block.
54
A script should hide system errors from users. System errors may
be important for the coder, but is of no interest to the user. To
make things easier for the user you can re-throw the exception with
a user friendly message:
<?php
class customException extends Exception
{
public function errorMessage()
{
//error message
$errorMsg = $this->getMessage().' is not a valid E-Mail address.';
return $errorMsg;
}
}
$email = "[email protected]";
try
{
try
{
//check for "example" in mail address
if(strpos($email, "example") !== FALSE)
{
//throw exception if email is not valid
throw new Exception($email);
}
}
catch(Exception $e)
{
//re-throw exception
throw new customException($email);
}
}
Example explained:
The code above tests if the email-address contains the string "example" in it, if it does, the
exception is re-thrown:
1. The customException() class is created as an extension of the old exception class. This
way it inherits all methods and properties from the old exception class
2. The errorMessage() function is created. This function returns an error message if an e-
mail address is invalid
3. The $email variable is set to a string that is a valid e-mail address, but contains the
string "example"
4. The "try" block contains another "try" block to make it possible to re-throw the
exception
5. The exception is triggered since the e-mail contains the string "example"
6. The "catch" block catches the exception and re-throws a "customException"
7. The "customException" is caught and displays an error message
If the exception is not caught in its current "try" block, it will search for a catch block on "higher
levels".
55
Set a Top Level Exception Handler
<?php
function myException($exception)
{
echo "<b>Exception:</b> " , $exception->getMessage();
}
set_exception_handler('myException');
In the code above there was no "catch" block. Instead, the top level exception handler
triggered. This function should be used to catch uncaught exceptions.
PHP Filter
PHP filters are used to validate and filter data coming from insecure sources, like user
input.
A PHP filter is used to validate and filter data coming from insecure sources.
To test, validate and filter user input or custom data is an important part of any web application.
The PHP filter extension is designed to make data filtering easier and quicker.
56
Almost all web applications depend on external input. Usually this comes from a user or another
application (like a web service). By using filters you can be sure your application gets the
correct input type.
<?php
$int = 123;
if(!filter_var($int, FILTER_VALIDATE_INT))
{
echo("Integer is not valid");
}
else
{
echo("Integer is valid");
}
?>
The code above uses the "FILTER_VALIDATE_INT" filter to filter the variable. Since the integer
is valid, the output of the code above will be: "Integer is valid".
If we try with a variable that is not an integer (like "123abc"), the output will be: "Integer is not
valid".
For a complete list of functions and filters, visit our PHP Filter Reference.
57
Validating filters:
Sanitizing filters:
Options and flags are used to add additional filtering options to the specified filters.
In the example below, we validate an integer using the filter_var() and the "min_range" and
"max_range" options:
<?php
$var=300;
$int_options = array(
"options"=>array
(
"min_range"=>0,
"max_range"=>256
)
);
Like the code above, options must be put in an associative array with the name "options". If a
flag is used it does not need to be in an array.
Since the integer is "300" it is not in the specified range, and the output of the code above will
be: "Integer is not valid".
For a complete list of functions and filters, visit our PHP Filter Reference. Check each filter to see
what options and flags are available.
Validate Input
58
Let's try validating input from a form.
The first thing we need to do is to confirm that the input data we are looking for exists.
In the example below, the input variable "email" is sent to the PHP page:
<?php
if(!filter_has_var(INPUT_GET, "email"))
{
echo("Input type does not exist");
}
else
{
if (!filter_input(INPUT_GET, "email", FILTER_VALIDATE_EMAIL))
{
echo "E-Mail is not valid";
}
else
{
echo "E-Mail is valid";
}
}
?>
Example Explained
The example above has an input (email) sent to it using the "GET" method:
Sanitize Input
First we confirm that the input data we are looking for exists.
59
In the example below, the input variable "url" is sent to the PHP
page:
<?php
if(!filter_has_var(INPUT_POST, "url"))
{
echo("Input type does not exist");
}
else
{
$url = filter_input(INPUT_POST,
"url", FILTER_SANITIZE_URL);
}
?>
Example Explained
The example above has an input (url) sent to it using the "POST" method:
http://www.W3Schools.com/
A form almost always consist of more than one input field. To avoid calling the filter_var or
filter_input functions over and over, we can use the filter_var_array or the filter_input_array
functions.
<?php
$filters = array
(
"name" => array
(
"filter"=>FILTER_SANITIZE_STRING
),
"age" => array
(
"filter"=>FILTER_VALIDATE_INT,
"options"=>array
(
"min_range"=>1,
"max_range"=>120
)
),
"email"=> FILTER_VALIDATE_EMAIL,
60
);
if (!$result["age"])
{
echo("Age must be a number between 1 and 120.<br />");
}
elseif(!$result["email"])
{
echo("E-Mail is not valid.<br />");
}
else
{
echo("User input is valid");
}
?>
Example Explained
The example above has three inputs (name, age and email) sent to it using the "GET" method:
1. Set an array containing the name of input variables and the filters used on the specified
input variables
2. Call the filter_input_array() function with the GET input variables and the array we just
set
3. Check the "age" and "email" variables in the $result variable for invalid inputs. (If any
of the input variables are invalid, that input variable will be FALSE after the
filter_input_array() function)
The second parameter of the filter_input_array() function can be an array or a single filter ID.
If the parameter is a single filter ID all values in the input array are filtered by the specified
filter.
Must be an associative array containing an input variable as an array key (like the "age"
input variable)
The array value must be a filter ID or an array specifying the filter, flags and options
It is possible to call a user defined function and use it as a filter using the FILTER_CALLBACK
filter. This way, we have full control of the data filtering.
You can create your own user defined function or use an existing PHP function
The function you wish to use to filter is specified the same way as an option is specified. In an
associative array with the name "options"
<?php
function convertSpace($string)
{
return str_replace("_", " ", $string);
61
}
$string = "Peter_is_a_great_guy!";
The result from the code above should look like this:
Example Explained
What is MySQL?
MySQL is a database.
A table is a collections of related data entries and it consists of columns and rows.
Databases are useful when storing information categorically. A company may have a database
with the following tables: "Employees", "Products", "Customers" and "Orders".
Database Tables
A database most often contains one or more tables. Each table is identified by a name (e.g.
"Customers" or "Orders"). Tables contain records (rows) with data.
62
The table above contains three records (one for each person) and four columns (LastName,
FirstName, Address, and City).
Queries
With MySQL, we can query a database for specific information and have a recordset returned.
The query above selects all the data in the "LastName" column from the "Persons" table, and
will return a recordset like this:
LastName
Hansen
Svendson
Pettersen
If you don't have a PHP server with a MySQL Database, you can download MySQL for free here:
http://www.mysql.com/downloads/index.html
One great thing about MySQL is that it can be scaled down to support embedded database
applications. Perhaps it is because of this reputation that many people believe that MySQL can
only handle small to medium-sized systems.
The truth is that MySQL is the de-facto standard database for web sites that support huge
volumes of both data and end users (like Friendster, Yahoo, Google).
63
Before you can access data in a database, you must create a connection to the database.
Syntax
mysql_connect(servername,username,password);
Parameter Description
servername Optional. Specifies the server to connect to. Default value is
"localhost:3306"
username Optional. Specifies the username to log in with. Default value is the name
of the user that owns the server process
password Optional. Specifies the password to log in with. Default is ""
Note: There are more available parameters, but the ones listed above are the most important.
Visit our full PHP MySQL Reference for more details.
Example
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
// some code
?>
Closing a Connection
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
// some code
mysql_close($con);
?>
64
PHP MySQL Create Database and Tables
Create a Database
Syntax
CREATE DATABASE database_name
To get PHP to execute the statement above we must use the mysql_query() function. This
function is used to send a query or command to a MySQL connection.
Example
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_close($con);
?>
Create a Table
Syntax
CREATE TABLE table_name
(
column_name1 data_type,
column_name2 data_type,
column_name3 data_type,
....
)
65
We must add the CREATE TABLE statement to the mysql_query() function to execute the
command.
Example
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
// Create database
if (mysql_query("CREATE DATABASE my_db",$con))
{
echo "Database created";
}
else
{
echo "Error creating database: " . mysql_error();
}
// Create table
mysql_select_db("my_db", $con);
$sql = "CREATE TABLE Persons
(
FirstName varchar(15),
LastName varchar(15),
Age int
)";
// Execute query
mysql_query($sql,$con);
mysql_close($con);
?>
Important: A database must be selected before a table can be created. The database is
selected with the mysql_select_db() function.
Note: When you create a database field of type varchar, you must specify the maximum length
of the field, e.g. varchar(15).
The data type specifies what type of data the column can hold. For a complete reference of all
the data types available in MySQL, go to our complete Data Types reference.
A primary key is used to uniquely identify the rows in a table. Each primary key value must be
unique within the table. Furthermore, the primary key field cannot be null because the database
engine requires a value to locate the record.
The following example sets the personID field as the primary key field. The primary key field is
often an ID number, and is often used with the AUTO_INCREMENT setting. AUTO_INCREMENT
66
automatically increases the value of the field by 1 each time a new record is added. To ensure
that the primary key field cannot be null, we must add the NOT NULL setting to the field.
Example
$sql = "CREATE TABLE Persons
(
personID int NOT NULL AUTO_INCREMENT,
PRIMARY KEY(personID),
FirstName varchar(15),
LastName varchar(15),
Age int
)";
mysql_query($sql,$con);
The INSERT INTO statement is used to add new records to a database table.
Syntax
The first form doesn't specify the column names where the data will
be inserted, only their values:
The second form specifies both the column names and the values to
be inserted:
To get PHP to execute the statements above we must use the mysql_query() function. This
function is used to send a query or command to a MySQL connection.
Example
67
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_select_db("my_db", $con);
mysql_close($con);
?>
Now we will create an HTML form that can be used to add new records to the "Persons" table.
<html>
<body>
</body>
</html>
When a user clicks the submit button in the HTML form in the example above, the form data is
sent to "insert.php".
The "insert.php" file connects to a database, and retrieves the values from the form with the
PHP $_POST variables.
Then, the mysql_query() function executes the INSERT INTO statement, and a new record will
be added to the "Persons" table.
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_select_db("my_db", $con);
68
VALUES
('$_POST[firstname]','$_POST[lastname]','$_POST[age]')";
if (!mysql_query($sql,$con))
{
die('Error: ' . mysql_error());
}
echo "1 record added";
mysql_close($con)
?>
Syntax
SELECT column_name(s)
FROM table_name
To get PHP to execute the statement above we must use the mysql_query() function. This
function is used to send a query or command to a MySQL connection.
Example
The following example selects all the data stored in the "Persons"
table (The * character selects all the data in the table):
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_select_db("my_db", $con);
while($row = mysql_fetch_array($result))
{
echo $row['FirstName'] . " " . $row['LastName'];
echo "<br />";
}
mysql_close($con);
69
?>
The example above stores the data returned by the mysql_query() function in the $result
variable.
Next, we use the mysql_fetch_array() function to return the first row from the recordset as an
array. Each call to mysql_fetch_array() returns the next row in the recordset. The while loop
loops through all the records in the recordset. To print the value of each row, we use the PHP
$row variable ($row['FirstName'] and $row['LastName']).
Peter Griffin
Glenn Quagmire
The following example selects the same data as the example above,
but will display the data in an HTML table:
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_select_db("my_db", $con);
while($row = mysql_fetch_array($result))
{
echo "<tr>";
echo "<td>" . $row['FirstName'] . "</td>";
echo "<td>" . $row['LastName'] . "</td>";
echo "</tr>";
}
echo "</table>";
mysql_close($con);
?>
Firstname Lastname
Glenn Quagmire
Peter Griffin
70
PHP MySQL The Where Clause
The WHERE clause is used to extract only those records that fulfill a specified criterion.
Syntax
SELECT column_name(s)
FROM table_name
WHERE column_name operator value
To get PHP to execute the statement above we must use the mysql_query() function. This
function is used to send a query or command to a MySQL connection.
Example
The following example selects all rows from the "Persons" table
where "FirstName='Peter':
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_select_db("my_db", $con);
while($row = mysql_fetch_array($result))
{
echo $row['FirstName'] . " " . $row['LastName'];
echo "<br />";
}
?>
71
Peter Griffin
If you want to sort the records in a descending order, you can use the DESC keyword.
Syntax
SELECT column_name(s)
FROM table_name
ORDER BY column_name(s) ASC|DESC
Example
The following example selects all the data stored in the "Persons"
table, and sorts the result by the "Age" column:
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_select_db("my_db", $con);
while($row = mysql_fetch_array($result))
{
echo $row['FirstName'];
echo " " . $row['LastName'];
echo " " . $row['Age'];
echo "<br />";
}
mysql_close($con);
?>
72
The output of the code above will be:
Glenn Quagmire 33
Peter Griffin 35
SELECT column_name(s)
FROM table_name
ORDER BY column1, column2
Syntax
UPDATE table_name
SET column1=value, column2=value2,...
WHERE some_column=some_value
Note: Notice the WHERE clause in the UPDATE syntax. The WHERE clause specifies which
record or records that should be updated. If you omit the WHERE clause, all records will be
updated!
To get PHP to execute the statement above we must use the mysql_query() function. This
function is used to send a query or command to a MySQL connection.
Example
73
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_select_db("my_db", $con);
mysql_close($con);
?>
After the update, the "Persons" table will look like this:
The DELETE FROM statement is used to delete records from a database table.
Syntax
DELETE FROM table_name
WHERE some_column = some_value
Note: Notice the WHERE clause in the DELETE syntax. The WHERE clause specifies which record
or records that should be deleted. If you omit the WHERE clause, all records will be deleted!
To get PHP to execute the statement above we must use the mysql_query() function. This
function is used to send a query or command to a MySQL connection.
Example
74
FirstName LastName Age
Peter Griffin 35
Glenn Quagmire 33
The following example deletes all the records in the "Persons" table
where LastName='Griffin':
<?php
$con = mysql_connect("localhost","peter","abc123");
if (!$con)
{
die('Could not connect: ' . mysql_error());
}
mysql_select_db("my_db", $con);
mysql_close($con);
?>
With an ODBC connection, you can connect to any database, on any computer in your network,
as long as an ODBC connection is available.
75
Note that this configuration has to be done on the computer where your web site is located. If
you are running Internet Information Server (IIS) on your own computer, the instructions above
will work, but if your web site is located on a remote server, you have to have physical access to
that server, or ask your web host to to set up a DSN for you to use.
Connecting to an ODBC
The odbc_connect() function is used to connect to an ODBC data source. The function takes four
parameters: the data source name, username, password, and an optional cursor type.
Example
$conn=odbc_connect('northwind','','');
$sql="SELECT * FROM customers";
$rs=odbc_exec($conn,$sql);
Retrieving Records
The odbc_fetch_row() function is used to return records from the result-set. This function
returns true if it is able to return rows, otherwise false.
The function takes two parameters: the ODBC result identifier and
an optional row number:
odbc_fetch_row($rs)
The odbc_result() function is used to read fields from a record. This function takes two
parameters: the ODBC result identifier and a field number or name.
The code line below returns the value of the first field from the
record:
$compname=odbc_result($rs,1);
$compname=odbc_result($rs,"CompanyName");
76
The odbc_close() function is used to close an ODBC connection.
odbc_close($conn);
An ODBC Example
<html>
<body>
<?php
$conn=odbc_connect('northwind','','');
if (!$conn)
{exit("Connection Failed: " . $conn);}
$sql="SELECT * FROM customers";
$rs=odbc_exec($conn,$sql);
if (!$rs)
{exit("Error in SQL");}
echo "<table><tr>";
echo "<th>Companyname</th>";
echo "<th>Contactname</th></tr>";
while (odbc_fetch_row($rs))
{
$compname=odbc_result($rs,"CompanyName");
$conname=odbc_result($rs,"ContactName");
echo "<tr><td>$compname</td>";
echo "<td>$conname</td></tr>";
}
odbc_close($conn);
echo "</table>";
?>
</body>
</html>
77