---
name: "XML::DOM::Entity"
section: "3pm"
platform: "linux"
package: "libxml-dom-perl"
version: "1.46-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/XML::DOM::Entity"
---

# XML::DOM::Entity(3pm)

An XML ENTITY in XML::DOM

## NAME

XML::DOM::Entity - An XML ENTITY in XML::DOM

## DESCRIPTION

XML::DOM::Entity extends XML::DOM::Node.

This node represents an Entity declaration, e.g.

```
 <!ENTITY % draft 'INCLUDE'>
 <!ENTITY hatch-pic SYSTEM "../grafix/OpenHatch.gif" NDATA gif>
```

The first one is called a parameter entity and is referenced like this: `%draft`; The 2nd is a (regular) entity and is referenced like this: &hatch-pic;

### METHODS

- getNotationName

  Returns the name of the notation for the entity.

  *Not Implemented* The DOM Spec says: For unparsed entities, the name of the  notation for the entity. For parsed entities, this is null. (This implementation does not support unparsed entities.)

- getSysId

  Returns the system id, or undef.

- getPubId

  Returns the public id, or undef.

### Additional methods not in the DOM Spec

- isParameterEntity

  Whether it is a parameter entity (%ent;) or not (&ent;)

- getValue

  Returns the entity value.

- getNdata

  Returns the NDATA declaration (for general unparsed entities), or undef.
