File: BindAttribute.cs
Web Access
Project: src\src\Mvc\Mvc.Core\src\Microsoft.AspNetCore.Mvc.Core.csproj (Microsoft.AspNetCore.Mvc.Core)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Linq;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.AspNetCore.Mvc.ModelBinding.Metadata;
 
namespace Microsoft.AspNetCore.Mvc;
 
/// <summary>
/// This attribute can be used on action parameters and types, to indicate model level metadata.
/// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Parameter, AllowMultiple = false, Inherited = true)]
public class BindAttribute : Attribute, IModelNameProvider, IPropertyFilterProvider
{
    private static readonly Func<ModelMetadata, bool> _default = (m) => true;
 
    private Func<ModelMetadata, bool>? _propertyFilter;
 
    /// <summary>
    /// Creates a new instance of <see cref="BindAttribute"/>.
    /// </summary>
    /// <param name="include">Names of parameters to include in binding.</param>
    public BindAttribute(params string[] include)
    {
        var items = new List<string>(include.Length);
        foreach (var item in include)
        {
            items.AddRange(SplitString(item));
        }
 
        Include = items.ToArray();
    }
 
    /// <summary>
    /// Gets the names of properties to include in model binding.
    /// </summary>
    public string[] Include { get; }
 
    /// <summary>
    /// Allows a user to specify a particular prefix to match during model binding.
    /// </summary>
    // This property is exposed for back compat reasons.
    public string? Prefix { get; set; }
 
    /// <summary>
    /// Represents the model name used during model binding.
    /// </summary>
    string? IModelNameProvider.Name => Prefix;
 
    /// <inheritdoc />
    public Func<ModelMetadata, bool> PropertyFilter
    {
        get
        {
            if (Include != null && Include.Length > 0)
            {
                _propertyFilter ??= PropertyFilter;
                return _propertyFilter;
            }
            else
            {
                return _default;
            }
 
            bool PropertyFilter(ModelMetadata modelMetadata)
            {
                if (modelMetadata.MetadataKind == ModelMetadataKind.Parameter)
                {
                    return Include.Contains(modelMetadata.ParameterName, StringComparer.Ordinal);
                }
 
                return Include.Contains(modelMetadata.PropertyName, StringComparer.Ordinal);
            }
        }
    }
 
    private static IEnumerable<string> SplitString(string original)
        => original?.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries) ?? Array.Empty<string>();
}