PHP Manual
Prev |  | Next

# xml_set_unparsed_entity_decl_handler

(PHP 3>= 3.0.6, PHP 4 )

xml_set_unparsed_entity_decl_handler -- Set up unparsed entity declaration handler

## Description

bool xml_set_unparsed_entity_decl_handler ( resource 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:

    <!ENTITY name {publicId | systemId}
            NDATA notationName>

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` ( resource parser, string entity_name, string base, string system_id, string public_id, string notation_name)

`parser`

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

`entity_name`

  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.

`system_id`

  System identifier for the external entity.

`public_id`

  Public identifier for the external entity.

`notation_name`

  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.

> Note: Instead of a function name, an array containing an object reference and a method name can also be supplied.

Prev | Home | Next
xml_set_start_namespace_decl_handler | Up | XML-RPC functions