orchardcore-rules

Orchard Core Rules

OrchardCore.Rules is the structured condition system used by features such as Layers. A rule is a model of conditions evaluated against the current request and context. It is different from OrchardCore.Scripting: scripting can power a condition, but Rules provides condition models, editors, registration, serialization, and composable all/any groups.

Guidelines

• Enable the exact OrchardCore.Rules feature; it depends on OrchardCore.Scripting.
• Use Condition as the base type for a custom condition.
• Implement IConditionEvaluator with ValueTask<bool> EvaluateAsync(Condition condition).
• Register standard conditions through AddRuleCondition; do not use obsolete AddCondition.
• Use AddRule when a condition has a display driver and the default condition factory is sufficient.
• Register polymorphic JSON information through the provided registration extensions.
• Keep evaluators scoped because a rule can require request-scoped services or a scripting engine.
• Use a display driver to expose a condition in the rule builder UI.
• Do not treat a JavaScript condition as a substitute for structured authorization logic.
• All C# classes in examples are sealed except View Models.

Enable Rules

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.Rules"
      ],
      "disable": []
    }
  ]
}

The module registers all, any, boolean, home page, URL, culture, role, JavaScript, authenticated, anonymous, and content-type conditions. It also registers string equality, prefix, suffix, and contains operators.

Core Types