API Reference elph v0.9.1
modules
Modules
The Contents context. This is the main module of the elph library. It provides functions to work with contents.
In this file macros regarding custom callbacks are defined.
Content is the abstract representation of the datastructure the user is sending and receiving from the frontends. It is also the "base class" for every other content type. Content subtype changesets are called from here.
This module provides macros to help with creation of custom content types.
The default elph callbacks. This will be automatically used if not defined otherwise
in your config. See Elph.Contents.Callbacks
for more info
The default elph content types. This will be automatically used if not defined otherwise
in your config. See Elph.Contents.Types
for more info.
This module holds the create_required_linked_content helper. It looks in the given changeset if a field is set. If so it does nothing. Otherwise it creates the new empty content and sets the linked field in the changeset.
This module provides macros and functions to enrich content types with media functionality. Right now uploading only handles elph media types. This has to be made configurable.
MediaUpload is the abstract representation for files that can be uploaded to the server. MediaUploads have to be transformed into concrete content types later on. Those types can be found in Elph.Content.Types.* or be defined by the user. Right now uploading only handles elph media types. This has to be made configurable.
In this file the macros regarding custom types are defined.
The AccordionRow is a type of container used to visualize its child contents. It represents an accordion row. Its childs are the content, which can either be shown or hidden. The title is the headline that is shown for this row and the default_open flag is there to save its default state with either the children hidden or visible.
This module is for saving audio-files as contents. The changeset is only for updating audio-files - that's why there is a requirement for the id. Creating an audio-file is handled by the Media-Context.
This content type is for saving html.
This module is for saving image-files as contents. The changeset is only for updating image-files - that's why there is a requirement for the id. Creating an image-file is handled by the Media-Context.
Lists are the simplest of containers usable in elph. They don't have any more parameters then their children.
This content type is for saving markdown.
This module is for saving video-files as contents. The changeset is only for updating video-files - that's why there is a requirement for the id. Creating a video-file is handled by the Media-Context.
The MediaProcessing context. Holds functions for automated editing of media files on the disk. This wraps ffmpeg into easy to access standardized function calls.
This module provides macros to help you with creating easier migrations for your custom content types.
This controller holds the basic functions of elph. Manipulation of contents.
This module contains views for the default non-media content types as well as some helper functions that take care of content-tree rendering.
A module providing Internationalization with a gettext-based API.
This controller provides the function to upload new media files.
This module contains views and helper functions for rendering of media content types.
This module is a covenience-wrapper for the Plug.Static to deliver uploaded files via static route.