Adds notes with links back to PR about server side validation

This commit is contained in:
Shannon
2020-07-23 23:06:58 +10:00
parent 06afab9893
commit ad9d0fad4f
6 changed files with 23 additions and 2 deletions

View File

@@ -7,6 +7,10 @@
* Used to handle server side validation and wires up the UI with the messages. There are 2 types of validation messages, one
* is for user defined properties (called Properties) and the other is for field properties which are attached to the native
* model objects (not user defined). The methods below are named according to these rules: Properties vs Fields.
*
* For a more indepth explanation of how server side validation works with the angular app, see this GitHub PR:
* https://github.com/umbraco/Umbraco-CMS/pull/8339
*
*/
function serverValidationManager($timeout) {

View File

@@ -7,6 +7,10 @@ namespace Umbraco.Web.PropertyEditors.Validation
/// <summary>
/// A collection of <see cref="ComplexEditorPropertyTypeValidationResult"/> for an element type within complex editor represented by an Element Type
/// </summary>
/// <remarks>
/// For a more indepth explanation of how server side validation works with the angular app, see this GitHub PR:
/// https://github.com/umbraco/Umbraco-CMS/pull/8339
/// </remarks>
public class ComplexEditorElementTypeValidationResult : ValidationResult
{
public ComplexEditorElementTypeValidationResult(string elementTypeAlias, Guid blockId)

View File

@@ -8,6 +8,10 @@ namespace Umbraco.Web.PropertyEditors.Validation
/// <summary>
/// A collection of <see cref="ValidationResult"/> for a property type within a complex editor represented by an Element Type
/// </summary>
/// <remarks>
/// For a more indepth explanation of how server side validation works with the angular app, see this GitHub PR:
/// https://github.com/umbraco/Umbraco-CMS/pull/8339
/// </remarks>
public class ComplexEditorPropertyTypeValidationResult : ValidationResult
{
public ComplexEditorPropertyTypeValidationResult(string propertyTypeAlias)

View File

@@ -8,7 +8,10 @@ namespace Umbraco.Web.PropertyEditors.Validation
/// A collection of <see cref="ComplexEditorElementTypeValidationResult"/> for a complex editor represented by an Element Type
/// </summary>
/// <remarks>
/// For example, each <see cref="ComplexEditorValidationResult"/> represents validation results for a row in Nested Content
/// For example, each <see cref="ComplexEditorValidationResult"/> represents validation results for a row in Nested Content.
///
/// For a more indepth explanation of how server side validation works with the angular app, see this GitHub PR:
/// https://github.com/umbraco/Umbraco-CMS/pull/8339
/// </remarks>
public class ComplexEditorValidationResult : ValidationResult
{

View File

@@ -7,7 +7,10 @@ namespace Umbraco.Web.PropertyEditors.Validation
/// Custom <see cref="ValidationResult"/> for content properties
/// </summary>
/// <remarks>
/// This clones the original result and then ensures the nested result if it's the correct type
/// This clones the original result and then ensures the nested result if it's the correct type.
///
/// For a more indepth explanation of how server side validation works with the angular app, see this GitHub PR:
/// https://github.com/umbraco/Umbraco-CMS/pull/8339
/// </remarks>
public class ContentPropertyValidationResult : ValidationResult
{

View File

@@ -15,6 +15,9 @@ namespace Umbraco.Web.PropertyEditors.Validation
/// <remarks>
/// This converter is specifically used to convert validation results for content in order to be able to have nested
/// validation results for complex editors.
///
/// For a more indepth explanation of how server side validation works with the angular app, see this GitHub PR:
/// https://github.com/umbraco/Umbraco-CMS/pull/8339
/// </remarks>
internal class ValidationResultConverter : JsonConverter
{