Installation / Configuration

XDebug is a debugging component which can be added as a module to PHP using PECL. To install XDebug (if you havent’t used my tutorial yet) simply use the following code:

1

pecl install xdebug

Now you need to configure XDebug. As a default configuration you should put the following into /etc/php5/conf.d/xdebug.ini:

1
2
3

xdebug.profiler_enable_trigger = 1
xdebug.profiler_enable=0
xdebug.profiler_output_dir = /tmp

The first line enables the profiler by using a trigger. The trigger is a GET/POST parameter called XDEBUG_PROFILE=1 you can use whenever you start a local page via your webbrowser.

The second line enables the profiler by default and would create a profiler output file without a trigger parameter. We don’t want to do that all the time, so the value here is 0. If you want to enable your profiler the whole time, just put a 1 in there.

The third parameter is the path of the directory you want to write your profiler output files to. I’ve inserted /tmp as a default here, but you can change it to any other directory your webserver has write access to.

So an example URL to access a local webpage and create a profile output would be something like this:
http://localhost/index.php?XDEBUG_PROFILE=1

There should be a cachegrind file in your output dir, e.g. cachegrind.out.12345

The number at the end of the filename is the apache pid. The name of the cachegrind file can be configured using another parameter, xdebug.profiler_output_name. A complete documentation of all possibilities can be found here.

Displaying the profile data

There are several tools to analyze the data created by the XDebug profiler. One of these tools is KCachegrind. KCachegrind visualizes traces generated by profiling, including a tree map and a call graph visualization of the calls happening.

As an example: you can analyze how often certain heavy-load methods are called within your application; that way you can find ways to minimize those calls, reduce them to a pure minimum and increase the performance of the application or website.

Alternative visualization tools for different platforms and operating systems are also available, e.g. MacCallGrind für MacOS. A web based solution would be Webgrind, hosted on Google Code.

Installation of System

First of all you have install from scratch, which means putting the CD-Rom in your drive or create a VirtualBox and use the ISO file as mount. Then just follow the menu to install Ubuntu.

After basic installation

Start by opening a console window and become superuser:

1

sudo -i

After that update your package list and upgrade all packages with available updates:

1
2

apt-get update
apt-get upgrade

In case you are using a VirtualBox environment, you have to restart the system and boot up again. After that open a console again and get superuser rights:

1

sudo -i

Then you should install VirtualBox Guest Extensions:

1
2

cd /cdrom
./VBoxLinuxAdditions-x86.run

Installation of LAMP environment

To test your code base you need a working webserver environment with PHP and MySQL Client / Server. If you want to use a separate MySQL Server for your databases then you can skip installing the MySQL Server.

First we start with Apache2:

1
2
3
4
5

apt-get install build-essential
apt-get install apache2 apache2-threaded-dev
a2enmod ssl
a2enmod rewrite
a2enmod include

a2enmod is used to activate apache2 modules like mod_ssl, mod_rewrite and mod_include.

To use php5-curl later, you need to install curl first:

1

apt-get install curl

Now it’s time for PHP5:

First we install some (more or less) necessary PHP5 packages (including imagemagick):

1
2
3

apt-get install php5 php5-cli php5-dev php-pear
apt-get install imagemagick
apt-get install php5-gd php5-mcrypt php5-imagick php5-curl php5-xmlrpc php5-xsl php5-mhash

The php5-dev package contains phpize which is necessary for installing and compiling PEAR/PECL extensions for PHP.

Since you might want to use PEAR packages, an upgrade of the channels and already installed packges is advised:

1
2

pear channel-update pear.php.net
pear upgrade-all

Some recommended PEAR packages include:

Template Engines:

1

pear install HTML_QuickForm HTML_Common HTML_Template_Sigma

PHP-Unit:

1
2
3
4
5

pear channel-discover pear.phpunit.de
pear remote-list -c phpunit
pear install phpunit/PHPUnit
pear channel-discover components.ez.no
pear install phpunit/phpcpd

Now the MySQL part:

You can either use standard MySQL/MySQLi or PDO. Since PHP 5.1 PDO comes preinstalled. To install everything just do the following:

1
2
3

apt-get install mysql-client mysql-server libmysqlclient15-dev
apt-get install mysql-query-browser mysql-admin
apt-get install php5-mysql

Those packages include MySQL Query Browser and MySQL Administrator which are quite handy tools to manage MySQL databases and tables.

For debugging your code (e.g. from the Eclipse environment) you have to install XDebug:

1

apt-get install php5-xdebug

As a default configuration you should put the following into /etc/php5/conf.d/xdebug.ini:

1
2
3
4
5
6
7
8

xdebug.profiler_enable_trigger = 1
xdebug.profiler_enable=0
xdebug.profiler_output_dir = /tmp
xdebug.remote_enable=On
xdebug.remote_host=127.0.0.1
xdebug.remote_port=9000
xdebug.remote_handler="dbgp"
xdebug.remote_log="/tmp/xdebug.log"

