aspose-cloud/aspose-words-cloud

打开、生成、编辑、拆分、合并、比较和转换 Word 文档。将 Cloud API 集成到您的解决方案中以操作文档。将 PDF 转换为 Word(DOC、DOCX、ODT、RTF 和 HTML),反之亦然。


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(Amazon Kindle 格式)文档的支持。
  • 为 SvgSaveOptionsData 类添加了 'MaxImageResolution' 属性。

版本 24.6 的改进

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

版本 24.5 的改进

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

版本 24.4 的改进

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

版本 24.3 的改进

  • 为 'Cleanup' 参数中的 'RemoveEmptyCells' 选项添加了支持。

版本 24.1 的改进

  • 在插入 API 中添加了对 InsertAfterNode 的支持,无需 NodePath。
  • 添加了对无需 NodePath 的节点(运行/行/单元格/书签)的插入支持。
  • 在 Watermark API 中添加了对透明度的支持。
  • 在 FileReference 中添加了对密码和 encryptedPassword 字段的 support。
  • 修复了文档响应中缺少 href 值的问题。

版本 23.12 的改进

  • 在插入书签操作中,将 Properties Name、Text、StartRange、EndRange 标记为必填。
  • 实现了删除文档中所有 Office 数学对象的 DeleteOfficeMathObjects 操作。
  • 从 UnprotectDocument 操作中删除了 ProtectionRequest 参数。现在从文档中移除保护不需要密码。
  • Model ProtectionRequest 已标记为弃用,请使用 ProtectionRequestV2 替代以执行 ProtectDocument 操作。要更改受保护文档的密码或保护类型,不需要旧密码。
  • 为通过密码加密的文档添加了 Password 和 EncryptedPassword 字段到 FileReference。
  • 从 CompareDocument 方法中删除了 encryptedPassword2 参数。请使用 FileReference 密码代替。

版本 23.11 的改进

  • 在模型中支持必填属性。
  • 属性 StyleName 在 InsertStyle 操作中被标记为必需。
  • 属性 StyleName 在 CopyStyle 操作中被标记为必需。
  • 属性 StyleName 在 ApplyStyleToDocumentElement 操作中被标记为必需。
  • 属性 SdtType 和 Level 在 InsertStructuredDocumentTag 操作中被标记为必需。
  • 属性 Text 在 InsertParagraph 操作中被标记为必需。
  • 属性 Value 在 CreateOrUpdateDocumentProperty 操作中被标记为必需。
  • 属性 NewValue 在 ReplaceText 操作中被标记为必需。
  • 属性 Text 在 ReplaceWithText 操作中被标记为必需。

版本 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 的增强功能

  • 将 ExportShapesAsSvg 添加到 HtmlSaveOption。
  • 添加了新的端点 '~/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 的增强功能

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

版本21.11的增强

版本21.10的增强

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

版本21.8的增强

  • 添加了新的API方法,用于从文档中获取、插入、更新或删除自定义xml部分。
  • 将'ResultDocumentFormat'参数添加到Compare API
  • 添加了'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的增强

  • 添加了Batch 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
    • UpdateParagraphFormatWithoutNodePath
    • UpdateParagraphListFormatWithoutNodePath
    • DeleteParagraphListFormatWithoutNodePath
  • 更改了与DrawingObject相关的方法的body内容。引入了特殊请求类代替字符串。
  • 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 友好
  • 更好的安全性
  • 使用 Request/Response 类来表示长参数列表。这允许代码更整洁,并且在未来更容易向后兼容

由于最后一个项目,新 SDK 与旧版 SDK 不兼容。如果您需要迁移方面的帮助,请访问免费支持论坛

许可

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

联系我们

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

资源

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

其他语言

我们用不同的语言生成我们的 SDK,您可能需要检查您的语言是否在我们的列表中。

如果您的语言不在列表中,请随时向我们请求,或使用您可以找到的原始 REST API 请求此处