README

此仓库包含 Aspose.Words Cloud SDK for PHP 的源代码。此 SDK 允许您快速、轻松地在 PHP 应用程序中使用 Aspose.Words Cloud REST API，且无需初始成本。

Aspose.Words Cloud
API 参考

主要功能

支持各种文档相关格式之间的转换（支持20多种格式），包括 PDF<->Word 转换
邮件合并和报告生成
拆分 Word 文档
访问 Word 文档元数据和统计信息
查找和替换
水印和保护
对文档对象模型（包括部分、段落、文本、图像、表格、页眉/页脚等）的完全读写访问

版本 24.9 的增强功能

为 DOC、DOCX、XPS 或 ODT 文档添加了数字签名方法。
为 XpsSaveOptions 和 HtmlSaveOptions 添加了 ReplaceBackslashWithYenSign 属性。
为 XpsSaveOptions 添加了 DigitalSignature 属性。
为 PdfSaveOptions 添加了 UseSdtTagAsFormFieldName 属性。
将 MergeWholeDocument 参数添加到邮件合并操作中，以在执行带有区域的邮件合并后更新整个文档中的字段。

版本 24.8 的增强功能

添加了对 OpenType 标准的支持。这对于需要高级排版的语言非常有用。

版本 24.7 的增强功能

添加了对 azw3（亚马逊Kindle格式）文档的支持。
为 SvgSaveOptionsData 类添加了 MaxImageResolution 属性。

版本 24.6 的增强功能

添加了将节点 ID 转换为节点路径的 'TranslateNodeId' 方法。

版本 24.5 的增强功能

添加了对多存储操作的支持。可以将操作结果保存到特定存储中，当使用文件路径的以下格式 '@storage:path/to/file.doc' 时。

版本 24.4 的增强功能

添加了将一个部分与下一个部分合并的 'MergeWithNext' 方法。
为 DrawingObjectInsert 和 DrawingObjectUpdate 方法添加了 'LockAspectRatio' 属性。

版本 24.3 的增强功能

为插入 'MailMerge' API 方法中的 'Cleanup' 参数添加了 'RemoveEmptyCells' 选项的支持。

版本 24.1 的增强功能

在插入 API 中添加了对 InsertAfterNode 的支持，无需 NodePath。
在插入 API 中添加了对无需 NodePath 的节点（runs/rows/cells/bookmarks）的支持。
在 Watermark API 中添加了对透明度的支持。
在 FileReference 中添加了对 password 和 encryptedPassword 字段的支持。
修复了文档响应中缺少 href 值的问题。

版本 23.12 的增强功能

在插入书签操作中，将属性名称、文本、StartRange 和 EndRange 标记为必需。
实现了 DeleteOfficeMathObjects 操作，用于从文档中删除所有 Office 数学对象。
从 UnprotectDocument 操作中删除了参数 ProtectionRequest。现在从文档中移除保护不需要密码。
将模型 ProtectionRequest 标记为已弃用，请使用 ProtectionRequestV2 代替以执行 ProtectDocument 操作。要更改受保护文档的密码或保护类型，不需要旧密码。
为加密文档添加了字段“密码”和“加密密码”到FileReference。
从CompareDocument方法中删除了参数encryptedPassword2。请使用FileReference密码代替。

版本23.11的增强功能

支持模型中的必需属性。
对于InsertStyle操作，将属性StyleName标记为必需。
对于CopyStyle操作，将属性StyleName标记为必需。
对于ApplyStyleToDocumentElement操作，将属性StyleName标记为必需。
对于InsertStructuredDocumentTag操作，将属性SdtType和Level标记为必需。
对于InsertParagraph操作，将属性Text标记为必需。
对于CreateOrUpdateDocumentProperty操作，将属性Value标记为必需。
对于ReplaceText操作，将属性NewValue标记为必需。
对于ReplaceWithText操作，将属性Text标记为必需。

版本23.9的增强功能

支持服务器响应中的类继承。

版本23.6的增强功能

修复了Web应用程序中的XMLHttpRequest。

版本23.5的增强功能

添加了InsertSection方法。

版本23.4的增强功能

为RangeApi添加了新的RangeEndIdentifier类型：document:end。

版本23.3的增强功能

修复了CreateDocument API与Dropbox存储之间的兼容性。
修复了FixedPageSaveOptionsData中PageCount属性的兼容性问题。

版本23.2的增强功能

添加了操作来处理文档中的结构化文档标签（SDT）。

版本23.1的增强功能

与稳定性和性能相关的各种更改

版本22.12的增强功能

与稳定性和性能相关的各种更改

版本22.11的增强功能

为PdfSaveOptionsData类添加了'EmbedAttachments'属性。

版本22.10的增强功能

