Skip to content

Add custom fields for template inheritance #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add custom fields for template inheritance #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
346 changes: 161 additions & 185 deletions Sitecore.Master/Code Generation Templates/GlassV3Item.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,129 +1,117 @@
<#@ template language="C#" #>
<#@ output encoding="utf-8"#>

<#@ include file="Helpers.tt" #>
<#@ include file="StringExtensions.tt" #>
<#@ include file="GeneralExtensions.tt" #>
<#@ include file="Inflector.tt" #>

<#@ assembly name="System.Core.dll" #>

<#@ import namespace="System" #>
<#@ import namespace="System.Text" #>
<#@ import namespace="System.Linq" #>
<#@ import namespace="System.Collections.Generic" #>
<#@ import namespace="HedgehogDevelopment.SitecoreProject.VSIP.CodeGeneration.Models" #>

<#@ parameter name="Model" type="HedgehogDevelopment.SitecoreProject.VSIP.CodeGeneration.Models.SitecoreItem" #>
<#@ parameter name="DefaultNamespace" type="System.String" #>

<#
/*
This TDS Code Generation template is used to generate objects that are compatible with the
Glass Sitecore Mapper that is available @ http://www.glass.lu/

There are a few things you can put in the 'Custom Data' property of a field in TDS.
There are a few things you can put in the 'Custom Data' property of a field in TDS.
To use multiple settings put them in as a querystring (key1=value&key2=value)

ignore=true
Sets a field to be skipped over for code gen
Sets a field to be skipped over for code gen
name=[name]
Forces the name of the generated property.
If not specified, then the generated property is the name of the Sitecore field.
If the field stores multiple values, the property name is pluralized.
Forces the name of the generated property.
If not specified, then the generated property is the name of the Sitecore field.
If the field stores multiple values, the property name is pluralized.
type=[type]
Sets the return type of the generated property
Sets the return type of the generated property
generic=[type]
In the event the type (either specificed or auto mapped) is a generic it will use this generic type. i.e. List<generic>

In the event the type (either specificed or auto mapped) is a generic it will use this generic type. i.e. List<generic>

Custom properties for template items:
inherits=[type]
Inherits the generated template model from the custom type
interface=[type]
Inherits the generated template interface from the custom interface

*/
#>

<#
// we only act on Templates
SitecoreTemplate template = Model as SitecoreTemplate;
if (template == null)
{
return "";
return "";
}

string Tool = "Team Development for Sitecore - GlassItem.tt";
string ToolVersion = "1.0";
string TemplateParentInterface = GetCustomProperty(template.Data, "interface");
string ParentInterface = !string.IsNullOrEmpty(TemplateParentInterface) ? TemplateParentInterface : "IGlassBase";
Func<string, string> getInterfaceName = (string s) => AsInterfaceName(!string.IsNullOrEmpty(TemplateParentInterface) ? TemplateParentInterface : s);
#>

