module JSONAPI::Rails::Controller::Hooks

Hooks for customizing rendering default options at controller-level.

Public Instance Methods

jsonapi_cache() click to toggle source

Hook for default cache. @return [#fetch_multi]

# File lib/jsonapi/rails/controller/hooks.rb, line 39
def jsonapi_cache
  instance_exec(&JSONAPI::Rails.config[:jsonapi_cache])
end
jsonapi_class() click to toggle source

Hook for serializable class mapping (for resources). Overridden by the `class` renderer option. @return [Hash{Symbol=>Class}]

# File lib/jsonapi/rails/controller/hooks.rb, line 13
def jsonapi_class
  JSONAPI::Rails.config[:jsonapi_class].dup
end
jsonapi_errors_class() click to toggle source

Hook for serializable class mapping (for errors). Overridden by the `class` renderer option. @return [Hash{Symbol=>Class}]

# File lib/jsonapi/rails/controller/hooks.rb, line 20
def jsonapi_errors_class
  JSONAPI::Rails.config[:jsonapi_errors_class].dup
end
jsonapi_expose() click to toggle source

Hook for default exposures. @return [Hash]

# File lib/jsonapi/rails/controller/hooks.rb, line 33
def jsonapi_expose
  instance_exec(&JSONAPI::Rails.config[:jsonapi_expose])
end
jsonapi_fields() click to toggle source

Hook for default fields. @return [Hash{Symbol=>Array<Symbol>},nil]

# File lib/jsonapi/rails/controller/hooks.rb, line 45
def jsonapi_fields
  instance_exec(&JSONAPI::Rails.config[:jsonapi_fields])
end
jsonapi_include() click to toggle source

Hook for default includes. @return [IncludeDirective]

# File lib/jsonapi/rails/controller/hooks.rb, line 51
def jsonapi_include
  instance_exec(&JSONAPI::Rails.config[:jsonapi_include])
end
jsonapi_meta() click to toggle source

Hook for default meta. @return [Hash,nil]

# File lib/jsonapi/rails/controller/hooks.rb, line 63
def jsonapi_meta
  instance_exec(&JSONAPI::Rails.config[:jsonapi_meta])
end
jsonapi_object() click to toggle source

Hook for the jsonapi object. Overridden by the `jsonapi_object` renderer option. @return [Hash,nil]

# File lib/jsonapi/rails/controller/hooks.rb, line 27
def jsonapi_object
  JSONAPI::Rails.config[:jsonapi_object]
end
jsonapi_pagination(resources) click to toggle source

Hook for pagination scheme. @return [Hash]

# File lib/jsonapi/rails/controller/hooks.rb, line 69
def jsonapi_pagination(resources)
  instance_exec(resources, &JSONAPI::Rails.config[:jsonapi_pagination])
end