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

6
      # Returns this record's primary key value wrapped in an Array if one is available
7
      def to_key
8
        key = send(self.class.primary_key)
9
        [key] if key
10 11
      end

12 13 14 15
      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
16
          @primary_key ||= reset_primary_key
17 18
        end

19 20 21 22 23
        # Returns a quoted version of the primary key name, used to construct SQL statements.
        def quoted_primary_key
          @quoted_primary_key ||= connection.quote_column_name(primary_key)
        end

24
        def reset_primary_key #:nodoc:
25 26 27
          key = self == base_class ? get_primary_key(base_class.name) :
            base_class.primary_key

28 29 30 31 32
          set_primary_key(key)
          key
        end

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

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

49
        attr_accessor :original_primary_key
G
Guillermo Iguaran 已提交
50

51 52 53 54 55
        # Attribute writer for the primary key column
        def primary_key=(value)
          @quoted_primary_key = nil
          @primary_key = value
        end
56

57 58 59 60 61 62 63 64
        # 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)
65
          @quoted_primary_key = nil
66 67 68 69
          @primary_key ||= ''
          self.original_primary_key = @primary_key
          value &&= value.to_s
          self.primary_key = block_given? ? instance_eval(&block) : value
70 71 72 73 74
        end
      end
    end
  end
end