diff --git a/reference/xml/functions/utf8-decode.xml b/reference/xml/functions/utf8-decode.xml index 217f716b66..912cbf9eec 100644 --- a/reference/xml/functions/utf8-decode.xml +++ b/reference/xml/functions/utf8-decode.xml @@ -1,15 +1,16 @@ - + utf8_decode Converts a string with ISO-8859-1 characters encoded with UTF-8 to single-byte ISO-8859-1 - + - - Description + + + &reftitle.description; stringutf8_decode stringdata @@ -18,12 +19,40 @@ This function decodes data, assumed to be UTF-8 encoded, to ISO-8859-1. + + + + &reftitle.parameters; - See also - utf8_encode for an explanation of UTF-8 - encoding. + + + data + + + An UTF-8 encoded string. + + + + + + + &reftitle.returnvalues; + + Returns the ISO-8859-1 translation of data. + + + + + &reftitle.seealso; + + + utf8_encode for an explanation of UTF-8 encoding + + + + + utf8_encode Encodes an ISO-8859-1 string to UTF-8 - - Description + + + &reftitle.description; stringutf8_encode stringdata @@ -60,6 +61,30 @@ used to store character data. + + + &reftitle.parameters; + + + + data + + + An ISO-8859-1 string. + + + + + + + + + &reftitle.returnvalues; + + Returns the UTF-8 translation of data. + + + + xml_error_string Get XML parser error string + &reftitle.description; @@ -16,6 +17,7 @@ code. + &reftitle.parameters; @@ -31,6 +33,7 @@ + &reftitle.returnvalues; @@ -38,6 +41,7 @@ code, or &false; if no description was found. + &reftitle.seealso; @@ -46,6 +50,7 @@ + + xml_get_current_byte_index Get current byte index for an XML parser + &reftitle.description; @@ -15,6 +16,7 @@ Gets the current byte index of the given XML parser. + &reftitle.parameters; @@ -30,6 +32,7 @@ + &reftitle.returnvalues; @@ -38,6 +41,7 @@ the parser is currently at in its data buffer (starting at 0). + &reftitle.notes; @@ -47,6 +51,7 @@ + &reftitle.seealso; @@ -56,6 +61,7 @@ + + xml_get_current_column_number @@ -7,6 +7,7 @@ Get current column number for an XML parser + &reftitle.description; @@ -17,6 +18,7 @@ Gets the current column number of the given XML parser. + &reftitle.parameters; @@ -32,6 +34,7 @@ + &reftitle.returnvalues; @@ -42,6 +45,7 @@ currently at. + &reftitle.seealso; @@ -51,6 +55,7 @@ + + xml_get_current_line_number Get current line number for an XML parser + &reftitle.description; @@ -15,6 +16,7 @@ Gets the current line number for the given XML parser. + &reftitle.parameters; @@ -30,6 +32,7 @@ + &reftitle.returnvalues; @@ -38,6 +41,7 @@ parser is currently at in its data buffer. + &reftitle.seealso; @@ -47,6 +51,7 @@ + + xml_get_error_code Get XML parser error code + &reftitle.description; @@ -15,6 +16,7 @@ Gets the XML parser error code. + &reftitle.parameters; @@ -30,6 +32,7 @@ + &reftitle.returnvalues; @@ -39,6 +42,7 @@ section. + &reftitle.seealso; @@ -47,6 +51,7 @@ + + xml_parse_into_struct Parse XML data into an array structure - - Description + + + &reftitle.description; intxml_parse_into_struct resourceparser @@ -15,19 +16,60 @@ arrayindex - This function parses an XML file into 2 parallel array - structures, one (index) containing pointers - to the location of the appropriate values in the - values array. These last two parameters - must be passed by reference. + This function parses an XML file into 2 parallel array structures, one + (index) containing pointers to the location of the + appropriate values in the values array. These last + two parameters must be passed by reference. - - - xml_parse_into_struct returns 0 for - failure and 1 for success. This is not the same as &false; - and &true;, be careful with operators such as ===. - - + + + + &reftitle.parameters; + + + + parser + + + + + + + data + + + + + + + values + + + + + + + index + + + + + + + + + + + &reftitle.returnvalues; + + xml_parse_into_struct returns 0 for failure and 1 for + success. This is not the same as &false; and &true;, be careful with + operators such as ===. + + + + + &reftitle.examples; Below is an example that illustrates the internal structure of the arrays being generated by the function. We use a simple @@ -234,6 +276,7 @@ Array + + xml_parse Start parsing an XML document + &reftitle.description; @@ -18,6 +19,7 @@ the configured events are called as many times as necessary. + &reftitle.parameters; @@ -53,6 +55,7 @@ + &reftitle.returnvalues; @@ -73,6 +76,7 @@ + + xml_parser_create_ns Create an XML parser with namespace support - - Description + + + &reftitle.description; resourcexml_parser_create_ns stringencoding @@ -17,30 +18,60 @@ with XML namespace support and returns a resource handle referencing it to be used by the other XML functions. + + + + &reftitle.parameters; - With a namespace aware parser tag parameters passed to the - various handler functions will consist of namespace and tag name - separated by the string specified in - seperator or ':' by - default. - - - The optional encoding specifies the character - encoding for the input/output in PHP 4. Starting from PHP 5, the input - encoding is automatically detected, so that the - encoding parameter specifies only the output - encoding. In PHP 4, the default output encoding is the same as the - input charset. In PHP 5.0.0 and 5.0.1, the default output charset is - ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported - encodings are ISO-8859-1, UTF-8 and - US-ASCII. - - - See also - xml_parser_create, and - xml_parser_free. + + + encoding + + + The optional encoding specifies the character + encoding for the input/output in PHP 4. Starting from PHP 5, the input + encoding is automatically detected, so that the + encoding parameter specifies only the output + encoding. In PHP 4, the default output encoding is the same as the + input charset. In PHP 5.0.0 and 5.0.1, the default output charset is + ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported + encodings are ISO-8859-1, UTF-8 and + US-ASCII. + + + + + separator + + + With a namespace aware parser tag parameters passed to the various + handler functions will consist of namespace and tag name separated by + the string specified in seperator or + ':' by default. + + + + + + + &reftitle.returnvalues; + + Returns a resource handle for the new XML parser. + + + + + &reftitle.seealso; + + + xml_parser_create + xml_parser_free + + + + + xml_parser_create Create an XML parser - - Description + + + &reftitle.description; resourcexml_parser_create stringencoding @@ -16,24 +17,51 @@ and returns a resource handle referencing it to be used by the other XML functions. + + + + &reftitle.parameters; - The optional encoding specifies the character - encoding for the input/output in PHP 4. Starting from PHP 5, the input - encoding is automatically detected, so that the - encoding parameter specifies only the output - encoding. In PHP 4, the default output encoding is the same as the - input charset. If empty string is passed, the parser attempts to identify - which encoding the document is encoded in by looking at the heading 3 or - 4 bytes. In PHP 5.0.0 and 5.0.1, the default output charset is - ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported - encodings are ISO-8859-1, UTF-8 and - US-ASCII. - - - See also xml_parser_create_ns and - xml_parser_free. + + + encoding + + + The optional encoding specifies the character + encoding for the input/output in PHP 4. Starting from PHP 5, the input + encoding is automatically detected, so that the + encoding parameter specifies only the output + encoding. In PHP 4, the default output encoding is the same as the + input charset. If empty string is passed, the parser attempts to identify + which encoding the document is encoded in by looking at the heading 3 or + 4 bytes. In PHP 5.0.0 and 5.0.1, the default output charset is + ISO-8859-1, while in PHP 5.0.2 and upper is UTF-8. The supported + encodings are ISO-8859-1, UTF-8 and + US-ASCII. + + + + + + + &reftitle.returnvalues; + + Returns a resource handle for the new XML parser. + + + + + &reftitle.seealso; + + + xml_parser_create_ns + xml_parser_free + + + + + xml_parser_free Free an XML parser - - Description + + + &reftitle.description; boolxml_parser_free resourceparser @@ -15,6 +16,7 @@ Frees the given XML parser. + &reftitle.parameters; @@ -30,6 +32,7 @@ + &reftitle.returnvalues; @@ -37,6 +40,7 @@ refer to a valid parser, or else it frees the parser and returns &true;. + + xml_parser_get_option Get options from an XML parser - - Description + + + &reftitle.description; mixedxml_parser_get_option resourceparser @@ -16,6 +17,7 @@ Gets an option value from an XML parser. + &reftitle.parameters; @@ -41,6 +43,7 @@ + &reftitle.returnvalues; @@ -50,6 +53,7 @@ Else the option's value is returned. + + xml_parser_set_option Set options in an XML parser - - Description + + + &reftitle.description; boolxml_parser_set_option resourceparser intoption mixedvalue + + Sets an option in an XML parser. + + + + + &reftitle.parameters; parser - + A reference to the XML parser to set an option in. - + option - + Which option to set. See below. - + + + The following options are available: + + XML parser options + + + + Option constant + Data type + Description + + + + + XML_OPTION_CASE_FOLDING + integer + + Controls whether case-folding is enabled for this + XML parser. Enabled by default. + + + + XML_OPTION_SKIP_TAGSTART + integer + + Specify how many characters should be skipped in the beginning of a + tag name. + + + + XML_OPTION_SKIP_WHITE + integer + + Whether to skip values consisting of whitespace characters. + + + + XML_OPTION_TARGET_ENCODING + string + + Sets which target encoding to + use in this XML parser.By default, it is set to the same as the + source encoding used by xml_parser_create. + Supported target encodings are ISO-8859-1, + US-ASCII and UTF-8. + + + + +
+ value - - The option's new value. - + + The option's new value. + + + + + &reftitle.returnvalues; This function returns &false; if parser does not refer to a valid parser, or if the option could not be set. Else the option is set and &true; is returned. - - The following options are available: - - XML parser options - - - - Option constant - Data type - Description - - - - - XML_OPTION_CASE_FOLDING - integer - - Controls whether case-folding is enabled for this - XML parser. Enabled by default. - - - - XML_OPTION_SKIP_TAGSTART - integer - - Specify how many characters should be skipped in the beginning of a - tag name. - - - - XML_OPTION_SKIP_WHITE - integer - - Whether to skip values consisting of whitespace characters. - - - - XML_OPTION_TARGET_ENCODING - string - - Sets which target encoding to - use in this XML parser.By default, it is set to the same as the - source encoding used by xml_parser_create. - Supported target encodings are ISO-8859-1, - US-ASCII and UTF-8. - - - - -
- + + xml_set_character_data_handler Set up character data handler - - Description + + + &reftitle.description; boolxml_set_character_data_handler resourceparser @@ -14,49 +15,76 @@ Sets the character data 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. + + + + &reftitle.parameters; - The function named by handler must accept - two parameters: - - handler - resourceparser - stringdata - parser - - The first parameter, parser, is a - reference to the XML parser calling the handler. - + + - data + handler - - The second parameter, data, contains - the character data as a string. - + + handler is a string containing the name of a + function that must exist when xml_parse is called + for parser. + + + The function named by handler must accept + two parameters: + + handler + resourceparser + stringdata + + + + parser + + + The first parameter, parser, is a + reference to the XML parser calling the handler. + + + + + data + + + The second parameter, data, contains + the character data as a string. + + + + + + + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + + ¬e.func-callback; - - - 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. - - ¬e.func-callback; + + + &reftitle.returnvalues; + + &return.success; + + + + xml_set_default_handler Set up default handler - - Description + + + &reftitle.description; boolxml_set_default_handler resourceparser @@ -14,56 +15,82 @@ Sets the default 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. + + + + &reftitle.parameters; - The function named by handler must accept - two parameters: - - handler - resourceparser - stringdata - - - parser - + parser - - The first parameter, parser, is a - reference to the XML parser calling the handler. - + + - - data - + handler - - The second parameter, data, contains - the character data.This may be the XML declaration, - document type declaration, entities or other data for which - no other handler exists. - + + handler is a string containing the name of a + function that must exist when xml_parse is called + for parser. + + + The function named by handler must accept + two parameters: + + handler + resourceparser + stringdata + + + + + parser + + + + The first parameter, parser, is a + reference to the XML parser calling the handler. + + + + + + data + + + + The second parameter, data, contains + the character data.This may be the XML declaration, + document type declaration, entities or other data for which + no other handler exists. + + + + + + + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + + ¬e.func-callback; - - 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. - - ¬e.func-callback; + + + &reftitle.returnvalues; + + &return.success; + + + + xml_set_element_handler Set up start and end element handlers - - Description + + + &reftitle.description; boolxml_set_element_handler resourceparser @@ -14,107 +15,134 @@ callbackend_element_handler - Sets the element handler functions for the XML parser - parser. + Sets the element handler functions for the XML parser. start_element_handler and end_element_handler are strings containing - the names of functions that must exist when - xml_parse is called for - parser. + the names of functions that must exist when xml_parse + is called for parser. - - The function named by start_element_handler - must accept three parameters: - - start_element_handler - resourceparser - stringname - arrayattribs - - - - parser - - - The first parameter, parser, is a - reference to the XML parser calling the handler. - - - - - name - - - The second parameter, name, contains the name - of the element for which this handler is called.If case-folding is in effect for this - parser, the element name will be in uppercase letters. - - - - - attribs - - - The third parameter, attribs, contains an - associative array with the element's attributes (if any).The keys - of this array are the attribute names, the values are the attribute - values.Attribute names are case-folded on the same criteria as - element names.Attribute values are not - case-folded. - - - The original order of the attributes can be retrieved by walking - through attribs the normal way, using - each.The first key in the array was the first - attribute, and so on. - - - - - - - The function named by end_element_handler - must accept two parameters: - - end_element_handler - resourceparser - stringname - - - - parser - - - The first parameter, parser, is a - reference to the XML parser calling the handler. - - - - - name - - - The second parameter, name, contains the name - of the element for which this handler is called.If case-folding is in effect for this - parser, the element name will be in uppercase letters. - - - - - - - If a handler function is set to an empty string, or &false;, the handler - in question is disabled. - - - &true; is returned if the handlers are set up, &false; if - parser is not a parser. - - ¬e.func-callback; + + + &reftitle.parameters; + + + + parser + + + + + + + start_element_handler + + + The function named by start_element_handler + must accept three parameters: + + start_element_handler + resourceparser + stringname + arrayattribs + + + + parser + + + The first parameter, parser, is a + reference to the XML parser calling the handler. + + + + + name + + + The second parameter, name, contains the name + of the element for which this handler is called.If case-folding is in effect for this + parser, the element name will be in uppercase letters. + + + + + attribs + + + The third parameter, attribs, contains an + associative array with the element's attributes (if any).The keys + of this array are the attribute names, the values are the attribute + values.Attribute names are case-folded on the same criteria as + element names.Attribute values are not + case-folded. + + + The original order of the attributes can be retrieved by walking + through attribs the normal way, using + each.The first key in the array was the first + attribute, and so on. + + + + + + ¬e.func-callback; + + + + end_element_handler + + + The function named by end_element_handler + must accept two parameters: + + end_element_handler + resourceparser + stringname + + + + parser + + + The first parameter, parser, is a + reference to the XML parser calling the handler. + + + + + name + + + The second parameter, name, contains the name + of the element for which this handler is called.If case-folding is in effect for this + parser, the element name will be in uppercase letters. + + + + + + + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + xml_set_end_namespace_decl_handler Set up end namespace declaration handler - - Description + + + &reftitle.description; boolxml_set_end_namespace_decl_handler resourceparser @@ -15,6 +16,14 @@ &warn.undocumented.func; ¬e.func-callback; + + + &reftitle.returnvalues; + + &return.success; + + + + xml_set_external_entity_ref_handler Set up external entity reference handler - - Description + + + &reftitle.description; boolxml_set_external_entity_ref_handler resourceparser @@ -14,90 +15,116 @@ Sets the external entity reference 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. + + + + &reftitle.parameters; - The function named by handler must accept - five parameters, and should return an integer value.If the - value returned from the handler is &false; (which it will be if no - value is returned), the XML parser will stop parsing and - xml_get_error_code will return XML_ERROR_EXTERNAL_ENTITY_HANDLING. - - handler - resourceparser - stringopen_entity_names - stringbase - stringsystem_id - stringpublic_id - parser - - The first parameter, parser, is a - reference to the XML parser calling the handler. - + + - open_entity_names + handler - - The second parameter, open_entity_names, is a - space-separated list of the names of the entities that are open for - the parse of this entity (including the name of the referenced - entity). - - - - - base - - - This is the base for resolving the system identifier - (system_id) of the external entity.Currently - this parameter will always be set to an empty string. - - - - - system_id - - - The fourth parameter, system_id, is the - system identifier as specified in the entity declaration. - - - - - public_id - - - The fifth parameter, public_id, is the - public identifier as specified in the entity declaration, or - an empty string if none was specified; the whitespace in the - public identifier will have been normalized as required by - the XML spec. - + + handler is a string containing the name of a + function that must exist when xml_parse is called + for parser. + + + The function named by handler must accept + five parameters, and should return an integer value.If the + value returned from the handler is &false; (which it will be if no + value is returned), the XML parser will stop parsing and + xml_get_error_code will return XML_ERROR_EXTERNAL_ENTITY_HANDLING. + + handler + resourceparser + stringopen_entity_names + stringbase + stringsystem_id + stringpublic_id + + + + parser + + + The first parameter, parser, is a + reference to the XML parser calling the handler. + + + + + open_entity_names + + + The second parameter, open_entity_names, is a + space-separated list of the names of the entities that are open for + the parse of this entity (including the name of the referenced + entity). + + + + + base + + + This is the base for resolving the system identifier + (system_id) of the external entity.Currently + this parameter will always be set to an empty string. + + + + + system_id + + + The fourth parameter, system_id, is the + system identifier as specified in the entity declaration. + + + + + public_id + + + The fifth parameter, public_id, is the + public identifier as specified in the entity declaration, or + an empty string if none was specified; the whitespace in the + public identifier will have been normalized as required by + the XML spec. + + + + + + + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + + ¬e.func-callback; - - 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. - - ¬e.func-callback; + + + &reftitle.returnvalues; + + &return.success; + + + + xml_set_notation_decl_handler Set up notation declaration handler - - Description + + + &reftitle.description; boolxml_set_notation_decl_handler resourceparser @@ -14,9 +15,6 @@ Sets the notation 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. @@ -31,80 +29,109 @@ See section 4.7 of the XML 1.0 spec for the definition of notation declarations. + + + + &reftitle.parameters; - The function named by handler must accept - five parameters: - - handler - resourceparser - stringnotation_name - stringbase - stringsystem_id - stringpublic_id - - - parser - + parser - - The first parameter, parser, is a - reference to the XML parser calling the handler. - + + - notation_name + handler - - This is the notation's name, as per - the notation format described above. - - - - - - base - - - - This is the base for resolving the system identifier - (system_id) of the notation declaration. - Currently this parameter will always be set to an empty string. - - - - - system_id - - - System identifier of the external notation declaration. - - - - - - public_id - - - - Public identifier of the external notation declaration. - + + handler is a string containing the name of a + function that must exist when xml_parse is called + for parser. + + + The function named by handler must accept + five parameters: + + handler + resourceparser + stringnotation_name + stringbase + stringsystem_id + stringpublic_id + + + + + parser + + + + The first parameter, parser, is a + reference to the XML parser calling the handler. + + + + + notation_name + + + This is the notation's name, as per + the notation format described above. + + + + + + base + + + + This is the base for resolving the system identifier + (system_id) of the notation declaration. + Currently this parameter will always be set to an empty string. + + + + + system_id + + + System identifier of the external notation declaration. + + + + + + public_id + + + + Public identifier of the external notation declaration. + + + + + + + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + + ¬e.func-callback; - - 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. - - ¬e.func-callback; + + + &reftitle.returnvalues; + + &return.success; + + + + xml_set_object Use XML Parser within an object - - Description + + + &reftitle.description; boolxml_set_object resourceparser @@ -18,6 +19,39 @@ xml_set_element_handler etc and assumed to be methods of object. + + + + &reftitle.parameters; + + + + parser + + + + + + + object + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.examples; <function>xml_set_object</function> example @@ -66,6 +100,7 @@ $xml_parser->parse("PHP"); + + xml_set_processing_instruction_handler @@ -7,8 +7,9 @@ Set up processing instruction (PI) handler - - Description + + + &reftitle.description; boolxml_set_processing_instruction_handler resourceparser @@ -16,9 +17,6 @@ Sets the processing instruction (PI) 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. @@ -34,55 +32,84 @@ with PIs in XML documents.If it does, the rest of the PHP code, as well as the "real" PI end tag, will be treated as character data. + + + + &reftitle.parameters; - The function named by handler must accept - three parameters: - - handler - resourceparser - stringtarget - stringdata - parser - - The first parameter, parser, is a - reference to the XML parser calling the handler. - + + - target + handler - - The second parameter, target, contains the PI - target. - - - - - data - - - The third parameter, data, contains the PI - data. - + + handler is a string containing the name of a + function that must exist when xml_parse is called + for parser. + + + The function named by handler must accept + three parameters: + + handler + resourceparser + stringtarget + stringdata + + + + parser + + + The first parameter, parser, is a + reference to the XML parser calling the handler. + + + + + target + + + The second parameter, target, contains the PI + target. + + + + + data + + + The third parameter, data, contains the PI + data. + + + + + + + If a handler function is set to an empty string, or &false;, the handler + in question is disabled. + + ¬e.func-callback; - - 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. - - ¬e.func-callback; + + + &reftitle.returnvalues; + + &return.success; + + + - + xml_set_start_namespace_decl_handler @@ -8,8 +7,9 @@ Set up start namespace declaration handler - - Description + + + &reftitle.description; boolxml_set_start_namespace_decl_handler resourceparser @@ -18,6 +18,14 @@ &warn.undocumented.func; ¬e.func-callback; + + + &reftitle.returnvalues; + + &return.success; + + + + xml_set_unparsed_entity_decl_handler @@ -7,8 +7,9 @@ Set up unparsed entity declaration handler - - Description + + + &reftitle.description; boolxml_set_unparsed_entity_decl_handler resourceparser @@ -16,15 +17,12 @@ 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: + The handler will be called if the XML parser + encounters an external entity declaration with an NDATA declaration, like + the following: name {publicId | systemId} @@ -37,84 +35,113 @@ the XML 1.0 spec for the definition of notation declared external entities. + + + + &reftitle.parameters; - The function named by handler must accept six - parameters: - - handler - resourceparser - stringentity_name - stringbase - stringsystem_id - stringpublic_id - stringnotation_name - parser - - The first parameter, parser, is a - reference to the XML parser calling the - handler. - + + - entity_name + handler - - 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). - + + handler is a string containing the name of a + function that must exist when xml_parse is called + for parser. + + + The function named by handler must accept six + parameters: + + handler + resourceparser + stringentity_name + stringbase + stringsystem_id + stringpublic_id + stringnotation_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. + + ¬e.func-callback; - - 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. - - ¬e.func-callback; + + + &reftitle.returnvalues; + + &return.success; + + +