Class: Plutonium::Definition::Base Abstract

Inherits:
Object
  • Object
show all
Includes:
Actions, ConfigAttr, DefineableProps, InheritableConfigAttr, Metadata, NestedInputs, Scoping, Search, Sorting, Views
Defined in:
lib/plutonium/definition/base.rb

Overview

This class is abstract.

Subclass and override #customize_fields, #customize_inputs, #customize_filters, #customize_scopes, and #customize_sorters to implement custom behavior.

Note:

This class is not thread-safe. Ensure proper synchronization if used in a multi-threaded environment.

Base class for Plutonium definitions

Examples:

class MyDefinition < Plutonium::Definition::Base
  field :name, as: :string
  input :email, as: :email
  filter :status, type: :select, collection: %w[active inactive]
  scope :active
  default_scope :active
  sorter :created_at

  def customize_fields
    field :custom_field, as: :integer
  end
end

Direct Known Subclasses

Resource::Definition

Defined Under Namespace

Classes: Display, EditPage, Form, Grid, IndexPage, InteractiveActionPage, NewPage, QueryForm, ShowPage, Table, TextFilter

Constant Summary

Constants included from Views

Views::GRID_LAYOUTS, Views::GRID_SLOTS, Views::KNOWN_VIEWS

Instance Method Summary collapse

Methods included from Metadata

#defined_metadata_fields

Methods included from Views

#default_view, #defined_grid_columns, #defined_grid_fields, #defined_grid_layout, #defined_views

Methods included from Search

#search_definition

Methods included from Scoping

#default_scope

Methods included from Sorting

#default_sort

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.



89
90
91
 
# File 'lib/plutonium/definition/base.rb', line 89

def initialize
  super
end

Instance Method Details

#collection_class ⇒ Object 



117
118
119
 
# File 'lib/plutonium/definition/base.rb', line 117

def collection_class
  self.class::Table
end

#detail_class ⇒ Object 



125
126
127
 
# File 'lib/plutonium/definition/base.rb', line 125

def detail_class
  self.class::Display
end

#edit_page_class ⇒ Object 



105
106
107
 
# File 'lib/plutonium/definition/base.rb', line 105

def edit_page_class
  self.class::EditPage
end

#form_class ⇒ Object 



113
114
115
 
# File 'lib/plutonium/definition/base.rb', line 113

def form_class
  self.class::Form
end

#grid_class ⇒ Object 



121
122
123
 
# File 'lib/plutonium/definition/base.rb', line 121

def grid_class
  self.class::Grid
end

#index_page_class ⇒ Object 



93
94
95
 
# File 'lib/plutonium/definition/base.rb', line 93

def index_page_class
  self.class::IndexPage
end

#interactive_action_page_class ⇒ Object 



109
110
111
 
# File 'lib/plutonium/definition/base.rb', line 109

def interactive_action_page_class
  self.class::InteractiveActionPage
end

#new_page_class ⇒ Object 



97
98
99
 
# File 'lib/plutonium/definition/base.rb', line 97

def new_page_class
  self.class::NewPage
end

#query_form ⇒ Object 



129
130
131
 
# File 'lib/plutonium/definition/base.rb', line 129

def query_form
  self.class::QueryForm
end

#show_page_class ⇒ Object 



101
102
103
 
# File 'lib/plutonium/definition/base.rb', line 101

def show_page_class
  self.class::ShowPage
end