PHP Mapping for Exceptions

On this page:

Inheritance Hierarchy for Exceptions in PHP

The ancestor of all exceptions is Exception, from which Ice\Exception is derived. Ice\LocalException and Ice\UserException are derived from Ice\Exception and form the base for all run-time and user exceptions.

PHP Mapping for User Exceptions

Here is a fragment of the Slice definition for our world time server once more:

Slice
exception GenericError
{
    string reason;
}
exception BadTimeVal extends GenericError {}
exception BadZoneName extends GenericError {}

These exception definitions map to the abbreviated PHP class definitions shown below:

PHP
class GenericError extends \Ice\UserException
{
    public function __construct($reason='');
    public function ice_id();
    public function __toString();

    public $reason;
}

class BadTimeVal extends GenericError
{
    public function __construct($reason='');
    public function ice_id();
    public function __toString();
}

class BadZoneName extends GenericError
{
    public function __construct($reason='');
    public function ice_id();
    public function __toString();
}

Each Slice exception is mapped to a PHP class with the same name. The inheritance structure of the Slice exceptions is preserved for the generated classes, so BadTimeVal and BadZoneName inherit from GenericError.

Each exception member corresponds to an instance variable of the instance, which the constructor initializes to a default value appropriate for its type:

Data Member TypeDefault Value
stringEmpty string
enumFirst enumerator in enumeration
structDefault-constructed value
NumericZero
boolFalse
sequenceNull
dictionaryNull
class/interfaceNull

You can also declare different default values for members of primitive and enumerated types. For derived exceptions, the constructor has one parameter for each of the base exception's data members, plus one parameter for each of the derived exception's data members, in base-to-derived order. As an example, although BadTimeVal and BadZoneName do not declare data members, their constructors still accept a value for the inherited data member reason in order to pass it to the constructor of the base exception GenericError.

Each exception also defines the ice_id function that returns the Slice type ID of the exception, as well as the __toString magic function to return a stringified representation of the exception and its members.

All user exceptions are derived from the base class Ice\UserException. This allows you to catch all user exceptions generically by installing a handler for Ice\UserException. Similarly, you can catch all Ice run-time exceptions with a handler for Ice\LocalException, and you can catch all Ice exceptions with a handler for Ice\Exception.

Back to Top ^

Optional Data Members

Optional data members use the same mapping as required data members, but an optional data member can also be set to the marker value \Ice\None to indicate that the member is unset. A well-behaved program must compare an optional data member to \Ice\None before using the member's value:

PHP
try
{
    ...
}
catch(\Ice\Exception $ex)
{
    if($ex->optionalMember == \Ice\None)
    {
        echo "optionalMember is unset\n";
    }
    else
    {
        echo "optionalMember = " . $ex->optionalMember . "\n";
    }
}

The \Ice\None marker value has different semantics than null. Since null is a legal value for certain Slice types, the Ice run time requires a separate marker value so that it can determine whether an optional value is set. An optional value set to null is considered to be set. If you need to distinguish between an unset value and a value set to null, you can do so as follows:

PHP
try
{
    ...
}
catch(\Ice\Exception $ex)
{
    if($ex->optionalMember == \Ice\None)
    {
        echo "optionalMember is unset\n";
    }
    else if($ex->optionalMember == null)
    {
        echo "optionalMember is null\n";
    }
    else
    {
        echo "optionalMember = " . $ex->optionalMember . "\n";
    }
}

Back to Top ^

PHP Mapping for Run-Time Exceptions

The Ice run time throws run-time exceptions for a number of pre-defined error conditions. All run-time exceptions directly or indirectly derive from \Ice\LocalException (which, in turn, derives from \Ice\Exception).

By catching exceptions at the appropriate point in the inheritance hierarchy, you can handle exceptions according to the category of error they indicate:

  • \Ice\LocalException
    This is the root of the inheritance tree for run-time exceptions.
  • \Ice\UserException
    This is the root of the inheritance tree for user exceptions.
  • \Ice\TimeoutException
    This is the base exception for both operation-invocation and connection-establishment timeouts.
  • \Ice\ConnectTimeoutException
    This exception is raised when the initial attempt to establish a connection to a server times out.

For example, \Ice\ConnectTimeoutException can be handled as \Ice\ConnectTimeoutException, \Ice\TimeoutException, \Ice\LocalException, or \Ice\Exception.

You will probably have little need to catch run-time exceptions as their most-derived type and instead catch them as \Ice\LocalException; the fine-grained error handling offered by the remainder of the hierarchy is of interest mainly in the implementation of the Ice run time. Exceptions to this rule are the exceptions related to facet and object life cycles, which you may want to catch explicitly. These exceptions are \Ice\FacetNotExistException and \Ice\ObjectNotExistException, respectively.

Back to Top ^

See Also