MishkaBlog.Dashboard.WidgetSettings (Mishka Blog v0.0.1)

Copy Markdown View Source

Registers every mishka_blog dashboard widget's own settings with the Settings page through the settings:register mishka_installer hook — so "Posts to show" is documented under the Blog tab (category: "blog", group Dashboard widgets) alongside the rest of the blog's settings, instead of hiding inside the dashboard's per-user layout where nothing else could see it.

It walks MishkaBlog.Application.dashboard_widgets/0 and asks each descriptor for its definitions (MishkaCmsCore.Dashboard.Widget.settings_definitions/1), which derives the key from Widget.setting_key/2 — the same function the dashboard reads through. A widget that adds a setting is registered by declaring it; there is no second list to keep in step, and a widget that declares none contributes nothing.

Every definition is scope: :user: the value belongs to the admin reading the board, and both editors — the card's gear and this tab — write the same Settings.put_user/3 row, so nobody ever sees anybody else's number. Registered in MishkaBlog.Application.

See MishkaBlog.Notifiers.NotifySettings for the sibling that registers the blog's notification toggles, and MishkaCmsCore.Settings.define/3.

Summary

Functions

Returns a specification to start this module under a supervisor.

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

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

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

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

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

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

Callback implementation for MishkaInstaller.Event.Hook.stop/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.

on_dependency_error(error)

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

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

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.