PHP Manual
Prev |  | Next

# xml_set_unparsed_entity_decl_handler

xml_set_unparsed_entity_decl_handler -- Set up unparsed entity declaration handler

## Description

`int xml_set_unparsed_entity_decl_handler` (int parser, string handler);

Sets the unparsed entity declaration handler function for the XML parser `parser`. `handler` is a string containing the name of a function that must exist when xml_parse() is called for `parser`.

This handler will be called if the XML parser encounters an external entity declaration with an NDATA declaration, like the following:

      1
      2 <!ENTITY name {publicId | systemId}
      3         NDATA notationName>
      4

See section 4.2.2 of the XML 1.0 spec for the definition of notation declared external entities.

The function named by `handler` must accept six parameters:

``handler``(int parser, string entityName, string base, string systemId, string publicId, string notationName);

`parser`

  The first parameter, `parser`, is a reference to the XML parser calling the handler.

`entityName`

  The name of the entity that is about to be defined.

`base`

  This is the base for resolving the system identifier (`systemId`) of the external entity. Currently this parameter will always be set to an empty string.

`systemId`

  System identifier for the external entity.

`publicId`

  Public identifier for the external entity.

`notationName`

  Name of the notation of this entity (see xml_set_notation_decl_handler()).

If a handler function is set to an empty string, or `false`, the handler in question is disabled.

True is returned if the handler is set up, false if `parser` is not a parser.

There is currently no support for object/method handlers.

Prev | Home | Next
xml_set_default_handler | Up | xml_set_notation_decl_handler