Class: Decidim::Components::BaseController

Inherits:

ApplicationController

• Object
• DecidimController
• ApplicationController
• Decidim::Components::BaseController

Includes:

NeedsPermission, ParticipatorySpaceContext, Settings

Defined in:

decidim-core/app/controllers/decidim/components/base_controller.rb

Overview

Controller from which all component engines inherit from. It is in charge of setting the appropiate layout, including necessary helpers, and overall fooling the engine into thinking it is isolated.

Direct Known Subclasses

Accountability::ApplicationController, Blogs::ApplicationController, Budgets::ApplicationController, Debates::ApplicationController, DummyResources::DummyResourcesController, Elections::ApplicationController, EndorsementsController, Meetings::ApplicationController, Pages::ApplicationController, Proposals::ApplicationController, Sortitions::ApplicationController, Surveys::ApplicationController, Templates::ApplicationController

Instance Method Summary

• #current_component ⇒ Object
• #current_manifest ⇒ Object
• #current_participatory_space ⇒ Object
• #permission_class_chain ⇒ Object
• #permission_scope ⇒ Object
• #redirect_unless_feature_private ⇒ Object
• #set_component_breadcrumb_item ⇒ Object
• #share_token ⇒ Object

Methods included from RegistersPermissions

register_permissions

Methods included from UserBlockedChecker

#check_user_block_status, #check_user_not_blocked

Methods included from NeedsSnippets

#snippets

Methods included from Headers::HttpCachingDisabler

#disable_http_caching

Methods included from HasStoredPath

#skip_store_location?, #store_current_location

Methods included from NeedsOrganization

enhance_controller, extended, included

Instance Method Details

#current_component ⇒ Object

# File 'decidim-core/app/controllers/decidim/components/base_controller.rb', line 44

def current_component
  request.env["decidim.current_component"]
end

#current_manifest ⇒ Object

# File 'decidim-core/app/controllers/decidim/components/base_controller.rb', line 48

def current_manifest
  @current_manifest ||= current_component.manifest
end

#current_participatory_space ⇒ Object

# File 'decidim-core/app/controllers/decidim/components/base_controller.rb', line 40

def current_participatory_space
  request.env["decidim.current_participatory_space"]
end

#permission_class_chain ⇒ Object

# File 'decidim-core/app/controllers/decidim/components/base_controller.rb', line 60

def permission_class_chain
  [
    current_component.manifest.permissions_class,
    current_participatory_space.manifest.permissions_class,
    Decidim::Admin::Permissions,
    Decidim::Permissions
  ]
end

#permission_scope ⇒ Object

# File 'decidim-core/app/controllers/decidim/components/base_controller.rb', line 56

def permission_scope
  :public
end

#redirect_unless_feature_private ⇒ Object

Raises:

• (ActionController::RoutingError)

# File 'decidim-core/app/controllers/decidim/components/base_controller.rb', line 69

def redirect_unless_feature_private
  raise ActionController::RoutingError, "Not Found" unless current_user_can_visit_space?
end

#set_component_breadcrumb_item ⇒ Object

# File 'decidim-core/app/controllers/decidim/components/base_controller.rb', line 73

def set_component_breadcrumb_item
  context_breadcrumb_items << {
    label: current_component.name,
    url: root_path,
    active: false,
    resource: current_component
  }
end

#share_token ⇒ Object

# File 'decidim-core/app/controllers/decidim/components/base_controller.rb', line 52

def share_token
  params[:share_token]
end