Section: User Contributed Perl Documentation (3pm)
Updated: 2014-04-12
Index?action=index Return to Main Contents
XML::LibXML::Text - XML::LibXML Class for Text Nodes
use XML::LibXML; # Only methods specific to Text nodes are listed here, # see XML::LibXML::Node manpage for other methods $text = XML::LibXML::Text->new( $content ); $nodedata = $text->data; $text->setData( $text_content ); $text->substringData($offset, $length); $text->appendData( $somedata ); $text->insertData($offset, $string); $text->deleteData($offset, $length); $text->deleteDataString($remstring, $all); $text->replaceData($offset, $length, $string); $text->replaceDataString($old, $new, $flag); $text->replaceDataRegEx( $search_cond, $replace_cond, $reflags );
Unlike the DOM specification, XML::LibXML implements the text node as the base class of all character data node. Therefore there exists no CharacterData class. This allows one to apply methods of text nodes also to Comments and CDATA-sections.
The class inherits from XML::LibXML::Node. The documentation for Inherited methods is not listed here.
Many functions listed here are extensively documented in the DOM Level 3 specification (<http://www.w3.org/TR/DOM-Level-3-Core/>). Please refer to the specification for extensive documentation.
$text = XML::LibXML::Text->new( $content );
The constructor of the class. It creates an unbound text node.
:
$nodedata = $text->data;
"nodeValue"attribute in the Node class, the DOM specification defines data as a separate attribute.
"XML::LibXML"implements these two attributes not as different attributes, but as aliases, such as
"libxml2"does. Therefore
$text->data;
and
$text->nodeValue;
will have the same result and are not different entities.
:
$text->setData( $text_content );
This function sets or replaces text content to a node. The node has to be of the type ``text, ``cdata or ``comment''.
:
$text->substringData($offset, $length);
$offsetand
$lengthand returns the sub-string, if available. If the node contains no data or
$offsetrefers to an non-existing string index, this function will return undef. If
$lengthis out of range
"substringData"will return the data starting at
$offsetinstead of causing an error.
:
$text->appendData( $somedata );
"setData".
:
$text->insertData($offset, $string);
$stringat the given
$offsetof the existing data of the node. This operation will not remove existing data, but change the order of the existing data. The
$offsethas to be a positive value. If
$offsetis out of range,
"insertData"will have the same behaviour as
"appendData".
:
$text->deleteData($offset, $length);
$lengthparameter tells, how many characters should be removed from the string.
:
$text->deleteDataString($remstring, $all);
"which"string to remove from a text node, this method allows more perlish code :) The functions takes two parameters: $string and optional the $all flag. If
$allis not set, undef or 0,
"deleteDataString"will remove only the first occurrence of
$string. If
$allis TRUE
"deleteDataString"will remove all occurrences of $string from the node data.
:
$text->replaceData($offset, $length, $string);
The DOM style version to replace node data.
:
$text->replaceDataString($old, $new, $flag);
The more programmer friendly version of replaceData() :)
Instead of giving offsets and length one can specify the exact string ($oldstring) to be replaced. Additionally the $all flag allows one to replace all occurrences of $oldstring.
:
$text->replaceDataRegEx( $search_cond, $replace_cond, $reflags );
"simple"regular expression. Optional, this function allows one to pass some flags that will be added as flag to the replace statement.
NOTE: This is a shortcut for
my $datastr = $node->getData(); $datastr =~ s/somecond/replacement/g; # 'g' is just an example for any flag $node->setData( $datastr );
This function can make things easier to read for simple replacements. For more complex variants it is recommended to use the code snippet above.
:
Matt Sergeant, Christian Glahn, Petr Pajas
2001-2007, AxKit.com Ltd.
2002-2006, Christian Glahn.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Menu
Tutoriais de Tecnologia Web
Áreas
Blogs
Sites Sociais