PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException Class Reference

Enhanced exception class for PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery objects. More...

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException:

Public Member Functions
	__construct (string $mesg, int $code=0x00, $return_code=null)
	hasReturnCode ()
	getReturnCode ()
Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Exception\TeamSpeak3Exception
	__construct (string $mesg, int $code=0x00)
	getRawCode ()
	getRawMessage ()
	getSender ()

Protected Attributes
string	$return_code
Protected Attributes inherited from PlanetTeamSpeak\TeamSpeak3Framework\Exception\TeamSpeak3Exception
int	$raw_code = 0x00
StringHelper string null	$raw_mesg = null

Additional Inherited Members
Static Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Exception\TeamSpeak3Exception
static	registerCustomMessage (int $code, string $mesg)
static	unregisterCustomMessage (int $code)
Protected Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Exception\TeamSpeak3Exception
	prepareCustomMessage (StringHelper $mesg)
Static Protected Attributes inherited from PlanetTeamSpeak\TeamSpeak3Framework\Exception\TeamSpeak3Exception
static array	$messages = []

Detailed Description

Enhanced exception class for PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery objects.

Definition at line 11 of file ServerQueryException.php.

Constructor & Destructor Documentation

__construct()

PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException::__construct	(	string	$mesg,
		int	$code = 0x00,
			$return_code = null )

The PlanetTeamSpeak\TeamSpeak3Framework\ServerQuery\Exception constructor.

Parameters

string	$mesg
integer	$code
string	$return_code

Definition at line 27 of file ServerQueryException.php.

Member Function Documentation

getReturnCode()

PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException::getReturnCode

(

)

Returns the optional return code for ServerQuery errors.

Returns

string|null

Definition at line 49 of file ServerQueryException.php.

hasReturnCode()

PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException::hasReturnCode

(

)

Returns TRUE if the exception provides a return code for ServerQuery errors.

Returns

boolean

Definition at line 39 of file ServerQueryException.php.

Member Data Documentation

$return_code

string PlanetTeamSpeak\TeamSpeak3Framework\Exception\ServerQueryException::$return_code

protected

Definition at line 18 of file ServerQueryException.php.

---

The documentation for this class was generated from the following file:

• src/Exception/ServerQueryException.php