PHP Resources
I put a list together for a friend of some good PHP resources, thought I’d stick it up here as well:
Of course, the best resource, the official docs:
http://www.php.net
Another great (official) place:
http://talks.php.net/
The talks are by the creators of PHP. Any talks by Rasmus Lerfdorf are excellent, he stresses simplicity over complexity. He’s also the creator of PHP. Derick Rethans is also an excellent presenter, he focuses a lot on security and debugging. Definitely watch the presentations in the “Security” section of the talks, but overall, any talk in there has information you can use to your advantage.
Other sites:
http://www.smashingmagazine.com/2009/03/24/10-useful-php-tips-revisited/
http://php.about.com/od/advancedphp/Advanced_PHP.htm
Sitepoint is where I first started learning HTML and CSS many years ago:
http://www.sitepoint.com/subcat/php-tutorials
MVC tutorials (how apps should be coded; obviously there’s some contention between OO and procedural styles, but you need knowledge of both to be able to make an educated judgment about what a good balance between the two is)
http://www.phpro.org/tutorials/Model-View-Controller-MVC.html
Good to go through to understand MVC completely
CakePHP has a good introduction:
http://book.cakephp.org/view/10/Understanding-Model-View-Controller
Which brings me to CakePHP itself. It’s an excellent MVC framework; after trying out CodeIgniter, Zend, Yii, Kohana, I’ve settled on Cake.
http://cakephp.org/
SQL resources – the best is the manual. Learning the concepts behind joins is essential and important. A good tutorial:
http://www.codinghorror.com/blog/archives/000976.html
Also database design:
http://www.simple-talk.com/sql/database-administration/ten-common-database-design-mistakes/
http://woork.blogspot.com/2008/09/10-useful-articles-about-database.html
Following that up are good ORM, which you may want to use as your database layer. CakePHP has ORM built-in, but sometimes all you need is just a DB layer.
http://www.doctrine-project.org/
For conventions, I tend to follow the CakePHP model (since that’s the framework I use the most):
http://book.cakephp.org/view/24/Model-and-Database-Conventions
http://bakery.cakephp.org/articles/view/database-design-and-cakephp
http://book.cakephp.org/view/22/CakePHP-Conventions
And then rounding it out, some general knowledge information:
http://articles.sitepoint.com/category/html
http://articles.sitepoint.com/category/javascript
http://articles.sitepoint.com/category/cssh
http://www.jquery.com
CakePHP Models – multiple columns to the same table
This one took me a few to figure out. On VACentral, there are schedules, which have an arrival and departure point. These points are all stored in one table, so one row in schedule refers to multiple entries in the airports table. It looks something like (ok, not something like, but exactly):
|
1 2 3 4 5 |
Schedules:
id | departure_icao | arrival_icao
Airports
id | icao |
So two ICAO columns in routes map to one same column in airports. The ICAO is a unique 4 character identifier, which is assigned to an airport. It’s quite simple actually, but took me a while to figure it it. First the Airports model:
|
1 2 3 4 5 6 |
class Airport extends AppModel
{
public $name = 'Airport';
public $primaryKey = 'id';
public $actAs = array('Containable');
} |
And then our Schedules model:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
class Schedule extends AppModel {
public $name = 'Schedule';
public $primaryKey = 'id';
public $actsAs = array('Containable');
public $belongsTo = array(
'DepartureAirport' => array(
'className' => 'Airport',
'foreignKey' => false,
'conditions' => 'DepartureAirport.icao = Schedule.departure_icao',
'fields' => '',
'order' => ''
),
'ArrivalAirport' => array(
'className' => 'Airport',
'foreignKey' => false,
'conditions' => 'ArrivalAirport.icao = Schedule.arrival_icao',
'fields' => '',
'order' => ''
)
);
} |
So we used the $belongTo relationship, and we will define two relationships – “DepartureAirport” and “ArrivalAirport”. We also select the class we will use (which IMO, should really be called “modelName” or “useModel”, that really tripped me up, but I digress). Next, we define the conditions – we’ll use the relationship name (DepartureAirport or ArrivalAirport), and the column name, along with the column name on the current table it should join on. And that’s pretty much it. You don’t really need a relationship on the “receiving” end (the Airports table), unless you will be querying airports, and finding out what schedules go there. I’ll leave that upto you ![]()
And then for the query itself:
|
1 2 3 4 5 6 |
$this->Schedule->contain('DepartureAirport', 'ArrivalAirport');
$schedule = $this->Schedule->find('first');
// Our Airport specific data will be contained in:
$schedule['DepartureAirport']
$schedule['ArrivalAirport'] |
Which will now return something like (etc fields ommitted):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
Array
(
[Schedule] => Array
(
[schedule_id] => 4178
[airline_id] => 2
[code] => AEA
[flightnum] => 6371
[depicao] => CYUL
[arricao] => KJFK
)
[DepartureAirport] => Array
(
[airport_id] => 597
[iata] => YUL
[icao] => CYUL
[name] => Montreal / Pierre Elliot Trudeau International Airport, Quebec
[timezone] => US/Eastern
[location] => Montreal QC Canada
[lat] => 45.470556
[lng] => -73.740833
)
[ArrivalAirport] => Array
(
[airport_id] => 268
[iata] => JFK
[icao] => KJFK
[name] => JFK Airport
[timezone] => US/Eastern
[location] => New York-Kennedy NY
[lat] => 40.6398262
[lng] => -73.7787443
)
) |
Note how it's using the Containable behavior; this is so it doesn't pull every relationship you've defined with that table (the schedules table above has many more relationships, but for brevity, I only pulled the relevant ones). Not specifying Containable() is REALLY expensive, especially when you don't need all those relationships to be included in every time! To speed it up even more, you should specify the actual field names to pull (the SQL * operator is expensive).
ezDB and PHP 5.3
As-per Justin’s request, I’ve renamed by fork of ezSQL to ezDB. I’ve updated the github links, it’s now:
http://github.com/nshahzad/ezdb/
This will include changes to the class names, to keep it all even (ezSQL to ezDB). I’m working on APC caching right now, since that’s what I’m using on current project.
PHP 5.3 was also released today! This is an exciting release – with the addition of namespaces and __callStatic(), the static DB class will be much easier to work with (instead of replicating every function). I will be finishing up the 5.2 release first, and then subsequent releases and features, I think I will be posting to the PHP 5.3 release only, unless there’s demand to back-port it all.
I’ll also be implementing some features from CakePHP’s ORM, such as “findBy{ColumnName}({tablename})”, and other simple lookups. I’ve been using Cake alot too, and it’s a great framework.
Cheers!
ezSQL updates
Well, got github working great. Did an update today, including:
- $allowed_columns parameter for quick_insert() and quick_update(). So you can pass in $_POST or $_GET, as well as a list of valid indices to use
- (optional) Exception handling with try/catch (more info)
- Set return type (object, associative array, numeric array) globally through $default_type
Also, I’m updating the wiki slowly, transferring all the useful information onto there, since it’s easy to keep everything together.
Thanks!
ezSQL on github
Learning how to use github, so I created a repo for ezSQL.
http://github.com/nshahzad/ezdb
I plan on creating another version (a fork I guess?) for PHP 5.3 when it hopefully launches next week. It’ll have proper namespace support. Haven’t gotten to memcache just yet (hey, been busy!
, but at least there’s an easier route of distribution now.
PHP Benchmarking
I came across a few sites which have some valuable information on the “cost” of certain functions or practices in PHP. It comes in handy to keep in mind and avoid doing, and also to remember that there are better ways of doing things. If your application is coming down to relying on micro-optimization, your application itself needs to be looked at. But there’s no harm in knowing what methods take more time than others. Or of course, you can use ‘em to impress a prospective employer
- The PHP Benchmark – http://www.phpbench.com/
- lixlpixel PHP Benchmark – http://lixlpixel.org/php-benchmarks/
- Comparing all different functions and uses – http://net-beta.net/ubench/
- PHP Benchmarking Suite – http://phplens.com/benchmark_suite/
There are also some lectures and talks on optimizing:
- Speeding up PHP applications by Derick Rethans
- Simple is Hard by Rasmus Lerdorf (the creator of PHP)
- Performance by Rasmus Lerdorf
- PHP Tips & Tricks by Rasmus Lerdorf
- PHP best practices – The dos and don’ts by Tobias Schlitt & Kore Nordmann
Some good stuff there to look over and to keep in mind, especially obvious things to avoid, such as including the count() inside every for() loop. Actually any of the stuff on http://talks.php.net are a good read, and good to see where PHP has evolved from and where it’s evolving to, and to understand how to leverage the language.
To benchmark your scripts, you can use the PEAR Benchmark package; I have PEAR in my path, so for me it was as simple as including the same code that was in the examples.
Nginx + PHP Query Strings
Nginx (Engine-X) is the sweetest web server I’ve used. It’s running my VPS now, CPU usage has barely budged, even with a decent number of visitors. I ran into a problem, which I was searching for a solution before I cracked at it myself. The solution ended up being incredibly simple, but still may help someone else who’s searchin’ for it.
With nginx, PHP is passed of to FastCGI PHP process to parse and execute. It relies on a location rule to find out what are PHP files. But it would fall apart using URLs like:
|
1 |
index.php/some/query/string/parameters |
Apache doesn’t have any trouble, with it, but nginx, if you looked at the error log, it’ll be about the directory not existing. (Hmm, parsing that in PHP sounds like a good idea for another post… noted).
So if we check out the current rewrite rules:
|
1 2 3 4 5 6 |
location ~ \.php$ {
include /etc/nginx/conf/fastcgi_params;
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME /path/to/public/$fastcgi_script_name;
} |
The fix is pretty simple:
|
1 2 3 4 5 6 |
location ~ \.php(.*)$ {
include /etc/nginx/conf/fastcgi_params;
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME /path/to/public/$fastcgi_script_name;
} |
Adding in the (.*) after the .php allows the PHP files to be picked up, and those additional query string parameters will get passed along into FastCGI.
Simple fix!
Shell scripts no more!
This weekend, I started my server migration, over to Slicehost. It went well, now I’m running on a lean ‘n mean nginx install. As I was moving my Subversion repositories, I was dreading having to move all my shell scripts, which I used to build and deploy some of my applications (outlined in this post). I was thinking there had to be a better way, after all, Ruby has Capistrano, and though it can be used with PHP, I didn’t want to have to install Ruby, etc etc. After some searching (not much), I found Phing, which looked like exactly what I needed. Sweet!
Phing takes an XML file, which you can define all the transformations and instructions. It has sets called “targets”, which are different stages of the build and transformation. They have a basic example here, but I’ll go through my phpVMS build.xml, since I do a number of things they don’t show in the examples, like checking out from Subversion, some variable replacements, and building tars for different “stages”. Having targets was great, since you can select which targets to run, so now I can combine a “beta” and “release” builder, instead of having separate files for it (as I did with the shell scripts). My goals are the same as in the SSH scripts:
- Automatically build beta, full, and update versions from SVN
- Update revision numbers within several files using tokens or regex
- Copy it to the test site
- Automatically generate PHPDoc API documentation
Phing is perfect for this. I had sets of painful-to-maintain and update SSH scripts to do this same thing. And it has a simple PEAR installer. I installed it using:
|
1 2 |
sudo pear channel-discover pear.phing.info
sudo pear install phing/phing |
]
And that was it! Installed. They do have instructions for a I now had “phing” available on the command line:
|
1 2 |
phing -version
Phing version 2.3.3 |
]
Now we can get started, building our XML file. The file starts with:
|
1 2 3 4 5 |
<xml version="1.0">
<project basedir="." default="beta" name="phpvms">
</project>
</xml> |
That’s our basic container; as you can see I set the project name, the default “target” or stage to run, and the base directory. Everything we do/add will go inside the project tags.
Now, I’m going to add some common “properties”, or variables, that will be used throughout the script, to make it easier, and not have to type out paths over and over:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
<!-- Build properties -->
<property name="project.wcdir" value="/path/to/phpvms.wc" />
<!-- This is the path to where a clean export can be done of SVN -->
<property name="project.exportdir" value="/path/to/phpvms.export" />
<!-- This is the path where the build binaries can go -->
<property name="dest.dir" value="/path/to/public/files/" />
<!-- This is the path where the "test build" goes (phpvms.net/test) -->
<property name="test.dir" value="/path/to/public/test/" />
<!-- This is where the docs generated by phpdoc will go -->
<property name="php.doc" value="/path/to/public/docs/api/" />
<!-- URL to our SVN repository -->
<property name="repository.url" value="svn://phpvms.net/phpvms/trunk" />
<!-- Username and password, blank since the above can be accessed anon -->
<property name="repository.user" value="" />
<property name="repository.pass" value="" /> |
Use absolute paths if you can, otherwise, it’s relative to the basedir property defined in the project tag.
The reason for having a working copy and an export directory for SVN is this – the checkout directory will be used to determine the latest revision, since the svnlastrevision command requires the path to a working copy. The export directory is to hold a clean export; without all the subversion specific data that’s included in a checkout. We’ll package that up, and use that to copy to a test site.
Next, I define the targets, or stages, I’m going to use: prepare, build, subs, phpdoc, beta, and release. They are setup this way in roughly the order they will run. The order doesn’t matter, since we determine the order of the targets by using the “depends” property. I’ll explain each one in detail:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
<target name="build" depends="prepare">
</target>
<!-- This is where we will do our variable substitutions
It depends on the target above, primarily in our case,
replace all version numbers -->
<target name="subs" depends="build">
</target>
<!-- This is the PHP doc target, it's its own target
since we will call it from beta and release -->
<target name="phpdoc">
</target>
<!-- In this target, we will create a "beta" release.
It depends on the subs build. We will call this
target, or the release target specifically from the
command line when we run phing -->
<target name="beta" depends="subs">
</target>
<!-- In this target, we create a "release", and it depends on
the "subs" target above. We'll also specifically call this
from the command line -->
<target name="release" depends="subs">
</target> |
So now that we have an outline, we can go through each target, doing what we need to do, first our “prepare” stage:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
<target name="prepare">
<!-- First we are going to delete the export directory
So we have a clean copy that we export from SVN.
Then we re-create it using the mkdir command -->
<delete dir="${project.exportdir}" failonerror="true" verbose="false" includeemptydirs="true" />
<mkdir dir="${project.exportdir}" />
<!-- Now we create the working-copy directory,
where the checkout will be -->
<mkdir dir="${project.wcdir}" />
</target> |
We’re using our properties which we defined, as ${propertyname}. Don’t need to do any escaping, etc, just use ‘em right in the strings.
Next is our build target stage, which will do the Subversion operations of getting the latest revision.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
<target name="build" depends="prepare">
<!-- We are checking it out to the checkout directory -->
<svncheckout todir="${project.wcdir}" repositoryurl="${repository.url}" nocache="true" force="true" password="${repository.pass}" username="${repository.user}" svnpath="/usr/bin/svn" />
<!-- We're now going to get the last revision
from the above checkout. The last revision
number will be stored in the propety called
svn.lastrevision, which we can access by
${svn.lastrevision}. No more parsing results
from the command line... wahoo! -->
<svnlastrevision svnpath="/usr/bin/svn" propertyname="svn.lastrevision" workingcopy="${project.wcdir}" />
<!-- Export a clean copy which we can package up -->
<svnexport todir="${project.exportdir}" repositoryurl="${repository.url}" nocache="true" force="true" password="${repository.pass}" username="${repository.user}" svnpath="/usr/bin/svn" />
</target> |
It’s great how Subversion operations can easily be done. Next target is subs, to replace any tokens and variables we define in the files.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
<target name="subs" depends="build">
<!-- Reflexive allows work on a set of files, and
a "reflexive" block is required for a filterchain-->
<reflexive>
<!-- Here we define the files that we're going to
work in using a filterchain -->
<fileset dir="${project.exportdir}">
<include name="changelog.htm" />
<include name="install/install.php" />
<include name="install/update.php" />
<include name="install/install.sql" />
</fileset>
<!-- Setup a filterchain now, the above files
pass through these filters -->
<filterchain>
<!-- Instead of doing a regular expression match,
Phing supports token replacement. I use the
##REVISION## token wherever I want it to be -->
<replacetokens endtoken="##" begintoken="##">
<!-- Replace the REVISION token with our svn.lastrevision property -->
<token value="${svn.lastrevision}" key="REVISION" />
</replacetokens>
</filterchain>
</reflexive>
</target> |
Next is our phpDoc function, which is sort of standalone, in the fact that there are no depends for it.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
<target name="phpdoc">
<!-- Setup the basic options -->
<phpdoc title="API Documentation" output="HTML:Smarty:PHP" sourcecode="no" destdir="${php.doc}">
<!-- These are the files that are going to be
included as part of the documentation -->
<fileset dir="${project.exportdir}">
<include name="core/classes/*.php" />
<include name="core/common/*.php" />
<include name="core/modules/**/.php" />
</fileset>
<!-- This lists the files which are part of the
official documentation -->
<projdocfileset dir="${project.exportdir}">
<include name="changelog.htm" />
</projdocfileset>
</phpdoc>
</target> |
Now that we’ve got the basics down, the next two targets are “beta” and “release”. Each of these handles a different set of tasks, though they are basically the same. First for beta:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
<target name="beta" depends="subs">
<echo msg="Creating archive..." />
<!-- Delete the files first, since they are not updated,
The tar function will just append onto them -->
<delete file="${dest.dir}/phpvms.beta.tar.gz" />
<delete file="${dest.dir}/phpvms.beta.zip" />
<!-- Create the tar file, specifying the files to include -->
<tar compression="gzip" destfile="${dest.dir}/phpvms.beta.tar.gz">
<fileset dir="${project.exportdir}">
<include name="*" />
</fileset>
</tar>
<!-- I was having trouble with the built-in ZIP functionality
So I resorted to using the command line. Either way, this
shows off the command line functionality that Phing has -->
<exec escape="false" command="cd ${project.exportdir}; zip -D -r ${dest.dir}phpvms.beta.zip ." />
<echo msg="Copying to test site" />
<!-- Copy it to the test site, so there's an updated
copy available there to debug-->
<copy todir="${test.dir}" overwrite="true">
<fileset dir="${project.exportdir}">
<include name="*" />
</fileset>
</copy>
<!-- Call the phpDoc target that we created -->
<echo msg="Creating phpDoc" />
<phingcall target="phpdoc" />
<echo msg="Files copied and compressed in build directory OK!" />
</target> |
And now for the release target. Release a bit different than beta – it creates two different archives – one full version, and one update. The difference essentially is that the update copy has the local configuration file removed, where database settings are stored, and other settings which are kept locally.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
<target name="release" depends="subs">
<echo msg="Creating release builds..." />
<!-- Delete all the files, start fresh -->
<delete file="${dest.dir}/phpvms.full.tar.gz" />
<delete file="${dest.dir}/phpvms.full.zip" />
<delete file="${dest.dir}/phpvms.update.tar.gz" />
<delete file="${dest.dir}/phpvms.update.zip" />
<!-- Create the tar file -->
<tar compression="gzip" destfile="${dest.dir}/phpvms.full.tar.gz">
<fileset dir="${project.exportdir}">
<include name="*" />
</fileset>
</tar>
<!-- Create the zip file -->
<exec escape="false" command="cd ${project.exportdir}; zip -D -r ${dest.dir}phpvms.full.zip ." />
<!-- Now create the update build, which basically deleting the
local.config.php file -->
<echo msg="Full release created, creating update" />
<!-- Delete the local.config.php file, since that's not distributed
with an update-->
<delete file="${project.exportdir}/core/local.config.php" />
<!-- Create the tar file -->
<tar compression="gzip" destfile="${dest.dir}/phpvms.update.tar.gz">
<fileset dir="${project.exportdir}">
<include name="*" />
</fileset>
</tar>
<!-- Create the zip file, using command line instead
I kept getting out of memory errors using the built-in
ZIP functionality. -->
<exec escape="false" command="cd ${project.exportdir}; zip -D -r ${dest.dir}phpvms.update.zip ." />
<!-- Call the phpDoc target -->
<echo msg="Creating phpDoc" />
<phingcall target="phpdoc" />
<echo msg="Files copied and files moved, done!" />
</target> |
And that’s it! Now we can run it using:
|
1 2 |
phing -buildfile /path/to/build.xml beta
phing -buildfile /path/to/build.xml release |
]
Using the appropriate one we want to use. In my SVN post-commit file, I run the beta line, in order to have that build every time.
I attached a fully doc’d version here (same as the above, just in one file). I hope it helps!
ezSQL Database Library (Improved!)
Note: I’ve made a dedicated page for ezSQL-related items, you can view it here
I’ve been using ezSQL for a long time, as my “database driver”. It’s an awesome little class, that you can easily use to get database results, and return in different formats. I’ve made a bunch of changes and updates to it, so I thought I’d put them out there and share them.
Along the way, I’ve made some updates and changes to it, to suite my requirements, including format PHP5 support. I’ve updated the error handling/logging, so now you can call:
|
1 2 |
$sql->error(); // Get the error string
$sql->errno(); // Get the error number |
Respectively after queries to return the “real” status of a query. the debug() function has been added to, so at call time, you can pass to bool whether to display the result on the screen, or pass it back as a string
I’ve also added several utility functions:
|
1 2 3 4 5 6 7 |
$sql->quick_select();
$sql->quick_update();
$sql->quick_insert();
// quick_select() example:
$columns = array('column1', 'column2');
$sql->quick_select('table_name', $columns, 'LIMIT 10'); |
To make it easier to do simple SELECT’s and UPDATEs, and INSERTs.
Another thing it was missing with MySQLi support, so that has been added (though I have not had the time to add support for statements (though that can be accessed rather easily). I had added MSSQL support, but the file has gone AWOL (Icreated and used it for a specific project a while ago). I will update when I get a hold of it.
And another thing I added was a static interface class, which I use all the time on PHP5 projects:
|
1 2 3 4 5 6 |
DB::init('mysql');
DB::connect('username', 'password', 'database_name', 'localhost');
// Now anywhere in your script:
$row = DB::get_row('...');
// Or
$results = DB::get_results('...', ARRAY_A); |
Makes it much easier to access the database function, without having to do $db = DB::getInstance(), in every single function to get a singleton object of the database. Since that’s for PHP5 only, the whole library has been updated for PHP 5 support, with public/private functions and constructors/destructors as well.
I also condensed it to just one include() now, just keep all the files in the same place (include ‘…/DB.class.php’). From that you can either use the static class, or declare a new ezSQL object.
I also added in phpDoc blocks on all the functions, since IntelliSense is awesome and really helpful.
I hope these improvements make it easier for everyone. Of course, the original credit goes to Justin Vincent. There are some docs and examples here as well.
Reducing HTTP Requests
In doing some optimizing for phpVMS, I noticed I have a lot of HTTP requests:
As you can see, there are 27 HTTP requests, 15 of them JavaScript files. This means, the browser has to reach out 15 times to grab individual JS files. This seems like a straight forward problem, if we can just condense those 15 files into one, then we can almost half the number of total requests.
So we can do this manually – copy and paste each file, into one master file. The problem is, when you update one file, you have to go and search around in your other files, and figure out exactly where to update, or just redo the entire condensing process. It’s a pain. but these seems like a good place to write some code to do it.
As part of Codon now, I’ve included a class called CodonCondenser. It’s just a basic class that will condense requested files into one file. I set out some requirements:
- It’s a class, so we can reuse it
- Use it for any file types
- Have a cached file of our condensed batch, so we don’t need to dynamically condense it every time, which could be expense.
- Be able to add/remove files at will, and it will handle that
Since we have some basic requirements, let’s plan how it’ll work:
- Set our options, the path to the files, the URL to the files since our function will return the URL to the generated file, set the file type, and a cache
- Pass an array, with the list of our files
- Generate a MD5 hash of the array we’ve passed, this will be our file name. If the array changes, as in we add files, or remove files, the hash will change, so we satisfy requirement #4… OR… use a filename that we generate, or pass in.
- Check this file name, see if it exists; if it does, see if the file age is older than we want (satisfying #3). If it’s not too old, then use this file
- If it’s too old, or doesn’t exist, then generate a new condensed file and return the URL to it.
So let’s start:
|
1 2 3 4 5 6 7 8 |
class CodonCondenser
{
public $path;
public $url;
public $timeout = 24;
public $file_ext = '';
public $filename;
} |
Our basic class, with the settings. Next is our function to set these options:
|
1 2 3 4 5 6 7 |
public function SetOptions($path, $url, $file_ext, $timeout=24)
{
$this->path = $path;
$this->url = $url;
$this->timeout = $timeout;
$this->file_ext = $file_ext;
} |
We pass the $path, which is the absolute path to the files, and $url, which is the path to where the file is will be publicly accessible.
$file_ext is the extension of the condensed file (js, css, htm, etc), and $timeout is the time that the condensed file is considered ‘fresh’. Passing this as blank ($timeout=’’), will disable the time check.
Next is our function to check the cached version. We’ll return true or false if the file passed is valid:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
protected function getCachedFile()
{
if(!file_exists($this->path.'/'.$this->filename))
{
return false;
}
# Check if the version that exists
# is older than the timeout we have alloted
# Value of "" skips the time check
if($this->timeout == '')
{
if ((time() - @filemtime($file)) > ($this->timeout*3600))
{
# It is older, so delete it
@unlink($this->path.'/'.$file);
return false;
}
}
# The cache file is ok
return true;
} |
So what we are checking, if the file doesn’t exist, then return false. Next, if the timeout value is blank, just skip the check, and only base it on whether the condensed file exists or not (as we saw the option up above). Otherwise, we check the modification time of the file, and if the current time – the time file created (in seconds), is greater than our timeout value, then return false. If we have 0 (zero) as a timeout value, it will generate a new file every time.
Note that the function is protected, so we can’t access it directly, and instead, go through the main function:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
public function GetCondensedFile($files, $filename='')
{
if($filename != '')
{
$this->filename = $filename;
}
else
{
$this->filename = md5(implode('',$files));
$this->filename .= '.'.$this->file_ext;
}
} |
First, here we are checking if we passed an optional filename. I use the filename option, depending on whether it’s being used in the admin area, or in the front-end client area. I’ll explain this later.
Otherwise, we will build a filename, we check for the cached file, using the function above:
|
1 2 3 4 5 6 |
# Check if we've already made this condensed cache file
# If we have, then just give the URL of that file
if($this->getCachedFile() == true)
{
return $this->url.'/'.$this->filename;
} |
If the getCachedFile() returns true, that mean’s that the cached file is okay, and we exit and just return the full URL path to the condensed file. If it’s not condensed, then we build our condensed file:
|
1 2 3 4 5 6 7 8 9 |
$fp = fopen($this->path.'/'.$this->filename, 'w');
foreach($files as $file)
{
fwrite($fp, file_get_contents($this->path.'/'.$file));
}
fclose($fp);
return $this->url.'/'.$this->filename; |
This is pretty straightforward, we just open the condensed file, and write every file into it, then return the full URL path to the file. So this is how we’ll use it:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
$condenser->SetOptions('/var/www/lib/js', 'http://mysite.com/lib/js', 'js');
$files = array( 'jquery.min.js', 'jquery-ui.js',
'jquery.dimensions.pack.js',
'jquery.form.js', 'jqModal.js',
'jquery.bigiframe.js',
'jquery.sparklines.js',
'jquery.autocomplete.js',
'jquery.tablesorter.pack.js',
'jquery.tablesorter.pager.js',
'jquery.metadata.js', 'jquery.impromptu.js',
'jquery.listen-min.js', 'nicEdit.js');
$url = $condenser->GetCondensedFile($files); |
And then to link the Javascript into our page:
|
1 |
<script type="text/javascript" src="<?php echo $url?>"></script> |
Our result in the end:
14 less requests! Almost half the number of requests. Woohoo! While it’s a basic class, and we can certainly expand it by adding features such as compression (such as implementing JSMin-PHP into), to minify and pack the JS. Be careful if your JS files are already packed if you re-pack them, it could cause errors. I use files that have already been packed, and merge them together this way.
You can also use this for HTML files, CSS, any other text files which are all brought in together in separate requests.
