Class MacroMethodContainer

Namespace

CMS.MacroEngine

Assembly

CMS.MacroEngine.dll

Container for method extensions of an arbitrary object used by MacroEngine.

public class MacroMethodContainer : MacroExtensionContainer<MacroMethodContainer, MacroMethod>

Inheritance

object

MacroExtensionContainer<MacroMethodContainer, MacroMethod>

MacroMethodContainer

Inherited Members

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.Instance

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.Extensions

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.RegisteredExtensions

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.RegisteredExtensionNames

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.GetExtensionsForObject(object)

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.GetExtensions(Type)

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.GetExtensionForObject(object, string)

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.GetExtension(Type, string)

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.RegisterExtension(MacroMethod)

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.GetExtension(string)

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.RegisterExtensions()

MacroExtensionContainer<MacroMethodContainer, MacroMethod>.CheckGlobalAdmin(EvaluationContext)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

RegisteredMethods

Returns enumerable of all methods.

public IEnumerable<MacroMethod> RegisteredMethods { get; }

Property Value

IEnumerable<MacroMethod>

Methods

CompareDateTime(DateTime, DateTime, string)

Compares DateTime values.

protected static object CompareDateTime(DateTime date1, DateTime date2, string op)

Parameters

date1 DateTime

DateTime to compare

date2 DateTime

DateTime to compare

op string

Comparison operator

Returns

object

CompareDouble(double, double, string)

Compares double numbers.

protected static object CompareDouble(double number1, double number2, string op)

Parameters

number1 double

Number to compare

number2 double

Number to compare

op string

Comparison operator

Returns

object

CompareString(string, string, string, EvaluationContext)

Compares strings (lexicographically).

protected static object CompareString(string str1, string str2, string op, EvaluationContext context)

Parameters

str1 string

String to compare

str2 string

String to compare

op string

Comparison operator

context EvaluationContext

Evaluation context

Returns

object

CompareTimeSpan(TimeSpan, TimeSpan, string)

Compares TimeSpan values.

protected static object CompareTimeSpan(TimeSpan span1, TimeSpan span2, string op)

Parameters

span1 TimeSpan

TimeSpan to compare

span2 TimeSpan

TimeSpan to compare

op string

Comparison operator

Returns

object

CompareValues(EvaluationContext, string, params object[])

Returns true if first parameter is lower than or equal to second.

protected static object CompareValues(EvaluationContext context, string op, params object[] parametersToCompare)

Parameters

context EvaluationContext

Evaluation context with child resolver

op string

Operator

parametersToCompare object[]

First two parameters are numbers to compare

Returns

object

GetBoolParam(object)

Returns the parameter converted to boolean or false if parameter is not boolean.

protected static bool GetBoolParam(object parameter)

Parameters

parameter object

Parameter to convert

Returns

bool

GetDecimalParam(object, string)

Returns the parameter converted to decimal or zero if parameter is not decimal.

protected static decimal GetDecimalParam(object parameter, string culture = null)

Parameters

parameter object

Parameter to convert

culture string

Culture to use to convert object to double

Returns

decimal

GetDoubleParam(object, string)

Returns the parameter converted to double or zero if parameter is not double.

protected static double GetDoubleParam(object parameter, string culture = null)

Parameters

parameter object

Parameter to convert

culture string

Culture to use to convert object to double

Returns

double

GetGuidParam(object)

Converts the parameter to GUID. Returns Guid.Empty if parameter is not GUID.

protected static Guid GetGuidParam(object parameter)

Parameters

parameter object

Parameter to convert

Returns

Guid

GetIntParam(object)

Returns the parameter converted to integer or zero if parameter is not integer.

protected static int GetIntParam(object parameter)

Parameters

parameter object

Parameter to convert

Returns

int

GetLazyParamValue(object, EvaluationContext, out bool)

Gets the lazy parameter value by evaluating it

protected static object GetLazyParamValue(object parameter, EvaluationContext evalContext, out bool securityPassed)

Parameters

parameter object

Parameter to evaluate

evalContext EvaluationContext

