Module: FriendlyId::Base

Included in:

ActiveRecordAdapter

Defined in:

lib/friendly_id.rb

Instance Method Summary

• #has_friendly_id(method, options = {}) ⇒ Object

  Set up a model to use a friendly_id.

• #uses_friendly_id? ⇒ Boolean

  Does the model class use the FriendlyId plugin?.

Instance Method Details

#has_friendly_id(method, options = {}) ⇒ Object

Set up a model to use a friendly_id. This method accepts a hash with several possible options.

Examples:

class User < ActiveRecord::Base
  has_friendly_id :user_name
end

class Post < ActiveRecord::Base
  has_friendly_id :title, :use_slug => true, :approximate_ascii => true
end

Parameters:

• method (#to_sym) —

  The column or method that should be used as the basis of the friendly_id string.

• options (Hash) (defaults to: {}) —

  For valid configuration options, see Configuration.

Raises:

• (NotImplementedError)

See Also:

• Configuration

# File 'lib/friendly_id.rb', line 45

def has_friendly_id(method, options = {})
  raise NotImplementedError
end

#uses_friendly_id? ⇒ Boolean

Does the model class use the FriendlyId plugin?

Returns:

• (Boolean)

# File 'lib/friendly_id.rb', line 50

def uses_friendly_id?
  respond_to? :friendly_id_config
end