README.md

PHPProject

PHPProject is a library written in pure PHP that provides a set of classes to write to different project management file formats, i.e. Microsoft MSProjectExchange (MPX) or GanttProject (GAN). PHPProject is an open source project licensed under the terms of LGPL version 3. PHPProject is aimed to be a high quality software product by incorporating continuous integration and unit testing. You can learn more about PHPProject by reading the Developers' Documentation and the API Documentation.

Read more about PHPProject:

• Features
• Requirements
• Installation
• Getting started
• Known issues
• Contributing
• Developers' Documentation
• API Documentation

Features

• Create an in-memory project management representation
• Set file meta data (author, title, description, etc)
• Add resources from scratch or from existing one
• Add tasks from scratch or from existing one
• Output to different file formats: MSProjectExchange (.mpx), GanttProject (.gan)
• ... and lots of other things!

Requirements

PHPProject requires the following:

• PHP 5.3+
• XML Parser extension

Installation

It is recommended that you install the PHPProject library through composer. To do so, add the following lines to your composer.json.

{
    "require": {
       "phpoffice/phpproject": "dev-master"
    }
}

Alternatively, you can download the latest release from the releases page. In this case, you will have to register the autoloader. Register autoloading is required only if you do not use composer in your project.

require_once 'path/to/PhpProject/src/PhpProject/Autoloader.php';
\PhpOffice\PhpProject\Autoloader::register();

Getting started

The following is a basic usage example of the PHPProject library.

require_once 'src/PhpProject/Autoloader.php';
\PhpOffice\PhpProject\Autoloader::register();

$objPHPProject = new PhpProject();$objPHPProject = new PhpProject();

// Create resource
$objRes1 = $objPHPProject->createResource();
$objRes1->setTitle('UserBoy');

// Create a task
$objTask1 = $objPHPProject->createTask();
$objTask1->setName('Start of the project');
$objTask1->setStartDate('02-01-2012');
$objTask1->setEndDate('03-01-2012');
$objTask1->setProgress(0.5);
$objTask1->addResource($objRes1);

$oWriterGAN = IOFactory::createWriter($objPHPPowerPoint, 'GanttProject');
$oWriterGAN->save(__DIR__ . "/sample.gan");

More examples are provided in the samples folder. You can also read the Developers' Documentation and the API Documentation for more details.

Contributing

We welcome everyone to contribute to PHPProject. Below are some of the things that you can do to contribute:

• Read our contributing guide
• Fork us and request a pull to the develop branch
• Submit bug reports or feature requests to GitHub
• Follow @PHPOffice on Twitter