Sitecore CMS 6.4及以上内容API开发指南

2星需积分: 9 173 浏览量更新于2024-07-25 1 收藏 566KB PDF 举报

本资源是关于Sitecore CMS 6.4及更高版本的Content API Cookbooks，是一份概念性概述文档，专为CMS开发人员设计。Sitecore是一个注册商标，文档中的所有内容均为Sitecore的财产，版权由Sitecore于2001年至2013年持有，所有权利保留。该文档主要涵盖了以下几个核心章节： 1. **引言**（Chapter 1） - 提供了一个关于Content API在Sitecore CMS中的概述，帮助开发人员理解API如何与内容管理系统互动，并可能介绍API的整体架构和目的。 2. **数据库操作**（Chapter 2） - 详细介绍了如何与Sitecore数据库交互： - **访问数据库**：包括通过上下文数据库（Context Database）、按名称访问数据库以及访问内容数据库。 - - 通过上下文数据库：开发人员可以利用当前请求的上下文获取所需数据。 - - 按名称访问数据库：对于特定任务，直接指定数据库名进行操作。 - - 内容数据库：通常用于处理实际内容数据。 - **发布内容**：包括发布单个或分支内容项，以及管理主数据库的发布流程。 3. **物品操作**（Chapter 3） - 如何访问和处理内容项： - **访问内容项**：包括系统项（System Items）的访问，这是非用户可编辑的后台支持内容。 - - 系统项：这些项如模板、字段定义等，对构建内容结构至关重要。通过这份Cookbook，开发人员可以学习到如何高效地利用Sitecore Content API进行数据库查询、内容管理和发布，从而更好地集成和扩展其CMS功能。这是一份实用的参考资源，适用于想要深入了解Sitecore CMS内部工作原理和API使用的开发者。

Sitecore CMS 6.4 and later Content API Cookbook

Sitecore® is a registered trademark. All other brand and product names are the property of their respective holders. The

Page 11 of 62

3.1 How to Access an Item

You can use the Sitecore.Data.Items.Item class to access any item.

Note

Sitecore provides specialized classes to represent specific types as items, such as

Sitecore.Data.Items.TemplateItem to represent a data template and

Sitecore.Data.Items.MediaItem to represent a media item.

You can use the Sitecore.Data.Database.GetItem() method to retrieve a

Sitecore.Data.Item.Item. You can specify the ID of the item or the path to the item as the first

parameter to the Sitecore.Data.Database.GetItem() method. For example, to access the

/Sitecore/Content/Home item in the Master database:

Sitecore.Data.Database master = Sitecore.Configuration.Factory.GetDatabase("master");

Sitecore.Data.Items.Item home = master.GetItem("/sitecore/content/home");

If the item does not exist, or the context user does not have read access rights to the item, the

Sitecore.Data.Database.GetItem() method returns Null.

Note

Sitecore does compare case when evaluating item paths.

3.1.1 How to Access System Items

You can use members of the Sitecore.ItemIDs class to access system items without hard-coding

paths.

For example, to access the /Sitecore/Media Library item in the Master database:

Sitecore.Data.Database master = Sitecore.Configuration.Factory.GetDatabase("master");

Sitecore.Data.Items.Item mediaRoot =

master.GetItem(Sitecore.ItemIDs.MediaLibraryRoot);

3.1.2 How to Access System Data Templates

You can use the Sitecore.TemplateIDs class to access system data templates.

For example, to

access the standard template in the Master database:

Sitecore.Data.Database master = Sitecore.Configuration.Factory.GetDatabase("master");

Sitecore.Data.Items.TemplateItem standard =

master.Templates[Sitecore.TemplateIDs.StandardTemplate];

3.1.3 How to Access the Context Item

In presentation and other components, processing often begins with the context item.

You can

access the context item using the Sitecore.Context.Item property. For example, to access the

context item:

Sitecore.Data.Items.Item contextItem = Sitecore.Context.Item.

For more information about the members of the Sitecore.ItemIDs class, see the Sitecore API

documentation at http://sdn.sitecore.net/Reference/Sitecore%206.aspx.

For more information about the members of the Sitecore.TemplateIDs class, see the Sitecore

API documentation at http://sdn.sitecore.net/Reference/Sitecore%206.aspx.

For more information about the standard template, see the Data Definition Reference manual at

http://sdn.sitecore.net/Reference/Sitecore%206/Data%20Definition%20Reference.aspx.

For more information about the context item, see the Presentation Component Reference manual at

http://sdn.sitecore.net/Reference/Sitecore%206/Presentation%20Component%20Reference.aspx.

Sitecore CMS 6.4 and later Content API Cookbook

Sitecore® is a registered trademark. All other brand and product names are the property of their respective holders. The

Page 12 of 62

3.1.4 How to Resolve Item Access Rights

Sitecore APIs operate in the context of a specific user with particular security access rights. Sitecore

APIs may return Null or throw exceptions if the context user does not have a required access right.

You can use a security user switcher or security disabler to work around access right limitations.

For

examples using a security disabler, see the section How to Place an Item in Editing Mode.

Note

We recommend that you provide the context user with the appropriate access rights instead of using

a security user switcher or a security disabler.

The code examples in this document do not use a security user switcher or security disabler. This

implies that the context user has the required access rights in order for the logic to succeed.

3.1.5 How to Place an Item in Editing Mode

Sitecore APIs that update items may throw exceptions if the item is not in editing mode. You can

place an item in editing mode using methods of the Sitecore.Data.Items.Item.Editing

property, or by using the Sitecore.Data.Items.EditContext class.

For example, the following code places the /Sitecore/Content/Home item in the Master database

in editing mode within a security disabler using methods in the

Sitecore.Data.Items.Item.Editing class:

Sitecore.Data.Database master = Sitecore.Configuration.Factory.GetDatabase("master");

Sitecore.Data.Items.Item home = master.GetItem("/sitecore/content/home");

//TODO: eliminate SecurityDisabler if possible

using (new Sitecore.SecurityModel.SecurityDisabler())

{

home.Editing.BeginEdit();

try

{

//TODO: update home

home.Editing.EndEdit();

}

catch (Exception ex)

{

home.Editing.CancelEdit();

}

If you do call the Sitecore.Data.Items.Item.Editing.CancelEdit() method or do not call

the Sitecore.Data.Items.Item.Editing.EndEdit() method, Sitecore does not commit the

changes.

Important

Developers should use try/catch blocks as shown in this example. For brevity, code examples in

this document do not always include try/catch blocks.

Alternatively, you can use the Sitecore.Data.Items.EditContext class with a C# using

statement to place an item in editing mode. The closure of the using statement invokes the

Sitecore.Data.Items.EditContext.Dispose() method, which commits any changes made

within that segment of code.

For example, the following code places the /Sitecore/Content/Home item in the Master database

in editing mode using a Sitecore.Data.Items.EditContext:

For more information about security user switchers and security disablers, see the Security API

Cookbook at http://sdn.sitecore.net/Reference/Sitecore%206/Security%20API%20Cookbook.aspx.

剩余61页未读，继续阅读

tangbohua

粉丝: 0
资源: 3

Sitecore CMS 6.4及以上内容API开发指南

Professional Sitecore Development

sitecore CMS API

Sitecore培训PPT-1

visual studio怎么使用Sitecore插件啊

sitecore常用配置

他们在动态渲染方面有什么好的实践吗？

请列举一些内容管理系统的中文参考资料

除了WordPress插件还有什么新闻发布插件可以使用到C#的

蓝牙配对漏洞 技术文档

Sitecore安装许可证

最新资源

蓝牙配对漏洞技术文档