class REXML::Entity

Constants

ENTITYDECL
ENTITYDEF
ENTITYVALUE
EXTERNALID
GEDECL
NDATADECL
PEDECL
PEDEF
PEREFERENCE
PEREFERENCE_RE
PUBIDCHAR
PUBIDLITERAL
SYSTEMLITERAL

Attributes

external [R]

name [R]

ndata [R]

pubid [R]

ref [R]

value [R]

Public Class Methods

matches? (string)

Source

# File lib/rexml/entity.rb, line 67
def Entity::matches? string
  (ENTITYDECL =~ string) == 0
end

Evaluates whether the given string matches an entity definition, returning true if so, and false otherwise.

new (stream, value=nil, parent=nil, reference=false)

Source

# File lib/rexml/entity.rb, line 34
def initialize stream, value=nil, parent=nil, reference=false
  super(parent)
  @ndata = @pubid = @value = @external = nil
  if stream.kind_of? Array
    @name = stream[1]
    if stream[-1] == '%'
      @reference = true
      stream.pop
    else
      @reference = false
    end
    if stream[2] =~ /SYSTEM|PUBLIC/
      @external = stream[2]
      if @external == 'SYSTEM'
        @ref = stream[3]
        @ndata = stream[4] if stream.size == 5
      else
        @pubid = stream[3]
        @ref = stream[4]
      end
    else
      @value = stream[2]
    end
  else
    @reference = reference
    @external = nil
    @name = stream
    @value = value
  end
end

Create a new entity. Simple entities can be constructed by passing a name, value to the constructor; this creates a generic, plain entity reference. For anything more complicated, you have to pass a Source to the constructor with the entity definition, or use the accessor methods. WARNING: There is no validation of entity state except when the entity is read from a stream. If you start poking around with the accessors, you can easily create a non-conformant Entity.

e = Entity.new( 'amp', '&' )

Calls superclass method REXML::Child::new

Public Instance Methods

normalized ()

Source

# File lib/rexml/entity.rb, line 86
def normalized
  @value
end

Returns the value of this entity unprocessed – raw. This is the normalized value; that is, with all %ent; and &ent; entities intact

to_s ()

Source

# File lib/rexml/entity.rb, line 120
def to_s
  rv = ''
  write rv
  rv
end

Returns this entity as a string. See write().

unnormalized ()

Source

# File lib/rexml/entity.rb, line 73
def unnormalized
  document&.record_entity_expansion

  return nil if @value.nil?

  @unnormalized = Text::unnormalize(@value, parent,
                                    entity_expansion_text_limit: document&.entity_expansion_text_limit)
end

Evaluates to the unnormalized value of this entity; that is, replacing &ent; entities.

write (out, indent=-1)

Source

# File lib/rexml/entity.rb, line 98
def write out, indent=-1
  out << '<!ENTITY '
  out << '% ' if @reference
  out << @name
  out << ' '
  if @external
    out << @external << ' '
    if @pubid
      q = @pubid.include?('"')?"'":'"'
      out << q << @pubid << q << ' '
    end
    q = @ref.include?('"')?"'":'"'
    out << q << @ref << q
    out << ' NDATA ' << @ndata if @ndata
  else
    q = @value.include?('"')?"'":'"'
    out << q << @value << q
  end
  out << '>'
end

Write out a fully formed, correct entity definition (assuming the Entity object itself is valid.)

out: An object implementing << to which the entity will be output
indent: DEPRECATED and ignored