Clase: Mongoid::Criterios::Consultables::Opciones

Hereda:
Smash
  • Objeto
Mostrar todo
Definido en:
lib/mongoid/criterios/consultables/opciones.rb

Overview

Las opciones son una representación hash de las opciones pasadas a las consultas de MongoDB, como omitir, limitar y criterios de clasificación.

Resumen de atributos de instancia

Atributos heredados de Smash

#aliased_associations, #aliased_associations Las aliased_associations., #aliases, #aliases Los aliases., #associations, #associations Las associations., #serializers, #serializers Los serializers.

Colapso del resumen del método de instancia

Métodos heredados de Smash

#[], #inicializar

Detalles del constructor

Esta clase hereda un constructor de Mongoid::Criteria::Queryable::Smash

Detalles del método de instancia

#__deep_copy__Options

Realizar una copia profunda de las opciones.

Ejemplos:

Realizar una copia profunda.

options.__deep_copy__

Devuelve:



87
88
89
90
91
92
93
# Archivo 'lib/mongoid/criteria/queryable/options.rb', línea 87

def __copia_profunda__
  yo.clase.Nuevo(aliases, serializadores, asociaciones, asociaciones_aliasadas) hacer |copy|
    each_pair hacer |clave, valor|
      copy.¡unir!(clave => valor.__copia_profunda__)
    end
  end
end

#camposHash

Método de conveniencia para obtener las opciones de campo.

Ejemplos:

Obtenga las opciones de los campos.

options.fields

Devuelve:

  • (Hash)

    Las opciones de campos.



18
19
20
# Archivo 'lib/mongoid/criteria/queryable/options.rb', línea 18

def campos
  yo[:campos]
end

#limitInteger

Método de conveniencia para obtener la opción de límite.

Ejemplos:

Obtenga la opción de límite.

options.limit

Devuelve:

  • (Entero)

    La opción límite.



28
29
30
# Archivo 'lib/mongoid/criteria/queryable/options.rb', línea 28

def limit
  yo[:limit]
end

#skipInteger

Método conveniente para obtener la opción de omisión.

Ejemplos:

Obtenga la opción de omitir.

options.skip

Devuelve:

  • (Entero)

    La opción de omitir.



38
39
40
# Archivo 'lib/mongoid/criteria/queryable/options.rb', línea 38

def Omitir
  yo[:saltar]
end

#sortHash

Método de conveniencia para obtener las opciones de ordenación.

Ejemplos:

Obtén las opciones de ordenación.

options.sort

Devuelve:

  • (Hash)

    Las opciones de clasificación.



48
49
50
# Archivo 'lib/mongoid/criteria/queryable/options.rb', línea 48

def sort
  yo[:sort]
end

#store(clave, valor, localize = true) ⇒ Objeto También conocido como: []=

Guarde el valor en las opciones de la clave proporcionada. Estas opciones gestionarán toda la serialización y localización necesarias en este paso.

Ejemplos:

Almacenar un valor en las opciones.

options.store(:key, "testing")

Parámetros:

  • clave (Cadena | Símbolo)

    El nombre del atributo.

  • valor (Objeto) -

    El valor a agregar.

Devuelve:

  • (Objeto) -

    El objeto almacenado.



62
63
64
# Archivo 'lib/mongoid/criteria/queryable/options.rb', línea 62

def store(clave, valor, localizar = true)
  Super(clave, evolucionar(valor, localizar))
end

#to_pipelineArray<Hash>

Convierta las opciones en opciones compatibles con la canalización de agregación.

Ejemplos:

Convierte las opciones en una canalización.

options.to_pipeline

Devuelve:

  • (Matriz<Hash>)

    Las opciones en forma de canalización.



73
74
75
76
77
78
79
# Archivo 'lib/mongoid/criteria/queryable/options.rb', línea 73

def a_tubería
  pipeline = []
  pipeline.Push({ "$saltar" => Omitir }) Si Omitir
  pipeline.Push({ "$límite" => limit }) Si limit
  pipeline.Push({ "$ordenar" => sort }) Si sort
  pipeline
end