为PdfSaveOptionsData类添加了'CacheHeaderFooterShapes'属性。
添加了FileReference结构，允许确定文档如何访问：从远程存储或直接加载到请求中。
'AppendDocument'和'AppendDocumentOnline'方法现在接受'FileReference'而不是'href'属性。
为'PageNumbers'类添加了'StartingNumber'属性。
为'FieldOptions'类添加了'GlobalCultureName'属性。

版本22.9的增强功能

CompressDocument方法现在可以处理图像。
通过ConvertDocument API添加了对受密码保护的文档的支持。

版本22.8的增强功能

为ConvertDocument API方法添加了可选的loadEncoding和password参数。

版本22.7的增强功能

将'AppendDocument' API方法扩展以支持直接将图像附加到文档中的'ImageEntryList'和其他图像。
添加了'CompressDocument' API方法以支持压缩和调整文档内图像的大小，以减小文档大小。

版本22.6的增强功能

添加了'DeleteBookmark'和'DeleteBookmarkOnline' API方法，用于按名称从文档中删除书签。
添加了'DeleteBookmarks'和'DeleteBookmarksOnline' API方法，用于从文档中删除所有书签。
添加了'InsertBookmark'和'InsertBookmarkOnline' API方法，用于在文档中创建新的书签。
支持所有保存格式用于'CreateDocument'操作。

版本22.5的增强功能

内部API的修复和改进。

版本22.4的增强功能

为HtmlSaveOption添加了ExportShapesAsSvg。
添加了新的端点~/styles/copy_from。

版本22.3的增强功能

在线方法现在返回包含原始文件名作为键的文件字典，而不是响应中的单个文件内容。
包含敏感数据的参数应以加密形式传递。参数的名称带有'encrypted'前缀。
添加了Encrypt方法以在API公钥上加密数据。使用它为需要加密数据的参数准备值。
已将SaveOptionsData和其他继承类的枚举成员的类型从字符串更改为枚举。

版本 22.2 的改进

将 'SaveOprionsData.SaveFormat' 属性设置为只读，并设置默认值。
为具有指定 SaveFormat 的所有 SaveOprionsData 格式添加了子类。
'SaveOptionsData'、'FixedPageSaveOptionsData'、'ImageSaveOptionsData'、'OoxmlSaveOptionsData'、'TxtSaveOptionsBaseData' 类现在为抽象类。

版本 22.1 的改进

添加了 'FieldOptions.FieldUpdateCultureName' 以设置字段的 Culture
添加了 'DocumentEntry.Password' 以设置追加文档的加密密码
向 CompareDocuments 添加了 'encryptedPassword2' 查询参数，以设置第二个比较文档的加密密码

版本 21.12 的改进

将 FieldOptions 参数添加到邮件合并操作中
将超时参数添加到 API 配置中
为批量请求添加了 dependsOn 和 resultOf 功能
为批量请求添加了 'displayIntermediateResults' 查询参数。如果为 'false'，则只返回批次的最后一个响应。默认为 'true'
支持 'CommonRequest.Password' 的加密。自动加密发送到 API 服务器的所有密码参数。

版本 21.11 的改进

版本 21.10 的改进

移除了不再支持的 'GraphicsQualityOptions' 图像保存选项。
为批量请求添加了 'displayIntermediateResults' 查询参数。如果为 'false'，则只返回批次的最后一个响应。默认为 'true'
向 'ReportEngineSettings' 添加了 'JsonDataLoadOptions' 和 'XmlDataLoadOptions'。

版本 21.8 的改进

添加了新的 API 方法，用于从文档中获取、插入、更新或删除自定义 XML 部分。
向 Compare API 添加了 'ResultDocumentFormat' 参数。
添加了 'ExportLanguageToSpanTag' PDF 保存选项。
添加了 'FlatOpcXmlMappingOnly' 保存选项。

版本 21.7 的改进

引入了 ImlRenderingMode 选项，用于确定墨迹（InkML）对象如何渲染。
引入了 MaxCharactersPerLine 选项，用于指定每行字符的最大数量。
添加了新的 API 方法来获取用于加密文档密码的 RSA 公钥。
添加了 encryptedPassword 查询参数，用于传递加密的文档密码。

版本 21.6 的改进

实现了 CompareDocumentOnline 功能的测试版，该功能包括请求中的文档发送。
CompareDocument 方法现在可以处理 PDF 文件。
引入了 AcceptAllRevisionsBeforeComparison 选项，用于指定是否在比较之前接受所有修订。

版本 21.5 的改进

更新了 SDK 中的依赖关系。

版本 21.4 的改进

移除了过时的 PDF 保存选项 'EscapeUri'
SaveOptions 现在包含 CustomTimeZoneInfo，用于在 SdtType.Date 结构化文档标签从自定义 XML 更新时设置自定义时区。
批量请求中子请求的 URL 现在可以是完整的（之前只能是相对的）。
向所有响应添加了 'RquestId' 标头。

