Pimcore文档管理：PHP API操作完全指南

最新推荐文章于 2025-06-11 09:03:57 发布

苏舰孝Noel

最新推荐文章于 2025-06-11 09:03:57 发布

阅读量381

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00892/article/details/148575538

Pimcore文档管理：PHP API操作完全指南

pimcore Open Source Data & Experience Management Platform (PIM, MDM, CDP, DAM, DXP/CMS & Digital Commerce) 项目地址: https://gitcode.com/gh_mirrors/pi/pimcore

前言

Pimcore作为一款强大的开源企业级内容管理平台，提供了完善的PHP API来操作文档系统。本文将深入讲解如何通过PHP API对Pimcore中的文档进行CRUD操作和高级查询，帮助开发者更好地理解和使用这套API。

文档基础概念

在Pimcore中，文档(Document)是内容管理系统的重要组成部分，主要包括以下几种类型：

页面(Page)
文件夹(Folder)
链接(Link)
电子邮件(Email)
代码片段(Snippet)等

可以通过\Pimcore\Model\Document::getTypes()方法获取所有支持的文档类型。每种类型都有对应的模型类，例如\Pimcore\Model\Document\Page表示页面文档。

文档CRUD操作

创建文档

创建新文档需要指定两个必要参数：

唯一键名(key)
父文档ID(parentId)

// 创建页面文档示例
$page = new \Pimcore\Model\Document\Page();
$page->setKey('about-us');  // 设置文档键名
$page->setParentId(82);     // 设置父文档ID

// 可选：设置版本备注
$page->save(["versionNote" => "创建关于我们页面"]);

创建完成后，在管理界面刷新父节点即可看到新创建的文档。

读取文档

Pimcore提供了两种主要方式获取文档对象：

// 通过ID获取
$document = \Pimcore\Model\Document::getById(4);

// 通过路径获取
$document = \Pimcore\Model\Document::getByPath('/products');

获取文档后，可以访问其属性和可编辑区域：

if($document instanceof \Pimcore\Model\Document\Page) {
    // 获取WYSIWYG编辑器内容
    $content = $document->getEditable('content')->getData();
}

更新文档

修改文档内容后调用save()方法保存：

$document->getEditable('content')
    ->setDataFromResource('<p>更新后的内容</p>');
$document->save();

删除文档

删除操作非常简单：

$document = \Pimcore\Model\Document::getById(110);
if ($document) {
    $document->delete();
}

文档列表查询

Pimcore提供了强大的文档列表查询功能。

基础查询示例

假设有以下文档结构：

根目录
└── 产品 (ID:82)
    ├── 产品1
    ├── 产品2
    └── 产品3

查询所有子文档：

$listing = new \Pimcore\Model\Document\Listing(); 
$listing->setCondition("parentId = 82");
foreach($listing as $doc) {
    // 处理每个文档
}

查询配置选项

| 方法 | 参数类型 | 描述 | |----------------|-----------|--------------------------| | setOrder() | string | 排序方式(asc/desc) | | setOrderKey() | string/array | 排序字段 | | setLimit() | int | 返回结果数量限制 | | setOffset() | int | 结果偏移量 | | setCondition() | string | SQL条件语句 | | setUnpublished() | bool | 是否包含未发布文档 |

高级查询方法

| 方法 | 描述 | |--------------------|-----------------------------| | getCount() | 获取匹配文档总数 | | getTotalCount() | 获取总数(忽略limit/offset) | | loadIdList() | 获取所有匹配文档ID数组 |

复杂查询示例

$listing = new \Pimcore\Model\Document\Listing();
$listing->setUnpublished(true)
    ->setCondition("`parentId` = 82")
    ->setOrderKey(['key', 'published'])
    ->setOrder('desc')
    ->setOffset(2)
    ->setLimit(2);
    
$total = $listing->getTotalCount();  // 获取总数
$ids = $listing->loadIdList();      // 获取ID列表

foreach($listing as $doc) {
    // 处理文档
}

也可以使用静态方法简化查询：

$listing = \Pimcore\Model\Document::getList([
    'unpublished' => true,
    'condition' => "`parentId` = 82",
    'orderKey' => ['key', 'published'],
    'order' => 'desc',
    'offset' => 2,
    'limit' => 2
]);