Mukesh Chapagain's Blog » PEAR

File Upload in PEAR and Smarty

Mukesh — Mon, 21 Jul 2008 10:07:18 +0000

For uploading files, you need to install a package of PEAR called ‘HTTP_Upload’ along with the installation of PEAR and Smarty.

HTTP_Upload is used for easy and secure managment of files submitted via HTML forms. This package provides an advanced system for managing uploads of files via HTML
fields. Features include:

1) Handling of multiple file uploads at a time

2) Safe file copying/moving from temporary directories

3) Upload validaton mechanisms

4) Extensive information about uploaded files

5) Renaming uploaded files

6) Internationalized error messages

Two class files are included in index.php. One is ConnectSmarty.class.php which is used for connecting with Smarty. I have explained about it in my previous article. The other is files.class.php.

files.class.php


class Files
{
function upload($field_name,$dest)
{
$upload =& new HTTP_Upload("en");
$file = $upload->getFiles($field_name);
if ($file->isValid())
{
$moved = $file->moveTo("$dest/");
if (PEAR::isError($moved))
{
require_once('ConnectSmarty.class.php');
// create an object of the class included above
$smarty = new ConnectSmarty;
$error =& $moved->getMessage();
// assign error message
$smarty->assign('errmessage',$error);

// display error message and exit
$smarty->display('error.tpl');
exit();
}
}
}
}
?>

This class file includes the upload class which becomes available after installing the HTTP_Upload package. I have created a function named ‘upload’ inside the class ‘Files’. The upload() function requires two parameters: $field_name and $dest.

$field_name is the name of input file.

$dest is the name of the destination directory where the file is to be uploaded.

The function getFiles() checks if a valid file was uploaded through the form. If the file is valid then it is moved to the destination directory.

If there is error while moving the file to the destination directory then the error message is fetched through the getMessage() function and displayed in a separate template file called error.tpl.

index.php


// create an object of the class included above
$smarty = new ConnectSmarty;
if(isset($_POST['submit']))
{
$post = $_POST;
$keys = "";
$type = $_FILES['logo']['type'];
// Only allowing jpeg and gif image to be uploaded
if($type == "image/jpeg" || $type == "image/gif")
{
/**
* file upload part
* creating an object of the class Files
* calling the upload function of the class Files
* the destination directory is to be created at first
* in this case, the destination directory is created and named 'uploads'
*/
$file =& new Files;
$fieldName = "logo";
$dest = "uploads";
$file->upload($fieldName,$dest);

// assign success message
$smarty->assign('success','File Uploaded Successfully');
}
else
{
// assign error message
$smarty->assign('error','Only jpge and gif image are supported.');

// display error message and exit
$smarty->display('index.tpl');
exit();
}
}

// display the content
$smarty->display('index.tpl');

?>

I have only allowed jpeg and gif image to be uploaded. If the file is successfully uploaded then a success message is assigned and displayed.

// assign success message

$smarty->assign('success','File Uploaded Successfully');

If the file is not of jpeg or gif type then an error message is assigned and displayed.

// assign error message

$smarty->assign('error','Only jpge and gif image are supported.');

// display error message and exit

$smarty->display('index.tpl');

exit();

index.tpl




 Homepage : File Upload




{$success}
{$error}

Upload Logo


Logo

error.tpl



{$errmessage}

Download source code

Note: I have not included Smarty library files in this zip file. You can download the Smarty library files from http://smarty.php.net/download.php or directly from http://chapagain.googlecode.com/files/smarty.zip

Copyright © 2011
This feed is for personal, non-commercial use only.
The use of this feed on other websites breaches copyright. If this content is not in your news reader, it makes the page you are viewing an infringement of the copyright. (Digital Fingerprint:
)

Related posts:

Pagination in PEAR and Smarty

Mukesh — Sun, 20 Jul 2008 10:20:53 +0000

First of all, you need to install PEAR in your web server. Then you need to install Smarty. After that, you need to install a package in PEAR. It’s called ‘Pager’.

Pager is a class to page an array of data. It is taken as input and it is paged according to various parameters. Pager also builds links within a specified range, and allows complete customization of the output.

In the index.php file, we make a function named getPager(). This function contains four parameters – $item, $perPage, $mode, and $delta.

$item is the array of data.

$perPage is the number of data to be displayed per page.

$mode defines about the mode of pagination links. There are two types of modes – Sliding and Jumping. The Jumping mode displays ‘Back’ and ‘Next’ link.

$delta defines the width of pagination links. High value of $delta increases the width of pagination links.

The getPager() function returns an array of data and links. The first element of the array contains array of data and the second element contains pagination links.

index.php


