reserved.constants.core.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<sect2 xml:id="reserved.constants.core" xmlns="http://docbook.org/ns/docbook">
 <title>Core Predefined Constants</title>
 <simpara>
  These constants are defined by the PHP core. This includes PHP,
  the Zend engine, and SAPI modules.
 </simpara>
 <variablelist>
  <varlistentry xml:id="constant.php-version">
   <term>
    <constant>PHP_VERSION</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The current PHP version as a string in
     "major.minor.release[extra]" notation.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-major-version">
   <term>
    <constant>PHP_MAJOR_VERSION</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The current PHP "major" version as an integer (e.g., int(5)
     from version "5.2.7-extra").
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-minor-version">
   <term>
    <constant>PHP_MINOR_VERSION</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The current PHP "minor" version as an integer (e.g., int(2)
     from version "5.2.7-extra").
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-release-version">
   <term>
    <constant>PHP_RELEASE_VERSION</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The current PHP "release" version as an integer (e.g., int(7)
     from version "5.2.7-extra").
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-version-id">
   <term>
    <constant>PHP_VERSION_ID</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The current PHP version as an integer, useful for
     version comparisons (e.g., int(50207) from version "5.2.7-extra").
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-extra-version">
   <term>
    <constant>PHP_EXTRA_VERSION</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The current PHP "extra" version as a string (e.g., '-extra'
     from version "5.2.7-extra"). Often used by distribution
     vendors to indicate a package version.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-build-date">
   <term>
    <constant>PHP_BUILD_DATE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The date and time when PHP was built, in <literal>"M d Y H:i:s"</literal> format. Available as of PHP 8.5.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-build-provider">
   <term>
    <constant>PHP_BUILD_PROVIDER</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The provider who built PHP. Available as of PHP 8.5.0.
    </simpara>
    <note>
     <simpara>
      This constant may not be available in all builds of PHP. (e.g., not set when
      building from source without specifying a value during configuration).
     </simpara>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.zend-thread-safe">
   <term>
    <constant>ZEND_THREAD_SAFE</constant>
    (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     Indicates whether the current build of PHP is thread safe.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.zend-debug-build">
   <term>
    <constant>ZEND_DEBUG_BUILD</constant>
    (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     Indicates whether the current build of PHP is a debug build.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-zts">
   <term>
    <constant>PHP_ZTS</constant>
    (<type>bool</type>)
    &Alias; <constant>ZEND_THREAD_SAFE</constant>
   </term>
   <listitem>
    <simpara>
     Indicates whether the current build of PHP is thread safe.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-debug">
   <term>
    <constant>PHP_DEBUG</constant>
    (<type>bool</type>)
    &Alias; <constant>ZEND_DEBUG_BUILD</constant>
   </term>
   <listitem>
    <simpara>
     Indicates whether the current build of PHP is a debug build.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.debug-backtrace-provide-object">
   <term>
    <constant>DEBUG_BACKTRACE_PROVIDE_OBJECT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Populate the "object" index.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.debug-backtrace-ignore-args">
   <term>
    <constant>DEBUG_BACKTRACE_IGNORE_ARGS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Don't include the argument information for functions in the stack trace.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-maxpathlen">
   <term>
    <constant>PHP_MAXPATHLEN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The maximum length of filenames (including path) supported
     by this build of PHP.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-os">
   <term>
    <constant>PHP_OS</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The operating system PHP was built for.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-os-family">
   <term>
    <constant>PHP_OS_FAMILY</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The operating system family PHP was built for. One of
     <literal>'Windows'</literal>, <literal>'BSD'</literal>,
     <literal>'Darwin'</literal>, <literal>'Solaris'</literal>,
     <literal>'Linux'</literal> or <literal>'Unknown'</literal>.
     Available as of PHP 7.2.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-sapi">
   <term>
    <constant>PHP_SAPI</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The Server API for this build of PHP.
     See also <function>php_sapi_name</function>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-eol">
   <term>
    <constant>PHP_EOL</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The correct 'End Of Line' symbol for this platform.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-int-max">
   <term>
    <constant>PHP_INT_MAX</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The largest integer supported in this build of PHP. Usually int(2147483647)
     in 32 bit systems and int(9223372036854775807) in 64 bit systems.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-int-min">
   <term>
    <constant>PHP_INT_MIN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The smallest integer supported in this build of PHP. Usually int(-2147483648) in 32 bit systems and
     int(-9223372036854775808) in 64 bit systems.
     Usually, PHP_INT_MIN === ~PHP_INT_MAX.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-int-size">
   <term>
    <constant>PHP_INT_SIZE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The size of an integer in bytes in this build of PHP.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-float-dig">
   <term>
    <constant>PHP_FLOAT_DIG</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Number of decimal digits that can be rounded into a float and back
     without precision loss.
     Available as of PHP 7.2.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-float-epsilon">
   <term>
    <constant>PHP_FLOAT_EPSILON</constant>
    (<type>float</type>)
   </term>
   <listitem>
    <simpara>
     Smallest representable positive number x, so that <literal>x + 1.0 !=
     1.0</literal>.
     Available as of PHP 7.2.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-float-min">
   <term>
    <constant>PHP_FLOAT_MIN</constant>
    (<type>float</type>)
   </term>
   <listitem>
    <simpara>
     Smallest representable <emphasis>positive</emphasis> floating point number.
     If you need the smallest representable <emphasis>negative</emphasis> floating point number, use <literal>- PHP_FLOAT_MAX</literal>.
     Available as of PHP 7.2.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-float-max">
   <term>
    <constant>PHP_FLOAT_MAX</constant>
    (<type>float</type>)
   </term>
   <listitem>
    <simpara>
     Largest representable floating point number.
     Available as of PHP 7.2.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.default-include-path">
   <term>
    <constant>DEFAULT_INCLUDE_PATH</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pear-install-dir">
   <term>
    <constant>PEAR_INSTALL_DIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.pear-extension-dir">
   <term>
    <constant>PEAR_EXTENSION_DIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-extension-dir">
   <term>
    <constant>PHP_EXTENSION_DIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The default directory where to look for dynamically loadable extensions
     (unless overridden by <link linkend="ini.extension-dir">extension_dir</link>).
     Defaults to <constant>PHP_PREFIX</constant> (or <code>PHP_PREFIX . "\\ext"</code> on Windows).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-prefix">
   <term>
    <constant>PHP_PREFIX</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The value <option role="configure">--prefix</option> was set to at configure.
     On Windows, it is the value <option role="configure">--with-prefix</option>
     was set to at configure.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-bindir">
   <term>
    <constant>PHP_BINDIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The value <option role="configure">--bindir</option> was set to at configure.
     On Windows, it is the value <option role="configure">--with-prefix</option>
     was set to at configure.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-sbindir">
   <term>
    <constant>PHP_SBINDIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The value <option role="configure">--sbindir</option> was set to at configure.
     On Windows, it is the value <option role="configure">--with-prefix</option>
     was set to at configure. Available as of PHP 8.4.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-binary">
   <term>
    <constant>PHP_BINARY</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the PHP binary path during script execution.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-mandir">
   <term>
    <constant>PHP_MANDIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Specifies where the manpages were installed into.
    </simpara>
    <note>
     <simpara>
      This constant is not present on Windows builds of PHP.
     </simpara>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-libdir">
   <term>
    <constant>PHP_LIBDIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-datadir">
   <term>
    <constant>PHP_DATADIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-sysconfdir">
   <term>
    <constant>PHP_SYSCONFDIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-localstatedir">
   <term>
    <constant>PHP_LOCALSTATEDIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-config-file-path">
   <term>
    <constant>PHP_CONFIG_FILE_PATH</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-config-file-scan-dir">
   <term>
    <constant>PHP_CONFIG_FILE_SCAN_DIR</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-shlib-suffix">
   <term>
    <constant>PHP_SHLIB_SUFFIX</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The build-platform's shared library suffix, such as "so" (most Unixes)
     or "dll" (Windows).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-fd-setsize">
   <term>
    <constant>PHP_FD_SETSIZE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The maximum number of file descriptors for select system calls. Available
     as of PHP 7.1.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    <constant>E_ERROR</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_WARNING</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_PARSE</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_NOTICE</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_CORE_ERROR</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_CORE_WARNING</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_COMPILE_ERROR</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_COMPILE_WARNING</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_USER_ERROR</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_USER_WARNING</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_USER_NOTICE</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_RECOVERABLE_ERROR</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_DEPRECATED</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_USER_DEPRECATED</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_ALL</constant>
    (<type>int</type>)
   </term>
   <term>
    <constant>E_STRICT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     <link linkend="errorfunc.constants">Error reporting constants</link>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>
    <constant>__COMPILER_HALT_OFFSET__</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>

    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.true">
   <term>
    &true;
    (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     See <link linkend="language.types.boolean">Booleans</link>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.false">
   <term>
    &false;
    (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     See <link linkend="language.types.boolean">Booleans</link>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.null">
   <term>
    &null;
    (<type>null</type>)
   </term>
   <listitem>
    <simpara>
     See <link linkend="language.types.null">Null</link>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-windows-event-ctrl-c">
   <term>
    <constant>PHP_WINDOWS_EVENT_CTRL_C</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     A Windows
     <keycombo action="simul">
      <keycap>CTRL</keycap>
      <keycap>C</keycap>
     </keycombo>
     event.
     Available as of PHP 7.4.0 (Windows only).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-windows-event-ctrl-break">
   <term>
    <constant>PHP_WINDOWS_EVENT_CTRL_BREAK</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     A Windows
     <keycombo action="simul">
      <keycap>CTRL</keycap>
      <keycap>BREAK</keycap>
     </keycombo>
     event.
     Available as of PHP 7.4.0 (Windows only).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-cli-process-title">
   <term>
    <constant>PHP_CLI_PROCESS_TITLE</constant>
    (<type>bool</type>)
   </term>
   <listitem>
    <simpara>
     Indicates whether the setting and getting of the process title is available.
     Available only under the CLI SAPI.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stderr">
   <term>
    <constant>STDERR</constant>
    (<type>resource</type>)
   </term>
   <listitem>
    <simpara>
     An already opened stream to <literal>stderr</literal>.
     Available only under the CLI SAPI.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stdin">
   <term>
    <constant>STDIN</constant>
    (<type>resource</type>)
   </term>
   <listitem>
    <simpara>
     An already opened stream to <literal>stdin</literal>.
     Available only under the CLI SAPI.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.stdout">
   <term>
    <constant>STDOUT</constant>
    (<type>resource</type>)
   </term>
   <listitem>
    <simpara>
     An already opened stream to <literal>stdout</literal>.
     Available only under the CLI SAPI.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
 <simpara>
  See also: <link linkend="language.constants.magic">Magic
  constants</link>.
 </simpara>
</sect2>
<!-- 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:
-->