版本 21.3 的改进

添加了 'UpdateCreatedTimeProperty' 保存选项。
在 HeaderFooter 中添加了表格，因此可以引用位于 HeaderFooter（sections/0/headersfooters/1/tables/0/rows/0/cells/0/paragraphs/0）中的表格内的段落。

版本 21.2 的改进

添加了删除所有注释的方法。

版本 21.1 的改进

为所有 API 方法添加了在线版本。

版本 20.11 的改进

在配置 json 文件中，appSid/appKey 已被 clientId/clientSecret 替换。
在 Words API 初始化方法中，clientId 参数在 clientSecret 参数之前。

版本 20.10 的改进

内部 API 更改。

版本 20.9 的改进

添加了批量 API 功能。

版本 20.8 的改进

添加了新的 API 方法（PUT '/words/{name}/compatibility/optimize'），该方法允许将文档内容以及 Aspose.Words 的默认行为优化到 MS Word 的特定版本。
向 AppendDocument API 的 'DocumentEntryList' 添加了 'ApplyBaseDocumentHeadersAndFootersToAppendingDocuments' 选项。
移除了 WithoutNodePath 方法，改为传递 null 值。

版本 20.7 的改进

添加了 'Markdown' 保存格式。
添加了更新段落格式而不使用节点路径的端点（PUT '/words/{name}/paragraphs/{index}/format'）。

版本 20.6 的改进

添加了新方法
- DeleteAllParagraphTabStopsWithoutNodePath
- DeleteParagraphTabStopWithoutNodePath
- GetParagraphTabStopsWithoutNodePath
- InsertOrUpdateParagraphTabStopWithoutNodePath
- InsertParagraphWithoutNodePath
- 不使用节点路径更新段落格式
- 不使用节点路径更新段落列表格式
- 不使用节点路径删除段落列表格式
与绘图对象相关的方法已更改内容。引入特殊请求类代替字符串。
InsertOrUpdateParagraphTabStop、DeleteParagraphTabStop方法已更改参数顺序
添加了OoxmlSaveOptionsData.CompressionLevel属性

20.5版本增强

添加了处理Word文档列表的方法
- GetLists
- GetList
- InsertList
- UpdateList
- UpdateListLevel
添加了处理样式的相关方法
- GetStyles
- UpdateStyle
- InsertStyle
- CopyStyle
- GetStyleFromDocumentElement
- ApplyStyleToDocumentElement
添加了处理段落列表格式的相关方法
- GetParagraphListFormat
- GetParagraphListFormatWithoutNodePath
- UpdateParagraphListFormat
- DeleteParagraphListFormat
添加了处理段落制表符的相关方法
- GetParagraphTabStops
- InsertOrUpdateParagraphTabStop
- DeleteAllParagraphTabStops
- DeleteParagraphTabStop
添加了构建报告的相关方法
- BuildReport
- BuildReportOnline
将阴影属性添加到ParagraphFormat

如何使用SDK？

完整源代码位于此仓库文件夹中。您可以直接通过源代码在项目中使用，或通过Packagist发行版（推荐）获取。有关更多详细信息，请访问我们的文档网站。

先决条件

要使用Aspose Words Cloud PHP SDK，您需要在与Aspose Cloud注册的账户中注册，并在云仪表板中查找/创建App Key和SID。有免费配额可用。有关更多详细信息，请参阅Aspose Cloud定价。

安装

通过Composer

aspose-words-cloud作为aspose-words-cloud包在Packagist上提供。运行以下命令

composer require aspose-cloud/aspose-words-cloud

要使用SDK，使用Composer的自动加载

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 example

测试包含使用SDK的各种示例。

依赖项

PHP 7.1或更高版本
引用包（有关更多详细信息，请参阅此处）

与旧版SDK的比较

新SDK与上一版本相比有以下优点

SDK与API完全同步，所有缺失的方法都已添加
类、方法和属性都有注释，并且对IDE友好
更好的安全性
使用请求/响应类表示长参数列表。这允许代码更干净，并且更容易进行未来的向后兼容

由于最后一条，新SDK与旧版SDK不向后兼容。如果您需要有关迁移的帮助，请向免费支持论坛寻求帮助。

许可证

所有Aspose.Words Cloud SDK、辅助脚本和模板均受MIT许可证许可。

联系我们

您的反馈对我们非常重要。请随时使用我们的支持论坛与我们联系。

资源

网站
 产品主页
 API 参考
 文档
 博客

其他语言

我们用不同的语言生成SDK，您可以在我们的列表中查看您的语言是否可用。

如果您在列表中找不到您想要的语言，请随时向我们提出请求，或者使用您能找到的原始REST API请求，具体请参考这里。

aspose / words-sdk-php

维护者

详细信息