This enables you to use XDebug as profiler (by using the parameter XDEBUG_PROFILE=1 as GET/POST parameter when executing your website). It creates a cachegrind file to be analysed (e.g. with kCacheGrind, I will explain that in another tutorial).

At the end don’t forget to reload Apache2 before starting to work with your system:

1

apache2ctl restart

Now the most important stuff is installed. You might want to install Subversion:

1

apt-get install subversion

but I will not go into details about using that here.

Applications

To use Eclipse, Aptana or Zend Studio (if you have a license) you need a Java Runtime Engine. Best is to install the default-jre:

1

apt-get install default-jre

Now you just need to download your favorite IDE (e.g. Eclipse) and you can start developing your applications. Some hints to do that:

• you can run your local webserver with your user account, just change it in /etc/apache2/envvars
• to use PEAR packages you need to uncomment the include_path part for linux based operating systems in /etc/php5/apache2/php5.ini.

I have started to toy around with it. I have written a mayor part of the current AdWords API integration for the company I work for, so it’s best to be prepared for the mayor overhaul Google has done with this new API implementation. Here is a quick overview and some thoughts I have about it.

Authentication

Google seems to unify the use of their APIs with a common login interface: the Account Authentication API. You can make a HTTPS Post Request to the API and use your Google credentials to get an Auth token. This token then will be used to access the functionalities of the API.

I think it is good to unify different kinds of API authentication into a single login service. I just hope that it is stable enough to endure all the load from not just one kind of service but every piece of Google API which will make use of it.

Accessing the Sandbox

I created some example codes (will publish some code in another article soon) to access the Google AdWords Sandbox. At first I had some difficulties because I don’t just use the examples from Google, I created my own kind of library to access the API. That lead to the assumption that I can always use the SOAP end url as namespace – which was wrong because the namespace for the request XML has to be

https://adwords.google.com/api/adwords/cm/v200902

while the actual xml request is being sent to

https://adwords-sandbox.google.com/api/adwords/cm/v200902/....

When sending the wrong namespace the API returns a server error, but no detailed error code about what kind of error occured. I hope Google will improve their error reporting there.

Get & Mutate – the new methods of getting data and manipulating data

Past versions of the AdWords API left the impression of a patchwork API. This time you basically have two functions:

get

Getting data is simple: just build an xml which contains all the parameters you need and send it to the API.

Example:

This piece of xml tells the API (assuming the header information with the AuthToken, sorry not posting that one here ) to retrieve all the campaigns in the account. You can limit the campaigns by telling it to only include certain campaign IDs (filling the StatsSelecter/campaignIds node with subnodes containing the actual IDs).

mutate

Mutate is the method to create and manipulate data structures in the API.

Example:

 
  ADD
 
   Test Campaign - 1242726211
   PAUSED
 
    DAILY
 
     EUR
     1000000
 
    STANDARD

It tells the API to create a new campaign in the account defined by the client email in the header (again not posted here). The additional OPERATOR tells what kind of operation (ADD, REMOVE, SET). After that all the necessary data for the operation are being added.

Final words (for now)

I think the new API is very clean and straight forward, with a new authentication method. The problems I currently see is the amount of work necessary to migrate applications based on the existing API v13 to the new v2009, but if people are using frameworks like APIlity or one of the other provided libraries, it is safe to assume that new versions will be available soon after the release to make a smooth upgrade.

I am looking forward to work closely with the new API.

Zend Framework

The Zend Framework is an object-oriented framework which is focusing on web 2.0 applications. It contains a lot of APIs to webservices like Google, Amazon, Yahoo!, Flickr.

CSV Utilities

PHP CSV Utilities or PCU, is a small, open source PHP library to simplify working with CSV files.

phpExcel

This project provides a set of classes, which allow you to write to and read from different file formats, like Excel 2007, PDF, HTML, … This project is built around Microsoft’s OpenXML standard and PHP.

phpQuery

phpQuery is a server-side, chainable, CSS3 selector driven Document Object Model (DOM) API based on jQuery JavaScript Library.

MC_Google_Visualization

MC_Google_Visualization provides simple support for integrating Google Visualization charts and graphs with your own internal database. It includes a complete parser for the Google Visualization Query Language, giving you the same ease of pivoting and formatting data from your database as is currently possible with Google Spreadsheets.

pChart

pChart is a PHP class oriented framework designed to create aliased charts.

FirePHP

FirePHP enables you to log to your Firebug Console using a simple PHP method call.

SimpleTest

The SimpleTest PHP unit tester is a PHP unit test and web test framework. It has support for SSL, forms, frames, proxies and basic authentication.

If you know any more good PHP libraries and tools, just leave a comment.