View Source Pow.Extension.Base behaviour (Pow v1.0.38)

Used to set up extensions to enable parts of extension for auto-discovery.

This exists to prevent unnecessary Code.ensure_compiled/1 calls, and will let the extension define what modules it has.

Usage

defmodule MyCustomExtension do
  use Pow.Extension.Base

  @impl true
  def ecto_schema?(), do: true
end

Summary

Callbacks

ecto_schema?()

phoenix_controller_callbacks?()

phoenix_messages?()

phoenix_router?()

phoenix_templates()

use_ecto_schema?()

Functions

has?(extension, module_list)

Checks whether an extension has a certain module.

use?(extension, module_list)

Checks whether an extension has a certain module that has a __using__/1 macro.

Callbacks

ecto_schema?()

@callback ecto_schema?() :: boolean()

phoenix_controller_callbacks?()

@callback phoenix_controller_callbacks?() :: boolean()

phoenix_messages?()

@callback phoenix_messages?() :: boolean()

phoenix_router?()

@callback phoenix_router?() :: boolean()

phoenix_templates()

@callback phoenix_templates() :: [{binary(), [binary()]}]

use_ecto_schema?()

@callback use_ecto_schema?() :: boolean()

Functions

has?(extension, module_list)

@spec has?(atom(), [any()]) :: boolean()

Checks whether an extension has a certain module.

If a base extension module doesn't exist, or is configured improperly, Code.ensure_compiled/1 will be used instead to see whether the module exists for the extension.

use?(extension, module_list)

@spec use?(atom(), [any()]) :: boolean()

Checks whether an extension has a certain module that has a __using__/1 macro.

This calls has?/2 first, If a base extension module doesn't exist, or is configured improperly, Kernel.macro_exported?/3 will be used instead to check if the module has a __using__/1 macro.