MishkaCmsMigrationWeb.SidebarMenu (Mishka CMS Migration v0.0.1)

Copy Markdown View Source

The migration's admin page and its sidebar entry, a "sidebar:menus" plugin (MishkaCmsCore.Sidebar). It lands in the core's Plugins section, and the core never names it: removing this extension removes the entry.

The page is admin:dashboard:migration's, the permission the runs themselves are gated by, and so is a run's Items page, declared beside it as a page that is not a link (nav: false). They read their gate from here:

MishkaCmsMigrationWeb.SidebarMenu.permissions("migration")

Registered in MishkaCmsMigration.Application.

Summary

Types

error_return()
okey_return()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

config()
config(key)
enable()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

items()

This extension's sidebar entry and the admin pages it owns.

on_dependency_error(error)

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

permissions(key)

The permissions declared for one of this extension's pages. See MishkaCmsCore.Sidebar.permissions/2.

register()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

restart()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])
stop()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.

Types

error_return()

@type error_return() ::
  {:error, [%{action: atom(), field: atom(), message: String.t()}]}

okey_return()

@type okey_return() :: {:ok, struct() | map() | module() | [any()]}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

config()

@spec config() :: keyword()

config(key)

@spec config(atom()) :: any()

enable()

@spec enable() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

@spec get() :: keyword()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

@spec health_check() :: :ok | {:degraded, term()} | {:error, term()}

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

items()

@spec items() :: [MishkaCmsCore.Sidebar.Item.t()]

This extension's sidebar entry and the admin pages it owns.

on_dependency_error(error)

@spec on_dependency_error(term()) :: term()

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

permissions(key)

@spec permissions(String.t()) :: [
  MishkaCmsCore.Accounts.Checks.AccessPermissions.requirement()
]

The permissions declared for one of this extension's pages. See MishkaCmsCore.Sidebar.permissions/2.

register()

@spec register() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

restart()

@spec restart() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

@spec start() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])

stop()

@spec stop() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

@spec unregister() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.