abstract struct DynFork::Model

• DynFork::Model
• DynFork::Extra
• Struct
• Value
• Object

Overview

Abstraction for converting Crystal structures into DynFork Models.

Simple example:

@[DynFork::Meta(service_name: "Accounts")]
struct User < DynFork::Model
  getter username = DynFork::Fields::TextField.new
  getter birthday = DynFork::Fields::DateField.new
end

Extended example:

@[DynFork::Meta(
  service_name: "Accounts",
  delete_doc?: false,
)]
struct User < DynFork::Model
  getter username = DynFork::Fields::TextField.new(
    label: "Username",
    maxlength: 150,
    minlength: 1,
    regex: "^[a-zA-Z0-9_@.+]$",
    regex_err_msg: "Allowed chars: a-z A-Z 0-9 _ @ . +",
    required: true,
    unique: true
  )
  getter email = DynFork::Fields::EmailField.new(
    label: "E-mail",
    maxlength: 320,
    required: true,
    unique: true
  )
  getter birthday = DynFork::Fields::DateField.new(
    label: "Birthday",
  )
  getter slug = DynFork::Fields::SlugField.new(
    label: "Slug",
    slug_sources: ["hash", "username"]
  )
  getter password = DynFork::Fields::PasswordField.new(
    label: "Password",
  )
  # Do not save the value of this field to the database.
  # This field is for verification purposes only.
  getter confirm_password = DynFork::Fields::PasswordField.new(
    label: "Confirm password",
    ignored: true
  )
  getter active = DynFork::Fields::BoolField.new(
    label: "is active?",
    default: true
  )
end

Included Modules

• DynFork::Globals::Date
• DynFork::QPaladins
• JSON::Serializable

Extended Modules

• DynFork::QCommons

Defined in:

Constructors

• .new(pull : JSON::PullParser)
• .new

Class Method Summary

• .full_model_name : String

  Get full Model name = ModuleName::StructureName.

• .meta : DynFork::Globals::CacheMetaDataType | Nil

  Metadata cache.

• .meta? : DynFork::Globals::CacheMetaDataType | Nil | Nil

  Metadata cache.

• .subclasses

  Get a list of Models.

Instance Method Summary

• #created_at : DynFork::Fields::DateTimeField

  Field for the date and time the document was created.

• #hash : DynFork::Fields::HashField

  Field for the document identifier.

• #object_id : BSON::ObjectId | Nil

  Get ObjectId from hash field.

• #updated_at : DynFork::Fields::DateTimeField

  Field for the date and time the document was updated.

Constructor Detail

Class Method Detail

Instance Method Detail