Class: Scrivito::BasicObj
- Inherits:
-
Object
- Object
- Scrivito::BasicObj
- Extended by:
- ActiveModel::Naming, ActiveSupport::DescendantsTracker, AttributeContent::ClassMethods
- Includes:
- AttributeContent
- Defined in:
- lib/scrivito/basic_obj.rb
Overview
The abstract base class for CMS objects.
A CMS object is a collection of properties and their values, as defined by its object class. These properties can be accessed in views, either directly as the object itself is rendered, or indirectly when other objects are rendered. The description of an image, for example, can be retrieved from within any view that requires it, e.g. a page on which the image is displayed.
Direct Known Subclasses
Class Method Summary collapse
-
.all ⇒ Scrivito::ObjSearchEnumerator
Returns an ObjSearchEnumerator of all Objs.
-
.attribute(name, type, options = {}) ⇒ Object
extended
from AttributeContent::ClassMethods
Defines an attribute.
-
.attribute_definitions ⇒ Scrivito::AttributeDefinitionCollection
extended
from AttributeContent::ClassMethods
Returns the attribute definitions.
-
.create(attributes = {}, context = {}) ⇒ Obj
Create a new Obj in the CMS.
-
.default_for(attribute_name, &block) ⇒ Object
extended
from AttributeContent::ClassMethods
Sets the default value of an attribute defined by AttributeContent::ClassMethods#attribute.
-
.description_for_editor ⇒ String
extended
from AttributeContent::ClassMethods
Short description of a CMS object or widget type for the UI.
-
.find(id_or_list) ⇒ Obj+
Find an Obj by its id.
-
.find_all_by_name(name) ⇒ Scrivito::ObjSearchEnumerator
Returns an ObjSearchEnumerator of all CMS objects with the given name.
-
.find_all_by_obj_class(obj_class) ⇒ Scrivito::ObjSearchEnumerator
Returns an ObjSearchEnumerator of all CMS objects with the given
obj_class
. -
.find_by_name(name) ⇒ Obj
Find an Obj with the given name.
-
.find_by_path(path) ⇒ Obj
Find the Obj with the given path.
-
.find_by_permalink(permalink) ⇒ Obj
Returns the Obj with the given permalink, or
nil
if no matching Obj exists. -
.find_by_permalink!(permalink) ⇒ Obj
Returns the Obj with the given permalink, or raises ResourceNotFound if no matching Obj exists.
-
.find_including_deleted(id_or_list) ⇒ Obj+
Find an Obj by its id.
-
.hide_from_editor ⇒ Object
extended
from AttributeContent::ClassMethods
This method prevents UI users from creating
Objs
orWidgets
of the given type. -
.restore(obj_id) ⇒ Object
Restores a previously deleted
Obj
. -
.root ⇒ Obj
Returns the root Obj, the object whose path is “/”.
-
.valid_page_classes_beneath(parent_path) ⇒ NilClass, Array<Class>
Hook method that lets you control which page classes are made available for pages with the given path.
-
.where(field, operator, value, boost = nil) ⇒ Scrivito::ObjSearchEnumerator
Returns an ObjSearchEnumerator with the given initial subquery consisting of the four arguments.
Instance Method Summary collapse
-
#[](key) ⇒ Object
Returns the value of a system or custom attribute specified by its name.
-
#alt_description ⇒ String
The alt description of an
Obj
used for ScrivitoHelper#scrivito_image_tag. -
#ancestors ⇒ Array<Obj>
Returns an Array of all the ancestor objects, starting at the root and ending at the parent of this object.
-
#apply_image_transformation? ⇒ Boolean
When delivering binary objects, this method decides whether the image transformations should be applied by default.
-
#as_json(options = nil) ⇒ Hash
included
from AttributeContent
Returns a hash to be used for the JSON serialization.
-
#binary ⇒ Binary?
This method is intended for CMS objects that represent binary resources like images or PDF documents.
-
#binary? ⇒ Boolean
This method indicates whether the Obj represents binary data.
-
#binary_content_type ⇒ String?
This method returns the content type of the binary of this Obj if the binary is set.
-
#binary_length ⇒ Fixnum
This method returns the byte length of the binary of the Obj.
-
#binary_url ⇒ String?
This method returns the URL under which the content of this binary is available to the public if the binary is set.
-
#body ⇒ String
Returns the body (main content) of the Obj for non-binary objects.
-
#children ⇒ Array<Obj>
Returns a list of all child Objs.
-
#controller_action_name ⇒ String
This method determines the action to be invoked when the
Obj
is requested. -
#controller_name ⇒ String
This method determines the controller to be invoked when the
Obj
is requested. -
#copy(options = {}) ⇒ Obj
Creates a copy of the Obj.
-
#description_for_editor ⇒ Object
This method determines the description shown in the UI.
- #destroy ⇒ Object
-
#display_title ⇒ String
Calculates an appropriate title for an
Obj
. -
#file_extension ⇒ String
Returns the name extension of the Obj (the part after the last dot).
- #id ⇒ Object
- #last_changed ⇒ Object
-
#meta_data ⇒ Scrivito::MetaDataCollection
Allows accessing the meta data for binary
Objs
. -
#name ⇒ Object
Returns the name of the Obj.
-
#obj_class ⇒ String
included
from AttributeContent
Returns the object class name of this CMS object.
-
#obj_class_name ⇒ String
included
from AttributeContent
deprecated
Deprecated.
Use AttributeContent#obj_class instead.
-
#parent ⇒ Object
Returns the Obj that is the parent of this Obj.
-
#path ⇒ Object
Returns the path of the Obj as a String.
-
#permalink ⇒ Object
Returns the permalink of the Obj.
-
#reload ⇒ Object
Reloads the attributes of this Obj from the database.
-
#revert ⇒ Object
Reverts all changes made to the
Obj
in the current workspace. -
#root? ⇒ Boolean
Returns true if this Obj is the root Obj.
-
#slug ⇒ String
This method is used to calculate a part of a URL of this Obj.
-
#sorted_toclist ⇒ Array<Obj>
Returns a list of children that are sorted according to the order specifed in the
child_order
attribute. - #title ⇒ Object
-
#toclist(*args) ⇒ Array<Obj>
Returns a list of children excluding the binary? ones unless :all is specfied.
-
#update(attributes) ⇒ Object
Update the Obj using the attributes provided.
-
#valid_widget_classes_for(field_name) ⇒ nil, Array<Class>
included
from AttributeContent
Hook method that lets you control the widget classes that are made available for adding instances of them to this page or widget.
-
#widgets ⇒ Scrivito::WidgetCollection
Allows accessing the Widgets of this Obj.
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Scrivito::AttributeContent
Class Method Details
.all ⇒ Scrivito::ObjSearchEnumerator
Returns an ObjSearchEnumerator of all Objs. If invoked on a subclass of Obj, the result is restricted to instances of this subclass.
242 243 244 245 246 247 248 249 |
# File 'lib/scrivito/basic_obj.rb', line 242 def self.all assert_not_basic_obj('.all') if self == ::Obj Workspace.current.objs.all else find_all_by_obj_class(name) end end |
.attribute(name, type, options = {}) ⇒ Object Originally defined in module AttributeContent::ClassMethods
Defines an attribute.
For the purpose of persisting model data in the CMS, the attributes of the model need to be defined. When defining an attribute, you specify the name under which Scrivito should persist its value as well as the type of content it is meant to contain, and, for the enum
and multienum
types, the selectable values.
Attributes are inherited. If, for example, the Page
model defines a title
attribute of the string
type, the SpecialPage
model, which inherits from Page
, is also equipped with title
. Inherited attributes can be overridden, i.e. you may redefine title
in SpecialPage
if you want its type to be html
, for example.
.attribute_definitions ⇒ Scrivito::AttributeDefinitionCollection Originally defined in module AttributeContent::ClassMethods
Returns the attribute definitions.
.create(attributes = {}, context = {}) ⇒ Obj
Create a new Obj in the CMS.
This allows you to set the different attributes of an Obj by providing a hash containing the attribute names as keys and the corresponding values you want to set. The defaults set via Obj.default_for are taken into account.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/scrivito/basic_obj.rb', line 129 def self.create(attributes = {}, context = {}) attributes = with_default_id_attribute(attributes) if obj_class = extract_obj_class_from_attributes(attributes) obj_class.create(attributes, context) else attributes = build_attributes_with_defaults(attributes, context) attributes = prepare_attributes_for_instantiation(attributes) api_attributes, = prepare_attributes_for_rest_api(attributes) workspace = Workspace.current obj_data = workspace.create_obj(obj: api_attributes) obj = BasicObj.instantiate(obj_data) obj.revision = workspace.revision CmsRestApi::WidgetExtractor.(obj, ) obj end end |
.default_for(attribute_name, &block) ⇒ Object Originally defined in module AttributeContent::ClassMethods
Sets the default value of an attribute defined by #attribute.
If Obj.create or Widget.new are called without providing a value for a specific custom attribute, the block
is called, and its return value is used as the initial value of this attribute.
The block
is called with two parameters.
The first parameter is an ActiveSupport::HashWithIndifferentAccess
containing the attributes that were passed to Obj.create or Widget.new.
The second parameter is a Hash
containing the context that was handed over to Obj.create or Widget.new. If the current visitor is a User, this user can be accessed by means of the :scrivito_user
key contained in the provided context.
.description_for_editor ⇒ String Originally defined in module AttributeContent::ClassMethods
Short description of a CMS object or widget type for the UI.
The description is displayed when adding new pages or widgets, for example. As a general rule, it is used whenever no widget or object instance is available. If there is, the BasicObj#description_for_editor and, respectively, BasicWidget#description_for_editor instance methods are used instead.
This method can be overridden to customize the description displayed to editors.
.find(id_or_list) ⇒ Obj+
Find an Obj by its id. If the parameter is an Array of ids, the list of corresponding objects is returned.
178 179 180 |
# File 'lib/scrivito/basic_obj.rb', line 178 def self.find(id_or_list) Workspace.current.objs.find(id_or_list) end |
.find_all_by_name(name) ⇒ Scrivito::ObjSearchEnumerator
Returns an ObjSearchEnumerator of all CMS objects with the given name.
282 283 284 |
# File 'lib/scrivito/basic_obj.rb', line 282 def self.find_all_by_name(name) where(:_name, :equals, name) end |
.find_all_by_obj_class(obj_class) ⇒ Scrivito::ObjSearchEnumerator
Returns an ObjSearchEnumerator of all CMS objects with the given obj_class
.
255 256 257 |
# File 'lib/scrivito/basic_obj.rb', line 255 def self.find_all_by_obj_class(obj_class) Workspace.current.objs.find_all_by_obj_class(obj_class) end |
.find_by_name(name) ⇒ Obj
Find an Obj with the given name. If several objects with the given name exist, an arbitrary one is chosen and returned. If no Obj with this name exists, nil
is returned.
274 275 276 |
# File 'lib/scrivito/basic_obj.rb', line 274 def self.find_by_name(name) where(:_name, :equals, name).batch_size(1).first end |
.find_by_path(path) ⇒ Obj
Find the Obj with the given path. Returns nil
if no matching Obj exists.
264 265 266 |
# File 'lib/scrivito/basic_obj.rb', line 264 def self.find_by_path(path) Workspace.current.objs.find_by_path(path) end |
.find_by_permalink(permalink) ⇒ Obj
Returns the Obj with the given permalink, or nil
if no matching Obj exists.
291 292 293 |
# File 'lib/scrivito/basic_obj.rb', line 291 def self.find_by_permalink(permalink) Workspace.current.objs.find_by_permalink(permalink) end |
.find_by_permalink!(permalink) ⇒ Obj
Returns the Obj with the given permalink, or raises ResourceNotFound if no matching Obj exists.
301 302 303 304 |
# File 'lib/scrivito/basic_obj.rb', line 301 def self.find_by_permalink!(permalink) find_by_permalink(permalink) or raise ResourceNotFound, "Could not find Obj with permalink '#{permalink}'" end |
.find_including_deleted(id_or_list) ⇒ Obj+
Find an Obj by its id. If the parameter is an Array containing ids, return a list of corresponding objects. The results include deleted objects as well.
192 193 194 |
# File 'lib/scrivito/basic_obj.rb', line 192 def self.find_including_deleted(id_or_list) Workspace.current.objs.find_including_deleted(id_or_list) end |
.hide_from_editor ⇒ Object Originally defined in module AttributeContent::ClassMethods
This method prevents UI users from creating Objs
or Widgets
of the given type. It does not prevent adding such objects programatically.
By default, hide_from_editor
is false
.
.restore(obj_id) ⇒ Object
Restores a previously deleted Obj
.
1170 1171 1172 1173 1174 1175 |
# File 'lib/scrivito/basic_obj.rb', line 1170 def restore(obj_id) Workspace.current.assert_revertable base_revision_path = "revisions/#{Workspace.current.base_revision_id}/objs/#{obj_id}" obj_attributes = CmsRestApi.get(base_revision_path).merge('_id' => obj_id) Workspace.current.api_request(:post, '/objs', obj: obj_attributes) end |
.root ⇒ Obj
Returns the root Obj, the object whose path is “/”.
467 468 469 470 471 472 |
# File 'lib/scrivito/basic_obj.rb', line 467 def self.root BasicObj.find_by_path('/') or raise ResourceNotFound, '"Obj.root" not found: There is no "Obj" with path "/". '\ 'Maybe you forgot the migration when setting up your Scrivito application? '\ 'Try "bundle exec rake scrivito:migrate scrivito:migrate:publish".' end |
.valid_page_classes_beneath(parent_path) ⇒ NilClass, Array<Class>
Hook method that lets you control which page classes are made available for pages with the given path. Override it to allow only specific classes or none at all. Must return either NilClass
, or Array
.
Be aware that the given argument is a parent path. E.g., when creating a page whose path is /products/shoes
, the argument must be /products
. The given parent path can also be NilClass
.
If NilClass
is returned, all page classes are made available. By default, NilClass
is returned.
If an Array
is returned, it is expected to contain the available classes. The order of the classes is preserved.
323 324 |
# File 'lib/scrivito/basic_obj.rb', line 323 def self.valid_page_classes_beneath(parent_path) end |
.where(field, operator, value, boost = nil) ⇒ Scrivito::ObjSearchEnumerator
If invoked on a subclass of Obj, the result will be restricted to instances of this
Returns an ObjSearchEnumerator with the given initial subquery consisting of the four arguments.
Note that field
and value
can also be arrays for searching several fields or searching for several values.
subclass.
ObjSearchEnumerators can be chained using one of the chainable methods (e.g. ObjSearchEnumerator#and and ObjSearchEnumerator#and_not).
227 228 229 230 231 232 233 234 235 |
# File 'lib/scrivito/basic_obj.rb', line 227 def self.where(field, operator, value, boost = nil) assert_not_basic_obj('.where') if self == ::Obj Workspace.current.objs.where(field, operator, value, boost) else Workspace.current.objs.where(:_obj_class, :equals, name) .and(field, operator, value, boost) end end |
Instance Method Details
#[](key) ⇒ Object
Returns the value of a system or custom attribute specified by its name. Passing an invalid key will not raise an error but return nil
.
638 639 640 641 642 643 644 645 |
# File 'lib/scrivito/basic_obj.rb', line 638 def [](key) key = key.to_s if SYSTEM_KEYS.include?(key) read_attribute(key) else super end end |
#alt_description ⇒ String
The alt description of an Obj
used for ScrivitoHelper#scrivito_image_tag.
By default, this method returns the title
of the Obj
.
You can customize this part by overriding #alt_description.
548 549 550 |
# File 'lib/scrivito/basic_obj.rb', line 548 def alt_description title end |
#ancestors ⇒ Array<Obj>
Returns an Array of all the ancestor objects, starting at the root and ending at the parent of this object.
427 428 429 430 431 432 433 434 435 |
# File 'lib/scrivito/basic_obj.rb', line 427 def ancestors return [] unless child_path? ancestor_paths = parent_path.scan(/\/[^\/]+/).inject([""]) do |list, component| list << list.last + component end ancestor_paths[0] = "/" Workspace.current.objs.find_by_paths(ancestor_paths) end |
#apply_image_transformation? ⇒ Boolean
Only relevant for binary objects
When delivering binary objects, this method decides whether the image transformations should be applied by default.
By default, this method returns false
. Override it in subclasses to fit your needs.
584 585 586 |
# File 'lib/scrivito/basic_obj.rb', line 584 def apply_image_transformation? false end |
#as_json(options = nil) ⇒ Hash Originally defined in module AttributeContent
Override it in subclasses to fit your needs.
Returns a hash to be used for the JSON serialization.
#binary ⇒ Binary?
This method is intended for CMS objects that represent binary resources like images or PDF documents. If the Obj represents a binary file, an instance of Scrivito::Binary is returned.
This method returns the blob
attribute if its type is binary
.
783 784 785 |
# File 'lib/scrivito/basic_obj.rb', line 783 def binary self[:blob] if self[:blob].is_a?(Binary) end |
#binary? ⇒ Boolean
This method indicates whether the Obj represents binary data. Binaries are handled differently in that they are not rendered using the normal layout but sent as a file. Examples of binary resources are Images or PDFs.
Every Obj that has a blob
attribute of the binary
type is considered a binary
566 567 568 569 |
# File 'lib/scrivito/basic_obj.rb', line 566 def binary? blob_attribute_definition = attribute_definitions['blob'] blob_attribute_definition.present? && blob_attribute_definition.type == 'binary' end |
#binary_content_type ⇒ String?
This method returns the content type of the binary of this Obj if the binary is set.
797 798 799 |
# File 'lib/scrivito/basic_obj.rb', line 797 def binary_content_type binary.try(:content_type) end |
#binary_length ⇒ Fixnum
This method returns the byte length of the binary of the Obj.
790 791 792 |
# File 'lib/scrivito/basic_obj.rb', line 790 def binary_length binary.try(:content_length) || 0 end |
#binary_url ⇒ String?
This method returns the URL under which the content of this binary is available to the public if the binary is set.
See Scrivito::Binary#url for details
807 808 809 |
# File 'lib/scrivito/basic_obj.rb', line 807 def binary_url binary.try(:url) end |
#body ⇒ String
Returns the body (main content) of the Obj for non-binary objects. Returns nil
for binary objects.
767 768 769 770 771 772 773 |
# File 'lib/scrivito/basic_obj.rb', line 767 def body if binary? nil else read_attribute('body') end end |
#children ⇒ Array<Obj>
Returns a list of all child Objs.
440 441 442 443 444 |
# File 'lib/scrivito/basic_obj.rb', line 440 def children return [] unless path workspace.objs.find_by_parent_path(path) end |
#controller_action_name ⇒ String
This method determines the action to be invoked when the Obj
is requested. The default action is ‘index’. Override this method to force a different action to be used.
499 500 501 |
# File 'lib/scrivito/basic_obj.rb', line 499 def controller_action_name "index" end |
#controller_name ⇒ String
This method determines the controller to be invoked when the Obj
is requested. By default, a controller matching the obj_class of the Obj is used. If the controller does not exist, the CmsController is used as a fallback. Override this method to force a different controller to be used.
490 491 492 |
# File 'lib/scrivito/basic_obj.rb', line 490 def controller_name obj_class end |
#copy(options = {}) ⇒ Obj
Creates a copy of the Obj.
392 393 394 395 396 397 398 399 400 |
# File 'lib/scrivito/basic_obj.rb', line 392 def copy(={}) = .stringify_keys.assert_valid_keys('_path', '_id', '_permalink') attributes_for_copy = self.class.with_default_id_attribute(copyable_attributes) attributes_for_copy = attributes_for_copy.with_indifferent_access.merge() attributes_for_copy = copy_binaries(attributes_for_copy) json = workspace.api_request(:post, '/objs', obj: attributes_for_copy) self.class.find(json['_id']) end |
#description_for_editor ⇒ Object
This method determines the description shown in the UI. It defaults to #display_title. It can be overridden by a custom value.
523 524 525 |
# File 'lib/scrivito/basic_obj.rb', line 523 def description_for_editor display_title end |
#destroy ⇒ Object
404 405 406 407 408 409 |
# File 'lib/scrivito/basic_obj.rb', line 404 def destroy if children.any? raise ClientError.new(I18n.t('scrivito.errors.models.basic_obj.has_children')) end workspace.api_request(:delete, "/objs/#{id}") end |
#display_title ⇒ String
Calculates an appropriate title for an Obj
.
536 537 538 |
# File 'lib/scrivito/basic_obj.rb', line 536 def display_title (binary_title || title).presence || self.class.description_for_editor end |
#file_extension ⇒ String
Returns the name extension of the Obj (the part after the last dot). Returns an empty string if the name of the Obj doesn’t have an extension.
759 760 761 |
# File 'lib/scrivito/basic_obj.rb', line 759 def file_extension File.extname(name)[1..-1] || "" end |
#id ⇒ Object
156 157 158 |
# File 'lib/scrivito/basic_obj.rb', line 156 def id read_attribute('_id') end |
#last_changed ⇒ Object
674 675 676 |
# File 'lib/scrivito/basic_obj.rb', line 674 def last_changed read_attribute('_last_changed') end |
#meta_data ⇒ Scrivito::MetaDataCollection
Allows accessing the meta data for binary Objs
.
822 823 824 |
# File 'lib/scrivito/basic_obj.rb', line 822 def binary.try(:meta_data) || MetaDataCollection.new({}) end |
#name ⇒ Object
Returns the name of the Obj. The name is the last component of a path.
456 457 458 459 460 461 462 |
# File 'lib/scrivito/basic_obj.rb', line 456 def name if child_path? path.match(/[^\/]+$/)[0] else "" end end |
#obj_class ⇒ String Originally defined in module AttributeContent
Returns the object class name of this CMS object.
#obj_class_name ⇒ String Originally defined in module AttributeContent
Use #obj_class instead.
Returns the object class name of this CMS object.
#parent ⇒ Object
Returns the Obj that is the parent of this Obj. Returns nil
for the root Obj.
418 419 420 421 422 |
# File 'lib/scrivito/basic_obj.rb', line 418 def parent if child_path? workspace.objs.find_by_path(parent_path) end end |
#path ⇒ Object
Returns the path of the Obj as a String.
450 451 452 |
# File 'lib/scrivito/basic_obj.rb', line 450 def path read_attribute('_path') end |
#permalink ⇒ Object
Returns the permalink of the Obj.
480 481 482 |
# File 'lib/scrivito/basic_obj.rb', line 480 def permalink read_attribute('_permalink') end |
#reload ⇒ Object
Reloads the attributes of this Obj from the database. Note that the Ruby class of this Obj instance will NOT change, even if the obj_class in the database has changed.
661 662 663 664 |
# File 'lib/scrivito/basic_obj.rb', line 661 def reload workspace.reload reload_data end |
#revert ⇒ Object
This method does not support Objs that are new
. Please use Obj#destroy to destroy them.
This method does not support Objs that are deleted
. Please use Obj.restore to restore them.
Reverts all changes made to the Obj
in the current workspace.
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 |
# File 'lib/scrivito/basic_obj.rb', line 880 def revert assert_revertable if modification == Modification::EDITED base_revision_path = "revisions/#{workspace.base_revision_id}/objs/#{id}" previous_attributes = CmsRestApi.get(base_revision_path).except('_id') = previous_attributes['_widget_pool'] = .keys - .keys .each { || [] = nil } previous_attributes = reset_blank_attributes(previous_attributes) workspace.api_request(:put, "/objs/#{id}", obj: previous_attributes) reload end end |
#root? ⇒ Boolean
Returns true if this Obj is the root Obj.
590 591 592 |
# File 'lib/scrivito/basic_obj.rb', line 590 def root? path == "/" end |
#slug ⇒ String
This method is used to calculate a part of a URL of this Obj.
The routing schema: <obj.slug>-<obj.id>
The default is parameterize on obj.title
.
You can customize this part by overriding #slug.
513 514 515 |
# File 'lib/scrivito/basic_obj.rb', line 513 def slug (title || '').parameterize end |
#sorted_toclist ⇒ Array<Obj>
Returns a list of children that are sorted according to the order specifed in the child_order
attribute. The same sort order is used when rendering navigations using the scrivito_tag_list helper.
612 613 614 615 616 617 618 |
# File 'lib/scrivito/basic_obj.rb', line 612 def sorted_toclist if sortable_toclist? (child_order & toclist) + (toclist - child_order).sort_by(&:id) else toclist end end |
#title ⇒ Object
553 554 555 |
# File 'lib/scrivito/basic_obj.rb', line 553 def title read_attribute('title') end |
#toclist(*args) ⇒ Array<Obj>
Returns a list of children excluding the binary? ones unless :all is specfied. This is useful for creating navigations.
598 599 600 601 602 603 |
# File 'lib/scrivito/basic_obj.rb', line 598 def toclist(*args) return [] if binary? toclist = children toclist = toclist.reject { |toc| toc.binary? } unless args.include?(:all) toclist end |
#update(attributes) ⇒ Object
Update the Obj using the attributes provided.
For an overview of the values you can set via this method, see the documentation of Obj.create.
Additionally, update
accepts a _widget_pool
hash in attributes
to modify widgets. The keys of _widget_pool
are widget instances, the values are the modified attributes of these particular widgets.
374 375 376 377 378 379 |
# File 'lib/scrivito/basic_obj.rb', line 374 def update(attributes) api_attributes, = prepare_attributes_for_rest_api(attributes) update_data(workspace.update_obj(id, obj: api_attributes)) CmsRestApi::WidgetExtractor.(self, ) self end |
#valid_widget_classes_for(field_name) ⇒ nil, Array<Class> Originally defined in module AttributeContent
Hook method that lets you control the widget classes that are made available for adding instances of them to this page or widget. Override it to allow only specific classes or none at all. Must return either NilClass
, or Array
.
If nil
is returned (default), all widget classes will be available for this page or widget.
If an Array
is returned, it is expected to include the permitted classes. Their order is preserved as they are offered to the user via the widget browser.
#widgets ⇒ Scrivito::WidgetCollection
Allows accessing the Widgets of this Obj.
857 858 859 |
# File 'lib/scrivito/basic_obj.rb', line 857 def @widgets ||= WidgetCollection.new(self) end |