Module: Mongoid::Document::ClassMethods

Defined in:
lib/mongoid/document.rb

Instance Method Summary collapse

Instance Method Details

#===(other) ⇒ true, false

Performs class equality checking.

Examples:

Compare the classes.

document === other

Parameters:

  • other (Document, Object)

    The other object to compare with.

Returns:

  • (true, false)

    True if the classes are equal, false if not.

Since:

  • 2.0.0.rc.4


291
292
293
# File 'lib/mongoid/document.rb', line 291

def ===(other)
  other.class == Class ? self <= other : other.is_a?(self)
end

#_typesArray<Class>

Returns all types to query for when using this class as the base.

Examples:

Get the types.

document._types

Returns:

  • (Array<Class>)

    All subclasses of the current document.

Since:

  • 1.0.0


328
329
330
# File 'lib/mongoid/document.rb', line 328

def _types
  @_type ||= (descendants + [ self ]).uniq.map(&:to_s)
end

#i18n_scopeSymbol

Set the i18n scope to overwrite ActiveModel.

Returns:

Since:

  • 2.0.0


337
338
339
# File 'lib/mongoid/document.rb', line 337

def i18n_scope
  :mongoid
end

#instantiate(attrs = nil, selected_fields = nil) {|doc| ... } ⇒ Document

Instantiate a new object, only when loaded from the database or when the attributes have already been typecast.

Examples:

Create the document.

Person.instantiate(:title => "Sir", :age => 30)

Parameters:

  • attrs (Hash) (defaults to: nil)

    The hash of attributes to instantiate with.

  • selected_fields (Integer) (defaults to: nil)

    The selected fields from the criteria.

Yields:

  • (doc)

Returns:

Since:

  • 1.0.0


308
309
310
311
312
313
314
315
316
317
318
# File 'lib/mongoid/document.rb', line 308

def instantiate(attrs = nil, selected_fields = nil)
  attributes = attrs || {}
  doc = allocate
  doc.__selected_fields = selected_fields
  doc.instance_variable_set(:@attributes, attributes)
  doc.apply_defaults
  yield(doc) if block_given?
  doc.run_callbacks(:find) unless doc._find_callbacks.empty?
  doc.run_callbacks(:initialize) unless doc._initialize_callbacks.empty?
  doc
end

#loggerLogger

Returns the logger

Examples:

Get the logger.

Person.logger

Returns:

  • (Logger)

    The configured logger or a default Logger instance.

Since:

  • 2.2.0


349
350
351
# File 'lib/mongoid/document.rb', line 349

def logger
  Mongoid.logger
end