phoenix v0.6.1

Modules summary

Mix.Tasks.Compile.Phoenix

Compiles Phoenix source files that support code reloading

Mix.Tasks.Phoenix.New

Creates a new Phoenix application

Mix.Tasks.Phoenix.Routes

Prints all routes for the default or a given router

Mix.Tasks.Phoenix.Start

Starts the router or a given worker. Defaults to MyApp.Router

Phoenix
Phoenix.Channel
Phoenix.Channel.Transport

Handles dispatching incoming and outgoing Channel messages

Phoenix.CodeReloader

A plug and module to handle automatic code reloading

Phoenix.Controller

Controllers are used to group common functionality in the same (pluggable) module

Phoenix.Controller.Flash

Handles One-time messages, often referred to as “Flash” messages. Messages can be stored in the session and persisted across redirects for notices and alerts about request state

Phoenix.Controller.Logger

Plug to handle request logging at the controller level

Phoenix.Controller.Pipeline

This module implements the controller pipeline responsible for handling requests

Phoenix.HTML

Conveniences for working HTML strings and templates

Phoenix.HTML.Engine

This is an implementation of EEx.Engine and Phoenix format encoder that guarantees templates are HTML Safe

Phoenix.Naming

Conveniences for inflecting and working with names in Phoenix

Phoenix.PubSub

Serves as a Notification and PubSub layer for broad use-cases. Used internally by Channels for pubsub broadcast

Phoenix.PubSub.GarbageCollector
Phoenix.PubSub.Server

Handles PubSub subscriptions and garbage collection with node failover

Phoenix.Router

Defines the Phoenix router

Phoenix.Router.RenderErrors

A module used to catch failures and render them using a view

Phoenix.Router.Socket
Phoenix.Socket

Holds state for multiplexed socket connections and Channel authorization

Phoenix.Socket.Message
Phoenix.Supervisor
Phoenix.Template

Templates are used by Phoenix on rendering

Phoenix.Template.EExEngine

The Phoenix engine that handles the .eex extension

Phoenix.Template.Engine

Specifies the API for adding custom template engines into Phoenix

Phoenix.Template.ExsEngine

The Phoenix engine that handles the .exs extension

Phoenix.Transports.Serializer

Defines a Behaviour for Transport Phoenix.Socket.Message serializiation

Phoenix.Transports.WebSocket

Handles WebSocket clients for the Channel Transport layer

Phoenix.View

Defines the view layer of a Phoenix application

Phoenix.WebSocket

Exceptions summary

Phoenix.Channel.Transport.InvalidReturn
Phoenix.NotAcceptableError

Raised when one of accept* headers are not accepted by the server

Phoenix.Router.NoRouteError

Exception raised when no route is found

Phoenix.Socket.Message.InvalidMessage
Phoenix.Template.UndefinedError

Exception raised when a template cannot be found

Protocols summary

Phoenix.HTML.Safe

Defines the HTML safe protocol