Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phpoffice/phpproject
A pure PHP library for reading and writing project management files
https://github.com/phpoffice/phpproject
gan mpx msproject office php project
Last synced: 1 day ago
JSON representation
A pure PHP library for reading and writing project management files
- Host: GitHub
- URL: https://github.com/phpoffice/phpproject
- Owner: PHPOffice
- License: other
- Created: 2012-03-13T15:30:14.000Z (almost 13 years ago)
- Default Branch: develop
- Last Pushed: 2018-10-29T10:17:10.000Z (about 6 years ago)
- Last Synced: 2024-04-26T03:03:33.930Z (8 months ago)
- Topics: gan, mpx, msproject, office, php, project
- Language: PHP
- Homepage:
- Size: 2.45 MB
- Stars: 204
- Watchers: 34
- Forks: 140
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING
Awesome Lists containing this project
README
# PHPProject
[](https://packagist.org/packages/phpoffice/phpproject)
[](https://travis-ci.org/PHPOffice/PHPProject)
[](https://scrutinizer-ci.com/g/PHPOffice/PHPProject/)
[](https://scrutinizer-ci.com/g/PHPOffice/PHPProject/)
[](https://packagist.org/packages/phpoffice/phpproject)
[](https://packagist.org/packages/phpoffice/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](http://support.microsoft.com/kb/270139) (MPX) or [GanttProject](http://www.ganttproject.biz) (GAN).
PHPProject is an open source project licensed under the terms of [LGPL version 3](https://github.com/PHPOffice/PHPProject/blob/develop/COPYING.LESSER). PHPProject is aimed to be a high quality software product by incorporating [continuous integration](https://travis-ci.org/PHPOffice/PHPProject) and [unit testing](http://phpoffice.github.io/PHPProject/coverage/develop/). You can learn more about PHPProject by reading the [Developers' Documentation](http://phpproject.readthedocs.org/) and the [API Documentation](http://phpoffice.github.io/PHPProject/docs/develop/).
Read more about PHPProject:
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Getting started](#getting-started)
- [Known issues](#known-issues)
- [Contributing](#contributing)
- [Developers' Documentation](http://phpproject.readthedocs.org/)
- [API Documentation](http://phpoffice.github.io/PHPProject/docs/master/)
### 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](http://www.php.net/manual/en/xml.installation.php)
### Installation
It is recommended that you install the PHPProject library [through composer](http://getcomposer.org/). To do so, add
the following lines to your ``composer.json``.
```json
{
"require": {
"phpoffice/phpproject": "dev-master"
}
}
```
Alternatively, you can download the latest release from the [releases page](https://github.com/PHPOffice/PHPProject/releases).
In this case, you will have to register the autoloader. Register autoloading is required only if you do not use composer in your project.
```php
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.
```php
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](samples/). You can also read the [Developers' Documentation](http://phpproject.readthedocs.org/) and the [API Documentation](http://phpoffice.github.io/PHPProject/docs/master/) 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](https://github.com/PHPOffice/PHPProject/blob/master/CONTRIBUTING.md)
- [Fork us](https://github.com/PHPOffice/PHPProject/fork) and [request a pull](https://github.com/PHPOffice/PHPProject/pulls) to the [develop](https://github.com/PHPOffice/PHPProject/tree/develop) branch
- Submit [bug reports or feature requests](https://github.com/PHPOffice/PHPProject/issues) to GitHub
- Follow [@PHPOffice](https://twitter.com/PHPOffice) on Twitter