local-lib5/man/man3/XML::LibXML::Namespace.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "XML::LibXML::Namespace 3"
 127 .TH XML::LibXML::Namespace 3 "2009-10-07" "perl v5.8.7" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 XML::LibXML::Namespace \- XML::LibXML Namespace Implementation
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 3
 137 \&  use XML::LibXML;
 138 \&  # Only methods specific to Namespace nodes are listed here,
 139 \&  # see XML::LibXML::Node manpage for other methods
 140 \&
 141 \&  my $ns = XML::LibXML::Namespace\->new($nsURI);
 142 \&  print $ns\->nodeName();
 143 \&  print $ns\->name();
 144 \&  $localname = $ns\->getLocalName();
 145 \&  print $ns\->getData();
 146 \&  print $ns\->getValue();
 147 \&  print $ns\->value();
 148 \&  $known_uri = $ns\->getNamespaceURI();
 149 \&  $known_prefix = $ns\->getPrefix();
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 Namespace nodes are returned by both \f(CW$element\fR\->findnodes('namespace::foo') or
 154 by \f(CW$node\fR\->\fIgetNamespaces()\fR.
 155 .PP
 156 The namespace node \s-1API\s0 is not part of any current \s-1DOM\s0 \s-1API\s0, and so it is quite
 157 minimal. It should be noted that namespace nodes are \fInot\fR a sub class of XML::LibXML::Node, however Namespace nodes act a lot like attribute nodes, and similarly named
 158 methods will return what you would expect if you treated the namespace node as
 159 an attribute. Note that in order to fix several inconsistencies between the \s-1API\s0
 160 and the documentation, the behavior of some functions have been changed in
 161 1.64.
 162 .SH "METHODS"
 163 .IX Header "METHODS"
 164 .IP "new" 4
 165 .IX Item "new"
 166 .Vb 1
 167 \&  my $ns = XML::LibXML::Namespace\->new($nsURI);
 168 .Ve
 169 .Sp
 170 Creates a new Namespace node. Note that this is not a 'node' as an attribute or
 171 an element node. Therefore you can't do call all XML::LibXML::Node Functions. All functions available for this node are listed below.
 172 .Sp
 173 Optionally you can pass the prefix to the namespace constructor. If this second
 174 parameter is omitted you will create a so called default namespace. Note, the
 175 newly created namespace is not bound to any document or node, therefore you
 176 should not expect it to be available in an existing document.
 177 .IP "declaredURI" 4
 178 .IX Item "declaredURI"
 179 Returns the \s-1URI\s0 for this namespace.
 180 .IP "declaredPrefix" 4
 181 .IX Item "declaredPrefix"
 182 Returns the prefix for this namespace.
 183 .IP "nodeName" 4
 184 .IX Item "nodeName"
 185 .Vb 1
 186 \&  print $ns\->nodeName();
 187 .Ve
 188 .Sp
 189 Returns \*(L"xmlns:prefix\*(R", where prefix is the prefix for this namespace.
 190 .IP "name" 4
 191 .IX Item "name"
 192 .Vb 1
 193 \&  print $ns\->name();
 194 .Ve
 195 .Sp
 196 Alias for \fInodeName()\fR
 197 .IP "getLocalName" 4
 198 .IX Item "getLocalName"
 199 .Vb 1
 200 \&  $localname = $ns\->getLocalName();
 201 .Ve
 202 .Sp
 203 Returns the local name of this node as if it were an attribute, that is, the
 204 prefix associated with the namespace.
 205 .IP "getData" 4
 206 .IX Item "getData"
 207 .Vb 1
 208 \&  print $ns\->getData();
 209 .Ve
 210 .Sp
 211 Returns the \s-1URI\s0 of the namespace, i.e. the value of this node as if it were an
 212 attribute.
 213 .IP "getValue" 4
 214 .IX Item "getValue"
 215 .Vb 1
 216 \&  print $ns\->getValue();
 217 .Ve
 218 .Sp
 219 Alias for \fIgetData()\fR
 220 .IP "value" 4
 221 .IX Item "value"
 222 .Vb 1
 223 \&  print $ns\->value();
 224 .Ve
 225 .Sp
 226 Alias for \fIgetData()\fR
 227 .IP "getNamespaceURI" 4
 228 .IX Item "getNamespaceURI"
 229 .Vb 1
 230 \&  $known_uri = $ns\->getNamespaceURI();
 231 .Ve
 232 .Sp
 233 Returns the string \*(L"http://www.w3.org/2000/xmlns/\*(R"
 234 .IP "getPrefix" 4
 235 .IX Item "getPrefix"
 236 .Vb 1
 237 \&  $known_prefix = $ns\->getPrefix();
 238 .Ve
 239 .Sp
 240 Returns the string \*(L"xmlns\*(R"
 241 .SH "AUTHORS"
 242 .IX Header "AUTHORS"
 243 Matt Sergeant,
 244 Christian Glahn,
 245 Petr Pajas
 246 .SH "VERSION"
 247 .IX Header "VERSION"
 248 1.70
 249 .SH "COPYRIGHT"
 250 .IX Header "COPYRIGHT"
 251 2001\-2007, AxKit.com Ltd.
 252 .PP
 253 2002\-2006, Christian Glahn.
 254 .PP
 255 2006\-2009, Petr Pajas.