// create an object of the class included above
$smarty = new ConnectSmarty;
function getPager($item,$perPage,$mode,$delta)
{
// setting Sliding as default mode
if($mode == "")
{
$mode = 'Sliding';
}

// setting the default delta value as 2
// delta means the width of pagination
// more delta value results more width
if($delta == "")
{
$delta = '2';
}

$params = array(
'mode'=>$mode,
'perPage'=>$perPage,
'delta'=>$delta,
'itemData'=>$item);
$pager =& Pager::factory($params);
$data = $pager->getPageData();
$links = $pager->getLinks();
$links = $pager->links;
return array($data,$links);
}

$mode = 'Sliding'; // $mode = 'Jumping';
$perPage = '3';
$delta = '2';
$item = array(
array('country_id'=>'1','country_name'=>'India'),
array('country_id'=>'2','country_name'=>'Pakistan'),
array('country_id'=>'3','country_name'=>'Nepal'),
array('country_id'=>'4','country_name'=>'Srilanka'),
array('country_id'=>'5','country_name'=>'Bangladesh'),
array('country_id'=>'6','country_name'=>'Maldives'),
array('country_id'=>'7','country_name'=>'Bhutan'),
array('country_id'=>'8','country_name'=>'Afganistan'),
array('country_id'=>'9','country_name'=>'China')
);
$pagination = getPager($item,$perPage,$mode,$delta);
// print_r($pagination);

$smarty->assign('pager',$pagination[1]);
$smarty->assign('country',$pagination['0']);

// display the content
$smarty->display('index.tpl');

?>

foreach loop is used to display data. Before trying foreach loop, I had tried section loop but it didn’t work with pagination/pager. After that I tried the foreach loop and it worked fine and smooth. J

A custom Smarty function ‘cycle’ is used to alternate row color of the table on which data is being displayed. Cycle is used to cycle through a set of values. This makes it easy to alternate between two or more colors in a table, or cycle through an array of values.

index.tpl



 Homepage : Pagination





{foreach from=$country item=view}

{/foreach}



Country ID Country Name

{$view.country_id}
{$view.country_name}
{$pager}

Download source code

Related posts:

Using database in PEAR and Smarty

Mukesh — Fri, 18 Jul 2008 06:00:57 +0000

For using database, you need to install a package of PEAR called ‘MDB2’ along with the installation of PEAR and Smarty.

MDB2 provides a common API for all support RDBMS.

Connecting to database

To connect to a database through PEAR::MDB2, you have to create a valid DSN – data source name. This DSN consists in the following parts:

phptype: Database backend used in PHP (i.e. mysql , pgsql etc.)

dbsyntax: Database used with regards to SQL syntax etc.

protocol: Communication protocol to use ( i.e. tcp, unix etc.)

hostspec: Host specification (hostname[:port])

database: Database to use on the DBMS server

username: User name for login

password: Password for login

proto_opts: Maybe used with protocol

option: Additional connection options in URI query string format. options get separated by &.

The DSN can either be provided as an associative array or as a string. The string format of the supplied DSN is in its fullest form:

phptype(dbsyntax)://username:password@protocol+hostspec/database?option=value

To instantiate a database object you have several methods available using MDB2.

factory() : Will instantiate a new MDB2_Driver_Common instance, but will not connect to the database until required. This will delay making the actual connection.

connect() : Will instantiate a new MDB2_Driver_Common instance, and will establish a database connection immediately. This way any connection issues will immediately raise an error.

singleton() : Returns a MDB2_Driver_Common instance.

A new MDB2_Driver_Common object is only created once using factory(), subsequent calls to singleton will return a reference to the existing object. This method is preferred over declaring your database object as a global.

To connect to a database you have to use the function factory(), connect() or singleton(), which require a valid DSN as the first parameter. This parameter can either be a string or an array. The second parameter is the optional $options array that can contain runtime configuration settings for this package.

I have used the connect() function with the DSN as

phptype://username:password@hostspec/database

$mdb2 =& MDB2::connect('mysql://root:@localhost/test');

In my case, the database backend is mysql, database username is root, database password is null, the hostname is localhost and the database name is test.

Querying the database

PEAR MDB2 provides several methods for querying databases. The most direct method is query(). It takes a SQL query string as an argument. There are two possible returns: A new MDB2_Result object for queries that return results (such as SELECT queries), or a MDB2_Error object on failure. It should not be used with statements that manipulate data (such as INSERT queries).

exec() should be used for manipulation queries. There are two possible returns: An integer denoting the number of affected rows for statements that manipulate data (such as INSERT queries), or a MDB2_Error object on failure. It should not be used with statements that return results (such as SELECT queries).

Here, I will only be dealing with the SELECT queries.

$mdb2 = new ConnectMDB2;
// calling the function conMDB2 of ConnectMDB2 class
$connect = $mdb2->conMDB2();
$res = $connect->query("SELECT * FROM basic");

Fetching result

