# `PhoenixKit.Install.IgniterHelpers`
[🔗](https://github.com/BeamLabEU/phoenix_kit/blob/v1.7.87/lib/phoenix_kit/install/igniter_helpers.ex#L1)

Helper functions for working with Igniter to detect parent application information.

This module provides utilities to automatically detect and extract information about
the parent Phoenix application during the installation process. These helpers are
used by the installer to determine module names, layouts, and router configurations
without requiring manual user input.

All functions are designed to work with Igniter's project detection capabilities
and provide sensible defaults when detection fails.

## Examples

    iex> igniter = Igniter.new()
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_name(igniter)
    :parent_app

    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module_web_string(igniter)
    "ParentAppWeb"

# `get_parent_app_module`

```elixir
@spec get_parent_app_module(Igniter.t()) :: module()
```

Gets the parent application module name from the Igniter project.

Extracts the main application module name (e.g., `ParentApp`) from the project
structure. This is used as the base for constructing other module names.

## Parameters

- `igniter` - The Igniter project struct

## Returns

The main application module as an atom (e.g., `ParentApp`)

## Examples

    iex> igniter = Igniter.new()
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module(igniter)
    ParentApp

# `get_parent_app_module_web`

```elixir
@spec get_parent_app_module_web(Igniter.t()) :: module()
```

Constructs the Web module name for the parent application.

Builds the standard Phoenix Web module name by concatenating the base
application module with "Web" (e.g., `ParentAppWeb`).

## Parameters

- `igniter` - The Igniter project struct

## Returns

The Web module as an atom (e.g., `ParentAppWeb`)

## Examples

    iex> igniter = Igniter.new()
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module_web(igniter)
    ParentAppWeb

# `get_parent_app_module_web_endpoint`

```elixir
@spec get_parent_app_module_web_endpoint(Igniter.t()) :: module()
```

Constructs the Endpoint module name for the parent application.

Builds the standard Phoenix Endpoint module name by concatenating the Web
module with "Endpoint" (e.g., `MyAppWeb.Endpoint`).

This is used during installation to add PhoenixKit sockets to the endpoint.

## Parameters

- `igniter` - The Igniter project struct

## Returns

The Endpoint module as an atom (e.g., `MyAppWeb.Endpoint`)

## Examples

    iex> igniter = Igniter.new()
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module_web_endpoint(igniter)
    MyAppWeb.Endpoint

# `get_parent_app_module_web_layouts`

```elixir
@spec get_parent_app_module_web_layouts(Igniter.t()) :: module() | nil
```

Detects the existing Layouts module in the parent application.

Searches for Layouts modules in both possible locations:
- `ParentAppWeb.Layouts` (standard Phoenix location)
- `ParentApp.Layouts` (alternative location)

This function is used during installation to determine which layout module
exists so PhoenixKit can integrate with the existing layout structure.

## Parameters

- `igniter` - The Igniter project struct

## Returns

The Layouts module if found, or `nil` if no Layouts module exists

## Search Order

1. `MyAppWeb.Layouts` - Standard Phoenix web layouts location
2. `MyApp.Layouts` - Alternative layouts location

## Examples

    iex> igniter = Igniter.new()
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module_web_layouts(igniter)
    MyAppWeb.Layouts

    # When no layouts module exists
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module_web_layouts(igniter)
    nil

# `get_parent_app_module_web_router`

```elixir
@spec get_parent_app_module_web_router(Igniter.t()) :: module()
```

Constructs the Router module name for the parent application.

Builds the standard Phoenix Router module name by concatenating the Web
module with "Router" (e.g., `MyAppWeb.Router`).

This is used during installation to determine where to inject PhoenixKit
routes into the existing router configuration.

## Parameters

- `igniter` - The Igniter project struct

## Returns

The Router module as an atom (e.g., `MyAppWeb.Router`)

## Examples

    iex> igniter = Igniter.new()
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module_web_router(igniter)
    MyAppWeb.Router

# `get_parent_app_module_web_string`

```elixir
@spec get_parent_app_module_web_string(Igniter.t(), String.t()) :: String.t()
```

Gets the Web module name as a string with fallback to default.

Converts the Web module to a string representation and provides a fallback
default value when detection fails. This is useful for generating user-facing
messages or configuration examples.

## Parameters

- `igniter` - The Igniter project struct
- `default` - Default string to return when detection fails (default: "YourAppWeb")

## Returns

The Web module name as a string (e.g., "ParentAppWeb") or the default value

## Examples

    iex> igniter = Igniter.new()
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module_web_string(igniter)
    "ParentAppWeb"

    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_module_web_string(igniter, "FallbackWeb")
    "ParentAppWeb"

# `get_parent_app_name`

```elixir
@spec get_parent_app_name(Igniter.t()) :: atom()
```

Gets the parent application name (atom) from the Igniter project.

Uses Igniter's application detection to determine the OTP application name.
This is typically used for configuration and dependency injection.

## Parameters

- `igniter` - The Igniter project struct

## Returns

The application name as an atom (e.g., `:parent_app`)

## Examples

    iex> igniter = Igniter.new()
    iex> PhoenixKit.Install.IgniterHelpers.get_parent_app_name(igniter)
    :parent_app

---

*Consult [api-reference.md](api-reference.md) for complete listing*
