Skip to main content

A DD4T.net Implementation - Strong-Typed Model in Component Controller

Image
By
In the previous post, I was mentioning that a Component controller can be reused in both cases when the Component Presentation is embedded on the Page, as well as when it is published as Dynamic Component Presentation (DCP). In this post I will elaborate this topic.

The Component controller consists of the following sample code:

    public class DeviceController : MyControllerBase
    {
        public ActionResult Index(int? publication, int? component, string view)
        {
            Device device;
            string viewName;
            ResolveModelAndView<Device>(publication, component, view, out device, out viewName);

            return View(viewName, device);
        }
    }

Two things to note here:
  • DeviceController is a specialization of MyControllerBase;
  • Method ResolveModelAndView is defined in a parent class and is in charge with figuring out both the strongly-typed model for the Component and the view name;

The method implementation, as defined in the MyControllerBase, is the following:

    public void ResolveModelAndView<T>(int? publication, int? component, string view, out T model, out string viewName) where T : ModelBase
    {
        model = GetModel<T>(publication, component, view);
        viewName = GetViewName(view);

        if (model == null || string.IsNullOrEmpty(viewName))
        {
            throw new HttpException(404, "Page Not Found");
        }
    }

The model is retrieved by method GetModel showcased below. The method behaves differently based on whether the Component Presentation is embedded on the Page or not.

If on the Page, calling GetComponentPresentation method defined in TridionControllerBase will give us the IComponentPresentation model; otherwise, we resort to using the ModelFactory to load the strongly-typed model.

One extra check is made on whether the Component Presentation is dynamic or not, this affecting the way we load its strong-typed model.

    public T GetModel<T>(int? publication, int? component, string view) where T : ModelBase
    {
        T model = null;
        string componentUri = null;
        IComponentPresentation componentPresentation = GetComponentPresentation();

        if (componentPresentation == null)
        {
            if (publication == null || component == null)
            {
                return null;
            }
            else
            {
                componentUri = string.Format("tcm:{0}-{1}", publication, component);
                model = ModelFactory.GetModel<T>(componentUri, view);
            }
        }
        else
        {
            if (componentPresentation.IsDynamic)
            {
                componentUri = componentPresentation.Component.Id;
                string templateUri = componentPresentation.ComponentTemplate.Id;
                model = ModelFactory.GetModel<T>(componentUri, templateUri);
            }
            else
            {
                model = ModelFactory.GetModel<T>(componentPresentation.Component);
            }
        }

        return model;
    }

The other method, GetViewName(string view) is quite straight forward, as it simply looks at the Component Template metadata to retrieve the view field.

    public string GetViewName(string view)
    {
        IComponentPresentation componentPresentation = GetComponentPresentation();
        return componentPresentation == null ? view : GetViewName(componentPresentation);
    }

    public string GetViewName(IComponentPresentation componentPresentation)
    {
        IComponentTemplate template = componentPresentation.ComponentTemplate;
        IFieldSet fields = template.MetadataFields;

        string viewName = fields.StringValue("view");
        if (string.IsNullOrEmpty(viewName))
        {
            viewName = template.Title;
        }

        return viewName;
    }

In case the Component Presentation is not present on the Page, there will be no Component Template model either, and as such, we need to provide our own view parameter (that we require as input parameter).



Labels:

Comments

Post a Comment

Popular posts from this blog

Scaling Policies

By
This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the
Post a Comment
Read more

Running sp_updatestats on AWS RDS database

By
Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as
1 comment
Read more

Toolkit - Dynamic Content Queries

By
This post if part of a series about the  File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents the Dynamic Content Query capability. The requirements for the Toolkit API are that it should be able to provide CustomMeta queries, pagination, and sorting -- all on the file system, without the use third party tools (database, search engines, indexers, etc). Therefore I had to implement a simple database engine and indexer -- which is described in more detail in post Writing My Own Database Engine . The querying logic does not make use of cache. This means the query logic is executed every time. When models are requested, the models are however retrieved using the ModelFactory and those are cached. Query Class This is the main class for dynamic content queries. It is the entry point into the execution logic of a query. The class takes as parameter a Criterion (presented below) which triggers the execution of query in all sub-criteria of a Criterio
Post a Comment
Read more