Module: Decidim::TranslationsHelper

Includes:
TranslatableAttributes
Included in:
Accountability::Admin::ResultForm, Accountability::Admin::StatusForm, Accountability::Admin::TimelineEntryForm, Accountability::ResultMCell, Accountability::ResultSerializer, Admin::ApplicationHelper, Admin::HelpSectionForm, Admin::HelpSectionsController, AreaPresenter, AreaTypePresenter, Assemblies::AssemblySerializer, AssemblyPresenter, Blogs::PostsHelper, Budgets::Admin::ProjectForm, Budgets::OrderSummaryMailer, Budgets::ProjectSerializer, CategoryPresenter, Comments::CommentSerializer, Conferences::Admin::InviteJoinConferenceMailer, Conferences::Admin::SendConferenceDiplomaMailer, Conferences::ConferenceRegistrationMailer, Consultations::Admin::QuestionsHelper, Debates::DebatePresenter, Elections::AnswerSerializer, Exporters::ParticipatorySpaceComponentsSerializer, Forms::AnswerForm, Forms::AnswerOptionPresenter, Forms::DataPortabilityUserAnswersSerializer, Forms::QuestionPresenter, Forms::UserAnswersSerializer, Initiatives::SimilarInitiatives, Initiatives::TypeSelectorOptions, Meetings::Admin::InviteJoinMeetingMailer, Meetings::MeetingPresenter, Meetings::MeetingsHelper, Meetings::RegistrationMailer, Meetings::RegistrationSerializer, Organization, ParticipatoryProcesses::ParticipatoryProcessSerializer, ParticipatoryProcesses::ProcessMCell, Proposals::CollaborativeDraftCellsHelper, Proposals::ProposalCellsHelper, Proposals::ProposalSerializer, Proposals::SimilarProposals, SimilarEmendations, Sortitions::Admin::SortitionsHelper, Sortitions::SortitionsHelper, Votings::VotingSerializer, WelcomeNotificationEvent
Defined in:
decidim-core/app/helpers/decidim/translations_helper.rb

Overview

Helper that provides convenient methods to deal with translated attributes.

Class Method Summary collapse

Methods included from TranslatableAttributes

#default_locale?

Class Method Details

.empty_translatable(locales = Decidim.available_locales) ⇒ Object

Public: Creates an translation for each available language in the list so empty fields still have the correct format.

locales - A list of locales to scope the translations to. Picks up all the

available locales by default.

Returns a Hash with the locales as keys and the empty strings as values.


32
33
34
35
36
# File 'decidim-core/app/helpers/decidim/translations_helper.rb', line 32

def empty_translatable(locales = Decidim.available_locales)
  locales.each_with_object({}) do |locale, result|
    result[locale.to_s] = ""
  end
end

.ensure_translatable(value, locales = Decidim.available_locales) ⇒ Object

Public: Creates a translation for each available language in the list with the given value so empty fields still have the correct format. If the value is not a hash, an `empty_translatable` will be returned.

value - A hash value containing the values for each locale. Those

locales that do not have a corresponding value in the hash will
be replaced by an empty string.

locales - A list of locales to scope the translations to. Picks up all the

available locales by default.

Returns a Hash with the locales as keys and value strings as values.


49
50
51
52
53
54
55
# File 'decidim-core/app/helpers/decidim/translations_helper.rb', line 49

def ensure_translatable(value, locales = Decidim.available_locales)
  return empty_translatable(locales) unless value.is_a?(Hash)

  locales.each_with_object({}) do |locale, result|
    result[locale.to_s] = value[locale.to_s] || value[locale] || ""
  end
end

.multi_translation(key, locales = Decidim.available_locales, *options) ⇒ Object

Public: Creates a translation for each available language in the list given a translation key.

key - The key to translate. locales - A list of locales to scope the translations to. Picks up all the

available locales by default.

options - Any other option to delegate to the individual I18n.t calls

Returns a Hash with the locales as keys and the translations as values.


17
18
19
20
21
22
23
# File 'decidim-core/app/helpers/decidim/translations_helper.rb', line 17

def multi_translation(key, locales = Decidim.available_locales, *options)
  locales.each_with_object({}) do |locale, result|
    I18n.with_locale(locale) do
      result[locale.to_sym] = I18n.t(key, *options)
    end
  end
end

.translated_in_current_locale?(attribute) ⇒ Boolean

Returns:

  • (Boolean)

57
58
59
60
61
# File 'decidim-core/app/helpers/decidim/translations_helper.rb', line 57

def translated_in_current_locale?(attribute)
  return false if attribute.nil?

  attribute[I18n.locale.to_s].present?
end