Home > Articles > Programming > PHP

This chapter is from the book

This chapter is from the book

4.3 Constants

  • "The only thing constant in life is change."

    —Francois de la Rouchefoucauld, French classical author

Some real-world constants, such as pi, the speed of light, the number of inches in a foot, and the value of midnight, are values that don't change. PHP not only provides its own predefined constants but lets you create your own. Using constants makes it easy to write and maintain your programs.

4.3.1 What Is a Constant?

Unlike variables, a constant is a value that, once set, cannot be changed or unset during the execution of your script. An example of a constant is the value of pi or the version of PHP you are using. Constants are very useful because they are visible throughout a program (global in scope) and their values don't change; for example, a constant might be defined for the document root of your server, the name of your site, or the title, author, and copyright year of this book. Once defined, those values are fixed.

You can define constants at the top of your program or in another file that can be included in your script. (See the require() and include() functions discussed in "Managing Content with Include Files" on page 487.) Later if a constant value needs to be modified, once you change its value in the program, then when the program is executed, the new value will be reflected wherever the constant is used throughout the program, thus facilitating program maintenance.

4.3.2 Creating Constants with the define() Function

PHP constants are defined as words, and by convention, capitalized. Like variables, they are case sensitive and consist of uppercase and lowercase letters, numbers, and the underscore. Like variables, they cannot start with a number.

Unlike variables, constants are not preceded by a dollar sign and are not interpreted when placed within quotes.

Constants are global in scope, meaning they are available for use anywhere in a PHP script.

The only way that you can create a constant is with he PHP built-in define() function. Only a single, scalar value can be assigned to a constant, including strings, integers, floats, and booleans.

The define() function creates a named constant. The first argument is the name of the constant and the second argument is the value that will be assigned to it. Constants are normally case sensitive, but you can use an optional third argument of TRUE to turn off case sensitivity.

Format

bool define ( string name, mixed value [, bool case_insensitive] )

Example:

// defines document root
define( 'DOC_ROOT', '/http://artemis/~ellie/public_html' );
// defines the include folder
define( 'INCLUDES', DOC_ROOT.'/../includes' );

Example 4.25.

    <?php
1   define('ISBN', "0-13-140162-9");
2   define('TITLE', "JavaScript by Example" );
3   if ( defined('ISBN') and defined('TITLE')){
4          print ISBN . "<br />";
           print TITLE . "<br />";
    }
5   define('TITLE', "PHP by Example");   // Can't change TITLE, and
                                         // can't redefine it.
6    print TITLE;
     ?>

Explanation

1, 2

Two constants are defined, ISBN and TITLE, the first argument to the function. The second argument is the value being assigned to each of the constants. Once set, the only way to change a constant is to redefine it with the define() function.

3

The define() function returns TRUE if the named constant has been defined. The expression reads, "if the constant ISBN and the constant TITLE have both been defined, proceed to line 3."

4

Notice that the constants are not quoted. If they are quoted, their values will not be printed, but just the words ISBN and TITLE.

5

You cannot redefine a constant like this. If you want to modify the value, you must go back into the program and change the original definition on line 2.

6

The constant TITLE was unaffected by line 5. By definition, a constant cannot be changed or unset. The output of this program is shown in Figure 4.30.

04fig30.jpg

Figure 4.30 User-defined constants. Output from Example 4.25.

The defined() function checks whether a constant has been set. It returns TRUE if the constant has been defined; otherwise, FALSE.

4.3.3 The constant() Function

The constant() function returns that value of a constant. This function can be helpful if you don't know the name of the constant because its name was stored in a variable or was returned from a function.

Format

mixed constant ( string name )

Example:

define (ISBN, "0-13-140162-9");
$value=constant(ISBN);  // Returns 0-13-140162-9

4.3.4 Predefined and "Magic" Constants

PHP comes with a number of predefined constants shown in Table 4.6. They provide information that doesn't change such as the name of the script file, the version of PHP and the operating system, and so on.

There are five predefined constants called magic constants (see Table 4.7). These are constants that change depending on how they are used in a program. They cannot be enclosed in quotes and are not case sensitive. The name of the contant is enclosed in two underscores on both sides.

Table 4.7. Magic Constants

Name

Description

__LINE__

The current line number of the file.

__FILE__

The full path and filename of the file. If used inside an include, the name of the included file is returned.

__FUNCTION__

The function name (added in PHP 4.3.0). As of PHP 5 this constant returns the function name as it was declared (case sensitive). In PHP 4 its value is always lowercased.

__CLASS__

The class name (added in PHP 4.3.0). As of PHP 5 this constant returns the class name as it was declared (case sensitive). In PHP 4 its value is always lowercased.

__METHOD__

The class method name (added in PHP 5.0.0). The method name is returned as it was declared (case sensitive).

PHP has several special built-in constants described in Table 4.8.

Table 4.8. Built-In Constants

Name

Description

PHP_VERSION

The version of the PHP parser currently running

PHP_OS

The operating system of the server on which the PHP parser is running

PHP_OS

The name of the operating system on which the PHP parser is executing; e.g., Linux

TRUE

A true value.

FALSE

A false value.

The script in Example 4.26 shows how the predefined constants can be used to give information to the browser. It's output is displayed in Figure 4.31.

Example 4.26.

<?php
    // Using PHP built-in constants
    echo "PHP version = " . PHP_VERSION . "<br />";
    echo "Server operating system = " . PHP_OS . "<br />";
    echo "Current file name= " . __FILE__ . "<br />";
    echo "Current line number= " . __LINE__ . "<br />";
    echo "TRUE = ". TRUE . "<br />";
    echo "false = ". FALSE . "<br />";
?>
04fig31.jpg

Figure 4.31 Predefined constants. Output from Example 4.26.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020