Skip to content

Commit 58e47b9

Browse files
babar-razababar-raza
authored
Standardized readme.md
1 parent 4f24c6a commit 58e47b9

1 file changed

Lines changed: 74 additions & 50 deletions

File tree

‎README.md‎

Lines changed: 74 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,64 @@
1-
# GroupDocs.Conversion Cloud SDK for PHP
1+
![](https://img.shields.io/badge/api-v2.0-lightgrey) ![Packagist Version](https://img.shields.io/packagist/v/groupdocscloud/groupdocs-conversion-cloud) ![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/groupdocscloud/groupdocs-conversion-cloud) [![GitHub license](https://img.shields.io/github/license/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php)](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php/blob/master/LICENSE)
22

3-
This repository contains GroupDocs.Conversion Cloud SDK for PHP source code. This SDK allows you to work with GroupDocs.Conversion Cloud REST APIs in your PHP applications.
3+
# PHP SDK to Convert Documents in the Cloud
44

5-
## Dependencies
5+
[GroupDocs.Conversion Cloud SDK for PHP](https://products.groupdocs.cloud/conversion/php) wraps GroupDocs.Conversion RESTful APIs so you may integrate **Document Conversion** features in your own apps with zero initial cost.
66

7-
- PHP 5.5 or later
7+
GroupDocs.Conversion Cloud API allows the developers to convert between 50+ file formats including Word documents, Excel spreadsheets, PowerPoint presentations, PDF, OpenDocument files, images & more.
88

9-
## Authorization
9+
## Document Conversion REST API
1010

11-
To use SDK you need AppSID and AppKey authorization keys. You can get your AppSID and AppKey at <https://dashboard.groupdocs.cloud> (free registration is required).
11+
- Convert the whole document to the desired target format.
12+
- Convert specific document page(s) or a page range.
13+
- Auto-detect source document format without requiring the file extension.
14+
- Load source document with extended options, such as specify password for password-protected documents.
15+
- Load specific part of the document.
16+
- Show or hide document comments.
17+
- Obtain all supported conversion formats list.
18+
- Replace missing fonts with any other font.
19+
- Add text or image watermarks to any page.
20+
- Specify resolution and quality for resultant images.
21+
- Extract metadata & basic information about the source document.
22+
- Integrated storage API.
1223

13-
## Installation & Usage
24+
Check out the [Developer's Guide](https://docs.groupdocs.cloud/conversion/developer-guide/) to know more about GroupDocs.Conversion REST API.
1425

15-
### Composer
26+
## Microsoft File Formats
1627

17-
The package is available at [Packagist](https://packagist.org/) and it can be installed via [Composer](http://getcomposer.org/) by executing following command:
28+
**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX\
29+
**Microsoft Excel:** XLS, XLSX, XLSB, XLSM\
30+
**Microsoft PowerPoint:** PPT, PPTX, PPS, PPSX\
31+
**Microsoft Project:** MPP, MPT\
32+
**Microsoft Outlook:** MSG, EML\
33+
**Microsoft Visio:** VSD, VDX, VSS, VSX, VST, VTX, VSDX, VDW, VSSX, VSTX, VSDM, VSTM, VSSM\
34+
**Microsoft OneNote:** ONE
35+
36+
## Other Formats
37+
38+
**Page Layout Formats:** PDF, XPS\
39+
**OpenDocument:** ODT, OTT, ODS, ODP, OTP, OTS, ODG\
40+
**CAD:** DXF, DWG, IFC, STL\
41+
**Images:** DCM, BMP, GIF, JPG, PNG, TIFF, WebP, DjVu, SVG, DNG, ICO\
42+
**Web:** HTML, MHT, MHTML\
43+
**Emails:** EML, EMLX\
44+
**eBooks:** EPUB, MOBI\
45+
**Metafile:** WMF, EMF\
46+
**LaTeX:** TEX\
47+
**Others:** TXT, RTF, CSV, TSV, XML
48+
49+
## Get Started with GroupDocs.Conversion Cloud SDK for PHP
50+
51+
First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, follow the installation steps as given below.
52+
53+
### Install via Composer
54+
55+
The package is available at [Packagist](https://packagist.org/) and it can be installed via [Composer](http://getcomposer.org/) by executing following command.
1856

1957
```shell
2058
composer require groupdocscloud/groupdocs-conversion-cloud
2159
```
2260

23-
Or you can install SDK via [Composer](http://getcomposer.org/) directly from this repository, add the following to `composer.json`:
61+
You can also install the package directly from this repository. Add the following to `composer.json`, then run `composer install`.
2462

2563
```javascript
2664
{
@@ -36,67 +74,53 @@ Or you can install SDK via [Composer](http://getcomposer.org/) directly from thi
3674
}
3775
```
3876

39-
Then run `composer install`
40-
41-
### Manual Installation
77+
### Install Manually
4278

43-
Clone or download this repository, then run `composer install` in the root directory to install dependencies and include `autoload.php` into your code file:
79+
Clone or download this repository, then run `composer install` in the root directory to install dependencies and include `autoload.php` into your code file.
4480

4581
```php
4682
require_once('/path/to/groupdocs-conversion-cloud-php/vendor/autoload.php');
4783
```
4884

49-
## Tests
85+
### Tests
5086

51-
To run the unit tests set your AppSID and AppKey in [json.config](tests/GroupDocs/Conversion/config.json) and execute following commands:
87+
Set your application information in [json.config](tests/GroupDocs/Conversion/config.json) and execute the following command to run the unit tests.
5288

5389
```shell
5490
php composer.phar install ./vendor/bin/phpunit
5591
```
5692

57-
## Getting Started
58-
59-
Please follow the [installation procedure](#installation--usage) and then run the following:
93+
## Convert DOCX to PDF in the Cloud
6094

6195
```php
62-
<?php
96+
// Get application information from https://dashboard.groupdocs.cloud
97+
use GroupDocs\Conversion\Model;
98+
use GroupDocs\Conversion\Model\Requests;
6399

64-
require_once(__DIR__ . '/vendor/autoload.php');
100+
$AppSid = "";
101+
$AppKey = "";
65102

66-
//TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
67103
$configuration = new GroupDocs\Conversion\Configuration();
68-
$configuration->setAppSid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
69-
$configuration->setAppKey("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");
70-
71-
$api = new GroupDocs\Conversion\InfoApi($configuration);
104+
$configuration->setAppSid($AppSid);
105+
$configuration->setAppKey($AppKey);
72106

73-
try {
74-
$request = new GroupDocs\Conversion\Model\Requests\GetSupportedConversionTypesRequest();
75-
$response = $api->getSupportedConversionTypes($request);
107+
$apiInstance = new GroupDocs\Conversion\ConvertApi($configuration);
76108

77-
foreach($response as $key => $format) {
78-
echo $format->getSourceFormat();
79-
}
80-
} catch (Exception $e) {
81-
echo "Something went wrong: ", $e->getMessage(), "\n";
82-
PHP_EOL;
83-
}
109+
// Prepare convert settings
110+
$settings = new Model\ConvertSettings();
111+
$settings->setFilePath("WordProcessing/four-pages.docx");
112+
$settings->setFormat("pdf");
113+
$settings->setOutputPath("converted");
84114

85-
?>
115+
// Convert
116+
$result = $apiInstance->convertDocument(new Requests\ConvertDocumentRequest($settings));
86117
```
87118

88-
## Licensing
89-
90-
GroupDocs.Conversion Cloud SDK for PHP is licensed under [MIT License](LICENSE).
91-
92-
## Resources
93-
94-
+[**Website**](https://www.groupdocs.cloud)
95-
+[**Product Home**](https://products.groupdocs.cloud/conversion)
96-
+[**Documentation**](https://docs.groupdocs.cloud/conversion)
97-
+[**Free Support Forum**](https://forum.groupdocs.cloud/c/conversion)
98-
+[**Blog**](https://blog.groupdocs.cloud/category/conversion)
119+
## GroupDocs.Conversion Cloud SDKs in Popular Languages
99120

100-
## Contact Us
121+
| .NET | Java | PHP | Python | Ruby | Node.js | Android |
122+
|---|---|---|---|---|---|---|
123+
| [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-dotnet) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-java) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-python) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-ruby) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-node) | [GitHub](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-android) |
124+
| [NuGet](https://www.nuget.org/packages/GroupDocs.Conversion-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-conversion-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-conversion-cloud) | [PIP](https://pypi.org/project/groupdocs-conversion-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_conversion_cloud) | [NPM](https://www.npmjs.com/package/groupdocs-conversion-cloud) | |
101125

102-
Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.groupdocs.cloud/c/conversion).
126+
[Home](https://www.groupdocs.cloud/) | [Product Page](https://products.groupdocs.cloud/conversion/php) | [Documentation](https://docs.groupdocs.cloud/conversion/) | [Live Demo](https://products.groupdocs.app/conversion/total) | [API Reference](https://apireference.groupdocs.cloud/conversion/) | [Code Samples](https://github.com/groupdocs-conversion-cloud/groupdocs-conversion-cloud-php-samples) | [Blog](https://blog.groupdocs.cloud/category/conversion/) | [Free Support](https://forum.groupdocs.cloud/c/conversion) | [Free Trial](https://dashboard.groupdocs.cloud)

0 commit comments

Comments
 (0)