Active Model Errors¶ ↑

传入正在使用 errors 对象的实例。

class Person
  def initialize
    @errors = ActiveModel::Errors.new(self)
  end
end

当传入一个符号或方法名时，返回该方法的错误数组。

person.errors[:name]  # => ["cannot be nil"]
person.errors['name'] # => ["cannot be nil"]

在 attribute 上添加一个 type 类型的新错误。同一个 attribute 可以添加多个错误。如果未提供 type，则默认为 :invalid。

person.errors.add(:name)
# Adds <#ActiveModel::Error attribute=name, type=invalid>
person.errors.add(:name, :not_implemented, message: "must be implemented")
# Adds <#ActiveModel::Error attribute=name, type=not_implemented,
                            options={:message=>"must be implemented"}>

person.errors.messages
# => {:name=>["is invalid", "must be implemented"]}

如果 type 是一个字符串，它将被用作错误消息。

如果 type 是一个符号，它将使用适当的范围进行翻译（参见 generate_message）。

person.errors.add(:name, :blank)
person.errors.messages
# => {:name=>["can't be blank"]}

person.errors.add(:name, :too_long, count: 25)
person.errors.messages
# => ["is too long (maximum is 25 characters)"]

如果 type 是一个 proc，它将被调用，允许使用例如 Time.now 在错误中使用。

如果设置了 :strict 选项为 true，则会引发 ActiveModel::StrictValidationFailed 而不是添加错误。:strict 选项也可以设置为任何其他异常。

person.errors.add(:name, :invalid, strict: true)
# => ActiveModel::StrictValidationFailed: Name is invalid
person.errors.add(:name, :invalid, strict: NameIsInvalid)
# => NameIsInvalid: Name is invalid

person.errors.messages # => {}

如果错误不直接与单个属性关联，则 attribute 应设置为 :base。

person.errors.add(:base, :name_or_email_blank,
  message: "either name or email must be present")
person.errors.messages
# => {:base=>["either name or email must be present"]}
person.errors.details
# => {:base=>[{error: :name_or_email_blank}]}

如果错误与提供的 attribute 和 type 匹配，则返回 true，否则返回 false。type 的处理方式与 add 方法相同。

person.errors.add :name, :blank
person.errors.added? :name, :blank           # => true
person.errors.added? :name, "can't be blank" # => true

如果错误需要选项，则在提供正确选项时返回 true，在提供不正确或缺失选项时返回 false。

person.errors.add :name, :too_long, count: 25
person.errors.added? :name, :too_long, count: 25                     # => true
person.errors.added? :name, "is too long (maximum is 25 characters)" # => true
person.errors.added? :name, :too_long, count: 24                     # => false
person.errors.added? :name, :too_long                                # => false
person.errors.added? :name, "is too long"                            # => false

返回一个可以作为此对象 JSON 表示形式的 Hash。您可以传递 :full_messages 选项。这决定了 JSON 对象是否应包含完整消息（默认为 false）。

person.errors.as_json                      # => {:name=>["cannot be nil"]}
person.errors.as_json(full_messages: true) # => {:name=>["name cannot be nil"]}

返回所有错误属性名称

person.errors.messages        # => {:name=>["cannot be nil", "must be specified"]}
person.errors.attribute_names # => [:name]

清除所有错误。但是，清除错误并不会使模型有效。下次运行验证时（例如，通过 ActiveRecord::Validations#valid?），如果任何验证失败，错误集合将再次填充。

删除 key 的消息。返回已删除的消息。

person.errors[:name]        # => ["cannot be nil"]
person.errors.delete(:name) # => ["cannot be nil"]
person.errors[:name]        # => []

返回一个包含属性及其错误详细信息数组的 Hash。

遍历每个错误对象。

person.errors.add(:name, :too_short, count: 2)
person.errors.each do |error|
  # Will yield <#ActiveModel::Error attribute=name, type=too_short,
                                    options={:count=>3}>
end

如果没有错误，则返回 true。

为给定的属性返回一个完整的消息。

