Pluf Installation

Pluf is written in the PHP scripting language. You need version 5.2.4 of PHP to use Pluf without any troubles¹.

The motto of Pluf is to develop in a DRY way and avoid the Non Invented Here syndrom by reusing well developed components from the standard PHP library.

The standard PHP library is PEAR and Pluf is using some of the PEAR components.

Installation Steps

1. Download the latest version of Pluf from the Pluf website.

2. Extract the archive somewhere on your system.

3. Ensure that you have PEAR installed with the Mail and Mail_Mime components. These components can usually be installed using the following commands:

   $ sudo pear install -a Mail
   $ sudo pear install -a Mail_Mime
   

4. Done! Yes, no obscure commands to run. You will run some of them when installting an application using both Pluf and the database, but no need for the base Pluf files.

Use Pluf in Your Scripts

You need to include the Pluf.php file and have the folder in which this file is in your include path of your script:

<?php
set_include_path(get_include_path().PATH_SEPARATOR.'/path/to/pluf/src');
require 'Pluf.php';
// now you can initialize the framework with a 
// given configuration file
Pluf::start('/path/to/config.php');

Read more about the layout of a Pluf application.

PEAR Compatibility

PEAR is nice, but some of the PEAR modules to do not follow the latest PHP 5 developments. To ensure that your application is running smoothly with PEAR, you need to provide the path to PEAR in your application config file.

On Ubuntu/Debian, Pluf will detect the PEAR path automatically, on OSX with MAMP, you need to add the following line to your config file:

$cfg['pear_path'] = '/Applications/MAMP/bin/php5/lib/php';

On Windows with XAMPP, you may need (not tested, take only from the documentation) to add:

$cfg['pear_path'] = 'C:\\xampp\php';

Report issues in the documentation

If you find errors or issues in the documentation, report a bug. We will update the documentation accordingly.