output of a list of objects within a view with specific routes

Dominic Resch 45 posts 115 karma points

Jan 19, 2024 @ 16:19

Hello everyone.

What I need (Umbraco 13):

I would like to display a list of search results when calling the following URLs.

/{culture}/discipline/{discipline}
/{culture}/disziplin/{discipline}
/{culture}/topic/{topic}
/{culture}/thema/{topic}

The URLs are therefore also language-dependent, in this case English and German, but more could be added in the future.

A distinction is also made between topic and discipline. The resulting list is the same, e.g. List of SearchResult objects. Only the logic within is different.

The view should have the master.cshtml defined as the layout, which currently contains the following line:

@inherits Umbraco.Cms.Web.Common.Views.UmbracoViewPage

Means I have to return content somehow.

I have now tried to define custom routes and have them point to a controller, which has 2 actions, which in turn returns the view with the list of search results. But I always got the error message that the model cannot be bound because it is not IPublishedContent. At least when I used the layout. Without the layout it worked without any problems.

I didn't create any document types or content nodes either, as I don't think they help me very much here. But none of it really works.

Has anyone already done something like this? I don't need a full implementation of course, just some guidance. A direction that leads me to the solution. Do I need to create custom routes? Do I have to create document types and solve this via route hijacking? Is there an alternative, perhaps without document types?

UPDATE

My current implementation (quick and dirty, since I'm only evaluating Umbraco currently to see if it fits our needs):

Composer:

public class SearchResultsControllerComposer : IComposer
{
    public void Compose(IUmbracoBuilder builder)
        => builder.Services.Configure<UmbracoPipelineOptions>(options =>
        {
            options.AddFilter(new UmbracoPipelineFilter(nameof(SearchResultsController))
            {
                Endpoints = app => app.UseEndpoints(endpoints =>
                {
                    // German
                    endpoints.MapControllerRoute(
                            "Search results controller - Disziplinen",
                            "/{culture}/disziplin/{discipline?}",
                            new { Controller = "SearchResults", Action = "Discipline" })
                        .ForUmbracoPage(FindContent);
                    endpoints.MapControllerRoute(
                            "Search results controller - Thema",
                            "/{culture}/thema/{topic?}",
                            new { Controller = "SearchResults", Action = "Topic" })
                        .ForUmbracoPage(FindContent);

                    // English
                    endpoints.MapControllerRoute(
                            "Search results controller - Discipline",
                            "/{culture}/discipline/{discipline?}",
                            new { Controller = "SearchResults", Action = "Discipline" })
                        .ForUmbracoPage(FindContent);
                    endpoints.MapControllerRoute(
                            "Search results controller - Topic",
                            "/{culture}/topic/{topic?}",
                            new { Controller = "SearchResults", Action = "Topic" })
                        .ForUmbracoPage(FindContent);
                })
            });
        });

    private IPublishedContent FindContent(ActionExecutingContext actionExecutingContext)
    {
        var umbracoContextAccessor = actionExecutingContext.HttpContext.RequestServices
            .GetRequiredService<IUmbracoContextAccessor>();

        IUmbracoContext umbracoContext = umbracoContextAccessor.GetRequiredUmbracoContext();
        IPublishedContent? root = umbracoContext.Content.GetAtRoot().FirstOrDefault();

        return root;
    }
}

Controller:

public class SearchResultsController(
    ILogger<UmbracoPageController> logger,
    ICompositeViewEngine compositeViewEngine,
    ISearchService searchService) : UmbracoPageController(logger, compositeViewEngine)
{
    [HttpGet]
    public IActionResult Discipline(string culture, string discipline)
    {
        IEnumerable<IPublishedContent> content = searchService.SearchContentTag(culture, discipline);

        return View(nameof(Index), GetSearchResult(content).ToList());
    }

    [HttpGet]
    public IActionResult Index(IEnumerable<SearchResultByTagModel> searchResults)
        => CurrentTemplate(CurrentPage);

    [HttpGet]
    public IActionResult Topic(string culture, string topic)
    {
        IEnumerable<IPublishedContent> content = searchService.SearchContentTag(culture, topic);

        return View(nameof(Index), GetSearchResult(content).ToList());
    }

    private IEnumerable<SearchResultByTagModel> GetSearchResult(IEnumerable<IPublishedContent> pages)
        => pages.Select(x => new SearchResultByTagModel(x)
        {
            Name = x.Name,
            Url = x.Url()
        });
}

index.cshtml (of my controller):

@using Project.Umbraco.Models
@model List<SearchResultByTagModel>

@{
    Layout = "../master.cshtml";
}

<article class="box">
    @foreach (SearchResultByTagModel item in Model)
    {

    }
</article>

master.cshtml (shortened):

@using System.Globalization

@inherits Umbraco.Cms.Web.Common.Views.UmbracoViewPage
@{
    Layout = null;

    var home = (Home)Model.Root();
    var font = home.Font;
    var colorTheme = home.ColorTheme;

    var currentCultureName = @Model.GetCultureFromDomains().ToLower();
}

<!DOCTYPE HTML>
<html lang="@currentCultureName">
    <head>
        <title>@Model.Name - @home.Sitename</title>
    </head>
    <body class="left-sidebar is-preload">
        @RenderBody()
    </body>
</html>

Flag this post as spam?

Output of a list of objects within a view with specific routes