Skip to content

Commit

Permalink
Move display types to constants (OrchardCMS#17371)
Browse files Browse the repository at this point in the history
  • Loading branch information
hishamco authored Jan 18, 2025
1 parent e7c62b4 commit b25a311
Show file tree
Hide file tree
Showing 122 changed files with 178 additions and 160 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ public sealed class VisitSiteNavbarDisplayDriver : DisplayDriver<Navbar>
public override IDisplayResult Display(Navbar model, BuildDisplayContext context)
{
return View("VisitSiteNavbarItem", model)
.Location("DetailAdmin", "Content:20");
.Location(OrchardCoreConstants.DisplayType.DetailAdmin, "Content:20");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ public async Task<IActionResult> Index()
wrappers.Add(new DashboardWrapper
{
Dashboard = widget,
Content = await _contentItemDisplayManager.BuildDisplayAsync(widget, _updateModelAccessor.ModelUpdater, "DetailAdmin")
Content = await _contentItemDisplayManager.BuildDisplayAsync(widget, _updateModelAccessor.ModelUpdater, OrchardCoreConstants.DisplayType.DetailAdmin)
});
}

Expand Down Expand Up @@ -124,7 +124,7 @@ public async Task<IActionResult> Manage()
var wrapper = new DashboardWrapper
{
Dashboard = widget,
Content = await _contentItemDisplayManager.BuildDisplayAsync(widget, _updateModelAccessor.ModelUpdater, "DetailAdmin")
Content = await _contentItemDisplayManager.BuildDisplayAsync(widget, _updateModelAccessor.ModelUpdater, OrchardCoreConstants.DisplayType.DetailAdmin)
};

wrappers.Add(wrapper);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public override async Task<IDisplayResult> DisplayAsync(ContentItem model, Build
var shapeTag = Initialize<ContentItemViewModel>("DashboardWidget_DetailAdmin__ContentsTags", m =>
{
m.ContentItem = model;
}).Location("DetailAdmin", "Tags:10");
}).Location(OrchardCoreConstants.DisplayType.DetailAdmin, "Tags:10");
results.Add(shapeTag);

return Combine(results.ToArray());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public override Task<IDisplayResult> DisplayAsync(AdminMenuDeploymentStep step,
{
return
CombineAsync(
View("AdminMenuDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("AdminMenuDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("AdminMenuDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public ArchiveLaterPartDisplayDriver(
public override IDisplayResult Display(ArchiveLaterPart part, BuildPartDisplayContext context)
=> Initialize<ArchiveLaterPartViewModel>(
$"{nameof(ArchiveLaterPart)}_SummaryAdmin",
model => PopulateViewModel(part, model)).Location("SummaryAdmin", "Meta:25");
model => PopulateViewModel(part, model)).Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "Meta:25");

public override IDisplayResult Edit(ArchiveLaterPart part, BuildPartEditorContext context)
=> Initialize<ArchiveLaterPartViewModel>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ public override Task<IDisplayResult> DisplayAsync(AuditTrailEvent auditTrailEven

return CombineAsync(
Initialize<AuditTrailEventViewModel>("AuditTrailEventTags_SummaryAdmin", model => BuildViewModel(auditTrailEvent, model, descriptor))
.Location("SummaryAdmin", "EventTags:10"),
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "EventTags:10"),
Initialize<AuditTrailEventViewModel>("AuditTrailEventMeta_SummaryAdmin", model => BuildViewModel(auditTrailEvent, model, descriptor))
.Location("SummaryAdmin", "EventMeta:10"),
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "EventMeta:10"),
Initialize<AuditTrailEventViewModel>("AuditTrailEventActions_SummaryAdmin", model => BuildViewModel(auditTrailEvent, model, descriptor))
.Location("SummaryAdmin", "Actions:10"),
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "Actions:10"),
Initialize<AuditTrailEventViewModel>("AuditTrailEventDetail_DetailAdmin", model => BuildViewModel(auditTrailEvent, model, descriptor))
.Location("DetailAdmin", "Content:before")
.Location(OrchardCoreConstants.DisplayType.DetailAdmin, "Content:before")
);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ public override async Task<IDisplayResult> DisplayAsync(Navbar model, BuildDispl
.Features
.Get<IRequestCultureFeature>()?.RequestCulture?.Culture ?? CultureInfo.CurrentUICulture;
}).RenderWhen(() => Task.FromResult(supportedCultures.Count() > 1))
.Location("Detail", "Content:5");
.Location(OrchardCoreConstants.DisplayType.Detail, "Content:5");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ ILocalizationService localizationService
public override IDisplayResult Display(LocalizationPart part, BuildPartDisplayContext context)
{
return Combine(
Initialize<LocalizationPartViewModel>("LocalizationPart_SummaryAdmin", model => BuildViewModelAsync(model, part)).Location("SummaryAdmin", "Tags:11"),
Initialize<LocalizationPartViewModel>("LocalizationPart_SummaryAdminLinks", model => BuildViewModelAsync(model, part)).Location("SummaryAdmin", "Actions:5")
Initialize<LocalizationPartViewModel>("LocalizationPart_SummaryAdmin", model => BuildViewModelAsync(model, part)).Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "Tags:11"),
Initialize<LocalizationPartViewModel>("LocalizationPart_SummaryAdminLinks", model => BuildViewModelAsync(model, part)).Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "Actions:5")
);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public async Task<IActionResult> Render()
return Ok();
}

