Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xml::easy::content(3pm) [debian man page]

XML::Easy::Content(3pm) 				User Contributed Perl Documentation				   XML::Easy::Content(3pm)

NAME

       XML::Easy::Content - abstract form of XML content

SYNOPSIS

	       use XML::Easy::Content;

	       $content = XML::Easy::Content->new([
		       "foo",
		       $subelement,
		       "bar",
	       ]);

	       $twine = $content->twine;

DESCRIPTION

       An object of this class represents a chunk of XML content, the kind of matter that can be contained within an XML element.  This is in an
       abstract form, intended for general manipulation.  It is completely isolated from the textual representation of XML, and holds only the
       meaningful content of the chunk.  The data in a content object cannot be modified: different data requires the creation of a new object.

       An XML content chunk consists of a sequence of zero or more characters and XML elements, interspersed in any fashion.  Character content
       can use almost all Unicode characters, with only a few characters (such as most of the ASCII control characters) prohibited by the
       specification from being directly represented in XML.  Each XML element in a content chunk itself recursively contains a chunk of content,
       in addition to having attached metadata.

       This class is not meant to be subclassed.  XML content is unextendable, dumb data.  Content objects are better processed using the
       functions in XML::Easy::NodeBasics than using the methods of this class.

CONSTRUCTOR

       XML::Easy::Content->new(TWINE)
	   Constructs and returns a new content chunk object with the specified content.  TWINE must be a reference to an array listing the
	   chunk's content in twine form (see "Twine" in XML::Easy::NodeBasics).  The content is checked for validity, against the XML 1.0
	   specification, and the function "die"s if it is invalid.

METHODS

       $content->twine
	   Returns a reference to an array listing the chunk's content in twine form (see "Twine" in XML::Easy::NodeBasics).

	   The returned array must not be subsequently modified.  If possible, it will be marked as read-only in order to prevent modification.

       $content->content
	   Deprecated alias for the "twine" method.

SEE ALSO

       XML::Easy::Element, XML::Easy::NodeBasics

AUTHOR

       Andrew Main (Zefram) <zefram@fysh.org>

COPYRIGHT

       Copyright (C) 2008, 2009 PhotoBox Ltd

       Copyright (C) 2009, 2010, 2011 Andrew Main (Zefram) <zefram@fysh.org>

LICENSE

       This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-11-16						   XML::Easy::Content(3pm)

Check Out this Related Man Page

XML::DOM::Text(3)					User Contributed Perl Documentation					 XML::DOM::Text(3)

NAME

       XML::DOM::Text - A piece of XML text in XML::DOM

DESCRIPTION

       XML::DOM::Text extends XML::DOM::CharacterData, which extends XML::DOM::Node.

       The Text interface represents the textual content (termed character data in XML) of an Element or Attr. If there is no markup inside an
       element's content, the text is contained in a single object implementing the Text interface that is the only child of the element.  If
       there is markup, it is parsed into a list of elements and Text nodes that form the list of children of the element.

       When a document is first made available via the DOM, there is only one Text node for each block of text. Users may create adjacent Text
       nodes that represent the contents of a given element without any intervening markup, but should be aware that there is no way to represent
       the separations between these nodes in XML or HTML, so they will not (in general) persist between DOM editing sessions. The normalize()
       method on Element merges any such adjacent Text objects into a single node for each block of text; this is recommended before employing
       operations that depend on a particular document structure, such as navigation with XPointers.

   METHODS
       splitText (offset)
	   Breaks this Text node into two Text nodes at the specified offset, keeping both in the tree as siblings. This node then only contains
	   all the content up to the offset point. And a new Text node, which is inserted as the next sibling of this node, contains all the
	   content at and after the offset point.

	   Parameters:
	    offset  The offset at which to split, starting from 0.

	   Return Value: The new Text node.

	   DOMExceptions:

	   o   INDEX_SIZE_ERR

	       Raised if the specified offset is negative or greater than the number of characters in data.

	   o   NO_MODIFICATION_ALLOWED_ERR

	       Raised if this node is readonly.

perl v5.16.3							    2000-01-31							 XML::DOM::Text(3)
Man Page