File: zend_mod_required_ex.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 (107 lines) | stat: -rw-r--r-- 3,157 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="internals2.ze1.zendapi.macros.zend-mod-required-ex" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ZEND_MOD_REQUIRED_EX</refname>
  <refpurpose>Create a full dependency entry for the required version of an extension</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;      
  <literallayout>#include &lt;zend_modules.h&gt;</literallayout>
  <methodsynopsis>
   <void/><methodname>ZEND_MOD_REQUIRED_EX</methodname>
    <methodparam><type>char *</type><parameter>name</parameter></methodparam>
    <methodparam><type>char *</type><parameter>rel</parameter></methodparam>
    <methodparam><type>char *</type><parameter>ver</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>ZEND_MOD_REQUIRED_EX</function> generates a <type>zend_module_dep</type>
   entry for the extension named by <parameter>ext_name</parameter>, including version
   information. It allows to specify requirements like "up to version x.y", 
   "starting with version x.y" or "exactly version x.y".
  </para>
  <warning>
   <para>
    Version specific comparisons are not implemented yet, 
    so for now <function>ZEND_MOD_REUQUIRE</function> and
    <function>ZEND_MOD_REQUIRE_EX</function> define identical behavior.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       Name of the required extension
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rel</parameter></term>
     <listitem>
      <para>
       Comparison operator, one of <literal>eq</literal>, <literal>lt</literal>, 
       <literal>le</literal>, <literal>gt</literal>, or <literal>ge</literal>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ver</parameter></term>
     <listitem>
      <para>
       Version string
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Code to register the required extension
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   See <function>ZEND_MOD_REQUIRED</function> if you do not need to 
   specify extension version requirements.
  </para>
  <para>
   See also <function>ZEND_MOD_OPTIONAL</function>,
   <function>ZEND_MOD_OPTIONAL_EX</function>,
   <function>ZEND_MOD_CONFLICTS</function>, and
   <function>ZEND_MOD_CONFLICTS_EX</function>.
  </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
-->