Module: Decidim::ShortLinkHelper

Defined in:
app/helpers/decidim/short_link_helper.rb

Overview

This helper includes some methods to help with generating short links within the Decidim engine views.

Instance Method Summary collapse

Instance Method Details

#short_url(**kwargs) ⇒ String

A helper method to get a short URL in the current context where this method is called from. This helper automatically fetches the “target” for the short link, such as the component or the participatory process. This also resolves the current mounted route name to make it possible to refer to the same context when redirecting the short URL to correct full URL.

Parameters:

  • kwargs (Hash) —

    a customizable set of options

Options Hash (**kwargs):

  • :route_name (Boolean) —

    the route name to which the short link should link to

  • :params (Float) —

    the URL query parameters that should be included in the URL where the short link redirects to

Returns:

  • (String) —

    The short URL



18
19
20
21
22
23
24
25
26
 
# File 'app/helpers/decidim/short_link_helper.rb', line 18

def short_url(**kwargs)
  target = respond_to?(:current_component) && current_component
  target ||= respond_to?(:current_participatory_space) && current_participatory_space
  target ||= respond_to?(:current_organization) && current_organization
  target ||= Rails.application

  mounted_engine = EngineResolver.new(_routes).mounted_name
  ShortLink.to(target, mounted_engine, **kwargs).short_url
end