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
142
143
144
145
146
147
148
149
150
151
152
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 325214 $ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.variant" xmlns="http://docbook.org/ns/docbook">
<titleabbrev>VARIANT</titleabbrev>
<title>VARIANT class</title>
<partintro>
<section xml:id="class.variant.class">
<title>Description</title>
<simpara>
The VARIANT is COM's equivalent of the PHP zval; it is a structure that
can contain a value with a range of different possible types. The VARIANT
class provided by the COM extension allows you to have more control over
the way that PHP passes values to and from COM.
</simpara>
<simpara>
<literal>$vVar = new VARIANT($var)</literal>
</simpara>
</section>
<section xml:id="variant.variant">
<title>Methods</title>
<methodsynopsis>
<methodname>VARIANT::VARIANT</methodname>
<methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>codepage</parameter></methodparam>
</methodsynopsis>
<para>
VARIANT class constructor. Parameters:
<variablelist>
<varlistentry><term>value</term>
<listitem>
<simpara>
initial value. if omitted, or set to &null; an VT_EMPTY object is created.
</simpara>
</listitem>
</varlistentry>
<varlistentry><term>type</term>
<listitem>
<simpara>
specifies the content type of the VARIANT object. Possible values are
one of the <constant>VT_XXX</constant> <xref
linkend="com.constants"/>.
</simpara>
<simpara>
In PHP versions prior to PHP 5, you could force PHP to pass a variant
object by reference by OR'ing <constant>VT_BYREF</constant>
with the <parameter>type</parameter>. In PHP 5, this hack is not
supported; instead, PHP 5 can detect parameters passed by reference
automatically; they do not even need to be passed as VARIANT objects.
</simpara>
<simpara>
Consult the <acronym>MSDN</acronym> library for additional information
on the VARIANT type.
</simpara>
</listitem>
</varlistentry>
<varlistentry><term>codepage</term>
<listitem>
<simpara>
specifies the codepage that is used to convert strings to
unicode. See the parameter of the same name in the
<xref linkend="class.com"/> class for more information.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
PHP versions prior to PHP 5 define a number of (undocumented) virtual properties
for instances of the VARIANT class; these properties have all been removed in
PHP 5 in favour of its more natural syntax; these differences are best
highlighted by example:
</para>
<para>
<example xml:id="com.variant.example.php4">
<title>Variant example, PHP 4.x style</title>
<programlisting role="php">
<![CDATA[
<?php
$v = new VARIANT(42);
print "The type is " . $v->type . "<br/>";
print "The value is " . $v->value . "<br/>";
?>
]]>
</programlisting>
</example>
</para>
<para>
<example xml:id="com.variant.example.php5">
<title>Variant example, PHP 5 style</title>
<programlisting role="php">
<![CDATA[
<?php
$v = new VARIANT(42);
print "The type is " . variant_get_type($v) . "<br/>";
print "The value is " . $v . "<br/>";
?>
]]>
</programlisting>
</example>
</para>
<para>
The reason for the change is that, internally, the COM extension sees
VARIANT, COM and DOTNET classes as the same thing, and the design
philosophy for these classes is that all property and member accesses are
passed through to COM with no interference. The new syntax is more
natural and less effort, and most of the removed virtual properties didn't
make any sense in a PHP context in any case.
</para>
<note>
<para>
PHP 5 takes a much simpler approach to handling VARIANTs; when returning
a value or fetching a variant property, the variant is converted to a PHP
value only when there is a direct mapping between the types that would
not result in a loss of information. In all other cases, the result is
returned as an instance of the VARIANT class. You can force PHP to
convert or evaluate the variant as a PHP native type by using a casting
operator explicitly, or implicitly casting to a string by
<function>print</function>ing it. You may use the wide range of variant
functions to perform arithmetic operations on variants without forcing a
conversion or risking a loss of data.
</para>
</note>
<para>
See also <function>variant_get_type</function>.
</para>
</section>
</partintro>
</phpdoc:classref>
<!-- 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
-->
|
