Módulo: Mongoid::Factory

Ampliado por:
Fábrica
Incluido en:
Fábrica
Definido en:
lib/mongoid/factory.rb

Overview

Instantiates los documentos que proceden de la base de datos.

Definido bajo Namespace

Clases: Instanciador

Resumen del método de instancia colapsar

Detalles del método de instancia

#build(klass, attributes = nil) ⇒ Document

Compila un nuevo Document utilizando los atributos suministrados.

Este método ya sea instantia klass o un descendiente de klass si los atributos incluyen la clave discriminadora de klass.

Si los atributos contienen la clave del discriminador (que por defecto es _type) y el valor del discriminador no corresponde a un descendiente de klass, entonces este método creará una instancia de klass.

Ejemplos:

Compila el documento.

Mongoid::Factory.build(Person, { "name" => "Durran" })

Parámetros:

  • klass (Clase) -

    La clase a instanciar si _type no está presente.

  • atributos (Hash) (predeterminado: nulo) —

    Los atributos del documento.

  • opciones (encriptada) —

    un conjunto personalizable de opciones

Devuelve:



154
155
156
 
# Archivo 'lib/mongoid/factory.rb', línea 154

def compilar(klass, atributos = nulo)
  execute_build(klass, atributos)
end

#execute_build(klass, attributes = nil, options = {}) ⇒ Documento

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Nota:

Un 2 error de Ruby.x impide que los hash de opciones se utilicen como argumentos de palabras clave. Una vez que se elimine el soporte para Ruby.x,2 podremos reimplementar los hash de opciones como argumentos de palabras clave. Consulte bugs.ruby-lang.org/issues/15753

Ejecute compilar.

Parámetros:

  • klass (Clase) -

    La clase a instanciar si _type no está presente.

  • atributos (Hash) (predeterminado: nulo) —

    Los atributos del documento.

  • opciones (Hash) (por defecto: {}) —

    Las opciones para usar.

Opciones Hash (options):

  • :ejecutar_callbacks (true | false) —

    El indicador especifica si se deben ejecutar las devoluciones de llamada.

Devuelve:



175
176
177
178
179
180
181
182
183
184
 
# Archivo 'lib/mongoid/factory.rb', línea 175

def execute_build(klass, atributos = nulo, opciones = {})
  atributos ||= {}
  dvalue = atributos[klass.discriminador_clave] || atributos[klass.discriminador_clave.to_sym]
  tipo = klass.get_discriminator_mapping(dvalue)
  si tipo
    tipo.construct_document(atributos, opciones)
  else
    klass.construct_document(atributos, opciones)
  end
end

#execute_from_db(klass, attributes = nil, criteria = nil, selected_fields = nil, execute_callbacks: Threaded.execute_callbacks?) ⇒ documento

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Ejecutar desde_db.

Parámetros:

  • klass (Clase) -

    La clase a instanciar si _type no está presente.

  • atributos (Hash) (predeterminado: nulo) —

    Los atributos del documento.

  • criterios (Criterios) (predeterminado: nulo) —

    Objeto de criterios opcional.

  • campos seleccionados (Hash) (predeterminado: nulo) —

    Campos que se recuperaron a través de #only. Si se especifican selected_fields, los campos que no estén listados en él no serán accesibles en el documento devuelto.

  • execute_callbacks (true | false) (predeterminado: Threaded.execute_callbacks?)

    Si este método debe invocar las devoluciones de llamada. Si es cierto, los callbacks se invocarán normalmente. Por el contrario, los callbacks se almacenarán en la lista pending_callbacks y será responsabilidad de quien invoca llamar a run_pending_callbacks en un momento posterior. Usa esta opción para diferir la ejecución de la función de retorno hasta que se construya todo el grafo de objetos que contiene las asociaciones embebidas.

Devuelve:



234
235
236
237
238
239
 
# Archivo 'lib/mongoid/factory.rb', línea 234

def execute_from_db(klass, atributos = nulo, criterios = nulo,
                    campos seleccionados = nulo,
                    execute_callbacks: Compacto.¿ejecutar_callbacks?)
  Instanciador.Nuevo(klass, atributos, criterios, campos seleccionados)
              .instancia(execute_callbacks: execute_callbacks)
end

#from_db(klass, attributes = nil, criteria = nil, selected_fields = nil) ⇒ Document

Construye un nuevo Document a partir de los atributos proporcionados cargados desde la base de datos.

Si los atributos contienen la clave discriminatoria (que por defecto es _type) y el valor discriminatorio no corresponde a un descendiente de klass, entonces este método genera un error de UnknownModel.

Si se proporciona un objeto de criterios, se utiliza de dos maneras:

  1. Si el criterio tiene una lista de campos especificados a través de #only, solo esos campos se llenan en el documento devuelto.

  2. Si el criterio tiene una asociación de referencia (es decir, este documento se está instanciando como una asociación de otro documento), el otro documento también se completa en la asociación inversa del documento devuelto, si existe una.

Ejemplos:

Compila el documento.

Mongoid::Factory.from_db(Person, { "name" => "Durran" })

Parámetros:

  • klass (Clase) -

    La clase a instanciar si _type no está presente.

  • atributos (Hash) (predeterminado: nulo) —

    Los atributos del documento.

  • criterios (Criterios) (predeterminado: nulo) —

    Objeto de criterios opcional.

  • campos seleccionados (Hash) (predeterminado: nulo) —

    Campos que se recuperaron a través de #only. Si se especifican selected_fields, los campos que no estén listados en él no serán accesibles en el documento devuelto.

Devuelve:



212
213
214
 
# Archivo 'lib/mongoid/factory.rb', línea 212

def desde_db(klass, atributos = nulo, criterios = nulo, campos seleccionados = nulo)
  execute_from_db(klass, atributos, criterios, campos seleccionados)
end