The MDB2_Result_Common object provides four methods for fetching data from rows of a result set: fetchOne(), fetchRow(), fetchCol() and fetchAll().

fetchRow() and fetchOne() read an entire row or a single field from a column respectively. The result pointer gets moved to the next row each time these methods are called. NULL is returned when the end of the result set is reached.

fetchAll() and fetchCol() read all rows in the result set and therefore move the result pointer to the end. While fetchAll() reads the entire row data, fetchCol() only reads a single column.

MDB2_Error is returned if an error is encountered.

I have used the fetchRow() method. The fetchmode MDB2_FETCHMODE_ASSOC is used for fetching data. The default fetchmode is MDB2_FETCHMODE_ORDERED.

while($row[] = $res->fetchRow(MDB2_FETCHMODE_ASSOC))
{
$result = $row;
}

If there is any error then the error message is displayed in a separate template called error.tpl. And if there is no error while fetching data then the fetched result is displayed in the template file index.tpl.

if(PEAR::isError($res))
{
// get error message
$error =& $res->getMessage();
// assign error message
$smarty->assign('errmessage',$error);
// display the message and exit
$smarty->display('error.tpl');
exit();
}
// asign the content
$smarty->assign('result',$result);

// display the content
$smarty->display('index.tpl');

In the template file, foreach loop is used to display the result.

{foreach from=$result item=view}

{$view.firstname}
{$view.lastname}

{/foreach}

Download source code

Related posts:

An Introduction to PEAR

Mukesh — Fri, 27 Jun 2008 12:11:31 +0000

PEAR is short for “PHP Extension and Application Repository” and is pronounced just like the fruit. It is a repository of PHP software code. The PEAR project was founded in 1999 by Stig S. Bakken to promote the re-use of code that performs common functions.

PEAR is a code library that can reduce development time by supplying prewritten classes for standard functionality. PEAR contains functionality for a number of features, including database, mail, and error handling. PEAR provides a level of standardization that facilitates interoperability of functions.

PEAR is broken into three classes: PEAR Core Components, PEAR Packages, and PECL Packages. The Core Components include the base classes of PEAR and PEAR_Error, along with database, HTTP, logging, and e-mailing functions. The PEAR Packages include functionality providing for authentication, networking, and file system features, as well as tools for working with XML and HTML templates. PECL Packages are extensions to PHP, written in C, that do not comply with the coding guidelines.

The purpose of PEAR is to provide:

A structured library of open-source code for PHP users

Each PEAR code package comprises an independent project under the PEAR umbrella. It has its own development team, versioning-control and documentation. Packages may relate to each other through explicit dependencies, but there is no automatic dependency relationship between packages based on the package name. For example, “HTTP_Post” is by default independent of “HTTP”.

A system for code distribution and package maintenance

All PEAR packages are registered in and downloaded from a central server at pear.php.net. All communication occurs over the HTTP protocol. Packages are distributed as a gzipped tar file with an XML description file inside. They contain source code or binaries or both. Many PEAR packages can readily be used by developers as ordinary third party code via simple include statements in PHP.

A standard style for code written in PHP

The PEAR Coding Standards apply to code that is part of the official PEAR distribution. Coding standards often abbreviated as CS among developers and they aim to keep code consistent to be easily readable and maintainable by most of PEAR folks. The PEAR Coding Standards defines about indenting and line length, control structures, function calls, function definitions, comments, including code, header comment blocks, naming conventions, etc.

The PHP Extension Community Library (PECL)

PECL (pronounced “pickle”) is a separate project that distributes PHP extensions. PECL extensions are also distributed as packages and can be installed using the PEAR installer with the pecl command. PECL contains C extensions for compiling into PHP. As C programs , PECL extensions run more efficiently than PEAR packages. PECL includes modules for XML-parsing, access to additional databases, mail-parsing, embedding Perl or Python in PHP scripts and for compiling PHP scripts.

A web site, mailing lists and download mirrors to support the PHP/PEAR community

One of the jobs of the PEAR Group is to issue administrative documents about diverse topics in PEAR. If you’re interested in submitting code for inclusion in PEAR, you can do so by joining the PEAR developer’s mailing list and requesting that your code be reviewed. To be considered, be sure to pay attention to functionality that’s already included and adhere to the PEAR coding guidelines. Submissions to PEAR are scrutinized by a panel, which provides quality assurance and reliability in the code.

As stated above, PEAR functionality is easy to deploy and requires no additional programming. By using quality prewritten, reusable code, you can tremendously shorten your development cycle.

Source:

1) PEAR Manual

2) http://en.wikipedia.org/PHP_Extension_and_Application_Repository

3) http://articles.techrepublic.com.com/5100-10878_11-1045409.html

Related posts:

Country ID	Country Name
{$view.country_id}	{$view.country_name}
{$pager}