Class: Blacklight::DocumentPresenter

Inherits:

Object

Object
Blacklight::DocumentPresenter

show all

Defined in:: app/presenters/blacklight/document_presenter.rb

Overview

An abstract class that the view presenters for SolrDocuments descend from

Direct Known Subclasses

IndexPresenter, ShowPresenter

Instance Attribute Summary collapse

#configuration ⇒ Object readonly
Returns the value of attribute configuration.
#document ⇒ Object readonly
Returns the value of attribute document.
#view_context ⇒ Object readonly
Returns the value of attribute view_context.

Instance Method Summary collapse

#display_type(base_name = nil, default: nil) ⇒ Object
#field_presenters(document_fields = fields, **kwargs) ⇒ Object
#field_value(field_config, options = {}) ⇒ Array
Render the field label for a document.
#fields_to_render(document_fields = fields, **kwargs) ⇒ Hash<String,Configuration::Field>
All the fields for this index view that should be rendered.
#heading ⇒ String
Get the value of the document's "title" field, or a placeholder value (if empty).
#html_title ⇒ String
Get the document's "title" to display in the element.</div> </li> <li class="public "> <a href="/gems/blacklight/Blacklight/DocumentPresenter#initialize-instance_method" title="#initialize (instance method)">#initialize(document, view_context, configuration = view_context.blacklight_config, view_config: nil, field_presenter_options: {}) ⇒ DocumentPresenter </a> constructor <div class='inline'>A new instance of DocumentPresenter.</div> </li> <li class="public "> <a href="/gems/blacklight/Blacklight/DocumentPresenter#inspect-instance_method" title="#inspect (instance method)">#inspect ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="/gems/blacklight/Blacklight/DocumentPresenter#link_rel_alternates-instance_method" title="#link_rel_alternates (instance method)">#link_rel_alternates(options = {}) ⇒ Object </a> <div class='inline'>Create <link rel="alternate"> links from a documents dynamically provided export formats.</div> </li> <li class="public "> <a href="/gems/blacklight/Blacklight/DocumentPresenter#show_view_config-instance_method" title="#show_view_config (instance method)">#show_view_config ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="/gems/blacklight/Blacklight/DocumentPresenter#thumbnail-instance_method" title="#thumbnail (instance method)">#thumbnail ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="/gems/blacklight/Blacklight/DocumentPresenter#thumbnail_presenter_class-instance_method" title="#thumbnail_presenter_class (instance method)">#thumbnail_presenter_class ⇒ Object </a> <div class='inline'></div> </li> <li class="public "> <a href="/gems/blacklight/Blacklight/DocumentPresenter#view_config-instance_method" title="#view_config (instance method)">#view_config ⇒ Object </a> <div class='inline'></div> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #initialize(document, view_context, configuration = view_context.blacklight_config, view_config: nil, field_presenter_options: {}) ⇒ <tt><a href="/gems/blacklight/Blacklight/DocumentPresenter" title="Blacklight::DocumentPresenter (class)">DocumentPresenter</a></tt> </h3><script> document.getElementById("initialize-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:initialize">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Returns a new instance of DocumentPresenter. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> document (<tt><a href="/gems/blacklight/SolrDocument" title="SolrDocument (class)">SolrDocument</a></tt>) </li> <li> view_context (<tt>ActionView::Base</tt>) — <div class='inline'>scope for linking and generating urls</div> </li> <li> configuration (<tt><a href="/gems/blacklight/Blacklight/Configuration" title="Blacklight::Configuration (class)">Blacklight::Configuration</a></tt>) (defaults to: <tt>view_context.blacklight_config</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 14 15 16 17 18 19 20</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 14 def initialize(document, view_context, configuration = view_context.blacklight_config, view_config: nil, field_presenter_options: {}) @document = document @view_context = view_context @configuration = configuration @view_config = view_config @field_presenter_options = field_presenter_options end</pre> </td> </tr> </table> </div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <div class="method_details first"> <h3 class="signature first" id="configuration-instance_method"> #configuration ⇒ <tt>Object</tt> (readonly) </h3><script> document.getElementById("configuration-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:configuration">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Returns the value of attribute configuration. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 6 7 8</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 6 def configuration @configuration end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="document-instance_method"> #document ⇒ <tt>Object</tt> (readonly) </h3><script> document.getElementById("document-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:document">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Returns the value of attribute document. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 6 7 8</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 6 def document @document end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="view_context-instance_method"> #view_context ⇒ <tt>Object</tt> (readonly) </h3><script> document.getElementById("view_context-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:view_context">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Returns the value of attribute view_context. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 6 7 8</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 6 def view_context @view_context end</pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="display_type-instance_method"> #display_type(base_name = nil, default: nil) ⇒ <tt>Object</tt> </h3><script> document.getElementById("display_type-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:display_type">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 72 def display_type(base_name = nil, default: nil) fields = [] fields += Array.wrap(view_config[:"#{base_name}_display_type_field"]) if base_name && view_config.key?(:"#{base_name}_display_type_field") fields += Array.wrap(view_config.display_type_field) if fields.empty? && show_view_config != view_config fields += Array.wrap(show_view_config[:"#{base_name}_display_type_field"]) if base_name && show_view_config.key?(:"#{base_name}_display_type_field") fields += Array.wrap(show_view_config.display_type_field) end fields += ['format'] if fields.empty? # backwards compatibility with the old default value for display_type_field display_type = fields.lazy.map { |field| field_presenter(display_fields[field] || <a href="/gems/blacklight/Blacklight/Configuration" title="Blacklight::Configuration (class)">Configuration</a>::<a href="/gems/blacklight/Blacklight/Configuration/NullDisplayField" title="Blacklight::Configuration::NullDisplayField (class)">NullDisplayField</a>.<a href="/gems/blacklight/Blacklight/Configuration/NullDisplayField#initialize-instance_method" title="Blacklight::Configuration::NullDisplayField#initialize (method)">new</a>(field)) }.detect(&:any?)&.values display_type || Array(default) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="field_presenters-instance_method"> #field_presenters(document_fields = fields, **kwargs) ⇒ <tt>Object</tt> </h3><script> document.getElementById("field_presenters-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:field_presenters">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 35 36 37 38 39</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 35 def field_presenters(document_fields = fields, **kwargs) return to_enum(:field_presenters, document_fields, **kwargs) unless block_given? fields_to_render(document_fields, **kwargs).each { |_, _, config| yield config } end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="field_value-instance_method"> #field_value(field_config, options = {}) ⇒ <tt>Array</tt> </h3><script> document.getElementById("field_value-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:field_value">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Render the field label for a document Allow an extention point where information in the document may drive the value of the field </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> field_config (<tt><a href="/gems/blacklight/Blacklight/Configuration/Field" title="Blacklight::Configuration::Field (class)">Configuration::Field</a></tt>) </li> <li> options (<tt>Hash</tt>) (defaults to: <tt>{}</tt>) </li> </ul> Options Hash (<tt>options</tt>): <ul class="option"> <li> :value (<tt>String</tt>) </li> </ul> Returns: <ul class="return"> <li> (<tt>Array</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 97 98 99</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 97 def field_value field_config, options = {} Array.wrap(field_presenter(field_config, options).render) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="fields_to_render-instance_method"> #fields_to_render(document_fields = fields, **kwargs) ⇒ <tt>Hash<String,<a href="/gems/blacklight/Blacklight/Configuration/Field" title="Blacklight::Configuration::Field (class)">Configuration::Field</a>></tt> </h3><script> document.getElementById("fields_to_render-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:fields_to_render">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Returns all the fields for this index view that should be rendered. </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>Hash<String,<a href="/gems/blacklight/Blacklight/Configuration/Field" title="Blacklight::Configuration::Field (class)">Configuration::Field</a>></tt>) — <div class='inline'>all the fields for this index view that should be rendered</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 23 24 25 26 27 28 29 30 31 32 33</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 23 def fields_to_render(document_fields = fields, **kwargs) return to_enum(:fields_to_render, document_fields, **kwargs) unless block_given? document_fields.each do |name, field_config| field_presenter = field_presenter(field_config, kwargs) next unless field_presenter.render_field? && field_presenter.any? yield name, field_config, field_presenter end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="heading-instance_method"> #heading ⇒ <tt>String</tt> </h3><script> document.getElementById("heading-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:heading">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Get the value of the document's "title" field, or a placeholder value (if empty) </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 46 47 48 49 50 51 52</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 46 def heading return field_value(view_config.title_field, join: true).first if view_config.title_field.is_a? <a href="/gems/blacklight/Blacklight" title="Blacklight (module)">Blacklight</a>::<a href="/gems/blacklight/Blacklight/Configuration" title="Blacklight::Configuration (class)">Configuration</a>::<a href="/gems/blacklight/Blacklight/Configuration/Field" title="Blacklight::Configuration::Field (class)">Field</a> fields = Array.wrap(view_config.title_field) + [configuration.document_model.unique_key] f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? } f ? field_value(f, except_operations: [<a href="/gems/blacklight/Blacklight/Rendering" title="Blacklight::Rendering (module)">Rendering</a>::<a href="/gems/blacklight/Blacklight/Rendering/HelperMethod" title="Blacklight::Rendering::HelperMethod (class)">HelperMethod</a>], join: true).first : "" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="html_title-instance_method"> #html_title ⇒ <tt>String</tt> </h3><script> document.getElementById("html_title-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:html_title">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Get the document's "title" to display in the <title> element. (by default, use the #document_heading) </div> </div> <div class="tags"> Returns: <ul class="return"> <li> (<tt>String</tt>) </li> </ul> See Also: <ul class="see"> <li>#document_heading</li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 60 61 62 63 64 65 66 67 68 69 70</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 60 def html_title return field_value(view_config.html_title_field, join: true).first if view_config.html_title_field.is_a? <a href="/gems/blacklight/Blacklight" title="Blacklight (module)">Blacklight</a>::<a href="/gems/blacklight/Blacklight/Configuration" title="Blacklight::Configuration (class)">Configuration</a>::<a href="/gems/blacklight/Blacklight/Configuration/Field" title="Blacklight::Configuration::Field (class)">Field</a> if view_config.html_title_field fields = Array.wrap(view_config.html_title_field) + [configuration.document_model.unique_key] f = fields.lazy.map { |field| field_config(field) }.detect { |field_config| field_presenter(field_config).any? } field_value(f, join: true).first else heading end end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="inspect-instance_method"> #inspect ⇒ <tt>Object</tt> </h3><script> document.getElementById("inspect-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:inspect">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 129 130 131 132</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 129 def inspect fields = "document:#{document.inspect}" "#<#{self.class.name}:#{object_id} #{fields}>" end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="link_rel_alternates-instance_method"> #link_rel_alternates(options = {}) ⇒ <tt>Object</tt> </h3><script> document.getElementById("link_rel_alternates-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:link_rel_alternates">permalink</a>' ); </script> <div class="docstring"> <div class="discussion"> Create <link rel="alternate"> links from a documents dynamically provided export formats. Returns empty string if no links available. </div> </div> <div class="tags"> Parameters: <ul class="param"> <li> options (<tt>Hash</tt>) (defaults to: <tt>{}</tt>) </li> </ul> Options Hash (<tt>options</tt>): <ul class="option"> <li> :unique (<tt>Boolean</tt>) — <div class='inline'>ensures only one link is output for every content type, e.g. as required by atom</div> </li> <li> :exclude (<tt>Array<String></tt>) — <div class='inline'>array of format shortnames to not include in the output</div> </li> </ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> 117 118 119</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 117 def link_rel_alternates(options = {}) <a href="/gems/blacklight/Blacklight/LinkAlternatePresenter" title="Blacklight::LinkAlternatePresenter (class)">LinkAlternatePresenter</a>.<a href="/gems/blacklight/Blacklight/LinkAlternatePresenter#initialize-instance_method" title="Blacklight::LinkAlternatePresenter#initialize (method)">new</a>(view_context, document, options).<a href="/gems/blacklight/Blacklight/LinkAlternatePresenter#render-instance_method" title="Blacklight::LinkAlternatePresenter#render (method)">render</a> end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="show_view_config-instance_method"> #show_view_config ⇒ <tt>Object</tt> </h3><script> document.getElementById("show_view_config-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:show_view_config">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 125 126 127</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 125 def show_view_config configuration.view_config(:show, action_name: view_context.action_name) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="thumbnail-instance_method"> #thumbnail ⇒ <tt>Object</tt> </h3><script> document.getElementById("thumbnail-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:thumbnail">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 105 106 107</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 105 def thumbnail @thumbnail ||= thumbnail_presenter_class.new(document, view_context, view_config) end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="thumbnail_presenter_class-instance_method"> #thumbnail_presenter_class ⇒ <tt>Object</tt> </h3><script> document.getElementById("thumbnail_presenter_class-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:thumbnail_presenter_class">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 101 102 103</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 101 def thumbnail_presenter_class view_config.thumbnail_presenter || thumbnail_presenter end</pre> </td> </tr> </table> </div> <div class="method_details "> <h3 class="signature " id="view_config-instance_method"> #view_config ⇒ <tt>Object</tt> </h3><script> document.getElementById("view_config-instance_method").insertAdjacentHTML( "afterbegin", '<a class="permalink" href="/gems/blacklight/Blacklight%2FDocumentPresenter:view_config">permalink</a>' ); </script> <table class="source_code"> <tr> <td> <pre class="lines"> 121 122 123</pre> </td> <td> <pre class="code"># File 'app/presenters/blacklight/document_presenter.rb', line 121 def view_config @view_config ||= show_view_config end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Tue Sep 22 13:21:56 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.45 (ruby-4.0.7). </div> </div> </body> </html>