Code Examples -> PHP 4 And the singleton pattern

	Submit Your Code
	SEO Monitor
	UpTime Monitor
	PHP Code Contest
	My Favorite Examples
	My Favorite Articles
	Update Your Profile

More Weber Sites
	PHP Code Search
	Web Development Forums
	Learn MySQL Playing Trivia
	PHPBB2 Templates
	Web Development Index
	Web Development Resources
	Web Development Content

Recommended Links
	PHPClasses
	PHP Editor
	PHP Jobs
	Vision.To Design
	Ajax Tutorials
	PHP Programming Help
	PHP/MySQL Programming
	Webmaster Resources
	Webmaster Forum
	XML meta language
	website builder

Recommended
	Forex Trading Online forex trading platform


BACK		ADD A COMMENT		SEND TO A FRIEND		ADD TO MY FAVORITES		ADD CODE EXAMPLES		PRINT

PHP Code Examples

Title :	PHP 4 And the singleton pattern
Categories :	PHP, PHP Classes	Joseph Crawford
Date :	Sep 22nd 2004
Grade :	4 of 5 (graded 2 times)
Viewed :	10338
File :	No file for this code example.
Images :	No Images for this code example.

Search :	More code by Joseph Crawford
Action :	Grade This Code Example
Tools :	My Examples List

Code

Like this code? Show the author your appreciation.

Recently i wrote a code example for using the singleton pattern in PHP 5, and have had several people ask if there was a way to do it in PHP 4. After some research i found that there is in fact a way to do this.

In PHP 4 you could not have static class properties however you can have static variables in a function. Here is the function you will need to use for your classes.

<?php

function &singleton($class) {
static $instances;

if (!is_array($instances)) {
$instances = array();
}

if (!isset($instances[$class])) {
$instances[$class] =& new $class;
}

return $instances[$class];
}
?>

Notice that i have used the & (reference operator) in the above code, this is so that we pass by reference rather than letting php make a copy of the object.

Now that you have this function you can place that anywhere in your files before you class is called or included. Next we will create an example class.

<?php

class Example {
var $test;

function Example($var) {
$this->test = $var;
}

function getTest() {
return $test;
}
}

class Example1 {
var $test;

function Example1($var) {
$this->test = $var;
}

function getTest() {
return $this->test;
}
}
?>

now with this code you can do something like

<?php

$myExample =& singleton('Example');

$myExample1 =& singleton('Example1');

$myExample->test = 'just a test';

$myExample1->test = 'another test';

echo 'Example $test: '.$myExample->getTest(); echo '<br>'; echo 'Example1 $test: '.$myExample1->getTest();
?>

The above function was sent in by Dan Cech, from the NYPHP Users Group.
The function i had didnt properly deal with more than one class, his does.
He also altered the way it returned the references.

This will return the static instance of the class and will set the values for each class's $test property, then it will echo them to show you that they are different.

Hopefully this has helped a few people and you now understand how to use the singleton pattern in PHP 4.

Please not that a static variable in php 4 is only good on one page load, meaning that if you navigate to another page $instance is no longer set. You will need to add some session handling in here to do this.

I also have another way to do something similar to this without all this singleton stuff that i will touch on.

If you dont want to get too involved in patterns with php 4 (which i dont think you should do anyway) there is a very simple way to achieve the above.

I have this in a file called global.php and i include the global file in all of my files

<?php

include('class/Cart.php');

session_start();

if ((!isset($_SESSION['cart'])) || (!is_object($_SESSION['cart']))) {
$_SESSION['cart'] = new cart;
} else {
$cart = &$_SESSION['cart'];
}

?>

this code will store the object in a session variable and it will only load a new object if the session object is not found.

basically the same results as above for php 4.

Notice i have have my class file included before the session_start(); In order for this to work you MUST have all classes that you will be storing in a session before the session_start().

Joe Crawford
weberdev@codebowl.com

Related Code Examples

	Use this class to connect your database transparently... Categories : PHP Classes, Databases, PHP
	Optimized Online users class Categories : PHP, PHP Classes, Sessions
	Password Creator: This PHP code exmaple shows how to use bitwise operations on a single variable and using it as a flagged variable. The class generates passwords of a given length using specified characters and the flags. Categories : PHP, PHP Classes, Algorithms, Security

	Use of bitmasks to represent permissions Categories : PHP, Authentication, Bitwise Operators, Security, PHP Classes
	Sitmap Generator PHP class Categories : PHP, PHP Classes, Search Engines, Site Planning
	Gonx Proxy - This class is meant to act as an HTTP proxy to serve pages of a remote server as if they were local pages. Categories : PHP, PHP Classes, HTTP
	Request Method Class - seful for situations like form processing or API development. Requires PHP5 for the magic __call() method. Categories : PHP, PHP Classes, HTTP, Headers
	Sort the results from a SELECT query (any number of columns) into an array automatically. Categories : PHP, PHP Classes, Arrays, Databases, MySQL
	PHP class generator, must be used from Command line interface. Categories : PHP, PHP Classes, Shell Scripting
	Easy upload class Categories : PHP Classes, Filesystem, HTTP, PHP
	Class TStringList include some metods from class TStringList implemented in INPRISE/BORLAND-DELPHI Categories : PHP Classes, PHP, Strings
	usercounter class Categories : PHP, PHP Classes, Databases, MySQL, Environment Variables
	Most of the browsers, especially Internet Explorer, behave in different ways. Hence it become necessary to use Browser detection to fix the non standard behavior of the browser. This is a browser sniffer class that can be used for the above purpose. Categories : PHP, PHP Classes, Browsers
	A Custom Error Handling And Debugging Class Categories : PHP, PHP Classes, Debugging, Errors and Logging