Change the access of Shape of BuildShapeContext

[infofromca]

Describe the bug

I want to assign
context.Shape = new EmptyShape();
in some condition.

Orchard Core version

latest main

To Reproduce

Expected behavior

change from --
using OrchardCore.DisplayManagement.Descriptors;
using OrchardCore.DisplayManagement.ModelBinding;
using OrchardCore.DisplayManagement.Zones;

namespace OrchardCore.DisplayManagement.Handlers;

public abstract class BuildShapeContext : IBuildShapeContext
{
protected BuildShapeContext(IShape shape, string groupId, IShapeFactory shapeFactory, IZoneHolding layout, IUpdateModel updater)
{
Shape = shape;
ShapeFactory = shapeFactory;
GroupId = groupId;
HtmlFieldPrefix = string.Empty;
Layout = layout;
FindPlacement = FindDefaultPlacement;
Updater = updater;
}

public IShape Shape { get; }
public IShapeFactory ShapeFactory { get; private set; }
public dynamic New => ShapeFactory;
public IZoneHolding Layout { get; set; }
public string GroupId { get; private set; }
public string HtmlFieldPrefix { get; protected set; }
public FindPlacementDelegate FindPlacement { get; set; }
public IUpdateModel Updater { get; }
public string DefaultZone { get; set; }
public string DefaultPosition { get; set; }

private static PlacementInfo FindDefaultPlacement(string shapeType, string differentiator, string displayType, IBuildShapeContext context)
{
    return null;
}

}

To--

using OrchardCore.DisplayManagement.Descriptors;
using OrchardCore.DisplayManagement.ModelBinding;
using OrchardCore.DisplayManagement.Zones;

namespace OrchardCore.DisplayManagement.Handlers;

public abstract class BuildShapeContext : IBuildShapeContext
{
protected BuildShapeContext(IShape shape, string groupId, IShapeFactory shapeFactory, IZoneHolding layout, IUpdateModel updater)
{
Shape = shape;
ShapeFactory = shapeFactory;
GroupId = groupId;
HtmlFieldPrefix = string.Empty;
Layout = layout;
FindPlacement = FindDefaultPlacement;
Updater = updater;
}

public IShape Shape { get; set; }
public IShapeFactory ShapeFactory { get; private set; }
public dynamic New => ShapeFactory;
public IZoneHolding Layout { get; set; }
public string GroupId { get; private set; }
public string HtmlFieldPrefix { get; protected set; }
public FindPlacementDelegate FindPlacement { get; set; }
public IUpdateModel Updater { get; }
public string DefaultZone { get; set; }
public string DefaultPosition { get; set; }

private static PlacementInfo FindDefaultPlacement(string shapeType, string differentiator, string displayType, IBuildShapeContext context)
{
    return null;
}

}

Logs and screenshots

[hishamco]

Why? What if you return a null on the displayed result

[infofromca]

I should change it inside public async Task BuildDisplayAsync(ContentItem contentItem, BuildDisplayContext context) of IContentDisplayHandler

[hishamco]

I don't think this is right. The ShapeFactory is responsible for setting the shape

[infofromca]

but after this minor change, my code can run smoothly. if use ShapeFactory, I think it is too complicated

[gvkries]

I agree with @hishamco. BuildShapeContext represents the building process for a specific shape. I don't think it is good to make Shape writable.

[infofromca]

But we should also need to consider the special way for coding. for my situation, only minor change of access let my whole app. go smoothly, I think OrchardCore as as a Core should endure that and make the things easier. and make the more exention .

[hishamco]

As I told you before you can return null when the shape is displayed

[infofromca]

No, your way cannot resolve my issue. return null only hide the part itself.but my purpose is beyond that. I remember we talked about this issue at a ticket #18748 which was closed days or weeks ago.

[hishamco]

but my purpose is beyond that.

Please elaborate

[infofromca]

DisplayDriver ONLY HIDE THAT CURRENT CONTENTPART, NOT ENTIRE CONTENTITEM(CONTENT TYPE), I already tested this.

I want to hide the whole Contents of that Content type (item) .

[infofromca]

and maybe I can change the multi shapes of another contentPart under the Content Type based on diff. conditions. but this idea is just my brainstorm. not my current target.

[hishamco]

DisplayDriver ONLY HIDE THAT CURRENT CONTENTPART

Nope, this is true if you are using ContentPartDisplayDriver, you can create a display driver that targets ContentItem, then you check your type and part before hiding it