Skip to content

Commit 575b637

Browse files
authored
Standardized readme.md
1 parent f442322 commit 575b637

File tree

1 file changed

+53
-47
lines changed

1 file changed

+53
-47
lines changed

README.md

Lines changed: 53 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,68 @@
1-
# Aspose.Tasks Cloud SDK for PHP
2-
This repository contains Aspose.Tasks Cloud SDK for PHP source code. This SDK allows you to work with Aspose.Tasks Cloud REST APIs in your PHP applications quickly and easily, with zero initial cost.
1+
![](https://img.shields.io/badge/api-v3.0-lightgrey) ![Packagist Version](https://img.shields.io/packagist/v/aspose/tasks-sdk-php) ![Packagist Downloads](https://img.shields.io/packagist/dt/aspose/tasks-sdk-php) ![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/aspose/tasks-sdk-php) [![GitHub license](https://img.shields.io/github/license/aspose-tasks-cloud/aspose-tasks-cloud-php)](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-php/blob/master/LICENSE) ![GitHub last commit](https://img.shields.io/github/last-commit/Aspose-tasks-Cloud/aspose-tasks-cloud-php)
32

4-
[Aspose.Tasks Cloud](https://products.aspose.cloud/tasks/family "Aspose.Tasks Cloud")
5-
[API Reference](https://apireference.aspose.cloud/tasks/)
3+
# PHP SDK to Manage Tasks in the Cloud
64

7-
## Key Features
8-
* Conversion between various file formats, including MPP->PDF conversion
9-
* Read, change and write Microsoft Project® documents
10-
* Create, update and write projects in XML project format
11-
* Manage extended attributes
12-
* Define weekdays for calendars and calendar exceptions
13-
* Manage task baseline scheduling and duration
14-
* Create and manage links between tasks
15-
* Manage resources costs and variances
16-
* Access assignment costs and budget
5+
Aspose.Tasks for Cloud offers the ability to manipulate and convert Microsoft Project MPT, MPP, MPX & Oracle Primavera XER, XML, and PrimaveraP6XML files in the Cloud. [Aspose.Tasks Cloud SDK for PHP](https://products.aspose.cloud/tasks/php) wraps the REST API to make it easier for PHP developers to integrate Task Management features in their own PHP applications.
176

18-
## How to use the SDK?
19-
The complete source code is available in this repository folder. You can either directly use it in your project via source code or get [Packagist distribution](https://packagist.org/packages/aspose/tasks-sdk-php) (recommended). For more details, please visit our [documentation website](https://docs.aspose.cloud/tasks/available-sdks/).
7+
## REST API for Task Management
208

21-
### Prerequisites
9+
* [Convert Microsoft Project & Oracle Primavera files](https://docs.aspose.cloud/tasks/convert-project-document-to-the-specified-format/) to other formats including MPP to PDF conversion.
10+
* Read, change and write Microsoft Project documents.
11+
* Create, update and write projects in XML project format.
12+
* Manage extended attributes.
13+
* [Define weekdays for calendars](https://docs.aspose.cloud/tasks/working-with-calendars/) and calendar exceptions.
14+
* [Manage tasks](https://docs.aspose.cloud/tasks/working-with-tasks/), baseline scheduling and duration.
15+
* Create and [manage task links](https://docs.aspose.cloud/tasks/working-with-task-links/).
16+
* Manage resources costs and variances.
17+
* Access assignment costs and budget.
2218

23-
To use Aspose Tasks for Cloud PHP SDK you need to register an account with [Aspose Cloud](https://www.aspose.cloud/) and lookup/create App Key and SID at [Cloud Dashboard](https://dashboard.aspose.cloud/#/apps). There is free quota available. For more details, see [Aspose Cloud Pricing](https://purchase.aspose.cloud/pricing).
19+
## Read & Write Project Data
2420

25-
### Installation
21+
**Microsoft Project** MPP, XML, MPT **Primavera** MPX
22+
23+
## Save Project Data As
24+
25+
XER, XLSX, HTML, XML, TXT, TIF, SVG, PNG, JPEG
26+
27+
## Get Started with Aspose.Tasks Cloud SDK for PHP
28+
29+
Register an account at [Aspose Cloud Dashboard](https://dashboard.aspose.cloud/#/apps) to get you application information. Next, either directly use the source from this repository in your project or get the package from [Packagist distribution](https://packagist.org/packages/aspose/tasks-sdk-php).
30+
31+
### Install Via Composer
32+
33+
Aspose.Tasks Cloud SDK for PHP is available at Packagist. Run the following command to get it through Composer.
2634

27-
#### Via Composer:
28-
*aspose-tasks-cloud-php* is available on Packagist as the
29-
[`tasks-sdk-php`](https://packagist.org/packages/aspose/tasks-sdk-php) package. Run the following command:
3035
```bash
3136
composer require aspose/tasks-sdk-php
3237
```
33-
34-
To use the SDK, use Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading):
38+
Run Composer's [autoload](https://getcomposer.org/doc/00-intro.md#autoloading) to start using the SDK.
3539

3640
```php
3741
require_once('vendor/autoload.php');
3842
```
43+
See [composer.json](composer.json) for details about the referenced packages.
44+
45+
## Convert MPP to CSV in the Cloud
46+
47+
```php
48+
$remoteName = "GetDocumentInCsvFormat.mpp";
49+
$folder = $this->uploadFile("template.mpp", $remoteName, '');
50+
51+
$response = $this->tasks->getTaskDocumentWithFormat(new GetTaskDocumentWithFormatRequest($remoteName,
52+
Model\ProjectFileFormat::CSV, false, self::$storageName, $folder));
53+
54+
Assert::assertNotNull($response);
55+
Assert::assertEquals("ID;Task_Name;Outline_Level;Duration;Start_Date;Finish_Date;Percent_Comp;Cost;Work\r\n", $response->current());
56+
$response->next();
57+
Assert::assertEquals("1;Five to Eight Weeks Before Moving;1;16 days;Thu 01.01.04 08:00;Thu 22.01.04 17:00;0%;$0;0 hrs\r\n", $response->current());
58+
59+
```
60+
61+
## Aspose.Tasks Cloud SDKs in Popular Languages
62+
63+
| .NET | PHP | Python | Node.js |
64+
|---|---|---|---|
65+
| [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-dotnet) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-php) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-python) | [GitHub](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-node) |
66+
| [NuGet](https://www.nuget.org/packages/Aspose.Tasks-Cloud/) | [Composer](https://packagist.org/packages/aspose/tasks-sdk-php) | [PIP](https://pypi.org/project/aspose-tasks-cloud/) | [NPM](https://www.npmjs.com/package/@asposecloud/aspose-tasks-cloud) |
3967

40-
## Dependencies
41-
- PHP 7.1 or later
42-
- referenced packages (see [here](composer.json) for more details)
43-
44-
## Licensing
45-
46-
All Aspose.Tasks Cloud SDKs, helper scripts and templates are licensed under [MIT License](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-php/blob/master/LICENSE).
47-
48-
## Contact Us
49-
Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.aspose.cloud/c/tasks).
50-
51-
## Resources
52-
53-
[Website](https://www.aspose.cloud/)
54-
[Product Home](https://products.aspose.cloud/tasks/family)
55-
[API Reference](https://apireference.aspose.cloud/tasks/)
56-
[Documentation](https://docs.aspose.cloud/tasks/)
57-
[Blog](https://blog.aspose.cloud/category/tasks/)
58-
59-
## Other languages
60-
We generate our SDKs in different languages so you may check if yours is available in our [list](https://github.com/aspose-tasks-cloud).
61-
62-
If you don't find your language in the list, feel free to request it from us, or use raw REST API requests as you can find it [here](https://products.aspose.cloud/tasks/curl).
68+
[Home](https://www.aspose.cloud) | [Product Page](https://products.aspose.cloud/tasks/php) | [Documentation](https://docs.aspose.cloud/tasks/) | [Live Demo](https://products.aspose.app/tasks/family) | [API Reference](https://apireference.aspose.cloud/tasks/) | [Code Samples](https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-dotnet/tree/master/Aspose.Tasks.Cloud.Sdk.Tests) | [Blog](https://blog.aspose.cloud/category/tasks/) | [Free Support](https://forum.aspose.cloud/c/tasks) | [Free Trial](https://dashboard.aspose.cloud/#/apps)

0 commit comments

Comments
 (0)