* 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. *
* @param string $separator [optional]* 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 separator. *
* @return resource|false|XMLParser a resource handle for the new XML parser. */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] function xml_parser_create_ns(?string $encoding, string $separator = ':') {} /** * Use XML Parser within an object * @link https://php.net/manual/en/function.xml-set-object.php * @param XMLParser|resource $parser* A reference to the XML parser to use inside the object. *
* @param object $object* The object where to use the XML parser. *
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_object(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, object $object) {} /** * Set up start and end element handlers * @link https://php.net/manual/en/function.xml-set-element-handler.php * @param XMLParser|resource $parser* A reference to the XML parser to set up start and end element handler functions. *
* @param callable $start_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.
* @param callable $end_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.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_element_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $start_handler, $end_handler) {} /** * Set up character data handler * @link https://php.net/manual/en/function.xml-set-character-data-handler.php * @param XMLParser|resource $parser* A reference to the XML parser to set up character data handler function. *
* @param callable $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 * two parameters: * handler * resourceparser * stringdata * parser * The first parameter, parser, is a * reference to the XML parser calling the handler.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_character_data_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $handler) {} /** * Set up processing instruction (PI) handler * @link https://php.net/manual/en/function.xml-set-processing-instruction-handler.php * @param XMLParser|resource $parser* A reference to the XML parser to set up processing instruction (PI) handler function. *
* @param callable $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 * three parameters: * handler * resourceparser * stringtarget * stringdata * parser * The first parameter, parser, is a * reference to the XML parser calling the handler.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_processing_instruction_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $handler) {} /** * Set up default handler * @link https://php.net/manual/en/function.xml-set-default-handler.php * @param XMLParser|resource $parser* A reference to the XML parser to set up default handler function. *
* @param callable $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 * two parameters: * handler * resourceparser * stringdata * parser * The first parameter, parser, is a * reference to the XML parser calling the handler.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_default_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $handler) {} /** * Set up unparsed entity declaration handler * @link https://php.net/manual/en/function.xml-set-unparsed-entity-decl-handler.php * @param XMLParser|resource $parser* A reference to the XML parser to set up unparsed entity declaration handler function. *
* @param callable $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.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_unparsed_entity_decl_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $handler) {} /** * Set up notation declaration handler * @link https://php.net/manual/en/function.xml-set-notation-decl-handler.php * @param XMLParser|resource $parser* A reference to the XML parser to set up notation declaration handler function. *
* @param callable $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 * 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.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_notation_decl_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $handler) {} /** * Set up external entity reference handler * @link https://php.net/manual/en/function.xml-set-external-entity-ref-handler.php * @param XMLParser|resource $parser* A reference to the XML parser to set up external entity reference handler function. *
* @param callable $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 * 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.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_external_entity_ref_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $handler) {} /** * Set up start namespace declaration handler * @link https://php.net/manual/en/function.xml-set-start-namespace-decl-handler.php * @param XMLParser|resource $parser* A reference to the XML parser. *
* @param callable $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 * three 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 * stringprefix * stringuri * parser * The first parameter, parser, is a * reference to the XML parser calling the handler.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_start_namespace_decl_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $handler) {} /** * Set up end namespace declaration handler * @link https://php.net/manual/en/function.xml-set-end-namespace-decl-handler.php * @param XMLParser|resource $parser* A reference to the XML parser. *
* @param callable $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 * two 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 * stringprefix * parser * The first parameter, parser, is a * reference to the XML parser calling the handler.
* @return bool TRUE on success or FALSE on failure. */ #[LanguageLevelTypeAware(["8.2" => "true"], default: "bool")] function xml_set_end_namespace_decl_handler(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, $handler) {} /** * Start parsing an XML document * @link https://php.net/manual/en/function.xml-parse.php * @param XMLParser|resource $parser* A reference to the XML parser to use. *
* @param string $data* Chunk of data to parse. A document may be parsed piece-wise by * calling xml_parse several times with new data, * as long as the is_final parameter is set and * TRUE when the last data is parsed. *
* @param bool $is_final [optional]* If set and TRUE, data is the last piece of * data sent in this parse. *
* @return int 1 on success or 0 on failure. ** For unsuccessful parses, error information can be retrieved with * xml_get_error_code, * xml_error_string, * xml_get_current_line_number, * xml_get_current_column_number and * xml_get_current_byte_index. *
** Entity errors are reported at the end of the data thus only if * is_final is set and TRUE. *
*/ function xml_parse(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, string $data, bool $is_final = false): int {} /** * Parse XML data into an array structure * @link https://php.net/manual/en/function.xml-parse-into-struct.php * @param XMLParser|resource $parser* A reference to the XML parser. *
* @param string $data* A string containing the XML data. *
* @param array &$values* An array containing the values of the XML data *
* @param array &$index [optional]* An array containing pointers to the location of the appropriate values in the $values. *
* @return int 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 ===. */ function xml_parse_into_struct(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, string $data, &$values, &$index): int {} /** * Get XML parser error code * @link https://php.net/manual/en/function.xml-get-error-code.php * @param XMLParser|resource $parser* A reference to the XML parser to get error code from. *
* @return int|false Returns one of the error codes listed in the error codes * section. */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")] function xml_get_error_code(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser) {} /** * Get XML parser error string * @link https://php.net/manual/en/function.xml-error-string.php * @param int $error_code* An error code from xml_get_error_code. *
* @return string|null a string with a textual description of the error * code, or FALSE if no description was found. */ #[Pure] function xml_error_string(int $error_code): ?string {} /** * Get current line number for an XML parser * @link https://php.net/manual/en/function.xml-get-current-line-number.php * @param XMLParser|resource $parser* A reference to the XML parser to get line number from. *
* @return int|false This function returns FALSE if parser does * not refer to a valid parser, or else it returns which line the * parser is currently at in its data buffer. */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")] function xml_get_current_line_number(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser) {} /** * Get current column number for an XML parser * @link https://php.net/manual/en/function.xml-get-current-column-number.php * @param XMLParser|resource $parser* A reference to the XML parser to get column number from. *
* @return int|false This function returns FALSE if parser does * not refer to a valid parser, or else it returns which column on * the current line (as given by * xml_get_current_line_number) the parser is * currently at. */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")] function xml_get_current_column_number(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser) {} /** * Get current byte index for an XML parser * @link https://php.net/manual/en/function.xml-get-current-byte-index.php * @param XMLParser|resource $parser* A reference to the XML parser to get byte index from. *
* @return int|false This function returns FALSE if parser does * not refer to a valid parser, or else it returns which byte index * the parser is currently at in its data buffer (starting at 0). */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")] function xml_get_current_byte_index(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser) {} /** * Free an XML parser * @link https://php.net/manual/en/function.xml-parser-free.php * @param XMLParser|resource $parser A reference to the XML parser to free. * @return bool This function returns FALSE if parser does not * refer to a valid parser, or else it frees the parser and returns TRUE. */ function xml_parser_free(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser): bool {} /** * Set options in an XML parser * @link https://php.net/manual/en/function.xml-parser-set-option.php * @param XMLParser|resource $parser* A reference to the XML parser to set an option in. *
* @param int $option* Which option to set. See below. *
** The following options are available: *
| 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. * | *
* The option's new value. *
* @return bool 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. */ function xml_parser_set_option(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, int $option, $value): bool {} /** * Get options from an XML parser * @link https://php.net/manual/en/function.xml-parser-get-option.php * @param XMLParser|resource $parser A reference to the XML parser to get an option from. * @param int $option Which option to fetch. XML_OPTION_CASE_FOLDING * and XML_OPTION_TARGET_ENCODING are available. * See xml_parser_set_option for their description. * @return string|int This function returns FALSE if parser does * not refer to a valid parser or if option isn't * valid (generates also a E_WARNING). * Else the option's value is returned. */ #[Pure] function xml_parser_get_option(#[LanguageLevelTypeAware(["8.0" => "XMLParser"], default: "resource")] $parser, int $option): string|int {} define('XML_ERROR_NONE', 0); define('XML_ERROR_NO_MEMORY', 1); define('XML_ERROR_SYNTAX', 2); define('XML_ERROR_NO_ELEMENTS', 3); define('XML_ERROR_INVALID_TOKEN', 4); define('XML_ERROR_UNCLOSED_TOKEN', 5); define('XML_ERROR_PARTIAL_CHAR', 6); define('XML_ERROR_TAG_MISMATCH', 7); define('XML_ERROR_DUPLICATE_ATTRIBUTE', 8); define('XML_ERROR_JUNK_AFTER_DOC_ELEMENT', 9); define('XML_ERROR_PARAM_ENTITY_REF', 10); define('XML_ERROR_UNDEFINED_ENTITY', 11); define('XML_ERROR_RECURSIVE_ENTITY_REF', 12); define('XML_ERROR_ASYNC_ENTITY', 13); define('XML_ERROR_BAD_CHAR_REF', 14); define('XML_ERROR_BINARY_ENTITY_REF', 15); define('XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF', 16); define('XML_ERROR_MISPLACED_XML_PI', 17); define('XML_ERROR_UNKNOWN_ENCODING', 18); define('XML_ERROR_INCORRECT_ENCODING', 19); define('XML_ERROR_UNCLOSED_CDATA_SECTION', 20); define('XML_ERROR_EXTERNAL_ENTITY_HANDLING', 21); define('XML_OPTION_CASE_FOLDING', 1); define('XML_OPTION_TARGET_ENCODING', 2); define('XML_OPTION_SKIP_TAGSTART', 3); define('XML_OPTION_SKIP_WHITE', 4); /** * Holds the SAX implementation method. * Can be libxml or expat. * @link https://php.net/manual/en/xml.constants.php */ define('XML_SAX_IMPL', "libxml"); /** * @since 8.0 */ final class XMLParser {} // End of xml v.