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 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="info.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants.core;
<variablelist xml:id="constant.credits.constants" role="constant_list">
<title>Pre-defined <function xmlns="http://docbook.org/ns/docbook">phpcredits</function> constants</title>
<varlistentry xml:id="constant.credits-group">
<term>
<constant>CREDITS_GROUP</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
A list of the core developers
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.credits-general">
<term>
<constant>CREDITS_GENERAL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
General credits: Language design and concept, PHP
authors and SAPI module.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.credits-sapi">
<term>
<constant>CREDITS_SAPI</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
A list of the server API modules for PHP, and their authors.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.credits-modules">
<term>
<constant>CREDITS_MODULES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
A list of the extension modules for PHP, and their authors.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.credits-docs">
<term>
<constant>CREDITS_DOCS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The credits for the documentation team.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.credits-fullpage">
<term>
<constant>CREDITS_FULLPAGE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Usually used in combination with the other flags. Indicates
that a complete stand-alone HTML page needs to be
printed including the information indicated by the other
flags.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.credits-qa">
<term>
<constant>CREDITS_QA</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The credits for the quality assurance team.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.credits-all">
<term>
<constant>CREDITS_ALL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
All the credits, equivalent to using: <literal>CREDITS_DOCS
| CREDITS_GENERAL | CREDITS_GROUP | CREDITS_MODULES | CREDITS_QA
| CREDITS_FULLPAGE</literal>. It generates a complete stand-alone HTML
page with the appropriate tags. This is the default value.
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="constant.info.constants" role="constant_list">
<title><function xmlns="http://docbook.org/ns/docbook">phpinfo</function> constants</title>
<varlistentry xml:id="constant.info-general">
<term>
<constant>INFO_GENERAL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The configuration line, &php.ini; location, build date, Web
Server, System and more.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.info-credits">
<term>
<constant>INFO_CREDITS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP Credits. See also <function xmlns="http://docbook.org/ns/docbook">phpcredits</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.info-configuration">
<term>
<constant>INFO_CONFIGURATION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Current Local and Master values for PHP directives. See
also <function xmlns="http://docbook.org/ns/docbook">ini_get</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.info-modules">
<term>
<constant>INFO_MODULES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Loaded modules and their respective settings.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.info-environment">
<term>
<constant>INFO_ENVIRONMENT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Environment Variable information that's also available in
<varname xmlns="http://docbook.org/ns/docbook">$_ENV</varname>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.info-variables">
<term>
<constant>INFO_VARIABLES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Shows all <link xmlns="http://docbook.org/ns/docbook" linkend="language.variables.predefined">
predefined variables</link> from <literal xmlns="http://docbook.org/ns/docbook">EGPCS</literal> (Environment, GET,
POST, Cookie, Server).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.info-license">
<term>
<constant>INFO_LICENSE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP License information. See also the <link xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.php.license;">license faq</link>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.info-all">
<term>
<constant>INFO_ALL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Shows all of the above. This is the default value.
</simpara>
</listitem>
</varlistentry>
</variablelist>
<variablelist xml:id="constant.ini-mode" role="constant_list">
<title>INI mode constants</title>
<varlistentry xml:id="constant.ini-user">
<term>
<constant>INI_USER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Entry can be set in user scripts (like with <function xmlns="http://docbook.org/ns/docbook">ini_set</function>)
or in the <link xmlns="http://docbook.org/ns/docbook" linkend="configuration.changes.windows">Windows registry</link>.
Entry can be set in &user-ini;
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ini-perdir">
<term>
<constant>INI_PERDIR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Entry can be set in &php.ini;, &htaccess;, &httpd.conf; or &user-ini;
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ini-system">
<term>
<constant>INI_SYSTEM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Entry can be set in &php.ini; or &httpd.conf;
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ini-all">
<term>
<constant>INI_ALL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Entry can be set anywhere
</simpara>
</listitem>
</varlistentry>
</variablelist>
<simpara>
Assert constants, these values are used to set
the assertion options in <function>assert_options</function>.
</simpara>
<variablelist xml:id="constant.assert.constants" role="constant_list">
<title><function xmlns="http://docbook.org/ns/docbook">assert</function> constants</title>
<varlistentry xml:id="constant.assert-active">
<term>
<constant>ASSERT_ACTIVE</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Enable <function xmlns="http://docbook.org/ns/docbook">assert</function> evaluation.
&warn.deprecated.feature-8-3-0;
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.assert-callback">
<term>
<constant>ASSERT_CALLBACK</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Callback to call on failed assertions.
&warn.deprecated.feature-8-3-0;
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.assert-bail">
<term>
<constant>ASSERT_BAIL</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Terminate execution on failed assertions.
&warn.deprecated.feature-8-3-0;
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.assert-exception">
<term>
<constant>ASSERT_EXCEPTION</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Throws an <classname>AssertionError</classname> for each failed assertion
&warn.deprecated.feature-8-3-0;
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.assert-warning">
<term>
<constant>ASSERT_WARNING</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Issues a PHP warning for each failed assertion
&warn.deprecated.feature-8-3-0;
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.assert-quiet-eval">
<term>
<constant>ASSERT_QUIET_EVAL</constant>
(<type>int</type>)
</term>
<listitem>
<para>
Disable <literal xmlns="http://docbook.org/ns/docbook">error_reporting</literal> during assertion expression evaluation.
&warn.feature.removed-8-0-0;
</para>
</listitem>
</varlistentry>
</variablelist>
<simpara>
The following constants are only available if the host operating
system is Windows, and can tell different versioning information
so its possible to detect various features and make use of them.
</simpara>
<variablelist xml:id="constant.windows.constants" role="constant_list">
<title>Windows specific constants</title>
<varlistentry xml:id="constant.php-windows-version-major">
<term>
<constant>PHP_WINDOWS_VERSION_MAJOR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The major version of Windows, this can be either <literal xmlns="http://docbook.org/ns/docbook">4</literal> (NT4/Me/98/95),
<literal xmlns="http://docbook.org/ns/docbook">5</literal> (XP/2003 R2/2003/2000) or <literal xmlns="http://docbook.org/ns/docbook">6</literal> (Vista/2008/7/8/8.1).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-version-minor">
<term>
<constant>PHP_WINDOWS_VERSION_MINOR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The minor version of Windows, this can be either <literal xmlns="http://docbook.org/ns/docbook">0</literal> (Vista/2008/2000/NT4/95),
<literal xmlns="http://docbook.org/ns/docbook">1</literal> (XP), <literal xmlns="http://docbook.org/ns/docbook">2</literal> (2003 R2/2003/XP x64), <literal xmlns="http://docbook.org/ns/docbook">10</literal> (98)
or <literal xmlns="http://docbook.org/ns/docbook">90</literal> (ME).
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-version-build">
<term>
<constant>PHP_WINDOWS_VERSION_BUILD</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The Windows build number (for example, Windows Vista with SP1 applied is build 6001)
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-version-platform">
<term>
<constant>PHP_WINDOWS_VERSION_PLATFORM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The platform that PHP currently is running on, this value is <literal xmlns="http://docbook.org/ns/docbook">2</literal> on Windows
Vista/XP/2000/NT4, Server 2008/2003 and on Windows ME/98/95 this value is <literal xmlns="http://docbook.org/ns/docbook">1</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-version-sp-major">
<term>
<constant>PHP_WINDOWS_VERSION_SP_MAJOR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The major version of the service pack installed, this value is <literal xmlns="http://docbook.org/ns/docbook">0</literal>
if no service pack is installed. For example, Windows XP with service pack 3 installed
will make this value <literal xmlns="http://docbook.org/ns/docbook">3</literal>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-version-sp-minor">
<term>
<constant>PHP_WINDOWS_VERSION_SP_MINOR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The minor version of the service pack installed, this value is <literal xmlns="http://docbook.org/ns/docbook">0</literal>
if no service pack is installed.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-version-suitemask">
<term>
<constant>PHP_WINDOWS_VERSION_SUITEMASK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
The suitemask is a bitmask that can tell if various features of Windows is installed,
see the table below for possible bitfield values.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-version-producttype">
<term>
<constant>PHP_WINDOWS_VERSION_PRODUCTTYPE</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
This contains the value used to determine the
<literal>PHP_WINDOWS_NT_<replaceable>*</replaceable></literal>
constants. This value may be one of the
<literal>PHP_WINDOWS_NT_<replaceable>*</replaceable></literal> constants
indicating the platform type.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-nt-domain-controller">
<term>
<constant>PHP_WINDOWS_NT_DOMAIN_CONTROLLER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
This is a domain controller
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-nt-server">
<term>
<constant>PHP_WINDOWS_NT_SERVER</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
This is a server system (eg. Server 2008/2003/2000), note that if this is a
domain controller its reported as <constant xmlns="http://docbook.org/ns/docbook">PHP_WINDOWS_NT_DOMAIN_CONTROLLER</constant>.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.php-windows-nt-workstation">
<term>
<constant>PHP_WINDOWS_NT_WORKSTATION</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
This is a workstation system (eg. Vista/XP/2000/NT4)
</simpara>
</listitem>
</varlistentry>
</variablelist>
<simpara>
This table shows a list of features that can be checked for using the
<constant>PHP_WINDOWS_VERSION_SUITEMASK</constant> bitmask.
</simpara>
<table>
<title>Windows suitemask bitfields</title>
<tgroup cols="3">
<thead>
<row>
<entry>Bits</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>0x00000004</literal></entry>
<entry>Microsoft BackOffice components are installed.</entry>
</row>
<row>
<entry><literal>0x00000400</literal></entry>
<entry>Windows Server 2003, Web Edition is installed.</entry>
</row>
<row>
<entry><literal>0x00004000</literal></entry>
<entry>Windows Server 2003, Compute Cluster Edition is installed.</entry>
</row>
<row>
<entry><literal>0x00000080</literal></entry>
<entry>
Windows Server 2008 Datacenter, Windows Server 2003, Datacenter Edition or
Windows 2000 Datacenter Server is installed.
</entry>
</row>
<row>
<entry><literal>0x00000002</literal></entry>
<entry>
Windows Server 2008 Enterprise, Windows Server 2003, Enterprise Edition,
Windows 2000 Advanced Server, or Windows NT Server 4.0 Enterprise Edition
is installed.
</entry>
</row>
<row>
<entry><literal>0x00000040</literal></entry>
<entry>Windows XP Embedded is installed.</entry>
</row>
<row>
<entry><literal>0x00000200</literal></entry>
<entry>
Windows Vista Home Premium, Windows Vista Home Basic, or Windows XP Home
Edition is installed.
</entry>
</row>
<row>
<entry><literal>0x00000100</literal></entry>
<entry>
Remote Desktop is supported, but only one interactive session is supported.
This value is set unless the system is running in application server mode.
</entry>
</row>
<row>
<entry><literal>0x00000001</literal></entry>
<entry>
Microsoft Small Business Server was once installed on the system, but may have
been upgraded to another version of Windows.
</entry>
</row>
<row>
<entry><literal>0x00000020</literal></entry>
<entry>
Microsoft Small Business Server is installed with the restrictive client
license in force.
</entry>
</row>
<row>
<entry><literal>0x00002000</literal></entry>
<entry>Windows Storage Server 2003 R2 or Windows Storage Server 2003 is installed.</entry>
</row>
<row>
<entry><literal>0x00000010</literal></entry>
<entry>
Terminal Services is installed. This value is always set. If this value is set but
<literal>0x00000100</literal> is not set, then the system is running in application
server mode.
</entry>
</row>
<row>
<entry><literal>0x00008000</literal></entry>
<entry>Windows Home Server is installed.</entry>
</row>
</tbody>
</tgroup>
</table>
</appendix>
<!-- 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
-->
|