class Marten::Handlers::RecordCreate

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

Overview

Handler allowing to create a new model record by processing a schema.

This handler can be used to process a form, validate its data through the use of a schema, and create a record by using the validated data. 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 corresponding model record is created and the handler returns an HTTP redirect to a configured success URL.

class MyFormHandler < Marten::Handlers::RecordCreate
  model MyModel
  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 model class used to create the new record can be configured through the use of the #model class method. The schema used to perform the validation can be defined through the use of the #schema class method. 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.

Defined in:

Class Method Summary

• .model(model : DB::Model.class | Nil)

  Allows to configure the model class that should be used to create the new record.

• .model : DB::Model.class | Nil

  Returns the configured model class.

Instance Method Summary

• #model : Model.class

  Returns the model used to create the new record.

• #process_valid_schema

  Produces the response when the processed schema is valid.

• #record : Marten::DB::Model?

  Returns the created record upon a valid schema processing, returns nil otherwise.

• #record=(record : Marten::DB::Model | Nil)

Class Method Detail

Instance Method Detail