Packages

phoenix_kit

1.7.42
1.7.207 1.7.206 1.7.205 1.7.204 1.7.203 1.7.202 1.7.201 1.7.200 1.7.199 1.7.198 1.7.197 1.7.196 1.7.194 1.7.193 1.7.192 1.7.191 1.7.190 1.7.189 1.7.187 1.7.186 1.7.185 1.7.184 1.7.183 1.7.182 1.7.181 1.7.180 1.7.179 1.7.178 1.7.177 1.7.176 1.7.175 1.7.174 1.7.173 1.7.172 1.7.171 1.7.170 1.7.169 1.7.168 1.7.167 1.7.166 1.7.165 1.7.164 1.7.162 1.7.161 1.7.160 1.7.159 1.7.157 1.7.156 1.7.155 1.7.154 1.7.153 1.7.152 1.7.151 1.7.150 1.7.149 1.7.146 1.7.145 1.7.144 1.7.143 1.7.138 1.7.133 1.7.132 1.7.131 1.7.130 1.7.128 1.7.126 1.7.125 1.7.121 1.7.120 1.7.119 1.7.118 1.7.117 1.7.116 1.7.115 1.7.114 1.7.113 1.7.112 1.7.111 1.7.110 1.7.109 1.7.108 1.7.107 1.7.106 1.7.105 1.7.104 1.7.103 1.7.102 1.7.101 1.7.100 1.7.99 1.7.98 1.7.97 1.7.96 1.7.95 1.7.94 1.7.93 1.7.92 1.7.91 1.7.90 1.7.89 1.7.88 1.7.87 1.7.86 1.7.85 1.7.84 1.7.83 1.7.82 1.7.81 1.7.80 1.7.79 1.7.78 1.7.77 1.7.76 1.7.75 1.7.74 1.7.71 1.7.70 1.7.69 1.7.66 1.7.65 1.7.64 1.7.63 1.7.62 1.7.61 1.7.59 1.7.58 1.7.57 1.7.56 1.7.55 1.7.54 1.7.53 1.7.52 1.7.51 1.7.49 1.7.44 1.7.43 1.7.42 1.7.41 1.7.39 1.7.38 1.7.37 1.7.36 1.7.34 1.7.33 1.7.31 1.7.30 1.7.29 1.7.28 1.7.27 1.7.26 1.7.25 1.7.24 1.7.23 1.7.22 1.7.21 1.7.20 1.7.19 1.7.18 1.7.17 1.7.16 1.7.15 1.7.14 1.7.13 1.7.12 1.7.11 1.7.10 1.7.9 1.7.8 1.7.7 1.7.6 1.7.5 1.7.4 1.7.3 1.7.2 1.7.1 1.7.0 1.6.20 1.6.19 1.6.18 1.6.17 1.6.16 1.6.15 1.6.14 1.6.13 1.6.12 1.6.11 1.6.10 1.6.9 1.6.8 1.6.7 1.6.6 1.6.5 1.6.4 1.6.3 1.5.2 1.5.1 1.5.0 1.4.9 1.4.8 1.4.7 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0 1.2.10 1.2.9 1.2.8 1.2.7 1.2.5 1.2.4 1.2.2 1.2.1 1.2.0 1.1.0 1.0.0

A foundation for building Elixir Phoenix apps — SaaS, social networks, ERP systems, marketplaces, and more

Current section

Files

Jump to
phoenix_kit lib modules languages languages.ex
Raw

lib/modules/languages/languages.ex