person.errors.full_message(:name, 'is invalid') # => "Name is invalid"

以数组形式返回所有完整的错误消息。

class Person
  validates_presence_of :name, :address, :email
  validates_length_of :name, in: 5..30
end

person = Person.create(address: '123 First St.')
person.errors.full_messages
# => ["Name is too short (minimum is 5 characters)", "Name can't be blank", "Email can't be blank"]

以数组形式返回给定属性的所有完整错误消息。

class Person
  validates_presence_of :name, :email
  validates_length_of :name, in: 5..30
end

person = Person.create()
person.errors.full_messages_for(:name)
# => ["Name is too short (minimum is 5 characters)", "Name can't be blank"]

在默认范围（activemodel.errors.messages）下翻译错误消息。

Error 消息首先在 activemodel.errors.models.MODEL.attributes.ATTRIBUTE.MESSAGE 中查找，如果不存在，则在 activemodel.errors.models.MODEL.MESSAGE 中查找，如果仍然不存在，则返回默认消息的翻译（例如 activemodel.errors.messages.MESSAGE）。翻译后的模型名称、翻译后的属性名称和值可用于插值。

在使用模型继承时，它会检查所有继承的模型，但前提是模型本身尚未找到。假设您有 class Admin < User; end，并且您想要 title 属性的 :blank 错误消息的翻译，它会查找以下翻译

• activemodel.errors.models.admin.attributes.title.blank

• activemodel.errors.models.admin.blank

• activemodel.errors.models.user.attributes.title.blank

• activemodel.errors.models.user.blank

• 您通过 options 哈希在 activemodel.errors 范围中提供的任何默认值

• activemodel.errors.messages.blank

• errors.attributes.title.blank

• errors.messages.blank

返回一个包含属性及其 Error 对象数组的 Hash。

person.errors.group_by_attribute
# => {:name=>[<#ActiveModel::Error>, <#ActiveModel::Error>]}

导入一个错误。导入的错误将被包装为 NestedError，提供对原始错误对象的访问。如果需要覆盖属性或类型，请使用 override_options。

Options¶ ↑

• :attribute - 覆盖错误所属的属性。

• :type - 覆盖错误的类型。

如果错误消息包含给定键 attribute 的错误，则返回 true，否则返回 false。

person.errors.messages        # => {:name=>["cannot be nil"]}
person.errors.include?(:name) # => true
person.errors.include?(:age)  # => false

合并 other 中的错误，每个 Error 都包装为 NestedError。

Parameters¶ ↑

• other - ActiveModel::Errors 实例。

Examples¶ ↑

person.errors.merge!(other)

返回一个包含属性及其错误消息数组的 Hash。

以数组形式返回给定属性的所有错误消息。

class Person
  validates_presence_of :name, :email
  validates_length_of :name, in: 5..30
end

person = Person.create()
person.errors.messages_for(:name)
# => ["is too short (minimum is 5 characters)", "can't be blank"]

如果属性上存在给定类型的错误，则返回 true，否则返回 false。type 的处理方式与 add 方法相同。

person.errors.add :age
person.errors.add :name, :too_long, count: 25
person.errors.of_kind? :age                                            # => true
person.errors.of_kind? :name                                           # => false
person.errors.of_kind? :name, :too_long                                # => true
person.errors.of_kind? :name, "is too long (maximum is 25 characters)" # => true
person.errors.of_kind? :name, :not_too_long                            # => false
person.errors.of_kind? :name, "is too long"                            # => false

返回错误数量。

返回一个包含属性及其错误消息的 Hash。如果 full_messages 为 true，则包含完整消息（参见 full_message）。

person.errors.to_hash       # => {:name=>["cannot be nil"]}
person.errors.to_hash(true) # => {:name=>["name cannot be nil"]}

搜索匹配 attribute、type 或 options 的错误。

只有提供的参数才会被匹配。

person.errors.where(:name) # => all name errors.
person.errors.where(:name, :too_short) # => all name errors being too short
person.errors.where(:name, :too_short, minimum: 2) # => all name errors being too short and minimum is 2