primary_key.rb 1.9 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
      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
17
          @primary_key ||= reset_primary_key
18 19 20
        end

        def reset_primary_key #:nodoc:
21 22 23
          key = self == base_class ? get_primary_key(base_class.name) :
            base_class.primary_key

24 25 26 27 28
          set_primary_key(key)
          key
        end

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

31
          case primary_key_prefix_type
A
Aaron Patterson 已提交
32
          when :table_name
33
            base_name.foreign_key(false)
A
Aaron Patterson 已提交
34
          when :table_name_with_underscore
35
            base_name.foreign_key
A
Aaron Patterson 已提交
36
          else
37 38 39 40 41
            if ActiveRecord::Base != self && connection.table_exists?(table_name)
              connection.primary_key(table_name)
            else
              'id'
            end
42 43 44
          end
        end

45 46 47
        attr_accessor :original_primary_key
        attr_writer :primary_key

48 49 50 51 52 53 54 55
        # 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)
56 57 58 59
          @primary_key ||= ''
          self.original_primary_key = @primary_key
          value &&= value.to_s
          self.primary_key = block_given? ? instance_eval(&block) : value
60 61 62 63 64
        end
      end
    end
  end
end