123456789_123456789_123456789_123456789_123456789_

Module: Mongoid::Criteria::Queryable::Macroable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Extended In:
Aggregable, Optional, Selectable
Defined in: lib/mongoid/criteria/queryable/macroable.rb

Overview

Adds macro behavior for adding symbol methods.

Instance Method Summary

Instance Method Details

#key(name, strategy, operator, additional = nil, &block)

Adds a method on ::Symbol for convenience in where queries for the provided operators.

Examples:

Add a symbol key.

key :all, "$all

Parameters:

  • name (Symbol) —

    The name of the method.

  • strategy (Symbol) —

    The merge strategy.

  • operator (String) —

    The MongoDB operator.

  • additional (String) (defaults to: nil) —

    The additional MongoDB operator.

[ GitHub ] 

  


# File 'lib/mongoid/criteria/queryable/macroable.rb', line 21



def key(name, strategy, operator, additional = nil, &block)
  ::Symbol.add_key(name, strategy, operator, additional, &block)
end