Joomla! Documentation - User contributions [en]

J1.5:Creating a simple module

2009-10-08T06:25:03Z

Ch00seLife: Corrected the comment that marks the end of the ModHelloWorld2Helper class

{{review}}
== Basic Hello World Module ==

A Joomla! 1.5 Module is in its most basic form two files: an XML configuration file and a PHP controller file. The XML configuration file contains general information about the module (as will be displayed in the Module Manager in the Joomla! administration interface), as well as module parameters which may be supplied to fine tune the appearance / functionality of the module. The PHP file provides the controlling logic for the module. A very simple "Hello World" module might looking something like this.

'''/modules/mod_hello_world/mod_hello_world.xml:'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a basic "Hello World" notice</description>


<files>

<filename module="mod_hello_world">mod_hello_world.php</filename>
<filename>index.html</filename>
</files>


<params />
</install>
</source>

Basically, this XML file just lines out basic information about the module such as the owner, version, etc. for identification by the Joomla! installer and then provides optional parameters which may be set in the Module Manager and accessed from within the module's logic to fine tune its behavior. Additionally, this file tells the installer which files should be copied and installed. Notice that we DO NOT include a reference in the files section for the XML file.

'''/modules/mod_hello_world/mod_hello_world.php:'''

<source lang="php">
<?php
//don't allow other scripts to grab and execute our file
defined('_JEXEC') or die('Direct Access to this location is not allowed.');
?>

Hello World

</source>

What happens when this module is loaded is that Joomla! includes (via the PHP include directive) the mod_hello_world.php file and stores the output into an output buffer which is then rendered onto the page output. This file would simply produce Hello World to the final page.

'''/modules/mod_hello_world/index.html:'''

<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

This really just helps to ensure that a default page is displayed if direct access to the directory is attempted without listing all of the other files in the directory. It's not necessary, but is good practice.

To package this module for distribution and installation, simply zip the files together, e.g.,

<source lang="text">
% cd mod_hello_world
% zip mod_hello_world.zip mod_hello_world.php mod_hello_world.xml index.html
</source>

The resulting mod_hello_world.zip file may be uploaded and installed through the standard Joomla! 1.5 Extension Manager.

== Real Joomla! 1.5 Style Module Implementation ==

Now that was easy...too easy. In fact, that was pretty much the simplest form of a module possible. In reality a module will probably be doing something much more substantial. Let's assume that our modules are going to be more complex - we need to take advantage of the MVC (Model View Controller) design pattern and consider using the following file layout for a "Hello World 2" module instead:

<source lang="text">
/modules/mod_hello_world2/index.html
/modules/mod_hello_world2/mod_hello_world2.php
/modules/mod_hello_world2/mod_hello_world2.xml
/modules/mod_hello_world2/helper.php
/modules/mod_hello_world2/en-GB.mod_hello_world2.ini
/modules/mod_hello_world2/tmpl/index.html
/modules/mod_hello_world2/tmpl/default.php
</source>

The differences to note here are that there are three additional files beyond what the "Hello World" module had, namely helper.php, tmpl/default.php, and the en-GB.mod_hello_world2.ini file. The purpose in adding the first two files is two-fold. Firstly, we separate the module's logic into the helper.php file to ensure that all of the thinking and data access is performed here and separate out the module's presentation / template into the tmpl/default.php file (the (X)HTML). I argue that this is just good programming - separating logic from presentation. There is a second advantage to this, however, which is that it will allow the HTML / presentation to be overridden easily by any Joomla! 1.5 template for optimal integration into any site. (Overriding module and component presentation in templates is beyond the scope of this article, however it should be addressed as it's really useful).

Let's take a look at what these files might look like and discuss what's going on.

'''/modules/mod_hello_world2/mod_hello_world2.php:'''

<source lang="php">
<?php
//no direct access
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

// include the helper file
require_once(dirname(__FILE__).DS.'helper.php');

// get a parameter from the module's configuration
$userCount = $params->get('usercount');

// get the items to display from the helper
$items = ModHelloWorld2Helper::getItems($userCount);

// include the template for display
require(JModuleHelper::getLayoutPath('mod_hello_world2'));
</source>

The important differences to note are that (1) we include a helper file which will be the work-horse of our logic and data access and (2) once we have our data, we just load a template which will use our data and render it as it sees fit.

'''/modules/mod_hello_world2/mod_hello_world2.xml'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World 2 - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a random listing of registered users</description>


