mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
9301355165
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336809 c90b9560-bf6c-de11-be94-00142212c4b1
387 lines
12 KiB
XML
387 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<chapter xml:id="language.constants" xmlns="http://docbook.org/ns/docbook">
|
|
<title>Constants</title>
|
|
|
|
<simpara>
|
|
A constant is an identifier (name) for a simple value. As the name
|
|
suggests, that value cannot change during the execution of the
|
|
script (except for <link linkend="language.constants.predefined">
|
|
magic constants</link>, which aren't actually constants).
|
|
A constant is case-sensitive by default. By convention, constant
|
|
identifiers are always uppercase.
|
|
</simpara>
|
|
<para>
|
|
The name of a constant follows the same rules as any label in PHP. A
|
|
valid constant name starts with a letter or underscore, followed
|
|
by any number of letters, numbers, or underscores. As a regular
|
|
expression, it would be expressed thusly:
|
|
<literal>[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*</literal>
|
|
</para>
|
|
&tip.userlandnaming;
|
|
<para>
|
|
<example>
|
|
<title>Valid and invalid constant names</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// Valid constant names
|
|
define("FOO", "something");
|
|
define("FOO2", "something else");
|
|
define("FOO_BAR", "something more");
|
|
|
|
// Invalid constant names
|
|
define("2FOO", "something");
|
|
|
|
// This is valid, but should be avoided:
|
|
// PHP may one day provide a magical constant
|
|
// that will break your script
|
|
define("__FOO__", "something");
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
For our purposes here, a letter is a-z, A-Z, and the ASCII
|
|
characters from 127 through 255 (0x7f-0xff).
|
|
</simpara>
|
|
</note>
|
|
|
|
<simpara>
|
|
Like &link.superglobals;, the scope of a constant is global. You
|
|
can access constants anywhere in your script without regard to scope.
|
|
For more information on scope, read the manual section on
|
|
<link linkend="language.variables.scope">variable scope</link>.
|
|
</simpara>
|
|
|
|
<sect1 xml:id="language.constants.syntax">
|
|
<title>Syntax</title>
|
|
<simpara>
|
|
You can define a constant by using the
|
|
<function>define</function>-function or by using the
|
|
<literal>const</literal> keyword outside a class definition as
|
|
of PHP 5.3.0. Once a constant is defined, it can never be
|
|
changed or undefined.
|
|
</simpara>
|
|
<simpara>
|
|
Only scalar data (<type>boolean</type>, <type>integer</type>,
|
|
<type>float</type> and <type>string</type>) can be contained
|
|
in constants prior to PHP 5.6. From PHP 5.6 onwards, it is possible to
|
|
define a constant as a scalar expression, and it is also possible
|
|
to define an <type>array</type> constant. It is possible to define
|
|
constants as a <type>resource</type>, but it should be avoided, as it can
|
|
cause unexpected results.
|
|
</simpara>
|
|
<simpara>
|
|
You can get the value of a constant by simply specifying its name.
|
|
Unlike with variables, you should <emphasis>not</emphasis> prepend
|
|
a constant with a <literal>$</literal>.
|
|
You can also use the function <function>constant</function> to
|
|
read a constant's value if you wish to obtain the constant's name
|
|
dynamically.
|
|
Use <function>get_defined_constants</function> to get a list of
|
|
all defined constants.
|
|
</simpara>
|
|
<note>
|
|
<simpara>
|
|
Constants and (global) variables are in a different namespace.
|
|
This implies that for example &true; and
|
|
<varname>$TRUE</varname> are generally different.
|
|
</simpara>
|
|
</note>
|
|
<simpara>
|
|
If you use an undefined constant, PHP assumes that you mean
|
|
the name of the constant itself, just as if you called it as
|
|
a <type>string</type> (CONSTANT vs "CONSTANT"). An error of level
|
|
<link linkend="ref.errorfunc">E_NOTICE</link> will be issued
|
|
when this happens. See also the manual entry on why
|
|
<link linkend="language.types.array.foo-bar">$foo[bar]</link> is
|
|
wrong (unless you first <function>define</function>
|
|
<literal>bar</literal> as a constant). If you simply want to check if a
|
|
constant is set, use the <function>defined</function> function.
|
|
</simpara>
|
|
<para>
|
|
These are the differences between constants and variables:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
Constants do not have a dollar sign (<literal>$</literal>)
|
|
before them;
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
Prior to PHP 5.3, Constants may only be defined using the
|
|
<function>define</function> function, not by simple assignment;
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
Constants may be defined and accessed anywhere without regard
|
|
to variable scoping rules;
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
Constants may not be redefined or undefined once they have been
|
|
set; and
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
Constants may only evaluate to scalar values. As of PHP 5.6 it is possible
|
|
to define array constant using <literal>const</literal> keywords and as of
|
|
PHP 7 array constants can also be defined using <function>define</function>
|
|
You may use arrays in constant scalar expressions
|
|
(for example, <literal>const FOO = array(1,2,3)[0];</literal>),
|
|
but the end result must be a value of allowed type.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
|
|
<para>
|
|
<example>
|
|
<title>Defining Constants</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
define("CONSTANT", "Hello world.");
|
|
echo CONSTANT; // outputs "Hello world."
|
|
echo Constant; // outputs "Constant" and issues a notice.
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
|
|
<para>
|
|
<example>
|
|
<title>Defining Constants using the <literal>const</literal> keyword</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Works as of PHP 5.3.0
|
|
const CONSTANT = 'Hello World';
|
|
|
|
echo CONSTANT;
|
|
|
|
// Works as of PHP 5.6.0
|
|
const ANOTHER_CONST = CONSTANT.'; Goodbye World';
|
|
echo ANOTHER_CONST;
|
|
|
|
const ANIMALS = array('dog', 'cat', 'bird');
|
|
echo ANIMALS[1]; // outputs "cat"
|
|
|
|
// Works as of PHP 7
|
|
define('ANIMALS', array(
|
|
'dog',
|
|
'cat',
|
|
'bird'
|
|
));
|
|
echo ANIMALS[1]; // outputs "cat"
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
|
|
<note>
|
|
<para>
|
|
As opposed to defining constants using <function>define</function>,
|
|
constants defined using the <literal>const</literal> keyword must be
|
|
declared at the top-level scope because they are defined at compile-time.
|
|
This means that they cannot be declared inside functions, loops,
|
|
<literal>if</literal> statements or <literal>try</literal>/
|
|
<literal>catch</literal> blocks.
|
|
</para>
|
|
</note>
|
|
|
|
<simpara>
|
|
See also <link linkend="language.oop5.constants">Class Constants</link>.
|
|
</simpara>
|
|
</sect1>
|
|
|
|
<sect1 xml:id="language.constants.predefined">
|
|
<title>Magic constants</title>
|
|
|
|
<simpara>
|
|
PHP provides a large number of <link
|
|
linkend="reserved.constants">predefined constants</link> to any script
|
|
which it runs. Many of these constants, however, are created by
|
|
various extensions, and will only be present when those extensions
|
|
are available, either via dynamic loading or because they have
|
|
been compiled in.
|
|
</simpara>
|
|
|
|
<para>
|
|
There are eight magical constants that change depending on
|
|
where they are used. For example, the value of
|
|
<constant>__LINE__</constant> depends on the line that it's
|
|
used on in your script. These special constants are
|
|
case-insensitive and are as follows:
|
|
</para>
|
|
<para>
|
|
<table>
|
|
<title>A few "magical" PHP constants</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Name</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row xml:id="constant.line">
|
|
<entry><constant>__LINE__</constant></entry>
|
|
<entry>
|
|
The current line number of the file.
|
|
</entry>
|
|
</row>
|
|
<row xml:id="constant.file">
|
|
<entry><constant>__FILE__</constant></entry>
|
|
<entry>
|
|
The full path and filename of the file with symlinks resolved. If used inside an include,
|
|
the name of the included file is returned.
|
|
</entry>
|
|
</row>
|
|
<row xml:id="constant.dir">
|
|
<entry><constant>__DIR__</constant></entry>
|
|
<entry>
|
|
The directory of the file. If used inside an include,
|
|
the directory of the included file is returned. This is equivalent
|
|
to <literal>dirname(__FILE__)</literal>. This directory name
|
|
does not have a trailing slash unless it is the root directory.
|
|
</entry>
|
|
</row>
|
|
<row xml:id="constant.function">
|
|
<entry><constant>__FUNCTION__</constant></entry>
|
|
<entry>
|
|
The function name.
|
|
</entry>
|
|
</row>
|
|
<row xml:id="constant.class">
|
|
<entry><constant>__CLASS__</constant></entry>
|
|
<entry>
|
|
The class name. The class name includes the namespace
|
|
it was declared in (e.g. <literal>Foo\Bar</literal>).
|
|
Note that as of PHP 5.4 __CLASS__ works also in traits. When used
|
|
in a trait method, __CLASS__ is the name of the class the trait
|
|
is used in.
|
|
</entry>
|
|
</row>
|
|
<row xml:id="constant.trait">
|
|
<entry><constant>__TRAIT__</constant></entry>
|
|
<entry>
|
|
The trait name. The trait name includes the namespace
|
|
it was declared in (e.g. <literal>Foo\Bar</literal>).
|
|
</entry>
|
|
</row>
|
|
<row xml:id="constant.method">
|
|
<entry><constant>__METHOD__</constant></entry>
|
|
<entry>
|
|
The class method name.
|
|
</entry>
|
|
</row>
|
|
<row xml:id="constant.namespace">
|
|
<entry><constant>__NAMESPACE__</constant></entry>
|
|
<entry>
|
|
The name of the current namespace.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
See also
|
|
<function>get_class</function>,
|
|
<function>get_object_vars</function>,
|
|
<function>file_exists</function>&listendand;
|
|
<function>function_exists</function>.
|
|
</para>
|
|
|
|
<sect2 xml:id="language.constants.predefined.changelog">
|
|
&reftitle.changelog;
|
|
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.4.0</entry>
|
|
<entry>
|
|
Added <constant>__TRAIT__</constant> constant
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.3.0</entry>
|
|
<entry>
|
|
Added <constant>__DIR__</constant> and <constant>__NAMESPACE__</constant> constants
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.0.0</entry>
|
|
<entry>
|
|
Added <constant>__METHOD__</constant> constant
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.0.0</entry>
|
|
<entry>
|
|
Before this version values of some magic constants were always lowercased.
|
|
All of them are case-sensitive now (contain names as they were declared).
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>4.3.0</entry>
|
|
<entry>
|
|
Added <constant>__FUNCTION__</constant> and <constant>__CLASS__</constant> constants
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>4.0.2</entry>
|
|
<entry>
|
|
<constant>__FILE__</constant> always contains an absolute path with symlinks
|
|
resolved whereas in older versions it contained relative path
|
|
under some circumstances
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<!-- 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
|
|
-->
|