var model = await _contentItemDisplayManager.BuildDisplayAsync(contentItem, _updateModelAccessor.ModelUpdater, "Detail");
var model = await _contentItemDisplayManager.BuildDisplayAsync(contentItem, _updateModelAccessor.ModelUpdater, OrchardCoreConstants.DisplayType.Detail);

return View(model);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using OrchardCore.ContentTypes.ViewModels;
using OrchardCore.Deployment;
using OrchardCore.DisplayManagement;
using OrchardCore.DisplayManagement.Handlers;
using OrchardCore.DisplayManagement.Views;

Expand All @@ -11,7 +12,7 @@ public override Task<IDisplayResult> DisplayAsync(ContentDefinitionDeploymentSte
{
return
CombineAsync(
View("ContentDefinitionDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("ContentDefinitionDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("ContentDefinitionDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
using OrchardCore.ContentTypes.ViewModels;
using OrchardCore.Deployment;
using OrchardCore.DisplayManagement;
using OrchardCore.DisplayManagement.Handlers;
using OrchardCore.DisplayManagement.Views;

Expand All @@ -13,7 +14,7 @@ public override Task<IDisplayResult> DisplayAsync(DeleteContentDefinitionDeploym
{
return
CombineAsync(
View("DeleteContentDefinitionDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("DeleteContentDefinitionDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("DeleteContentDefinitionDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public override Task<IDisplayResult> DisplayAsync(ReplaceContentDefinitionDeploy
{
return
CombineAsync(
View("ReplaceContentDefinitionDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("ReplaceContentDefinitionDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("ReplaceContentDefinitionDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public override Task<IDisplayResult> DisplayAsync(ContentItem contentItem, Build
{
return Task.FromResult<IDisplayResult>(
Initialize<ContentItemViewModel>("AuditTrailContentsAction_SummaryAdmin", m => m.ContentItem = contentItem)
.Location("SummaryAdmin", "ActionsMenu:10")
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "ActionsMenu:10")
.RenderWhen(() => _authorizationService.AuthorizeAsync(_httpContextAccessor.HttpContext?.User, AuditTrailPermissions.ViewAuditTrail))
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ public override Task<IDisplayResult> DisplayAsync(ContentItem model, BuildDispla
{
return CombineAsync(
Dynamic("AddToDeploymentPlan_Modal__ActionDeploymentPlan")
.Location("SummaryAdmin", "ActionsMenu:30")
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "ActionsMenu:30")
.RenderWhen(async () => await _deploymentPlanService.DoesUserHavePermissionsAsync()),
Shape("AddToDeploymentPlan_SummaryAdmin__Button__Actions", new ContentItemViewModel(model))
.Location("SummaryAdmin", "ActionsMenu:30")
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "ActionsMenu:30")
.RenderWhen(async () => await _deploymentPlanService.DoesUserHavePermissionsAsync())
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public override Task<IDisplayResult> DisplayAsync(ContentItemDeploymentStep step
{
return
CombineAsync(
View("ContentItemDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("ContentItemDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("ContentItemDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public override Task<IDisplayResult> DisplayAsync(AllContentDeploymentStep step,
{
return
CombineAsync(
View("AllContentDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("AllContentDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("AllContentDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public override Task<IDisplayResult> DisplayAsync(ContentDeploymentStep step, Bu
{
return
CombineAsync(
View("ContentDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("ContentDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("ContentDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public override IDisplayResult Display(ContentItem contentItem, BuildDisplayCont
var user = _httpContextAccessor.HttpContext.User;

return Shape("Download_SummaryAdmin__Button__Actions", new ContentItemViewModel(contentItem))
.Location("SummaryAdmin", "ActionsMenu:20")
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "ActionsMenu:20")
.RenderWhen(() => _authorizationService.AuthorizeAsync(user, OrchardCore.Deployment.CommonPermissions.Export, contentItem));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public override Task<IDisplayResult> DisplayAsync(ContentItem model, BuildDispla
{
return CombineAsync(
Dynamic("ExportContentToDeploymentTarget_Modal__ActionDeploymentTarget")
.Location("SummaryAdmin", "ActionsMenu:30")
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "ActionsMenu:30")
.RenderWhen(async () =>
{
if (await _deploymentPlanService.DoesUserHaveExportPermissionAsync())
Expand All @@ -41,7 +41,7 @@ public override Task<IDisplayResult> DisplayAsync(ContentItem model, BuildDispla
return false;
}),
Shape("ExportContentToDeploymentTarget_SummaryAdmin__Button__Actions", new ContentItemViewModel(model))
.Location("SummaryAdmin", "ActionsMenu:40")
.Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "ActionsMenu:40")
.RenderWhen(async () =>
{
if (await _deploymentPlanService.DoesUserHaveExportPermissionAsync())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public override Task<IDisplayResult> DisplayAsync(ExportContentToDeploymentTarge
{
return
CombineAsync(
View("ExportContentToDeploymentTargetDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("ExportContentToDeploymentTargetDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("ExportContentToDeploymentTargetDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public ContentTypesSitemapSourceDriver(IRouteableContentTypeCoordinator routeabl
public override Task<IDisplayResult> DisplayAsync(ContentTypesSitemapSource sitemapSource, BuildDisplayContext context)
{
return CombineAsync(
View("ContentTypesSitemapSource_SummaryAdmin", sitemapSource).Location("SummaryAdmin", "Content"),
View("ContentTypesSitemapSource_SummaryAdmin", sitemapSource).Location(OrchardCoreConstants.DisplayType.SummaryAdmin, "Content"),
View("ContentTypesSitemapSource_Thumbnail", sitemapSource).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public override Task<IDisplayResult> DisplayAsync(CustomSettingsDeploymentStep s
{
return
CombineAsync(
View("CustomSettingsDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("CustomSettingsDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("CustomSettingsDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ public override IDisplayResult Display(ContentItem contentItem, BuildDisplayCont

return Combine(
// A new shape is created and the properties of the object are bound to it when rendered
Copy("TestContentPartA", testContentPart).Location("Detail", "Content"),
Copy("TestContentPartA", testContentPart).Location(OrchardCoreConstants.DisplayType.Detail, "Content"),
// New shape, no initialization, custom location
Dynamic("LowerDoll").Location("Detail", "Footer"),
Dynamic("LowerDoll").Location(OrchardCoreConstants.DisplayType.Detail, "Footer"),
// New shape
Factory("TestContentPartA",
async ctx => (await ctx.New.TestContentPartA()).Creating(_creating++),
Expand All @@ -34,14 +34,14 @@ public override IDisplayResult Display(ContentItem contentItem, BuildDisplayCont

return Task.CompletedTask;
})
.Location("Detail", "Content")
.Location(OrchardCoreConstants.DisplayType.Detail, "Content")
.Cache("lowerdoll2", cache => cache.WithExpiryAfter(TimeSpan.FromSeconds(5))),
// A strongly typed shape model is used and initialized when rendered
Initialize<TestContentPartAShape>(shape => { shape.Line = "Strongly typed shape"; })
.Location("Detail", "Content:2"),
.Location(OrchardCoreConstants.DisplayType.Detail, "Content:2"),
// Cached shape
Dynamic("LowerDoll")
.Location("Detail", "/Footer")
.Location(OrchardCoreConstants.DisplayType.Detail, "/Footer")
.Cache("lowerdoll", cache => cache.WithExpiryAfter(TimeSpan.FromSeconds(5)))
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ public async Task<IActionResult> Display(long id)
var items = new List<dynamic>();
foreach (var step in deploymentPlan.DeploymentSteps)
{
var item = await _displayManager.BuildDisplayAsync(step, _updateModelAccessor.ModelUpdater, "Summary");
var item = await _displayManager.BuildDisplayAsync(step, _updateModelAccessor.ModelUpdater, OrchardCoreConstants.DisplayType.Summary);
item.Properties["DeploymentStep"] = step;
items.Add(item);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using OrchardCore.Deployment.ViewModels;
using OrchardCore.DisplayManagement;
using OrchardCore.DisplayManagement.Handlers;
using OrchardCore.DisplayManagement.Views;

Expand All @@ -17,7 +18,7 @@ public override Task<IDisplayResult> DisplayAsync(DeploymentPlanDeploymentStep s
{
return
CombineAsync(
View("DeploymentPlanDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("DeploymentPlanDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("DeploymentPlanDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using OrchardCore.Deployment.ViewModels;
using OrchardCore.DisplayManagement;
using OrchardCore.DisplayManagement.Handlers;
using OrchardCore.DisplayManagement.Views;

Expand All @@ -10,7 +11,7 @@ public override Task<IDisplayResult> DisplayAsync(CustomFileDeploymentStep step,
{
return
CombineAsync(
View("CustomFileDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("CustomFileDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("CustomFileDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public override Task<IDisplayResult> DisplayAsync(JsonRecipeDeploymentStep step,
{
return
CombineAsync(
View("JsonRecipeDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("JsonRecipeDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("JsonRecipeDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public override Task<IDisplayResult> DisplayAsync(RecipeFileDeploymentStep step,
{
return
CombineAsync(
View("RecipeFileDeploymentStep_Fields_Summary", step).Location("Summary", "Content"),
View("RecipeFileDeploymentStep_Fields_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("RecipeFileDeploymentStep_Fields_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public override Task<IDisplayResult> DisplayAsync(FacebookLoginDeploymentStep st
{
return
CombineAsync(
View("FacebookLoginDeploymentStep_Summary", step).Location("Summary", "Content"),
View("FacebookLoginDeploymentStep_Summary", step).Location(OrchardCoreConstants.DisplayType.Summary, "Content"),
View("FacebookLoginDeploymentStep_Thumbnail", step).Location("Thumbnail", "Content")
);
}
Expand Down
Loading

0 comments on commit b25a311

Please sign in to comment.