Action Text `Content`

ActionText::Content 類別包裝 HTML 片段，以新增對解析、渲染和序列化之支援。它可以用於提取連結和附件，將片段轉換為純文字，或將片段序列化到資料庫。

ActionText::RichText 記錄將 body 屬性序列化為 ActionText::Content。

class Message < ActiveRecord::Base
  has_rich_text :content
end

message = Message.create!(content: "<h1>Funny times!</h1>")
body = message.content.body # => #<ActionText::Content "<div class=\"trix-conte...">
body.to_s # => "<h1>Funny times!</h1>"
body.to_plain_text # => "Funny times!"

方法

#

A

append_attachables（附加可附加物件）,
as_json（轉換為 JSON 格式）,
attachables（可附加物件）,
attachment_galleries（附件畫廊）,
attachments（附件）

F

fragment_by_canonicalizing_content（透過規範化內容取得片段）

G

gallery_attachments（畫廊附件）

I

inspect（檢查）

L

links（連結）

N

new（新的）

R

render_attachment_galleries（渲染附件畫廊）,
render_attachments（渲染附件）

T

to_html（轉換為 HTML）,
to_partial_path（轉換為部分路徑）,
to_plain_text（轉換為純文字）,
to_rendered_html_with_layout（轉換為帶有佈局的渲染 HTML）,
to_s（轉換為字串）,
to_trix_html（轉換為 Trix HTML）

屬性

[R]

fragment（片段）

類別公開方法

fragment_by_canonicalizing_content(content) 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 33
def fragment_by_canonicalizing_content(content)
  fragment = ActionText::Attachment.fragment_by_canonicalizing_attachments(content)
  fragment = ActionText::AttachmentGallery.fragment_by_canonicalizing_attachment_galleries(fragment)
  fragment
end

new(content = nil, options = {}) 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 40
def initialize(content = nil, options = {})
  options.with_defaults! canonicalize: true

  if options[:canonicalize]
    @fragment = self.class.fragment_by_canonicalizing_content(content)
  else
    @fragment = ActionText::Fragment.wrap(content)
  end
end

實例公開方法

==(other) 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 169
def ==(other)
  if self.class == other.class
    to_html == other.to_html
  elsif other.is_a?(self.class)
    to_s == other.to_s
  end
end

append_attachables(attachables) 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 93
def append_attachables(attachables)
  attachments = ActionText::Attachment.from_attachables(attachables)
  self.class.new([self.to_s.presence, *attachments].compact.join("\n"))
end

as_json(*) 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 161
def as_json(*)
  to_html
end

attachables() 連結

從 HTML 片段中提取 +ActionText::Attachable+ 物件

attachable = ActiveStorage::Blob.first
html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
content = ActionText::Content.new(html)
content.attachables # => [attachable]

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 87
def attachables
  @attachables ||= attachment_nodes.map do |node|
    ActionText::Attachable.from_node(node)
  end
end

attachment_galleries() 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 71
def attachment_galleries
  @attachment_galleries ||= attachment_gallery_nodes.map do |node|
    attachment_gallery_for_node(node)
  end
end

attachments() 連結

從 HTML 片段中提取 +ActionText::Attachment+ 物件

attachable = ActiveStorage::Blob.first
html = %Q(<action-text-attachment sgid="#{attachable.attachable_sgid}" caption="Captioned"></action-text-attachment>)
content = ActionText::Content.new(html)
content.attachments # => [#<ActionText::Attachment attachable=#<ActiveStorage::Blob...

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 65
def attachments
  @attachments ||= attachment_nodes.map do |node|
    attachment_for_node(node)
  end
end

gallery_attachments() 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 77
def gallery_attachments
  @gallery_attachments ||= attachment_galleries.flat_map(&:attachments)
end

inspect() 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 165
def inspect
  "#<#{self.class.name} #{to_html.truncate(25).inspect}>"
end

links() 連結

從 HTML 片段中提取連結

html = '<a href="http://example.com/">Example</a>'
content = ActionText::Content.new(html)
content.links # => ["http://example.com/"]

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 55
def links
  @links ||= fragment.find_all("a[href]").map { |a| a["href"] }.uniq
end

render_attachment_galleries(&block) 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 109
def render_attachment_galleries(&block)
  content = ActionText::AttachmentGallery.fragment_by_replacing_attachment_gallery_nodes(fragment) do |node|
    block.call(attachment_gallery_for_node(node))
  end
  self.class.new(content, canonicalize: false)
end

render_attachments(**options, &block) 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 98
def render_attachments(**options, &block)
  content = fragment.replace(ActionText::Attachment.tag_name) do |node|
    if node.key?("content")
      sanitized_content = sanitize_content_attachment(node.remove_attribute("content").to_s)
      node["content"] = sanitized_content if sanitized_content.present?
    end
    block.call(attachment_for_node(node, **options))
  end
  self.class.new(content, canonicalize: false)
end

to_html() 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 138
def to_html
  fragment.to_html
end

to_partial_path() 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 146
def to_partial_path
  "action_text/contents/content"
end

to_plain_text() 連結

傳回內容中標記的純文字版本，移除標籤但編碼 HTML 實體。

content = ActionText::Content.new("<h1>Funny times!</h1>")
content.to_plain_text # => "Funny times!"

content = ActionText::Content.new("<div onclick='action()'>safe<script>unsafe</script></div>")
content.to_plain_text # => "safeunsafe"

注意：傳回的字串不是 HTML 安全的，不應在瀏覽器中呈現。

content = ActionText::Content.new("&lt;script&gt;alert()&lt;/script&gt;")
content.to_plain_text # => "<script>alert()</script>"

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 130
def to_plain_text
  render_attachments(with_full_attributes: false, &:to_plain_text).fragment.to_plain_text
end

to_rendered_html_with_layout() 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 142
def to_rendered_html_with_layout
  render layout: "action_text/contents/content", partial: to_partial_path, formats: :html, locals: { content: self }
end

to_s() 連結

安全地將 Content 轉換為 HTML 字串。

content = ActionText::Content.new(content: "<h1>Funny times!</h1>")
content.to_s # => "<h1>Funny times!</h1>"

content = ActionText::Content.new("<div onclick='action()'>safe<script>unsafe</script></div>")
content.to_s # => "<div>safeunsafe</div>"

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 157
def to_s
  to_rendered_html_with_layout
end

to_trix_html() 連結

來源：顯示 | 在 GitHub 上

# File actiontext/lib/action_text/content.rb, line 134
def to_trix_html
  render_attachments(&:to_trix_attachment).to_html
end

類別 ActionText::Content < 物件

Action Text Content

屬性

類別公開方法

fragment_by_canonicalizing_content(content) 連結

new(content = nil, options = {}) 連結

實例公開方法

==(other) 連結

append_attachables(attachables) 連結

as_json(*) 連結

attachables() 連結

attachment_galleries() 連結

attachments() 連結

gallery_attachments() 連結

inspect() 連結

links() 連結

render_attachment_galleries(&block) 連結

render_attachments(**options, &block) 連結

to_html() 連結

to_partial_path() 連結

to_plain_text() 連結

to_rendered_html_with_layout() 連結

to_s() 連結

to_trix_html() 連結

Action Text `Content`