<files>

<filename module="mod_hello_world2">mod_hello_world2.php</filename>
<filename>index.html</filename>
<filename>helper.php</filename>
<filename>tmpl/default.php</filename>
<filename>tmpl/index.html</filename>
</files>

<languages>

<language tag="en-GB">en-GB.mod_hello_world2.ini</language>
</languages>


<params>

<param name="moduleclass_sfx" type="text" default="" label="Module Class Suffix" description="PARAMMODULECLASSSUFFIX" />


<param name="@spacer" type="spacer" default="" label="" description="" />


<param name="usercount" type="text" default="5" label="LABEL USER COUNT" description="DESC USER COUNT" />
</params>
</install>
</source>

The main differences to note here are that we have added a language file reference (we could have added more) and we added some parameters.

'''/modules/mod_hello_world2/helper.php:'''

<source lang="php">
<?php
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

class ModHelloWorld2Helper
{
/**
* Returns a list of post items
*/
public function getItems($userCount)
{
// get a reference to the database
$db = &JFactory::getDBO();

// get a list of $userCount randomly ordered users
$query = 'SELECT a.name FROM `#__users` AS a ORDER BY rand() LIMIT ' . $userCount . '';

$db->setQuery($query);
$items = ($items = $db->loadObjectList())?$items:array();

return $items;
} //end getItems

} //end ModHelloWorld2Helper
</source>