namespace <#= GetNamespace(DefaultNamespace, template)#>
{


/// <summary>
/// <#= AsInterfaceName(template.Name) #> Interface
/// <para><#= GetValue(template.SitecoreFields, "__Short description")#></para>
/// <para>Path: <#= template.Path #></para>
/// <para>ID: <#= template.ID.ToString() #></para>
/// </summary>
[SitecoreType(TemplateId=<#= AsInterfaceName(template.Name) #>Constants.TemplateIdString )] //, Cachable = true
public partial interface <#= AsInterfaceName(template.Name) #> : IGlassBase <#=GetObjectInheritanceDefinition(DefaultNamespace, template, true, (string s) => AsInterfaceName(s))#>
{
<#foreach(SitecoreField field in GetFieldsForTemplate(template, false)){#>
/// <summary>
/// The <#=field.Name#> field.
/// <para><#= GetValue(field.SitecoreFields, "__Short description")#></para>
/// <para>Field Type: <#=field.Type#></para>
/// <para>Field ID: <#=field.ID.ToString()#></para>
/// <para>Custom Data: <#=field.Data#></para>
/// </summary>
[SitecoreField(<#= AsInterfaceName(template.Name) #>Constants.<#= GetPropertyName(field) #>FieldName)]
<#=GetGlassFieldType(field)#> <#= GetPropertyName(field) #> {get; set;}

<#}#>
}


public static partial class <#= AsInterfaceName(template.Name) #>Constants{

public const string TemplateIdString = "<#= template.ID.ToString() #>";
public static readonly ID TemplateId = new ID(TemplateIdString);
public const string TemplateName = "<#= template.Name #>";

<#foreach(SitecoreField field in GetFieldsForTemplate(template, true)){#>

public static readonly ID <#= GetPropertyName(field) #>FieldId = new ID("<#=field.ID.ToString()#>");
public const string <#= GetPropertyName(field) #>FieldName = "<#=field.Name#>";

<#}#>

}

/// <summary>
/// <#= AsInterfaceName(template.Name) #> Interface
/// <para><#= GetValue(template.SitecoreFields, "__Short description")#></para>
/// <para>Path: <#= template.Path #></para>
/// <para>ID: <#= template.ID.ToString() #></para>
/// </summary>
[SitecoreType(TemplateId=<#= AsInterfaceName(template.Name) #>Constants.TemplateIdString )] //, Cachable = true
public partial interface <#= AsInterfaceName(template.Name) #> : <#= ParentInterface #> <#=GetObjectInheritanceDefinition(DefaultNamespace, template, true, getInterfaceName)#>
{
<#foreach(SitecoreField field in GetFieldsForTemplate(template, false)){#>
/// <summary>
/// The <#=field.Name#> field.
/// <para><#= GetValue(field.SitecoreFields, "__Short description")#></para>
/// <para>Field Type: <#=field.Type#></para>
/// <para>Field ID: <#=field.ID.ToString()#></para>
/// <para>Custom Data: <#=field.Data#></para>
/// </summary>
[SitecoreField(<#= AsInterfaceName(template.Name) #>Constants.<#= GetPropertyName(field) #>FieldName)]
<#=GetGlassFieldType(field)#> <#= GetPropertyName(field) #> {get; set;}
<#}#>
}
public static partial class <#= AsInterfaceName(template.Name) #>Constants{
public const string TemplateIdString = "<#= template.ID.ToString() #>";
public static readonly ID TemplateId = new ID(TemplateIdString);
public const string TemplateName = "<#= template.Name #>";
<#foreach(SitecoreField field in GetFieldsForTemplate(template, true)){#>
public static readonly ID <#= GetPropertyName(field) #>FieldId = new ID("<#=field.ID.ToString()#>");
public const string <#= GetPropertyName(field) #>FieldName = "<#=field.Name#>";
<#}#>
}
<#
// If the name of the template looks like an Interface, then don't generate a class definition
if (!IsInterfaceWord(template.Name)){ #>
/// <summary>
/// <#= AsClassName(template.Name) #>
/// <para><#= GetValue(template.SitecoreFields, "__Short description")#></para>
/// <para>Path: <#= template.Path #></para>
/// <para>ID: <#= template.ID.ToString() #></para>
/// </summary>
[SitecoreType(TemplateId=<#= AsInterfaceName(template.Name) #>Constants.TemplateIdString)] //, Cachable = true
public partial class <#= AsClassName(template.Name) #> : GlassBase, <#=AsInterfaceName(template.Name)#>
{

<#foreach(SitecoreField field in GetFieldsForTemplate(template, true)){#>
/// <summary>
/// The <#=field.Name#> field.
/// <para><#= GetValue(field.SitecoreFields, "__Short description")#></para>
/// <para>Field Type: <#=field.Type#></para>
/// <para>Field ID: <#=field.ID.ToString()#></para>
/// <para>Custom Data: <#=field.Data#></para>
/// </summary>
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("<#=Tool#>", "<#=ToolVersion#>")]
[SitecoreField(<#= AsInterfaceName(template.Name) #>Constants.<#= GetPropertyName(field) #>FieldName)]
public virtual <#=GetGlassFieldType(field)#> <#= GetPropertyName(field) #> {get; set;}

<#}#>
}
if (!IsInterfaceWord(template.Name)){
string TemplateParentClass = GetCustomProperty(template.Data, "inherits");
string className = !string.IsNullOrEmpty(TemplateParentClass) ? TemplateParentClass : "GlassBase";
#>
/// <summary>
/// <#= AsClassName(template.Name) #>
/// <para><#= GetValue(template.SitecoreFields, "__Short description")#></para>
/// <para>Path: <#= template.Path #></para>
/// <para>ID: <#= template.ID.ToString() #></para>
/// </summary>
[SitecoreType(TemplateId=<#= AsInterfaceName(template.Name) #>Constants.TemplateIdString)] //, Cachable = true
public partial class <#= AsClassName(template.Name) #> : <#= className #>, <#=AsInterfaceName(template.Name)#>
{
<#foreach(SitecoreField field in GetFieldsForTemplate(template, true)){#>
/// <summary>
/// The <#=field.Name#> field.
/// <para><#= GetValue(field.SitecoreFields, "__Short description")#></para>
/// <para>Field Type: <#=field.Type#></para>
/// <para>Field ID: <#=field.ID.ToString()#></para>
/// <para>Custom Data: <#=field.Data#></para>
/// </summary>
[global::System.CodeDom.Compiler.GeneratedCodeAttribute("<#=Tool#>", "<#=ToolVersion#>")]
[SitecoreField(<#= AsInterfaceName(template.Name) #>Constants.<#= GetPropertyName(field) #>FieldName)]
public virtual <#=GetGlassFieldType(field)#> <#= GetPropertyName(field) #> {get; set;}
<#}#>
}
<#}#>
}

<#+
/// <summary>
/// Gets the inheritance string for the generated template
Expand All @@ -134,107 +122,95 @@ if (!IsInterfaceWord(template.Name)){ #>
/// <returns></returns>
public static string GetObjectInheritanceDefinition(string defaultNamespace, SitecoreTemplate item, bool includeLeadingComma, Func<string, string> nameFunc)
{
if (item.BaseTemplates.Count > 0)
{
return string.Concat(includeLeadingComma ? ", " : "",
item.BaseTemplates
.Select( bt => GetFullyQualifiedName(defaultNamespace, bt, nameFunc)) // select the name of the template with an 'I' prefix
.Aggregate( (total,next) => total + ", " + next) // basically a string.join(string[], '')
);
}
return "";
if (item.BaseTemplates.Count > 0)
{
return string.Concat(includeLeadingComma ? ", " : "",
item.BaseTemplates
.Select( bt => GetFullyQualifiedName(defaultNamespace, bt, nameFunc)) // select the name of the template with an 'I' prefix
.Aggregate( (total,next) => total + ", " + next) // basically a string.join(string[], '')
);
}
return "";
}

public static string GetGlassFieldType(SitecoreField field)
{
if (field != null && field.Type != null)
{
// Pull out any 'type' param from the custom data field on the field in TDS
string customType = GetCustomProperty(field.Data, "type");
string generic = GetCustomProperty(field.Data, "generic");

if (customType != "")
{
if (generic != "")
{
return string.Format("{0}<{1}>", customType, generic);
}
else
{
return customType;
}
}

switch(field.Type.ToLower())
{
case "tristate":
return "TriState";
case "checkbox":
return "bool";

case "date":
case "datetime":
return "DateTime";

case "number":
return "float";

case "integer":
return "int";

case "treelist with search":
case "treelist":
case "treelistex":
case "treelist descriptive":
case "checklist":
case "multilist with search":
case "multilist":
return string.Format("IEnumerable<{0}>", string.IsNullOrEmpty(generic) ? "Guid" : generic);

case "grouped droplink":
case "droplink":
case "lookup":
case "droptree":
case "reference":
case "tree":
return "Guid";

case "file":
return "File";

case "image":
return "Image";

case "general link":
case "general link with search":
return "Link";

case "password":
case "icon":
case "rich text":
case "html":
case "single-line text":
case "multi-line text":
case "frame":
case "text":
case "memo":
case "droplist":
case "grouped droplist":
case "valuelookup":
return "string";
case "attachment":
case "word document":
return "System.IO.Stream";
case "name lookup value list":
case "name value list":
return "System.Collections.Specialized.NameValueCollection";
default:
return "object /* UNKNOWN */";
}
}
else
{
throw new Exception("There is no 'Type' field on the " + field.Name + " field.");
}
if (field != null && field.Type != null)
{
// Pull out any 'type' param from the custom data field on the field in TDS
string customType = GetCustomProperty(field.Data, "type");
string generic = GetCustomProperty(field.Data, "generic");
if (customType != "")
{
if (generic != "")
{
return string.Format("{0}<{1}>", customType, generic);
}
else
{
return customType;
}
}
switch(field.Type.ToLower())
{
case "tristate":
return "TriState";
case "checkbox":
return "bool";
case "date":
case "datetime":
return "DateTime";
case "number":
return "float";
case "integer":
return "int";
case "treelist with search":
case "treelist":
case "treelistex":
case "treelist descriptive":
case "checklist":
case "multilist with search":
case "multilist":
return string.Format("IEnumerable<{0}>", string.IsNullOrEmpty(generic) ? "Guid" : generic);
case "grouped droplink":
case "droplink":
case "lookup":
case "droptree":
case "reference":
case "tree":
return "Guid";
case "file":
return "File";
case "image":
return "Image";
case "general link":
case "general link with search":
return "Link";
case "password":
case "icon":
case "rich text":
case "html":
case "single-line text":
case "multi-line text":
case "frame":
case "text":
case "memo":
case "droplist":
case "grouped droplist":
case "valuelookup":
return "string";
case "attachment":
case "word document":
return "System.IO.Stream";
case "name lookup value list":
case "name value list":
return "System.Collections.Specialized.NameValueCollection";
default:
return "object /* UNKNOWN */";
}
}
else
{
throw new Exception("There is no 'Type' field on the " + field.Name + " field.");
}
}
#>