.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "XML::Easy::Element 3pm" .TH XML::Easy::Element 3pm "2011-11-16" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" XML::Easy::Element \- abstract form of XML element .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use XML::Easy::Element; \& \& $element = XML::Easy::Element\->new("a", \& { href => "#there" }, $content); \& \& $type_name = $element\->type_name; \& $attributes = $element\->attributes; \& $href = $element\->attribute("href"); \& $content = $element\->content_object; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" An object of this class represents an \s-1XML\s0 element, a node in the tree making up an \s-1XML\s0 document. This is in an abstract form, intended for general manipulation. It is completely isolated from the textual representation of \s-1XML\s0, and holds only the meaningful content of the element. The data in an element object cannot be modified: different data requires the creation of a new object. .PP The properties of an \s-1XML\s0 element are of three kinds. Firstly, the element has exactly one type, which is referred to by a name. Secondly, the element has a set of zero or more attributes. Each attribute consists of a name, which is unique among the attributes of the element, and a value, which is a string of characters. Finally, the element has content, which is a sequence of zero or more characters and (recursively) elements, interspersed in any fashion. .PP The element type name and attribute names all follow the \s-1XML\s0 syntax for names. This allows the use of a wide set of Unicode characters, with some restrictions. Attribute values and character content can use almost all Unicode characters, with only a few characters (such as most of the \s-1ASCII\s0 control characters) prohibited by the specification from being directly represented in \s-1XML\s0. .PP This class is not meant to be subclassed. \s-1XML\s0 elements are unextendable, dumb data. Element objects are better processed using the functions in XML::Easy::NodeBasics than using the methods of this class. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .IP "XML::Easy::Element\->new(\s-1TYPE_NAME\s0, \s-1ATTRIBUTES\s0, \s-1CONTENT\s0)" 4 .IX Item "XML::Easy::Element->new(TYPE_NAME, ATTRIBUTES, CONTENT)" Constructs and returns a new element object with the specified properties. \&\fI\s-1TYPE_NAME\s0\fR must be a string. \fI\s-1ATTRIBUTES\s0\fR must be a reference to a hash in the same form that is returned by the accessor method \&\f(CW\*(C`attributes\*(C'\fR (below). \fI\s-1CONTENT\s0\fR must be a reference to either an XML::Easy::Content object or a twine array (see \*(L"Twine\*(R" in XML::Easy::NodeBasics). All are checked for validity, against the \s-1XML\s0 1.0 specification, and the function \f(CW\*(C`die\*(C'\fRs if any are invalid. .SH "METHODS" .IX Header "METHODS" .ie n .IP "$element\->type_name" 4 .el .IP "\f(CW$element\fR\->type_name" 4 .IX Item "$element->type_name" Returns the element type name, as a string. .ie n .IP "$element\->attributes" 4 .el .IP "\f(CW$element\fR\->attributes" 4 .IX Item "$element->attributes" Returns a reference to a hash encapsulating the element's attributes. In the hash, each key is an attribute name, and the corresponding value is the attribute's value as a string. .Sp The returned hash must not be subsequently modified. If possible, it will be marked as read-only in order to prevent modification. As a side effect, the read-only-ness may make lookup of any non-existent attribute generate an exception rather than returning \f(CW\*(C`undef\*(C'\fR. .ie n .IP "$element\->attribute(\s-1NAME\s0)" 4 .el .IP "\f(CW$element\fR\->attribute(\s-1NAME\s0)" 4 .IX Item "$element->attribute(NAME)" Looks up a specific attribute of the element. The supplied \fI\s-1NAME\s0\fR must be a string containing a valid attribute name. If there is an attribute by that name then its value is returned, as a string. If there is no such attribute then \f(CW\*(C`undef\*(C'\fR is returned. .ie n .IP "$element\->content_object" 4 .el .IP "\f(CW$element\fR\->content_object" 4 .IX Item "$element->content_object" Returns a reference to an XML::Easy::Content object encapsulating the element's content. .ie n .IP "$element\->content_twine" 4 .el .IP "\f(CW$element\fR\->content_twine" 4 .IX Item "$element->content_twine" Returns a reference to a twine array (see \*(L"Twine\*(R" in XML::Easy::NodeBasics) listing the element's content. .Sp The returned array must not be subsequently modified. If possible, it will be marked as read-only in order to prevent modification. .ie n .IP "$element\->content" 4 .el .IP "\f(CW$element\fR\->content" 4 .IX Item "$element->content" Deprecated alias for the \*(L"content_twine\*(R" method. .SH "SEE ALSO" .IX Header "SEE ALSO" XML::Easy::Content, XML::Easy::NodeBasics .SH "AUTHOR" .IX Header "AUTHOR" Andrew Main (Zefram) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2008, 2009 PhotoBox Ltd .PP Copyright (C) 2009, 2010, 2011 Andrew Main (Zefram) .SH "LICENSE" .IX Header "LICENSE" This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.