Módulo: Mongoid::Association::Options

Incluído em:
Relacionado
Definido em:
lib/mongoid/association/options.rb

Visão geral

Contexto de opções usado para todos os tipos de associação.

Recolhimento do Resumo do método de instância

Detalhes do método de instância

#as ⇒ String | Symbol

Retorna o nome do pai para um filho polimórfico.

Retorna:

  • (string | Símbolo) —

    O nome.



13
14
15
 
# Arquivo 'lib/mongoid/association/options.rb', linha 13

def como
  @opções[:as]
end

#construção de automóveis? ➤ verdadeiro | false

Se a associação é de construção automática.

Retorna:

  • (verdadeiro | falso) 


41
42
43
 
# Arquivo 'lib/mongoid/association/options.rb', linha 41

def construção de automóveis?
  !!@opções[:autobuild]
end

#autosave ➤ true | false Também conhecido como: salvamento automático?

Opções para salvar quaisquer membros carregados e destruir os membros que estiverem marcados para destruição quando o objeto pai for salvo.

Retorna:

  • (verdadeiro | falso) —

    A opção de salvamento automático.



71
72
73
 
# Arquivo 'lib/mongoid/association/options.rb', linha 71

def autosave
  !!@opções[:autosave]
end

#cascading_callbacks? ➤ verdadeiro | false

Se a associação tem retornos de chamada em cascata do pai.

Retorna:

  • (verdadeiro | falso) —

    Se os retornos de chamada são em cascata.



91
92
93
 
# Arquivo 'lib/mongoid/association/options.rb', linha 91

def cascading_callbacks?
  !!@opções[:cascade_callbacks]
end

#counter_cached? ➤ verdadeiro | false

Se a associação é armazenada em cache.

Retorna:

  • (verdadeiro | falso) 


79
80
81
 
# Arquivo 'lib/mongoid/association/options.rb', linha 79

def counter_cached?
  !!@opções[:counter_cache]
end

#cíclico? ➤ verdadeiro | false

A associação é cíclica.

Retorna:

  • (verdadeiro | falso) —

    Se a associação é cíclica.



48
49
50
 
# Arquivo 'lib/mongoid/association/options.rb', linha 48

def cíclica?
  !!@opções[: cíclica]
end

#string ⇒ string

Especifique o que acontece com o objeto associado quando o proprietário é destruído.

Retorna:

  • (string) —

    A opção dependente.



20
21
22
 
# Arquivo 'lib/mongoid/association/options.rb', linha 20

def dependente
  @opções[:dependen]
end

#force_nil_inverse? ➤ false

Se a associação forou um inverso nulo (para que nenhuma chave estrangeira seja salva).

Retorna:

  • (falso) —

    O padrão é falso.



103
 
# Arquivo 'lib/mongoid/association/options.rb', linha 103

def forced_nil_inverse?; false; end

#indexado? ➤ verdadeiro | false

Se deve indexar o campo de chave primária ou externa .

Retorna:

  • (verdadeiro | falso) 


34
35
36
 
# Arquivo 'lib/mongoid/association/options.rb', linha 34

def indexado?
  @indexed ||= !!@opções[:index]
end

#inverse_of ➤ string

O nome que o objeto proprietário usa para se referir a essa associação.

Retorna:

  • (string) —

    A opção inverse_of.



55
56
57
 
# Arquivo 'lib/mongoid/association/options.rb', linha 55

def inverse_of
  @opções[:inverse_of]
end

#order ⇒ Criteria::Queryable::Key

As opções de classificação personalizada na associação.

Retorna:



27
28
29
 
# Arquivo 'lib/mongoid/association/options.rb', linha 27

def order
  @opções[:order]
end

#polimórfico? ➤ verdadeiro | false

Se esta associação é polimórfica.

Retorna:

  • (verdadeiro | falso) —

    Se a associação é polimórfica.



86
 
# Arquivo 'lib/mongoid/association/options.rb', linha 86

def polimórfico?; false; end

#primary_key ➤ Símbolo | string

O Mongoid pressupõe que o campo usado para manter a chave primária da associação seja ID. Você pode substituir isso e especificar explicitamente a chave primária com a opção :primary_key.

Retorna:

  • (Símbolo | string) —

    A chave primária.



63
64
65
 
# Arquivo 'lib/mongoid/association/options.rb', linha 63

def primary_key
  @primary_key ||= @opções[:primary_key] ? @opções[:primary_key].to_s : Relacionado::PRIMARY_KEY_DEFAULT
end

#store_as ⇒ nil

A opção store_as.

Retorna:

  • (nil) —

    O padrão é nulo.



98
 
# Arquivo 'lib/mongoid/association/options.rb', linha 98

def store_as; end

#toque_campo ➤ nil

O campo para salvar o tipo de objeto associado.

Retorna:

  • (nil) —

    O padrão é nulo.



113
114
115
 
# Arquivo 'lib/mongoid/association/options.rb', linha 113

def toque_campo
  @Touch_field ||= opções[:toque] se (opções[:toque].is_a?(String) || opções[:toque].is_a?(Símbolo))
end

#tocável? ➤ verdadeiro | false

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Se o objeto de associação deve ser tocado automaticamente quando seu objeto inverso for atualizado.

Retorna:

  • (verdadeiro | falso) —

    retorna verdadeiro se essa associação for automaticamente tocada; caso contrário, retorna falso. O padrão é "falso".



124
125
126
 
# Arquivo 'lib/mongoid/association/options.rb', linha 124

def tocável?
  !!@opções[:toque]
end

#type ⇒ nil

O campo para salvar o tipo de objeto associado.

Retorna:

  • (nil) —

    O padrão é nulo.



108
 
# Arquivo 'lib/mongoid/association/options.rb', linha 108

def type; end