跳至内容 跳至搜索

Action Text Attachable ↑

包含此模块可使记录可附加到 ActionText::Content。

class Person < ApplicationRecord
  include ActionText::Attachable
end

person = Person.create! name: "Javan"
html = %Q(<action-text-attachment sgid="#{person.attachable_sgid}"></action-text-attachment>)
content = ActionText::Content.new(html)
content.attachables # => [person]
方法
A
F
P
T

常量

LOCATOR_NAME = "attachable"
 

类公共方法

from_attachable_sgid(sgid, options = {})

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 43
def from_attachable_sgid(sgid, options = {})
  method = sgid.is_a?(Array) ? :locate_many_signed : :locate_signed
  record = GlobalID::Locator.public_send(method, sgid, options.merge(for: LOCATOR_NAME))
  record || raise(ActiveRecord::RecordNotFound)
end

from_node(node)

从附件 HTML 节点中提取 ActionText::Attachable

person = Person.create! name: "Javan"
html = %Q(<action-text-attachment sgid="#{person.attachable_sgid}"></action-text-attachment>)
fragment = ActionText::Fragment.wrap(html)
attachment_node = fragment.find_all(ActionText::Attachment.tag_name).first
ActionText::Attachable.from_node(attachment_node) # => person

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 31
def from_node(node)
  if attachable = attachable_from_sgid(node["sgid"])
    attachable
  elsif attachable = ActionText::Attachables::ContentAttachment.from_node(node)
    attachable
  elsif attachable = ActionText::Attachables::RemoteImage.from_node(node)
    attachable
  else
    ActionText::Attachables::MissingAttachable.new(node["sgid"])
  end
end

实例公共方法

attachable_content_type()

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 83
def attachable_content_type
  try(:content_type) || "application/octet-stream"
end

attachable_filename()

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 87
def attachable_filename
  filename.to_s if respond_to?(:filename)
end

attachable_filesize()

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 91
def attachable_filesize
  try(:byte_size) || try(:filesize)
end

attachable_metadata()

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 95
def attachable_metadata
  try(:metadata) || {}
end

attachable_sgid()

返回可附加项的签名全局 ID。ID 的目的是设置为 'attachable'，这样它就不能被用于其他目的。

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 79
def attachable_sgid
  to_sgid(expires_in: nil, for: LOCATOR_NAME).to_s
end

from_attachable_sgid(sgid)

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 58
def from_attachable_sgid(sgid)
  ActionText::Attachable.from_attachable_sgid(sgid, only: self)
end

previewable_attachable?()

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 99
def previewable_attachable?
  false
end

to_attachable_partial_path()

返回用于渲染可附加项的部分文件的路径。默认为 to_partial_path。

覆盖以渲染不同的部分文件

class User < ApplicationRecord
  def to_attachable_partial_path
    "users/attachable"
  end
end

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 127
def to_attachable_partial_path
  to_partial_path
end

to_missing_attachable_partial_path()

返回用于渲染丢失的可附加项的部分文件的路径。默认为“action_text/attachables/missing_attachable”。

覆盖以渲染不同的部分文件

class User < ApplicationRecord
  def self.to_missing_attachable_partial_path
    "users/missing_attachable"
  end
end

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 72
def to_missing_attachable_partial_path
  ActionText::Attachables::MissingAttachable::DEFAULT_PARTIAL_PATH
end

to_rich_text_attributes(attributes = {})

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 131
def to_rich_text_attributes(attributes = {})
  attributes.dup.tap do |attrs|
    attrs[:sgid] = attachable_sgid
    attrs[:content_type] = attachable_content_type
    attrs[:previewable] = true if previewable_attachable?
    attrs[:filename] = attachable_filename
    attrs[:filesize] = attachable_filesize
    attrs[:width] = attachable_metadata[:width]
    attrs[:height] = attachable_metadata[:height]
  end.compact
end

to_trix_content_attachment_partial_path()

返回用于在 Trix 中渲染可附加项的部分文件的路径。默认为 to_partial_path。

覆盖以渲染不同的部分文件

class User < ApplicationRecord
  def to_trix_content_attachment_partial_path
    "users/trix_content_attachment"
  end
end

来源： 显示 | 在 GitHub 上

# File actiontext/lib/action_text/attachable.rb, line 113
def to_trix_content_attachment_partial_path
  to_partial_path
end