lsm/Orchard
1
0
Fork 0
mirror of https://github.com/OrchardCMS/Orchard.git synced 2026-02-09 09:16:41 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Improving blueprint support for content part elements in a content part agnostic manner.

Browse Source 
This enables scenarios such as creating blueprints for content part elements, which themselves are 'virtualized' elements based on the ContentPart element.
This commit is contained in:
Sipke Schoorstra
2014-11-06 00:29:22 -08:00
parent 6b8f870091
commit dcfaf50c95
8 changed files with 77 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
src/Orchard.Web/Modules/Orchard.Layouts/Drivers/ContentPartDriver.cs
View File

@@ -1,7 +1,43 @@
using Orchard.Layouts.Elements;
using System.Linq;
using System.Web.Mvc;
using Orchard.Data;
using Orchard.Layouts.Elements;
using Orchard.Layouts.Framework.Display;
using Orchard.Layouts.Framework.Drivers;
using Orchard.Layouts.Services;
namespace Orchard.Layouts.Drivers {
public class ContentPartDriver : ElementDriver<ContentPart> {
private readonly IContentPartDisplay _contentPartDisplay;
private readonly ICultureAccessor _cultureAccessor;
private readonly ITransactionManager _transactionManager;
public ContentPartDriver(IContentPartDisplay contentPartDisplay, ICultureAccessor cultureAccessor, ITransactionManager transactionManager) {
_contentPartDisplay = contentPartDisplay;
_cultureAccessor = cultureAccessor;
_transactionManager = transactionManager;
}
protected override void OnDisplaying(ContentPart element, ElementDisplayContext context) {
var contentItem = context.Content.ContentItem;
var contentPartName = (string)element.Descriptor.StateBag["ElementTypeName"];
var contentPart = contentItem.Parts.FirstOrDefault(x => x.PartDefinition.Name == contentPartName);
if ((contentItem.Id == 0 || context.DisplayType == "Design") && context.Updater != null) {
// The content item hasn't been stored yet, so bind form values with the content part to represent actual state.
var controller = (Controller)context.Updater;
var oldValueProvider = controller.ValueProvider;
controller.ValueProvider = new DictionaryValueProvider<string>(context.Element.State, _cultureAccessor.CurrentCulture);
_contentPartDisplay.UpdateEditor(contentPart, context.Updater);
_transactionManager.Cancel();
controller.ValueProvider = oldValueProvider;
}
var contentPartShape = _contentPartDisplay.BuildDisplay(contentPart, displayType: "Layout");
context.ElementShape.ContentPart = contentPart;
context.ElementShape.Content = contentPartShape;
}
}
}

3
src/Orchard.Web/Modules/Orchard.Layouts/Framework/Elements/ElementDescriptor.cs
View File

@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using Orchard.Layouts.Framework.Display;
using Orchard.Localization;
@@ -11,6 +12,7 @@ namespace Orchard.Layouts.Framework.Elements {
Category = category;
CreatingDisplay = context => {};
Displaying = context => {};
StateBag = new Dictionary<string, object>();
}
public LocalizedString DisplayText { get; set; }
@@ -21,5 +23,6 @@ namespace Orchard.Layouts.Framework.Elements {
public Action<ElementDisplayContext> Displaying { get; set; }
public bool IsSystemElement { get; set; }
public bool EnableEditorDialog { get; set; }
public IDictionary<string, object> StateBag { get; set; }
}
}

3
src/Orchard.Web/Modules/Orchard.Layouts/Orchard.Layouts.csproj
View File

@@ -362,6 +362,9 @@
<ItemGroup>
<Content Include="Views\Element-Content-Projection.cshtml" />
</ItemGroup>
<ItemGroup>
<Content Include="Views\Element-ContentPart.Design.cshtml" />
</ItemGroup>
<PropertyGroup>
<VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>
<VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>

3
src/Orchard.Web/Modules/Orchard.Layouts/Providers/BlueprintElementHarvester.cs
View File

@@ -41,6 +41,9 @@ namespace Orchard.Layouts.Providers {
IsSystemElement = false,
CreatingDisplay = creatingDisplayContext => CreatingDisplay(creatingDisplayContext, blueprint),
Displaying = displayContext => Displaying(displayContext, baseElement),
StateBag = new Dictionary<string, object> {
{"ElementTypeName", baseElement.Descriptor.TypeName}
}
};
var descriptors = query.ToArray();

46
src/Orchard.Web/Modules/Orchard.Layouts/Providers/ContentPartElementHarvester.cs
View File

