This repository contains Aspose.Words Cloud SDK for PHP source code. This SDK allows you to work with Aspose.Words Cloud REST APIs in your PHP applications quickly and easily, with zero initial cost.
Aspose.Words Cloud
API Reference
- Conversion between various document-related formats (20+ formats supported), including PDF<->Word conversion
- Mail merge and reports generation
- Splitting Word documents
- Accessing Word document metadata and statistics
- Find and replace
- Watermarks and protection
- Full read & write access to Document Object Model, including sections, paragraphs, text, images, tables, headers/footers and many others
- Various changes related to stability and performance
- Various changes related to stability and performance
- Added 'EmbedAttachments' property for PdfSaveOptionsData class.
- Added 'CacheHeaderFooterShapes' property for PdfSaveOptionsData class.
- FileReference structure has been added that allows to determine how the document will be accessed: from the remote storage, or loaded directly in the request.
- The 'AppendDocument' and 'AppendDocumentOnline' methods takes a 'FileReference' instead of an 'href' property.
- Added property 'StartingNumber' for 'PageNumbers' class.
- Added property 'GlobalCultureName' for 'FieldOptions' class.
- CompressDocument method now can handle images.
- Added support to convert password protected document using ConvertDocument API.
- Added optional loadEncoding and password parameters for ConvertDocument API method.
- Expand 'AppendDocument' API method to support 'ImageEntryList' for directly appending images to documents and another images.
- Added 'CompressDocument' API method to support compression and resizing images inside the document for reduce the size of the document.
- Added 'DeleteBookmark' and 'DeleteBookmarkOnline' API methods for delete bookmarks by name from the document.
- Added 'DeleteBookmarks' and 'DeleteBookmarksOnline' API methods for delete all bookmarks from the document.
- Added 'InsertBookmark' and 'InsertBookmarkOnline' API methods for create new bookmarks in the document.
- Support all save formats for 'CreateDocument' operation.
- Internal API fixes and improvments.
- Added ExportShapesAsSvg to HtmlSaveOption.
- Added new endpoint '~/styles/copy_from'.
- Online methods returns the dictionary of files with included original filename as key instead of single file content in responses.
- Parameters contained sensitive data should be passed in encrypted form. Names of the parameters have 'encrypted' prefix.
- Added Encrypt method to encrypt data on the API public key. Use it to prepare values for parameters required encrypted data.
- Changed type of enumerations for members of SaveOptionsData and other inherited classes from string to enum.
- Made 'SaveOprionsData.SaveFormat' property readonly with default value.
- Added subclasses for all formats of SaveOprionsData with specified SaveFormat.
- 'SaveOptionsData', 'FixedPageSaveOptionsData', 'ImageSaveOptionsData', 'OoxmlSaveOptionsData', 'TxtSaveOptionsBaseData' classes now is abstract.
- Added 'FieldOptions.FieldUpdateCultureName' to set Culture for fields
- Added 'DocumentEntry.Password' to set an encrypted password for appending document
- Added 'encryptedPassword2' query parameter to CompareDocuments to set an encrypted password for the second comparing document
- Added FieldOptions parameter to mail merge operations
- Added timeout parameter to api configuration
- Added dependsOn and resultOf features for batch requests
- Added query parameter 'displayIntermediateResults' for batch requests. If 'false', the last response in batch will be returned only. Default is 'true'
- Support encryption of 'CommonRequest.Password'. Automatic encryption of all passwords sent to the API server as request parameters.
- Removed 'GraphicsQualityOptions' image save option as it no longer supported.
- Added query parameter 'displayIntermediateResults' for batch requests. If 'false', the last response in batch will be returned only. Default is 'true'
- Added 'JsonDataLoadOptions' and 'XmlDataLoadOptions' to 'ReportEngineSettings'
- Added new api methods to get, insert, update or delete custom xml parts from documents.
- Added parameter 'ResultDocumentFormat' to Compare API
- Added 'ExportLanguageToSpanTag' pdf save option
- Added 'FlatOpcXmlMappingOnly' save option
- ImlRenderingMode option introduced witch is used to determine how ink (InkML) objects are rendered
- MaxCharactersPerLine option introduced which is used to specify the maximum number of characters per one line
- Added new API method to get a RSA public key to encrypt document passwords
- Added encryptedPassword common query option to pass an encrypted document password
- Implemented beta version of CompareDocumentOnline feature with both document sending in request
- CompareDocument method now can handle PDF files
- AcceptAllRevisionsBeforeComparison option introduced which is used to specify if accept all revisions before comparison
- Update dependencies in sdk
- Removed obsolete pdf save option 'EscapeUri'
- SaveOptions now contains CustomTimeZoneInfo to set custom timezone when SdtType.Date structured document tag updated from custom XML
- Url of child requests in batch can be full now (earlier it can be only relative)
- Added 'RquestId' header to all responses
- Added 'UpdateCreatedTimeProperty' save option
- Added Tables into HeaderFooter so it's possible to address paragraphs inside table which is located in headerfooter (sections/0/headersfooters/1/tables/0/rows/0/cells/0/paragraphs/0)
- Added delete all comments method
- Added online version for all API methods
- In configuration json file appSid / appKey has been replaced to clientId / clientSecret.
- In Words API initialization methods clientId parameter precedes clientSecret parameter.
- Internal API changes.
- Added Batch API feature
- Added new api method (PUT '/words/{name}/compatibility/optimize') which is allows to optimize the document contents as well as default Aspose.Words behavior to a particular versions of MS Word
- Added 'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments' option to 'DocumentEntryList' for AppendDocument API
- WithoutNodePath methods have been removed, pass null values instead
- Added 'Markdown' save format
- Added endpoint to update paragraph format without node path (PUT '/words/{name}/paragraphs/{index}/format')
- Added new methods:
- DeleteAllParagraphTabStopsWithoutNodePath
- DeleteParagraphTabStopWithoutNodePath
- GetParagraphTabStopsWithoutNodePath
- InsertOrUpdateParagraphTabStopWithoutNodePath
- InsertParagraphWithoutNodePath
- UpdateParagraphFormatWithoutNodePath
- UpdateParagraphListFormatWithoutNodePath
- DeleteParagraphListFormatWithoutNodePath
- DrawingObject related methods have been changed body content. Special request classes are introduced instead of strings.
- InsertOrUpdateParagraphTabStop, DeleteParagraphTabStop methods have been changed parameter order
- OoxmlSaveOptionsData.CompressionLevel property has been added
- Added methods to work with Word document lists
- GetLists
- GetList
- InsertList
- UpdateList
- UpdateListLevel
- Added methods to work with styles
- GetStyles
- UpdateStyle
- InsertStyle
- CopyStyle
- GetStyleFromDocumentElement
- ApplyStyleToDocumentElement
- Added methods to work with paragraph list format
- GetParagraphListFormat
- GetParagraphListFormatWithoutNodePath
- UpdateParagraphListFormat
- DeleteParagraphListFormat
- Added methods to work with paragraph tab stops
- GetParagraphTabStops
- InsertOrUpdateParagraphTabStop
- DeleteAllParagraphTabStops
- DeleteParagraphTabStop
- Added methods to build reports
- BuildReport
- BuildReportOnline
- Added Shading property to ParagraphFormat
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 (recommended). For more details, please visit our documentation website.
To use Aspose Words Cloud PHP SDK you need to register an account with Aspose Cloud and lookup/create App Key and SID at Cloud Dashboard. There is free quota available. For more details, see Aspose Cloud Pricing.
aspose-words-cloud is available on Packagist as the
aspose-words-cloud package. Run the following command:
composer require aspose-cloud/aspose-words-cloudTo use the SDK, use Composer's autoload:
require_once('vendor/autoload.php'); // Start README example
$api = new WordsApi($clientId, $clientSecret);
// the step is optional, the default value is https://api.aspose.cloud
$api->getConfig()->setHost($baseUrl);
// upload file to cloud
$upload_request = new Requests\UploadFileRequest($localFilePath, 'fileStoredInCloud.doc');
$upload_result = $api->uploadFile($upload_request);
// save as pdf file
$saveOptions = new PdfSaveOptionsData(array("file_name" => 'destination.pdf'));
$request = new Requests\SaveAsRequest('fileStoredInCloud.doc', $saveOptions);
$result = $api->saveAs($request);
// End README exampleTests contain various examples of using the SDK.
- PHP 7.1 or later
- referenced packages (see here for more details)
New SDK has the following advantages over the previous version:
- SDK is fully in sync with the API, all missing methods are added
- Classes, methods and properties have comments and are IDE-friendly
- Better security
- Usage of Request/Response classes to represent long lists of parameters. This allows for cleaner code and easier backwards-compatibility going forward
New SDK is not backwards compatible with previous generation because of the last item. It should be straightforward to convert your code to using Request/Response objects, if you need any help on migration please ask at Free Support Forums.
All Aspose.Words Cloud SDKs, helper scripts and templates are licensed under MIT License.
Your feedback is very important to us. Please feel free to contact us using our Support Forums.
Website
Product Home
API Reference
Documentation
Blog
We generate our SDKs in different languages so you may check if yours is available in our list.
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.