primary_key.rb 1.7 KB
Newer Older
1 2 3 4 5
module ActiveRecord
  module AttributeMethods
    module PrimaryKey
      extend ActiveSupport::Concern

6 7
      # Returns this record's primary key value wrapped in an Array or nil if
      # the record is not persisted? or has just been destroyed.
8
      def to_key
9 10
        key = send(self.class.primary_key)
        [key] if key
11 12
      end

13 14 15 16 17 18 19 20 21 22 23 24 25 26
      module ClassMethods
        # Defines the primary key field -- can be overridden in subclasses. Overwriting will negate any effect of the
        # primary_key_prefix_type setting, though.
        def primary_key
          reset_primary_key
        end

        def reset_primary_key #:nodoc:
          key = get_primary_key(base_class.name)
          set_primary_key(key)
          key
        end

        def get_primary_key(base_name) #:nodoc:
27
          return 'id' unless base_name && !base_name.blank?
28

29
          case primary_key_prefix_type
A
Aaron Patterson 已提交
30
          when :table_name
31
            base_name.foreign_key(false)
A
Aaron Patterson 已提交
32
          when :table_name_with_underscore
33
            base_name.foreign_key
A
Aaron Patterson 已提交
34
          else
35 36 37 38 39
            if ActiveRecord::Base != self && connection.table_exists?(table_name)
              connection.primary_key(table_name)
            else
              'id'
            end
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
          end
        end

        # Sets the name of the primary key column to use to the given value,
        # or (if the value is nil or false) to the value returned by the given
        # block.
        #
        #   class Project < ActiveRecord::Base
        #     set_primary_key "sysid"
        #   end
        def set_primary_key(value = nil, &block)
          define_attr_method :primary_key, value, &block
        end
        alias :primary_key= :set_primary_key
      end
    end
  end
end