class Marten::Handlers::Schema

• Marten::Handlers::Schema
• Marten::Handlers::Template
• Marten::Handlers::Base
• Reference
• Object

Overview

Handler allowing to process a form through the use of a schema.

This handler can be used to process a form and validate its data through the use of a schema. It is expected that the handler will be accessed through a GET request first: when this happens the configured template is rendered and displayed, and the configured schema which is initialized can be accessed from the template context in order to render a form for example. When the form is submitted via a POST request, the configured schema is validated using the form data. If the data is valid, the handler returns an HTTP redirect to a configured success URL.

class MyFormHandler < Marten::Handlers::Schema
  schema MyFormSchema
  template_name "my_form.html"
  success_route_name "my_form_success"
end

It should be noted that the redirect response issued will be a 302 (found).

The schema used to perform the validation can be defined through the use of the #schema macro. Alternatively, the #schema_class method can also be overridden to dynamically define the schema class as part of the request handling.

The #template_name class method allows to define the name of the template to use to render the schema while the #success_route_name method can be used to specify the name of a route to redirect to once the schema has been validated. Alternatively, the #sucess_url class method can be used to provide a raw URL to redirect to. The same method can also be overridden at the instance level in order to rely on a custom logic to generate the sucess URL to redirect to.

Included Modules

• Marten::Handlers::Schema::Callbacks

Direct Known Subclasses

• Marten::Handlers::RecordCreate
• Marten::Handlers::RecordUpdate

Defined in:

Class Method Summary

• .schema_context_name(name : String | Symbol)

  Allows to configure the name to use to include the schema into the template context.

• .schema_context_name : String

  Returns the name to use to include the schema object into the template context (defaults to #schema).

• .success_route_name(success_route_name : String | Nil)

  Allows to set the route name that should be resolved to produce the URL to when processing a valid schema.

• .success_route_name : String | Nil

  Returns the route name that should be resolved to produce the URL to redirect to when processing a valid schema.

• .success_url(success_url : String | Nil)

  Allows to configure a raw URL to redirect to when processing a valid schema.

• .success_url : String | Nil

  Returns the configured raw URL to redirect when processing a valid schema.

Macro Summary

• schema(schema_klass)

  Allows to configure the schema class that should be used to process request data.

Instance Method Summary

• #initial_data

  Returns the initial data to use to initialize the schema.

• #post

  Handles a POST HTTP request and returns a Marten::HTTP::Response object.

• #process_invalid_schema

  Produces the response when the processed schema is invalid.

• #process_valid_schema

  Produces the response when the processed schema is valid.

• #put

  Handles a PUT HTTP request and returns a Marten::HTTP::Response object.

• #schema

  Returns the schema, initialized using the request data.

• #schema_class

  Returns the schema class that should be used by the handler.

• #success_url

  Returns the URL to redirect to after the schema has been validated and processed.

Class Method Detail

Macro Detail

Instance Method Detail