defmodule PhoenixKit.Modules.Languages do
@moduledoc """
Languages management for PhoenixKit - complete language configuration in a single module.
This module provides management for language module in PhoenixKit applications.
It handles language configuration, settings, and language data through JSON settings.
## Language Structure
Each language has the following structure:
- `code`: Language code (e.g., "en-US", "es-ES", "fr-FR")
- `name`: Full language name (e.g., "English (United States)", "Spanish (Spain)", "French (France)")
- `is_default`: Boolean indicating if this is the default language
- `is_enabled`: Boolean indicating if this language is active
## Core Functions
### Languages Management
- `enabled?/0` - Check if languages are enabled
- `enable_system/0` - Enable languages with default English
- `disable_system/0` - Disable languages
- `get_config/0` - Get complete configuration
### Language Management
- `get_languages/0` - Get all configured languages
- `get_enabled_languages/0` - Get only enabled languages
- `get_default_language/0` - Get the default language
- `get_language/1` - Get a specific language by code
- `get_language_codes/0` - Get list of all language codes
- `get_enabled_language_codes/0` - Get list of enabled language codes
- `valid_language?/1` - Check if a language code exists
- `language_enabled?/1` - Check if a language is enabled
- `add_language/1` - Add a new language to the system
- `update_language/2` - Update an existing language
- `remove_language/1` - Remove a language from the system
- `set_default_language/1` - Set a new default language
- `enable_language/1` - Enable a specific language
- `disable_language/1` - Disable a specific language
## Usage Examples
# Check if languages are enabled
if PhoenixKit.Modules.Languages.enabled?() do
# Languages are active
end
# Enable languages (creates default English language)
{:ok, config} = PhoenixKit.Modules.Languages.enable_system()
# Add a new language
{:ok, config} = PhoenixKit.Modules.Languages.add_language("es")
# Get all languages
languages = PhoenixKit.Modules.Languages.get_languages()
# => [%{code: "en-US", name: "English (United States)", is_default: true, is_enabled: true}, ...]
# Get only enabled languages (most common use case)
enabled_languages = PhoenixKit.Modules.Languages.get_enabled_languages()
# => [%{code: "en-US", name: "English (United States)", ...}, %{code: "es-ES", name: "Spanish (Spain)", ...}]
# Get a specific language by code
spanish = PhoenixKit.Modules.Languages.get_language("es-ES")
# => %{code: "es-ES", name: "Spanish (Spain)", is_enabled: true}
# Get just the language codes
codes = PhoenixKit.Modules.Languages.get_enabled_language_codes()
# => ["en-US", "es-ES", "fr-FR"]
# Check if a language is valid and enabled
if PhoenixKit.Modules.Languages.language_enabled?("es-ES") do
# Use Spanish language
end
## JSON Storage Format
Languages are stored in the `languages_config` setting as JSON.
The array order determines the display order:
{
"languages": [
{
"code": "en-US",
"name": "English (United States)",
"is_default": true,
"is_enabled": true
},
{
"code": "es-ES",
"name": "Spanish (Spain)",
"is_default": false,
"is_enabled": true
}
]
}
"""
alias PhoenixKit.Config
alias PhoenixKit.Modules.Languages.Language
alias PhoenixKit.Settings
@config_key "languages_config"
@default_locale Config.default_locale()
@enabled_key "languages_enabled"
@module_name "languages"
# Available languages are sourced from BeamLabCountries.Languages
# Default configuration when system is first enabled
@default_config %{
"languages" => [
%{
"code" => "en-US",
"name" => "English (United States)",
"is_default" => true,
"is_enabled" => true
}
]
}
# Top 10 most common languages for permanent display in admin
@top_10_languages [
%Language{code: "en-US", name: "English (United States)", is_default: true, is_enabled: true},
%Language{code: "es-ES", name: "Spanish (Spain)", is_default: false, is_enabled: true},
%Language{code: "fr-FR", name: "French (France)", is_default: false, is_enabled: true},
%Language{code: "de-DE", name: "German (Germany)", is_default: false, is_enabled: true},
%Language{code: "ja", name: "Japanese", is_default: false, is_enabled: true},
%Language{code: "pt-BR", name: "Portuguese (Brazil)", is_default: false, is_enabled: true},
%Language{code: "it", name: "Italian", is_default: false, is_enabled: true},
%Language{code: "ko", name: "Korean", is_default: false, is_enabled: true},
%Language{code: "ru", name: "Russian", is_default: false, is_enabled: true},
%Language{code: "nl", name: "Dutch", is_default: false, is_enabled: true},
%Language{code: "zh-CN", name: "Chinese (Mandarin)", is_default: false, is_enabled: true},
%Language{code: "ar", name: "Arabic", is_default: false, is_enabled: true}
]
## --- System Management Functions ---
@doc """
Checks if the language module is enabled.
Returns true if the module is enabled, false otherwise.
## Examples
iex> PhoenixKit.Modules.Languages.enabled?()
false
"""
def enabled? do
Settings.get_boolean_setting(@enabled_key, false)
end
@doc """
Enables the language module and creates default configuration.
Creates the initial module configuration with English as the default language.
If a previous configuration exists, it will be restored instead of reset.
Updates both the enabled flag and the JSON configuration.
Returns `{:ok, config}` on success, `{:error, reason}` on failure.
## Examples
iex> PhoenixKit.Modules.Languages.enable_system()
{:ok, %{"languages" => [%{"code" => "en-US", ...}]}}
"""
def enable_system do
# Enable the system
case Settings.update_boolean_setting_with_module(@enabled_key, true, @module_name) do
{:ok, _setting} ->
# Check if a previous configuration exists to preserve languages
existing_config = Settings.get_json_setting(@config_key, nil)
config_to_save = if is_nil(existing_config), do: @default_config, else: existing_config
# Save the configuration (either existing or new default)
case Settings.update_json_setting_with_module(@config_key, config_to_save, @module_name) do
{:ok, _setting} -> {:ok, config_to_save}
{:error, changeset} -> {:error, changeset}
end
{:error, changeset} ->
{:error, changeset}
end
end
@doc """
Disables the language module.
Turns off the language module but preserves the language configuration.
Returns `{:ok, setting}` on success, `{:error, changeset}` on failure.
## Examples
iex> PhoenixKit.Modules.Languages.disable_system()
{:ok, %Setting{}}
"""
def disable_system do
Settings.update_boolean_setting_with_module(@enabled_key, false, @module_name)
end
@doc """
Gets the complete language module configuration.
Returns a map with module status and language configuration.
## Examples
iex> PhoenixKit.Modules.Languages.get_config()
%{
enabled: true,
languages: [%{"code" => "en-US", "name" => "English (United States)", ...}],
language_count: 1,
enabled_count: 1,
default_language: %{"code" => "en-US", "name" => "English (United States)", ...}
}
"""
def get_config do
enabled = enabled?()
languages = get_languages()
enabled_languages = Enum.filter(languages, & &1.is_enabled)
default_language = Enum.find(languages, & &1.is_default)
%{
enabled: enabled,
languages: languages,
language_count: length(languages),
enabled_count: length(enabled_languages),
default_language: default_language
}
end
## --- Language Management Functions ---
@doc """
Gets all configured languages from the JSON setting.
Returns a list of language maps, or empty list if not configured.
## Examples
iex> PhoenixKit.Modules.Languages.get_languages()
[%{"code" => "en-US", "name" => "English (United States)", "is_default" => true, ...}]
# When system is disabled:
iex> PhoenixKit.Modules.Languages.get_languages()
[]
"""
def get_languages do
if enabled?() do
case Settings.get_json_setting_cached(@config_key, nil) do
%{"languages" => languages} when is_list(languages) ->
Enum.map(languages, &Language.from_json_map/1)
_ ->
[]
end
else
[]
end
end
@doc """
Gets only enabled languages, sorted by position.
Returns a list of enabled language maps.
## Examples
iex> PhoenixKit.Modules.Languages.get_enabled_languages()
[%{"code" => "en-US", "name" => "English (United States)", ...}]
"""
def get_enabled_languages do
get_languages()
|> Enum.filter(& &1.is_enabled)
|> Enum.sort_by(& &1.position)
end
@doc """
Gets the default language.
Returns the language map marked as default, or nil if none found.
## Examples
iex> PhoenixKit.Modules.Languages.get_default_language()
%{"code" => "en-US", "name" => "English (United States)", "is_default" => true, ...}
# When system is disabled:
iex> PhoenixKit.Modules.Languages.get_default_language()
nil
"""
def get_default_language do
if enabled?() do
get_languages()
|> Enum.find(& &1.is_default)
else
nil
end
end
@doc """
Gets a specific language by its code.
Returns the language map if found, or nil if not found.
## Examples
iex> PhoenixKit.Modules.Languages.get_language("es-ES")
%{"code" => "es-ES", "name" => "Spanish (Spain)", "is_enabled" => true}
iex> PhoenixKit.Modules.Languages.get_language("invalid")
nil
"""
def get_language(code) when is_binary(code) do
if enabled?() do
get_languages()
|> Enum.find(&(&1.code == code))
else
nil
end
end
@doc """
Gets a list of all language codes.
Returns a list of language code strings.
## Examples
iex> PhoenixKit.Modules.Languages.get_language_codes()
["en-US", "es-ES", "fr-FR"]
"""
def get_language_codes do
get_languages()
|> Enum.map(& &1.code)
end
@doc """
Gets a list of enabled language codes, sorted by position.
Returns a list of enabled language code strings.
## Examples
iex> PhoenixKit.Modules.Languages.get_enabled_language_codes()
["en-US", "es-ES"]
"""
def get_enabled_language_codes do
get_enabled_languages()
|> Enum.map(& &1.code)
end
@doc """
Gets enabled language codes for locale-based routing.
Returns a list of enabled language codes that can be used in URL routing.
Falls back to ["en"] when the language module is disabled.
## Examples
iex> PhoenixKit.Modules.Languages.enabled_locale_codes()
["en-US", "es-ES", "fr-FR"]
# When system is disabled:
iex> PhoenixKit.Modules.Languages.enabled_locale_codes()
["en-US"]
"""
def enabled_locale_codes do
# Return enabled language codes from the frontend language module only
# Admin navbar languages are managed separately in settings
if enabled?() do
codes = get_enabled_language_codes()
# Ensure we always have at least the default locale as a fallback
if Enum.empty?(codes), do: [@default_locale], else: codes
else
[@default_locale]
end
end
@doc """
Gets the appropriate language list for frontend display.
Returns the configured languages if the module is enabled.
Otherwise, returns the permanent top 12 most common languages for display.
This allows the frontend to always show a language list, reverting to the top 12 when
the module is disabled.
## Examples
# When enabled (any number of languages)
iex> PhoenixKit.Modules.Languages.get_display_languages()
[%{"code" => "en-US", "name" => "English (United States)", ...}]
# When disabled
iex> PhoenixKit.Modules.Languages.get_display_languages()
[%{"code" => "en-US", ...}, %{"code" => "es-ES", ...}, ...] # Top 12 default
"""
def get_display_languages do
if enabled?() do
# Show configured languages when enabled (even if just 1)
get_languages()
else
# Show top 12 default languages when disabled
@top_10_languages
end
end
@doc """
Checks if currently in configured mode (showing user-configured languages vs defaults).
Returns true if the module is enabled and has 2+ configured languages.
Returns false if showing the default top 10 languages.
## Examples
iex> PhoenixKit.Modules.Languages.in_configured_mode?()
true # When enabled with 2+ languages
iex> PhoenixKit.Modules.Languages.in_configured_mode?()
false # When disabled or only 1 language
"""
def in_configured_mode? do
enabled?() and length(get_languages()) >= 2
end
@doc """
Checks if a language code is valid (exists in configuration).
Returns true if the language exists, false otherwise.
## Examples
iex> PhoenixKit.Modules.Languages.valid_language?("es-ES")
true
iex> PhoenixKit.Modules.Languages.valid_language?("invalid")
false
"""
def valid_language?(code) when is_binary(code) do
not is_nil(get_language(code))
end
@doc """
Checks if a language is enabled.
Returns true if the language exists and is enabled, false otherwise.
## Examples
iex> PhoenixKit.Modules.Languages.language_enabled?("es-ES")
true
iex> PhoenixKit.Modules.Languages.language_enabled?("disabled_lang")
false
"""
def language_enabled?(code) when is_binary(code) do
enabled?() &&
case get_language(code) do
%Language{is_enabled: true} -> true
_ -> false
end
end
@doc """
Gets the 12 default popular languages for admin panel display.
Returns a list of the most commonly used language codes that should
be available in the admin panel language selector.
## Examples
iex> PhoenixKit.Modules.Languages.get_default_language_codes()
["en-US", "es-ES", "fr-FR", "de-DE", "pt-BR", "it", "nl", "ru", "ja", "ko", "zh-CN", "ar"]
"""
def get_default_language_codes do
@top_10_languages
|> Enum.map(& &1.code)
end
@doc """
Gets all available predefined languages.
Returns the complete list of languages that can be added to the system.
This list is used to populate dropdown selections.
## Examples
iex> PhoenixKit.Modules.Languages.get_available_languages()
[%{code: "en-US", name: "English (United States)", native: "English (US)", flag: "🇺🇸"}, ...]
"""
# Cache key for memoized language data (static, never changes at runtime)
@available_languages_cache_key :phoenix_kit_available_languages_cache
@available_languages_map_cache_key :phoenix_kit_available_languages_map_cache
def get_available_languages do
# Use cached version if available (static data, never changes at runtime)
case :persistent_term.get(@available_languages_cache_key, :not_cached) do
:not_cached ->
languages = build_available_languages()
:persistent_term.put(@available_languages_cache_key, languages)
languages
cached ->
cached
end
end
@doc """
Gets a language by code with O(1) lookup from cached map.
Returns nil if not found.
"""
def get_available_language_by_code(code) do
map = get_available_languages_map()
Map.get(map, code)
end
# Returns a map of code => language for O(1) lookups
defp get_available_languages_map do
case :persistent_term.get(@available_languages_map_cache_key, :not_cached) do
:not_cached ->
languages = get_available_languages()
map = Map.new(languages, fn lang -> {lang.code, lang} end)
:persistent_term.put(@available_languages_map_cache_key, map)
map
cached ->
cached
end
end
# Builds the language list (called once, then cached)
defp build_available_languages do
BeamLabCountries.Languages.all_locales()
|> Enum.map(fn locale ->
%Language{
code: locale.code,
name: locale.name,
native: locale.native_name,
flag: locale.flag,
countries: BeamLabCountries.Languages.country_names_for_language(locale.base_code)
}
end)
end
@doc """
Gets available languages for selection (excludes already added languages).
Returns languages that can be added to the system, filtered to exclude
languages that have already been configured.
## Examples
iex> PhoenixKit.Modules.Languages.get_available_languages_for_selection()
[%{code: "es-ES", name: "Spanish (Spain)", native: "Español (España)", flag: "🇪🇸"}, ...]
"""
def get_available_languages_for_selection do
all_languages = get_available_languages()
if enabled?() do
current_codes = get_languages() |> Enum.map(& &1.code)
all_languages
|> Enum.reject(fn lang -> lang.code in current_codes end)
else
all_languages
end
end
@doc """
Gets a predefined language by code.
Returns the language definition from the available languages list.
## Examples
iex> PhoenixKit.Modules.Languages.get_predefined_language("es-ES")
%{code: "es-ES", name: "Spanish (Spain)", native: "Español (España)", flag: "🇪🇸"}
iex> PhoenixKit.Modules.Languages.get_predefined_language("invalid")
nil
"""
def get_predefined_language(code) when is_binary(code) do
case BeamLabCountries.Languages.get_locale(code) do
nil ->
nil
locale ->
%Language{
code: locale.code,
name: locale.name,
native: locale.native_name,
flag: locale.flag,
countries: BeamLabCountries.Languages.country_names_for_language(locale.base_code)
}
end
end
@doc """
Gets all available languages grouped by continent, then by country.
Returns a list of {continent, countries} tuples where countries is a list of
{country, flag, languages} tuples. Sorted alphabetically by continent and country.
Only shows languages that are actually used in each country based on the
`language_locales` field from BeamLabCountries.
## Examples
iex> PhoenixKit.Modules.Languages.get_languages_grouped_by_continent()
[
{"Africa", [{"South Africa", "🇿🇦", [%{code: "en-ZA", ...}]}, ...]},
{"Asia", [{"China", "🇨🇳", [%{code: "zh-CN", ...}]}, ...]},
{"Europe", [{"Germany", "🇩🇪", [%{code: "de-DE", ...}]}, ...]},
...
]
"""
def get_languages_grouped_by_continent do
get_available_languages()
|> Enum.flat_map(fn lang ->
# Create one entry per country for this language
Enum.map(lang.countries, fn country ->
Map.put(lang, :country, country)
end)
end)
|> Enum.group_by(& &1.country)
|> Enum.map(fn {country, languages} ->
# Get country data from BeamLabCountries
country_data = BeamLabCountries.get_by(:name, country)
continent = if country_data, do: country_data.continent, else: "Other"
country_flag = if country_data, do: country_data.flag, else: "🌐"
# Filter languages based on language_locales if available
filtered_languages = filter_languages_by_locale(languages, country_data)
{continent, country, country_flag, Enum.sort_by(filtered_languages, & &1.name)}
end)
|> Enum.reject(fn {_, _, _, langs} -> langs == [] end)
|> Enum.group_by(fn {continent, _, _, _} -> continent end)
|> Enum.sort_by(fn {continent, _} -> continent end)
|> Enum.map(fn {continent, countries} ->
sorted_countries =
countries
|> Enum.map(fn {_, country, flag, langs} -> {country, flag, langs} end)
|> Enum.sort_by(fn {country, _, _} -> country end)
{continent, sorted_countries}
end)
end
# Filter languages based on country's languages_official and language_locales
# - languages_official: determines WHICH languages to show (e.g., ["fr"] for France)
# - language_locales: determines which SPECIFIC LOCALE to use (e.g., %{en: "en-GB"})
defp filter_languages_by_locale(languages, nil), do: languages
defp filter_languages_by_locale(languages, country_data) do
languages_spoken = country_data.languages_official || []
language_locales = country_data.language_locales || %{}
if languages_spoken == [] do
languages
else
languages_spoken
|> Enum.map(&find_language_for_code(languages, &1, language_locales))
|> Enum.reject(&is_nil/1)
end
end
# Find the appropriate language for a given code, using specific locale if available
defp find_language_for_code(languages, lang_code, language_locales) do
locale_code = Map.get(language_locales, String.to_atom(lang_code), lang_code)
Enum.find(languages, fn lang -> lang.code == locale_code end)
end
@doc """
Adds a predefined language to the module by language code.
Takes a language code and adds the corresponding predefined language
to the module configuration. Only languages from the predefined list
can be added.
## Examples
iex> PhoenixKit.Modules.Languages.add_language("es-ES")
{:ok, updated_config}
iex> PhoenixKit.Modules.Languages.add_language("en-US") # if already exists
{:error, "Language already exists"}
iex> PhoenixKit.Modules.Languages.add_language("invalid")
{:error, "Language not found in available languages"}
"""
def add_language(code) when is_binary(code) do
# Check if language exists in predefined list
case get_predefined_language(code) do
nil ->
{:error, "Language not found in available languages"}
predefined_lang ->
current_config = Settings.get_json_setting(@config_key, @default_config)
current_languages = Map.get(current_config, "languages", [])
# Check if language code already exists
if Enum.any?(current_languages, &(&1["code"] == code)) do
{:error, "Language already exists"}
else
# Create new language from predefined data
new_language = %{
"code" => predefined_lang.code,
"name" => predefined_lang.name,
"is_default" => false,
"is_enabled" => true
}
# Add new language to the end of the list
final_languages = current_languages ++ [new_language]
updated_config = Map.put(current_config, "languages", final_languages)
# Save updated configuration
case Settings.update_json_setting_with_module(@config_key, updated_config, @module_name) do
{:ok, _setting} -> {:ok, updated_config}
{:error, changeset} -> {:error, changeset}
end
end
end
end
@doc """
Updates an existing language in the system.
Takes a language code and map of attributes to update.
## Examples
iex> PhoenixKit.Modules.Languages.update_language("es-ES", %{name: "Español"})
{:ok, updated_config}
iex> PhoenixKit.Modules.Languages.update_language("nonexistent", %{name: "Test"})
{:error, "Language not found"}
"""
def update_language(code, attrs) when is_binary(code) and is_map(attrs) do
current_config = Settings.get_json_setting(@config_key, @default_config)
current_languages = Map.get(current_config, "languages", [])
case Enum.find_index(current_languages, &(&1["code"] == code)) do
nil ->
{:error, "Language not found"}
index ->
do_update_language_at_index(current_config, current_languages, index, attrs)
end
end
@doc """
Removes a language from the system.
Cannot remove the default language or the last remaining language.
## Examples
iex> PhoenixKit.Modules.Languages.remove_language("es-ES")
{:ok, updated_config}
iex> PhoenixKit.Modules.Languages.remove_language("en-US") # if it's default
{:error, "Cannot remove default language"}
"""
def remove_language(code) when is_binary(code) do
current_config = Settings.get_json_setting(@config_key, @default_config)
current_languages = Map.get(current_config, "languages", [])
language_to_remove = Enum.find(current_languages, &(&1["code"] == code))
cond do
is_nil(language_to_remove) ->
{:error, "Language not found"}
language_to_remove["is_default"] ->
{:error, "Cannot remove default language"}
length(current_languages) <= 1 ->
{:error, "Cannot remove the last language"}
true ->
updated_languages = Enum.reject(current_languages, &(&1["code"] == code))
updated_config = Map.put(current_config, "languages", updated_languages)
# Save updated configuration
case Settings.update_json_setting_with_module(@config_key, updated_config, @module_name) do
{:ok, _setting} -> {:ok, updated_config}
{:error, changeset} -> {:error, changeset}
end
end
end
@doc """
Sets a new default language.
Removes default status from all other languages and sets the specified language as default.
## Examples
iex> PhoenixKit.Modules.Languages.set_default_language("es-ES")
{:ok, updated_config}
iex> PhoenixKit.Modules.Languages.set_default_language("nonexistent")
{:error, "Language not found"}
"""
def set_default_language(code) when is_binary(code) do
update_language(code, %{"is_default" => true})
end
@doc """
Enables a specific language.
## Examples
iex> PhoenixKit.Modules.Languages.enable_language("es-ES")
{:ok, updated_config}
"""
def enable_language(code) when is_binary(code) do
update_language(code, %{"is_enabled" => true})
end
@doc """
Disables a specific language.
Cannot disable the default language.
## Examples
iex> PhoenixKit.Modules.Languages.disable_language("es-ES")
{:ok, updated_config}
iex> PhoenixKit.Modules.Languages.disable_language("en-US") # if it's default
{:error, "Cannot disable default language"}
"""
def disable_language(code) when is_binary(code) do
current_languages = get_languages()
language = Enum.find(current_languages, &(&1.code == code))
if language && language.is_default do
{:error, "Cannot disable default language"}
else
update_language(code, %{"is_enabled" => false})
end
end
@doc """
Moves a language up one position in the array.
Moves the language one index earlier in the languages array. Cannot move the first language up.
## Examples
iex> PhoenixKit.Modules.Languages.move_language_up("es-ES")
{:ok, updated_config}
iex> PhoenixKit.Modules.Languages.move_language_up("en-US") # if first in array
{:error, "Language is already at the top"}
"""
def move_language_up(code) when is_binary(code) do
current_config = Settings.get_json_setting(@config_key, @default_config)
current_languages = Map.get(current_config, "languages", [])
# Find the index of the language to move
current_index = Enum.find_index(current_languages, &(&1["code"] == code))
if current_index do
if current_index == 0 do
{:error, "Language is already at the top"}
else
# Swap with the previous element in the array
updated_languages =
current_languages
|> List.update_at(current_index, fn _ ->
Enum.at(current_languages, current_index - 1)
end)
|> List.update_at(current_index - 1, fn _ ->
Enum.at(current_languages, current_index)
end)
updated_config = Map.put(current_config, "languages", updated_languages)
# Save updated configuration
case Settings.update_json_setting_with_module(@config_key, updated_config, @module_name) do
{:ok, _setting} -> {:ok, updated_config}
{:error, changeset} -> {:error, changeset}
end
end
else
{:error, "Language not found"}
end
end
@doc """
Moves a language down one position in the array.
Moves the language one index later in the languages array. Cannot move the last language down.
## Examples
iex> PhoenixKit.Modules.Languages.move_language_down("en-US")
{:ok, updated_config}
iex> PhoenixKit.Modules.Languages.move_language_down("es-ES") # if last in array
{:error, "Language is already at the bottom"}
"""
def move_language_down(code) when is_binary(code) do
current_config = Settings.get_json_setting(@config_key, @default_config)
current_languages = Map.get(current_config, "languages", [])
# Find the index of the language to move
current_index = Enum.find_index(current_languages, &(&1["code"] == code))
if current_index do
max_index = length(current_languages) - 1
if current_index == max_index do
{:error, "Language is already at the bottom"}
else
# Swap with the next element in the array
updated_languages =
current_languages
|> List.update_at(current_index, fn _ ->
Enum.at(current_languages, current_index + 1)
end)
|> List.update_at(current_index + 1, fn _ ->
Enum.at(current_languages, current_index)
end)
updated_config = Map.put(current_config, "languages", updated_languages)
# Save updated configuration
case Settings.update_json_setting_with_module(@config_key, updated_config, @module_name) do
{:ok, _setting} -> {:ok, updated_config}
{:error, changeset} -> {:error, changeset}
end
end
else
{:error, "Language not found"}
end
end
## --- Private Helper Functions ---
# Update a language at a specific index with proper default handling
defp do_update_language_at_index(current_config, current_languages, index, attrs) do
# Update the language
current_language = Enum.at(current_languages, index)
updated_language = Map.merge(current_language, stringify_keys(attrs))
# If setting as default, remove default from other languages
updated_languages =
if updated_language["is_default"] do
update_languages_with_new_default(current_languages, index, updated_language)
else
List.replace_at(current_languages, index, updated_language)
end
updated_config = Map.put(current_config, "languages", updated_languages)
# Save updated configuration
case Settings.update_json_setting_with_module(@config_key, updated_config, @module_name) do
{:ok, _setting} -> {:ok, updated_config}
{:error, changeset} -> {:error, changeset}
end
end
# Update languages list when setting a new default language
defp update_languages_with_new_default(current_languages, index, updated_language) do
current_languages
|> List.replace_at(index, updated_language)
|> Enum.with_index()
|> Enum.map(fn {lang, idx} ->
if idx != index, do: Map.put(lang, "is_default", false), else: lang
end)
end
# Convert atom keys to string keys for JSON storage
defp stringify_keys(map) when is_map(map) do
Map.new(map, fn
{key, value} when is_atom(key) -> {Atom.to_string(key), value}
{key, value} -> {key, value}
end)
end
end