@@ -1,9 +1,7 @@
using System.Collections.Generic;
using System.Linq;
using System.Web.Mvc;
using Orchard.ContentManagement.MetaData;
using Orchard.ContentManagement.MetaData.Models;
using Orchard.Data;
using Orchard.Environment;
using Orchard.Layouts.Framework.Display;
using Orchard.Layouts.Framework.Elements;
@@ -14,23 +12,17 @@ using Orchard.Layouts.Settings;
namespace Orchard.Layouts.Providers {
public class ContentPartElementHarvester : Component, IElementHarvester {
private readonly Work<IContentDefinitionManager> _contentDefinitionManager;
private readonly Work<ITransactionManager> _transactionManager;
private readonly Work<ICultureAccessor> _cultureAccessor;
private readonly Work<IContentPartDisplay> _contentPartDisplay;
private readonly Work<IElementFactory> _elementFactory;
private readonly Work<IElementManager> _elementManager;
public ContentPartElementHarvester(
Work<IContentDefinitionManager> contentDefinitionManager,
Work<ITransactionManager> transactionManager,
Work<ICultureAccessor> cultureAccessor,
Work<IContentPartDisplay> contentPartDisplay,
Work<IElementFactory> elementFactory) {
Work<IContentDefinitionManager> contentDefinitionManager,
Work<IElementFactory> elementFactory,
Work<IElementManager> elementManager) {
_contentDefinitionManager = contentDefinitionManager;
_transactionManager = transactionManager;
_cultureAccessor = cultureAccessor;
_contentPartDisplay = contentPartDisplay;
_elementFactory = elementFactory;
_elementManager = elementManager;
}
public IEnumerable<ElementDescriptor> HarvestElements(HarvestElementsContext context) {
@@ -39,39 +31,31 @@ namespace Orchard.Layouts.Providers {
var contentParts = GetContentParts(context);
return contentParts.Select(contentPart => new ElementDescriptor(elementType, contentPart.Name, T(contentPart.Name), contentPartElement.Category) {
Displaying = displayContext => Displaying(displayContext)
Displaying = displayContext => Displaying(displayContext),
StateBag = new Dictionary<string, object> {
{"ElementTypeName", contentPart.Name}
}
});
}
private IEnumerable<ContentPartDefinition> GetContentParts(HarvestElementsContext context) {
var contentTypeDefinition = context.Content != null
? _contentDefinitionManager.Value.GetTypeDefinition(context.Content.ContentItem.ContentType)
var contentTypeDefinition = context.Content != null
? _contentDefinitionManager.Value.GetTypeDefinition(context.Content.ContentItem.ContentType)
: default(ContentTypeDefinition);
var parts = contentTypeDefinition != null
? contentTypeDefinition.Parts.Select(x => x.PartDefinition)
? contentTypeDefinition.Parts.Select(x => x.PartDefinition)
: _contentDefinitionManager.Value.ListPartDefinitions();
return parts.Where(p => p.Settings.GetModel<ContentPartLayoutSettings>().Placable);
}
private void Displaying(ElementDisplayContext context) {
var contentItem = context.Content.ContentItem;
var contentPart = contentItem.Parts.FirstOrDefault(x => x.PartDefinition.Name == context.Element.Descriptor.TypeName);
var drivers = _elementManager.Value.GetDrivers(context.Element);
if ((contentItem.Id == 0 || context.DisplayType == "Design") && context.Updater != null) {
// The content item hasn't been stored yet, so bind form values with the content part to represent actual state.
var controller = (Controller)context.Updater;
var oldValueProvider = controller.ValueProvider;
controller.ValueProvider = new DictionaryValueProvider<string>(context.Element.State, _cultureAccessor.Value.CurrentCulture);
_contentPartDisplay.Value.UpdateEditor(contentPart, context.Updater);
_transactionManager.Value.Cancel();
controller.ValueProvider = oldValueProvider;
foreach (var driver in drivers) {
driver.Displaying(context);
}
var contentPartShape = _contentPartDisplay.Value.BuildDisplay(contentPart, displayType: "Layout");
context.ElementShape.ContentPart = contentPartShape;
}
}
}

2
src/Orchard.Web/Modules/Orchard.Layouts/Services/ElementBlueprintService.cs
View File

@@ -35,7 +35,7 @@ namespace Orchard.Layouts.Services {
public ElementBlueprint CreateBlueprint(IElement baseElement, string elementTypeName, string elementDisplayName, string elementCategory) {
var blueprint = new ElementBlueprint {
BaseElementTypeName = baseElement.Type,
BaseElementTypeName = baseElement.Descriptor.TypeName,
ElementTypeName = elementTypeName,
ElementDisplayName = elementDisplayName,
ElementCategory = elementCategory

14
src/Orchard.Web/Modules/Orchard.Layouts/Views/Element-ContentPart.Design.cshtml Normal file
View File

@@ -0,0 +1,14 @@
@using Orchard.DisplayManagement.Shapes
@using Orchard.Layouts.Helpers
@{
var element = Model.Element;
var tagBuilder = TagBuilderExtensions.AddCommonElementAttributes(new OrchardTagBuilder("div"), Model);
}
<div class="element-component">
<div>@element.Descriptor.DisplayText</div>
</div>
<div>
@tagBuilder.StartElement
@Display(Model.Content)
@tagBuilder.EndElement
</div>

2
src/Orchard.Web/Modules/Orchard.Layouts/Views/Element-ContentPart.cshtml
View File

@@ -4,5 +4,5 @@
var tagBuilder = TagBuilderExtensions.AddCommonElementAttributes(new OrchardTagBuilder("div"), Model);
}
@tagBuilder.StartElement
@Display(Model.ContentPart)
@Display(Model.Content)
@tagBuilder.EndElement