Phoenix v0.9.0

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.Server

Starts the application by configuring all endpoints servers to run

Phoenix
Phoenix.Channel

Defines a 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.Logger

Plug to handle request logging at the controller level

Phoenix.Controller.Pipeline

This module implements the controller pipeline responsible for handling requests

Phoenix.Endpoint

Defines a Phoenix endpoint

Phoenix.HTML

Conveniences for working HTML strings and templates

Phoenix.HTML.Controller

Imports the following functions from Phoenix.Controller into your views:

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.Local

PubSub implementation for handling local-node process groups

Phoenix.PubSub.PG2

The Supervisor for the :pg2 Phoenix.PubSub adapter

Phoenix.PubSub.PG2Server

Phoenix.PubSub adapter based on :pg2

Phoenix.PubSub.Redis

The Supervisor for the Redis Phoenix.PubSub adapter

Phoenix.PubSub.RedisConn

The connection pool for the Phoenix.PubSub.Redis adapter See Phoenix.PubSub.Redis for configuration details

Phoenix.PubSub.RedisServer

Phoenix.PubSub adapter for Redis

Phoenix.Router

Defines a Phoenix router

Phoenix.Socket

Holds state for multiplexed socket connections and Channel authorization

Phoenix.Socket.Message

Defines a Phoenix.Socket Message dispatched over channels

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

Exceptions summary

Phoenix.Channel.Transport.InvalidReturn
Phoenix.NotAcceptableError

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

Phoenix.PubSub.BroadcastError
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