This helper class (note that it is named for the module name so that it doesn't collide with other class names) simply retrieves a list of all users in the database and randomly selects a subset of those based upon the number supplied as $userCount.

'''/modules/mod_hello_world2/tmpl/default.php:'''

<source lang="php">
<?php defined('_JEXEC') or die('Restricted access'); // no direct access ?>
<?php echo JText::_('RANDOM USERS'); ?>
<ul>
<?php foreach ($items as $item) { ?>
<li>
<?php echo JText::sprintf('USER LABEL', $item->name); ?>
</li>
<?php } ?>
</ul>
</source>

Here we simply create an unordered HTML list and then iterate through the items returned by our helper (in mod_hello_world2.php), printing out a message with each user's name.

'''/modules/mod_hello_world2/en-GB.mod_hello_world2.ini:'''

<source lang="text">
LABEL USER COUNT=User Count
DESC USER COUNT=The number of users to display
RANDOM USERS=Random Users for Hello World2
USER LABEL=%s is a randomly selected user
</source>

Here we simply identify strings which appear in the module configuration file and the module template which appear in JText::_ or JText::sprintf statements. This allows someone to easily write a new language file without editing any of the HTML or code for the module.

Now all we have to do is zip up these files, as in:

<source lang="text">
% pwd
/somesite/modules/mod_hello_world2
% zip -r ../mod_hello_world2.zip *
% ls ..
mod_hello_world2.zip
</source>

The resulting mod_hello_world2.zip file is ready for installation and distribution. When the ZIP file is installed, the en-GB.mod_hello_world2.ini file is copied to /language/en-GB/en-GB.mod_hello_world2.ini and is loaded each time the module is loaded. All of the other files are copied to the /modules/mod_hello_world2 subfolder of the Joomla! installation.
<noinclude>[[Category:Development]]</noinclude>

Talk:Inserting a link to another Article or content page into an Article

2009-07-20T06:45:57Z

Ch00seLife:

Hi I believe the best way to link an Article to another article on the same Joomla website should be just giving it Article ID through the index.php like this:

/index.php?option=com_content&view=article&id=50&Itemid=61

You can always can get to know the Article ID

Regards,

Javier

If you turn on Search Engine Friendly URLs (SEF) in the global settings, you can use the alias names in your links.
Note: test this in your staging/development environment first in case your installation doesn't work well with SEF.
-- Added by Ch00seLife on 2009-07-19 at 23:46 Pacific Daylight Time

Talk:Inserting a link to another Article or content page into an Article

2009-07-20T06:44:07Z

Ch00seLife:

{{inuse}}
Hi I believe the best way to link an Article to another article on the same Joomla website should be just giving it Article ID through the index.php like this:

/index.php?option=com_content&view=article&id=50&Itemid=61

You can always can get to know the Article ID

Regards,

Javier

I think that there should be an easy way to do this using aliases. Does anyone else agree?
-- Added by Ch00seLife on 2009-07-19 at 23:09 Pacific Daylight Time

Talk:Inserting a link to another Article or content page into an Article

2009-07-20T06:09:21Z

Ch00seLife:

Hi I believe the best way to link an Article to another article on the same Joomla website should be just giving it Article ID through the index.php like this:

/index.php?option=com_content&view=article&id=50&Itemid=61

You can always can get to know the Article ID

Regards,

Javier

I think that there should be an easy way to do this using aliases. Does anyone else agree?
-- Added by Ch00seLife on 2009-07-19 at 23:09 Pacific Daylight Time

PHP essentials

2009-05-12T07:56:09Z

Ch00seLife: /* Defining array Structures */

{{review}}
===PHP essentials===
----
Many web designers and casual website owners are not conversant with the
PHP language in which Joomla! is written and since Joomla! templates
usually contain PHP statements it is necessary to understand at least a
little of the language in order to be able to create or customize
templates. This chunk will describe, in simple terms, how to use each aspect of PHP in the
context of a Joomla! template. For example, a simple explanation of the PHP
if-then-else syntax using extracts from a template for illustration.

The best resource to learn PHP is probably hands on experience and Joomla can provide that to you thanks to it's native PHP code. This can be overwhelming for people who have not programmed before. Though Joomla is easy enough to [[Installation|install]] with the help of the community and a little of your time you'll have people asking you to do their websites.

One place that has a nice short list if functions and examples is http://en.wikiversity.org/wiki/25_Essential_PHP_Functions which is good to get familiar with PHP. Though for an extensive function list, explanations, and examples go to http://www.php.net.

Once you have the basics of PHP you'll need to get the basics of the Joomla PHP syntax. Start by looking at some existing {{jsite|ext|extensions}} and check out the code and also take a look at some these Tutorials about Joomla:

[http://developer.joomla.org/tutorials/184-how-to-create-a-joomla-plugin.html How to create a Joomla! Plugin]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_1 Developing a Model-View-Controller Component - Part 1]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_2_-_Adding_a_Model Developing a Model-View-Controller Component - Part 2 - Adding a Model]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_3_-_Using_the_Database Developing a Model-View-Controller Component - Part 3 - Using the Database]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_4_-_Creating_an_Administrator_Interface Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface]

That will help you get familiar with some of the functions available within Joomla's system and what they do (using the API). Take particular care to understand the MVC (model view control) setup.

If however, you are absolutely new to PHP, following may help as very brief introduction to PHP.

==== PHP Introduction ====
PHP is a scripting language and is designed primarily for producing dynamic web pages. It is in general embedded into a HTML page with tags like <?php ... ?>. When such a page is passed on to the PHP engine, the engine translates the PHP tags into HTML and which can then be rendered by a browser. Further during translation the script may require to pull data from a database and thus a database is needed. So for creating PHP pages we require in general, the PHP engine, a database typically MySQL and finally the webserver which will co-ordinate these actions and forward the final HTML to the browser. These 3 components can be installed separately, however, for convenience we have packages like WAMP for windows, MAMP for mac and LAMP for Linux. Installing the packages is discussed next.

==== PHP Installation ====
The packages can be downloaded from [http://www.wampserver.com/en/download.php WAMP]. WAMP stands for Windows Apache MySQL PHP. The instructions can be followed as given in the site and is pretty straightforward. The installation can be done is any directory (say D:/wamp). Once installed, it can be started from the program->start->WampServer. This should give a small icon in the system tray using which the server can be started/stopped/restarted. It also gives links to all important files like php.ini and other configuration files. For Mac users MAMP can be found [http://www.macupdate.com/info.php/id/16197 here]. For the purpose of this tutorial [http://www.apachefriends.org/en/xampp.html XAMPP] can also be used.

==== PHP Round trip ====
Our primary target here is to write a small PHP page and get it rendered by the Apache web server. To render a page WAMP by default looks into the www folder of the WAMP install directory referred henceforth as WAMP_HOME for convenience. Fire up your primary text editor and create a page say first.php and save it in the WAMP_HOME/www/x/y folder, where x, y are folders (which you can create for organizing your scripts). Write the following in the script

<source lang="php">
<html>
<head>
<title>Basic PHP Page</title>
</head>
<body>
<?php
echo ("My first php snippet");
?>
</body>
</html>
</source>

Save this file and point your browser to http://localhost/x/y/first.php and you should be able to see the echo message.

Primary things to note here are <pre>
1. It is strongly advised to start any PHP code by "<?php" and end with a "?>" tag.
2. To have a semicolon after each PHP statement.
3. The directory in which this script resides needs to be given in the URL.
</pre>

This completes our round trip. Now for the sake of learning either you can keep including new elements in this file or may create separate scripts and load them in the browser.

==== PHP Variable declaration and Data types ====
For any programming we need to hold data. In PHP following are the ways in which you can define variables.
<ol>
<li>$variable_name = 0; </li>
Note here we did not define what is the type of variable, whether integer or string that the variable should hold. This is referred to as dynamic scoping.
<li> the variable names should start with an alphabet and can contain alphanumeric characters and "_"
<li> Defining constants - <source lang="php"> define ("NAME_OF_THE_CONSTANT" , $value); </source> </li>
</ol>

==== Basic operators ====
The general operators are as below and explained.
<pre>
a. + e.g. 6 + 3, addition operator, answer is 9
b. – e.g. 6 - 3, subtraction operator, answer is 3
c. / e.g. 6 / 3, division operator, answer is 2
d. * e.g. 6 * 3, multiplication operator, answer is 18
e. % e.g. 6 % 3, modulus operator, answer is 0
f. . e.g. '6'.'3', concatenation operator, gives string '63'
g. += e.g. $x += 6, adds 6
h. -= e.g. $x -= 6, subtracts 6
i. /= e.g. $x /= 6, divides by 6
j. %= e.g. $x %= 6, modulus by 6
k. .= e.g. $x .= '6', concats 6 to x
l. < e.g. $x < $y, evaluates to true if $x is < $y
m. > e.g. $x > $y, evaluates to true if $x is > $y
n. == e.g. $x == $y, evaluates to true if $x is equal by value to $y
o. != e.g. $x != $y, evaluates to true if $x is not equal to $y
p. === e.g. $x === $y, evaluates to true if $x is and $y is identical i.e both of same type both value and reference
q. >= e.g. $x >= $y, evaluates to true if $x is >= $y
r. <= e.g. $x <= $y, evaluates to true if $x is <= $y
s. && e.g. ($x == 2 && $y == 3) , evaluates to true if $x equals 2 and $y equals 3
t. || e.g. ($x == 2 || $y == 3) , evaluates to true if either $x equals 2 or $y equals 3
u. xor e.g. ($x == 2 xor $y == 3) , evaluates to true if either $x equals 2 or $y equals 3 but not both
v. ++ e.g. $x++, increments $x
w. –- e.g. $x--, decrements $x
</pre>

==== Defining array Structures ====
'''Ways of declaring arrays'''
 Suppose we want many variables, we could have done in the way declaring variables as above, however, that is not elegant, for suppose u want a 100 variables; declaring arrays come to the rescue. Note that index in PHP starts from 0.
<pre>
$my_guitar_heroes = array ("Hendrix", "Schenker", "Gilmour", "to_name_a_few!");
</pre>
Or
<pre>
$my_guitar_heroes [] = "Hendrix";
$my_guitar_heroes [] = "Schenker";
$my_guitar_heroes [] = "Gilmour";
$my_guitar_heroes [] = "to_name_a_few!";
</pre>
Here PHP automatically assigns the index.

Or
<pre>
$my_guitar_heroes [0] = "Hendrix";
$my_guitar_heroes [10000] = "Mainak";
</pre>
Here in I just knew the first element and the 10,001st element and that's me!

Or
a combination of the above means

Or
<pre>
// Set the elements at positions 1 through 9999 to the value, "to be decided".
$my_guitar_heroes = array_fill( 1, 9999, "to be decided" );
</pre>

'''Accessing the arrays'''
<pre>
print $my_guitar_heroes[2]; //Access the 2nd element
</pre>
Or
<pre>
// Access the last element (Note that the element positions are numbered zero to
// [number of elements] minus one.)
$my_guitar_heroes[count($my_guitar_heroes)-1];
</pre>
Or
<pre>
// Access the last element using a function call.
end($my_guitar_heroes);
</pre>

'''Iterating over the element of an array'''
<pre>
foreach ( $my_guitar_heroes as $temp) {
print "$temp ";
}
</pre>

==== Control expressions ====
To execute a statement of collection of statements over and over, we use Control expressions. The following are general syntax of the control structures

'''if statements''' 
<source lang="php">
if( $x > 0) {
print("$x is positive");
} else if( $x < 0 ) {
print("$x is negative");
} else {
print("$x is 0");
}
</source>

'''for loop''' 
<source lang="php">
for ( $x=1; $x<= 10; $x++ ) {
print "$x ";
}
</source>

'''while loop''' 
<source lang="php">
$x = 1
while ( $x <= 10 ) {
print "$x ";
}
</source>

'''do while loop''' 
<source lang="php">
$x = 1;
do {
print "$x ";
$x++;
}while($x <= 10);
</source>

==== Defining functions ====
Code which is duplicated at many places are best placed in a function. Following are the ways of describing the function.
<source lang="php">
function name_of_the_function( $arguments, $size='default_values_if_any' ) {
print "here goes in the code";
return "this value is returned, return statement is optional";
}
</source>
The arguments are passed by value. If they are to be passed by reference then an argument is prefixed by "&" as below
<source lang="php">
function name_of_the_function( &$arguments, $size='default_values_if_any' ) {
print "here goes in the code";
return "this value is returned, return statement is optional";
}
</source>
Scope of a variables defined within a function is valid within the function only.

Calling a function
<source lang="php">$x = add(5, 3);</source>

==== Debugging ====
'''Basic printing options''' 
A basic way to debug is to print the value of the variable. The following basic statments acheives that

<ul>
<li>echo "if double quotes are used then dollar variables are resolved";
<li>echo 'if single quote are used then dollar variables are not resolved';
<li>print "another way to print";
<li>nl2br("any new line characters like \n get automatically resolved to HTML line breaks");
</ul>

Apart from these the log files are very helpful and can be found in the WAMP_HOME/logs directory.

==== Handling forms ====
PHP does not change any HTML structure, thus any syntax of HTML remains the same. The part that PHP plays is making any part dynamic for e.g the action attribute of a form can be coded as action=<?php my_own_action(); ?> so that it is dynamically generated. The part where PHP kicks in is after the form is submitted, to say obtain the values of the form fields, set cookies etc. For this super global variables are used which are always available to PHP code. Some of these are
<ol>
<li>$_GET - get the data from a GET request</li>
<li>$_POST - get the data from a POST request</li>
<li>$_REQUEST - get the request</li>
<li>$_COOKIE - obtain the cookies from the browser</li>
<li>$_SESSION - obtain the session</li>
</ol>

All of these are arrays and behave accordingly.

----
[[Category:Templates]]

PHP essentials

2009-05-12T07:54:09Z

Ch00seLife: /* Defining array Structures */

{{review}}
===PHP essentials===
----
Many web designers and casual website owners are not conversant with the
PHP language in which Joomla! is written and since Joomla! templates
usually contain PHP statements it is necessary to understand at least a
little of the language in order to be able to create or customize
templates. This chunk will describe, in simple terms, how to use each aspect of PHP in the
context of a Joomla! template. For example, a simple explanation of the PHP
if-then-else syntax using extracts from a template for illustration.

The best resource to learn PHP is probably hands on experience and Joomla can provide that to you thanks to it's native PHP code. This can be overwhelming for people who have not programmed before. Though Joomla is easy enough to [[Installation|install]] with the help of the community and a little of your time you'll have people asking you to do their websites.

One place that has a nice short list if functions and examples is http://en.wikiversity.org/wiki/25_Essential_PHP_Functions which is good to get familiar with PHP. Though for an extensive function list, explanations, and examples go to http://www.php.net.

Once you have the basics of PHP you'll need to get the basics of the Joomla PHP syntax. Start by looking at some existing {{jsite|ext|extensions}} and check out the code and also take a look at some these Tutorials about Joomla:

[http://developer.joomla.org/tutorials/184-how-to-create-a-joomla-plugin.html How to create a Joomla! Plugin]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_1 Developing a Model-View-Controller Component - Part 1]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_2_-_Adding_a_Model Developing a Model-View-Controller Component - Part 2 - Adding a Model]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_3_-_Using_the_Database Developing a Model-View-Controller Component - Part 3 - Using the Database]

[http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_4_-_Creating_an_Administrator_Interface Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface]

That will help you get familiar with some of the functions available within Joomla's system and what they do (using the API). Take particular care to understand the MVC (model view control) setup.

If however, you are absolutely new to PHP, following may help as very brief introduction to PHP.

==== PHP Introduction ====
PHP is a scripting language and is designed primarily for producing dynamic web pages. It is in general embedded into a HTML page with tags like <?php ... ?>. When such a page is passed on to the PHP engine, the engine translates the PHP tags into HTML and which can then be rendered by a browser. Further during translation the script may require to pull data from a database and thus a database is needed. So for creating PHP pages we require in general, the PHP engine, a database typically MySQL and finally the webserver which will co-ordinate these actions and forward the final HTML to the browser. These 3 components can be installed separately, however, for convenience we have packages like WAMP for windows, MAMP for mac and LAMP for Linux. Installing the packages is discussed next.

==== PHP Installation ====
The packages can be downloaded from [http://www.wampserver.com/en/download.php WAMP]. WAMP stands for Windows Apache MySQL PHP. The instructions can be followed as given in the site and is pretty straightforward. The installation can be done is any directory (say D:/wamp). Once installed, it can be started from the program->start->WampServer. This should give a small icon in the system tray using which the server can be started/stopped/restarted. It also gives links to all important files like php.ini and other configuration files. For Mac users MAMP can be found [http://www.macupdate.com/info.php/id/16197 here]. For the purpose of this tutorial [http://www.apachefriends.org/en/xampp.html XAMPP] can also be used.

==== PHP Round trip ====
Our primary target here is to write a small PHP page and get it rendered by the Apache web server. To render a page WAMP by default looks into the www folder of the WAMP install directory referred henceforth as WAMP_HOME for convenience. Fire up your primary text editor and create a page say first.php and save it in the WAMP_HOME/www/x/y folder, where x, y are folders (which you can create for organizing your scripts). Write the following in the script

<source lang="php">
<html>
<head>
<title>Basic PHP Page</title>
</head>
<body>
<?php
echo ("My first php snippet");
?>
</body>
</html>
</source>

Save this file and point your browser to http://localhost/x/y/first.php and you should be able to see the echo message.

Primary things to note here are <pre>
1. It is strongly advised to start any PHP code by "<?php" and end with a "?>" tag.
2. To have a semicolon after each PHP statement.
3. The directory in which this script resides needs to be given in the URL.
</pre>

This completes our round trip. Now for the sake of learning either you can keep including new elements in this file or may create separate scripts and load them in the browser.

==== PHP Variable declaration and Data types ====
For any programming we need to hold data. In PHP following are the ways in which you can define variables.
<ol>
<li>$variable_name = 0; </li>
Note here we did not define what is the type of variable, whether integer or string that the variable should hold. This is referred to as dynamic scoping.
<li> the variable names should start with an alphabet and can contain alphanumeric characters and "_"
<li> Defining constants - <source lang="php"> define ("NAME_OF_THE_CONSTANT" , $value); </source> </li>
</ol>

==== Basic operators ====
The general operators are as below and explained.
<pre>
a. + e.g. 6 + 3, addition operator, answer is 9
b. – e.g. 6 - 3, subtraction operator, answer is 3
c. / e.g. 6 / 3, division operator, answer is 2
d. * e.g. 6 * 3, multiplication operator, answer is 18
e. % e.g. 6 % 3, modulus operator, answer is 0
f. . e.g. '6'.'3', concatenation operator, gives string '63'
g. += e.g. $x += 6, adds 6
h. -= e.g. $x -= 6, subtracts 6
i. /= e.g. $x /= 6, divides by 6
j. %= e.g. $x %= 6, modulus by 6
k. .= e.g. $x .= '6', concats 6 to x
l. < e.g. $x < $y, evaluates to true if $x is < $y
m. > e.g. $x > $y, evaluates to true if $x is > $y
n. == e.g. $x == $y, evaluates to true if $x is equal by value to $y
o. != e.g. $x != $y, evaluates to true if $x is not equal to $y
p. === e.g. $x === $y, evaluates to true if $x is and $y is identical i.e both of same type both value and reference
q. >= e.g. $x >= $y, evaluates to true if $x is >= $y
r. <= e.g. $x <= $y, evaluates to true if $x is <= $y
s. && e.g. ($x == 2 && $y == 3) , evaluates to true if $x equals 2 and $y equals 3
t. || e.g. ($x == 2 || $y == 3) , evaluates to true if either $x equals 2 or $y equals 3
u. xor e.g. ($x == 2 xor $y == 3) , evaluates to true if either $x equals 2 or $y equals 3 but not both
v. ++ e.g. $x++, increments $x
w. –- e.g. $x--, decrements $x
</pre>

==== Defining array Structures ====
'''Ways of declaring arrays'''
 Suppose we want many variables, we could have done in the way declaring variables as above, however, that is not elegant, for suppose u want a 100 variables; declaring arrays come to the rescue. Note that index in PHP starts from 0.
<pre>
$my_guitar_heroes = array ("Hendrix", "Schenker", "Gilmour", "to_name_a_few!");
</pre>
Or
<pre>
$my_guitar_heroes [] = "Hendrix";
$my_guitar_heroes [] = "Schenker";
$my_guitar_heroes [] = "Gilmour";
$my_guitar_heroes [] = "to_name_a_few!";
</pre>
Here PHP automatically assigns the index.

Or
<pre>
$my_guitar_heroes [0] = "Hendrix";
$my_guitar_heroes [10000] = "Mainak";
</pre>
Here in I just knew the first element and the 10,001st element and that&apost;s me!

Or
a combination of the above means

Or
<pre>
// Set the elements at positions 1 through 9999 to the value, "to be decided".
$my_guitar_heroes = array_fill( 1, 9999, "to be decided" );
</pre>

'''Accessing the arrays'''
<pre>
print $my_guitar_heroes[2]; //Access the 2nd element
</pre>
Or
<pre>
// Access the last element (Note that the element positions are numbered zero to
// [number of elements] minus one.)
$my_guitar_heroes[count($my_guitar_heroes)-1];
</pre>
Or
<pre>
// Access the last element using a function call.
end($my_guitar_heroes);
</pre>

'''Iterating over the element of an array'''
<pre>
foreach ( $my_guitar_heroes as $temp) {
print "$temp ";
}
</pre>

==== Control expressions ====
To execute a statement of collection of statements over and over, we use Control expressions. The following are general syntax of the control structures

'''if statements''' 
<source lang="php">
if( $x > 0) {
print("$x is positive");
} else if( $x < 0 ) {
print("$x is negative");
} else {
print("$x is 0");
}
</source>

'''for loop''' 
<source lang="php">
for ( $x=1; $x<= 10; $x++ ) {
print "$x ";
}
</source>

'''while loop''' 
<source lang="php">
$x = 1
while ( $x <= 10 ) {
print "$x ";
}
</source>

'''do while loop''' 
<source lang="php">
$x = 1;
do {
print "$x ";
$x++;
}while($x <= 10);
</source>

==== Defining functions ====
Code which is duplicated at many places are best placed in a function. Following are the ways of describing the function.
<source lang="php">
function name_of_the_function( $arguments, $size='default_values_if_any' ) {
print "here goes in the code";
return "this value is returned, return statement is optional";
}
</source>
The arguments are passed by value. If they are to be passed by reference then an argument is prefixed by "&" as below
<source lang="php">
function name_of_the_function( &$arguments, $size='default_values_if_any' ) {
print "here goes in the code";
return "this value is returned, return statement is optional";
}
</source>
Scope of a variables defined within a function is valid within the function only.

Calling a function
<source lang="php">$x = add(5, 3);</source>

==== Debugging ====
'''Basic printing options''' 
A basic way to debug is to print the value of the variable. The following basic statments acheives that

<ul>
<li>echo "if double quotes are used then dollar variables are resolved";
<li>echo 'if single quote are used then dollar variables are not resolved';
<li>print "another way to print";
<li>nl2br("any new line characters like \n get automatically resolved to HTML line breaks");
</ul>

Apart from these the log files are very helpful and can be found in the WAMP_HOME/logs directory.

==== Handling forms ====
PHP does not change any HTML structure, thus any syntax of HTML remains the same. The part that PHP plays is making any part dynamic for e.g the action attribute of a form can be coded as action=<?php my_own_action(); ?> so that it is dynamically generated. The part where PHP kicks in is after the form is submitted, to say obtain the values of the form fields, set cookies etc. For this super global variables are used which are always available to PHP code. Some of these are
<ol>
<li>$_GET - get the data from a GET request</li>
<li>$_POST - get the data from a POST request</li>
<li>$_REQUEST - get the request</li>
<li>$_COOKIE - obtain the cookies from the browser</li>
<li>$_SESSION - obtain the session</li>
</ol>

All of these are arrays and behave accordingly.

----
[[Category:Templates]]