---
title: "Enumerations"
url: https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations
language: php
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# Enumerations

Programming language: PHP. Other languages: [C++](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/cpp.md), [C#](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/csharp.md), [Java](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/java.md), [JavaScript](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/matlab.md), [Python](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/python.md), [Ruby](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/ruby.md), [Swift](https://docs.zeroc.com/ice/3.8/slice/user-defined-types/enumerations/swift.md).

## Enumeration Syntax and Semantics

An enumeration defines a set of named values, its enumerators:

```slice
module M
{
    enum Fruit { Apple, Pear, Orange }
}
```

This definition introduces a new type named `Fruit`. By default, the first enumerator has a value of zero, with sequentially increasing values for subsequent enumerators.

A Slice enum type introduces a new namespace scope, so the following is legal:

```slice
module M
{
    enum Fruit { Apple, Pear, Orange }
    enum ComputerBrands { Apple, Dell, HP, Lenovo }
}
```

The example below shows how to refer to an enumerator from a different scope:

```slice
module M
{
    enum Color { Red, Green, Blue }
}

module N
{
    struct Pixel
    {
        M::Color c = Blue;
    }
}
```

Slice does not permit empty enumerations.

> **Note**
>
> In Ice releases prior to Ice 3.7, an enum type did not create a new namespace and its enumerators were in the same namespace as the enum type itself. With these releases, you had to select longer enumerator names to avoid a naming clash.

## Custom Enumerator Values

Slice also permits you to assign custom values to enumerators:

```slice
const int PearValue = 7;
enum Fruit { Apple = 0, Pear = PearValue, Orange }
```

Custom values must be unique and non-negative, and may refer to Slice constants of integer types. If no custom value is specified for an enumerator, its value is one greater than the enumerator that immediately precedes it. In the example above, `Orange` has the value 8.

The maximum value for an enumerator value is the same as the maximum value for `int`, 2<sup>31</sup> - 1.

Slice does not require custom enumerator values to be declared in increasing order:

```slice
enum Fruit { Apple = 5, Pear = 3, Orange = 1 }   // Legal
```

The language mapping determines whether a program can compare two enumerators for order, and whether such a comparison follows the enumerators' values or their declaration order.

> **Warning**
>
> For an application that is still using version 1.0 of the [Ice encoding](https://docs.zeroc.com/ice/3.8/encoding/basic-data-encoding.md), changing the definition of an enumerated type **may** break backward compatibility with existing applications. For more information, please refer to the [encoding rules](https://docs.zeroc.com/ice/3.8/encoding/basic-data-encoding.md) for enumerators.

## Language Mapping

A Slice enumeration is mapped to a PHP class: the name of the Slice enumeration becomes the name of the PHP class; for each enumerator, the class contains a constant with the same name as the enumerator. For example:

```slice
enum Fruit { Apple, Pear, Orange }
```

The generated PHP class looks as follows:

```php
class Fruit
{
    const Apple = 0;
    const Pear = 1;
    const Orange = 2;
}
```

Suppose we modify the Slice definition to include a custom enumerator value:

```slice
enum Fruit { Apple, Pear = 3, Orange }
```

The generated PHP class changes accordingly:

```php
class Fruit
{
    const Apple = 0;
    const Pear = 3;
    const Orange = 4;
}
```

Since enumerated values are mapped to integer constants, application code is not required to use the generated constants. When an enumerated value enters the Ice runtime, Ice validates that the given integer is a valid value for the enumeration. However, to minimize the potential for defects in your code, we recommend using the generated constants instead of literal integers.

## See Also

- [Constants and Literals](https://docs.zeroc.com/ice/3.8/slice/constants-and-literals/php.md)
