1. class
  2. Joserick
  3. \
  4. PHPlex
  5. \
  6. Exception
  7. \
  8. Plex_Exception_Machine

Plex_Exception_Machine

class Plex_Exception_Machine extends Plex_ExceptionAbstract

Exception to be thrown for any problems at the machine level.

Constants

DEFAULT_MESSAGE

The default error message if no error message can be found.
DEFAULT_CODE

The default error code if no error code can be found.
INVALID_EXCEPTION_TYPE_MESSAGE

If an invalid type is thrown against an exception a higher level exception will be thrown. This message is shown in that case.

Properties

protected mixed[] $validTypes List of valid exception types for the machine exception class.

Methods

void
__construct(string $type, mixed[] $params = array())

Constructor for an exception. This makes sure the type being set up is valid, gets the code and message of the exception type and instantiates a PHP Exception object.

from Plex_ExceptionAbstract
boolean
isValidType(string $type)

Makes sure the type of exception being thrown is valid for the module trying to throw the exception.

from Plex_ExceptionAbstract
integer
getCodeForType(string $type)

Every valid exception type should have an HTTP code with which it is associated. This method brings back said code for the given exception type.

from Plex_ExceptionAbstract
string
getMessageForType(string $type, mixed[] $params = array())

Every valid exception type should have a message with which it is associated. This method brings back said message for the given exception type.

from Plex_ExceptionAbstract
mixed[]
getValidTypes()

Module specific exceptions will have a defined set of exception types they are allowed to throw. This method will list the valid exception types for the instantiated exception class.

from Plex_ExceptionAbstract

Details

in Plex_ExceptionAbstract at line 87
void __construct(string $type, mixed[] $params = array())

Constructor for an exception. This makes sure the type being set up is valid, gets the code and message of the exception type and instantiates a PHP Exception object.

Parameters

string $type The type of exception being thrown.
mixed[] $params Optional parameters that can be used to fill in variables in the exception message.

Return Value

void

Exceptions

Exception Type exception is not supported

in Plex_ExceptionAbstract at line 119
boolean isValidType(string $type)

Makes sure the type of exception being thrown is valid for the module trying to throw the exception.

Parameters

string $type The type of exception being thrown.

Return Value

boolean Whether or not the type of exception being thrown is valid for the module trying to throw the exception.

in Plex_ExceptionAbstract at line 135
integer getCodeForType(string $type)

Every valid exception type should have an HTTP code with which it is associated. This method brings back said code for the given exception type.

Parameters

string $type The type of exception being thrown.

Return Value

integer The HTTP code for the given exception type.

in Plex_ExceptionAbstract at line 157
string getMessageForType(string $type, mixed[] $params = array())

Every valid exception type should have a message with which it is associated. This method brings back said message for the given exception type.

Parameters

string $type The type of exception being thrown.
mixed[] $params An array of values that will fill in variables in the message. This is used for exception messages that can not be static.

Return Value

string The message of the exception being thrown. If parameters were passed and correclty correlated, the variables in the message will be properly filled in.

in Plex_ExceptionAbstract at line 180
mixed[] getValidTypes()

Module specific exceptions will have a defined set of exception types they are allowed to throw. This method will list the valid exception types for the instantiated exception class.

Return Value

mixed[] Associative array of exception types for the instantiated exception class.