# `MishkaBlog.Plugins.PageSource`
[🔗](https://github.com/mishka-group/mishka_blog/blob/v0.0.1/lib/mishka_blog/plugins/page_source.ex#L5)

Reads the rows a page of the blog shows, once, through the `runtime:page:source` mishka_installer
hook `MishkaCmsWeb.RuntimeLive` fires in `handle_params/3` before the frame and the head
(`MishkaCmsCore.Runtime.PageSource` is the contract: the map it is handed and where what it reads
goes).

A page is matched by the kind of record it says it shows (`record`, its `extra`'s `"record"`):
`"blog:post"`, `"blog:category"`, `"blog:tag"`, `"blog:author"` or `"blog:team"`, the kinds
`MishkaBlog.Plugins.PageRecords` names and `MishkaBlog.Plugins.PageSeo` and
`MishkaBlog.Plugins.PageFrame` answer for, whatever section the page is in; and the blog's front
page, the page of its Posts place. Every other page is handed back untouched, before anything is
read. What is read, and as whom, is `MishkaBlog.PageSource`'s.

Registered in `MishkaBlog.Application`.

# `error_return`

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

# `okey_return`

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

# `child_spec`

Returns a specification to start this module under a supervisor.

See `Supervisor`.

# `config`

```elixir
@spec config() :: keyword()
```

# `config`

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

# `enable`

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

# `get`

```elixir
@spec get() :: keyword()
```

# `health_check`

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

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

# `on_dependency_error`

```elixir
@spec on_dependency_error(term()) :: term()
```

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

# `register`

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

# `restart`

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

# `start`

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

# `start_link`

# `stop`

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

# `unregister`

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

---

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