File: xml-set-start-namespace-decl-handler.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (141 lines) | stat: -rw-r--r-- 4,325 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id='function.xml-set-start-namespace-decl-handler'>
 <refnamediv>
  <refname>xml_set_start_namespace_decl_handler</refname>
  <refpurpose>
   Set up start namespace declaration handler
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xml_set_start_namespace_decl_handler</methodname>
   <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
   <methodparam><type>callback</type><parameter>handler</parameter></methodparam>
  </methodsynopsis>
  <para>
   Set a handler to be called when a namespace is declared. Namespace
   declarations occur inside start tags. But the namespace declaration start
   handler is called before the start tag handler for each namespace declared
   in that start tag.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parser</parameter></term>
     <listitem>
      <para>
       A reference to the XML parser.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>handler</parameter></term>
     <listitem>
      <para>
       <parameter>handler</parameter> is a string containing the name of a
       function that must exist when <function>xml_parse</function> is called
       for <parameter>parser</parameter>.
      </para>
      <para>
       The function named by <parameter>handler</parameter> must accept
       four 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
       <function>xml_get_error_code</function> will return
       <constant>XML_ERROR_EXTERNAL_ENTITY_HANDLING</constant>.
       <methodsynopsis>
        <methodname><replaceable>handler</replaceable></methodname>
        <methodparam><type>resource</type><parameter>parser</parameter></methodparam>
        <methodparam><type>string</type><parameter>user_data</parameter></methodparam>
        <methodparam><type>string</type><parameter>prefix</parameter></methodparam>
        <methodparam><type>string</type><parameter>uri</parameter></methodparam>
       </methodsynopsis>
       <variablelist>
        <varlistentry>
         <term><parameter>parser</parameter></term>
         <listitem>
          <simpara>
           The first parameter, <replaceable>parser</replaceable>, is a
           reference to the XML parser calling the handler.
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>user_data</parameter></term>
         <listitem>
          <simpara>
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>prefix</parameter></term>
         <listitem>
          <simpara>
          </simpara>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term><parameter>uri</parameter></term>
         <listitem>
          <simpara>
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
      <para>
       If a handler function is set to an empty string, or &false;, the handler
       in question is disabled.
      </para>
      &note.func-callback;
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>xml_set_end_namespace_decl_handler</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->