Evaluation context

securityPassed bool

Indicates whether the security check passed

Returns

object

GetMethod(string)

Returns a method of given name (return null if specified method does not exist).

public MacroMethod GetMethod(string name)

Parameters

name string

Method name

Returns

MacroMethod

GetMethodForObject(object, string)

Returns macro method object of given name if registered for specified object. It loops through all MacroMethodContainer extensions of given object type. Returns null if there is no such Extension for given object.

public static MacroMethod GetMethodForObject(object obj, string name)

Parameters

obj object

Object to check

name string

Name of the method

Returns

MacroMethod

GetMethodsForObject(object)

Returns list of macro method extension registered for specified object. Returns null if there is no such extension for given object.

public static IEnumerable<MacroMethod> GetMethodsForObject(object obj)

Parameters

obj object

Object to check

Returns

IEnumerable<MacroMethod>

GetOptionalParam<T>(object[], int, T, CultureInfo)

Gets the optional param of the given type

protected static T GetOptionalParam<T>(object[] parameters, int index, T defaultValue, CultureInfo culture = null)

Parameters

parameters object[]

List of method parameters

index int

Parameter index

defaultValue T

Default value in case conversion fails or parameter is not available

culture CultureInfo

Culture for the conversion

Returns

T

Type Parameters

T

GetParamValue<T>(object[], int, T)

Returns the index-th parameter evaluated using given resolver.

protected static T GetParamValue<T>(object[] parameters, int index, T defaultValue)

Parameters

parameters object[]

Method parameters

index int

Index of the parameter within the array

defaultValue T

Default value which will be used if the parameter is not present

Returns

T

Type Parameters

T

GetStringParam(object, string)

Returns the parameter converted to string or empty string.

protected static string GetStringParam(object parameter, string culture = null)

Parameters

parameter object

Parameter to convert

culture string

Culture to use to convert object to string

Returns

string

RegisterExtensions()

Registers all the methods.

protected override void RegisterExtensions()

RegisterMethod(MacroMethod)

Registers the given method.

public void RegisterMethod(MacroMethod method)

Parameters

method MacroMethod

Method to register

RegisterMethodInternal(string, Func<EvaluationContext, object[], object>, Type, string, int, object[,], string[])

Registers the given method within the method table.

protected void RegisterMethodInternal(string name, Func<EvaluationContext, object[], object> method, Type type, string comment, int minimumParameters, object[,] parameterDefinition, string[] specialParameters = null)

Parameters

name string

Method name

method Func<EvaluationContext, object[], object>

Method delegate

type Type

Return type of the method

comment string

Comment for the method

minimumParameters int

Minimal number of parameters needed to call the method

parameterDefinition object[,]

Parameter definition in format {{name, type, comment}, {name, type, comment}}

specialParameters string[]

A list of special parameters needed to be supplied by resolver

RegisterMethodInternal(string[], Func<EvaluationContext, object[], object>, Type, string, int, object[,], string[])

Registers the given method within the method table.

protected void RegisterMethodInternal(string[] names, Func<EvaluationContext, object[], object> method, Type type, string comment, int minimumParameters, object[,] parameterDefinition, string[] specialParameters = null)

Parameters

names string[]

Method names to register

method Func<EvaluationContext, object[], object>

Method delegate

type Type

Return type of the method

comment string

Comment for the method

minimumParameters int

Minimal number of parameters needed to call the method

parameterDefinition object[,]

Parameter definition in format {{name, type, comment}, {name, type, comment}}

specialParameters string[]

A list of special parameters needed to be supplied by resolver

RegisterMethods()

Registers all the methods.

protected virtual void RegisterMethods()

RegisterMethods(params MacroMethod[])

Registers the given methods.

public void RegisterMethods(params MacroMethod[] methods)

Parameters

methods MacroMethod[]

Methods to register

UnwrapContainer(object[])

Unwraps all DateTime and TimeSpan containers to their original system value.

protected static object[] UnwrapContainer(object[] parameters)

Parameters

parameters object[]

Parameters to process

Returns

object[]