PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event Class Reference

Provides methods to analyze and format a ServerQuery event. More...

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event:

Public Member Functions
	__construct (StringHelper $evt, Host $con=null)
	getType ()
	getData ()
	getMessage ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	__get ($offset)
	__set ($offset, $value)

Protected Attributes
StringHelper	$type
array	$data
StringHelper	$mesg

Detailed Description

Provides methods to analyze and format a ServerQuery event.

Definition at line 20 of file Event.php.

Constructor & Destructor Documentation

__construct()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::__construct	(	StringHelper	$evt,
		Host	$con = null )

Creates a new PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event object.

Parameters

StringHelper	$evt
Host | null	$con

Exceptions

AdapterException
ServerQueryException

Definition at line 51 of file Event.php.

Member Function Documentation

__get()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::__get

(

$offset

)

Exceptions

ServerQueryException

@ignore

Definition at line 146 of file Event.php.

__set()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::__set	(		$offset,
			$value )

Exceptions

NodeException

@ignore

Definition at line 155 of file Event.php.

getData()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::getData

(

)

Returns the event data array.

Returns

array

Definition at line 89 of file Event.php.

getMessage()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::getMessage

(

)

Returns the event data as an unparsed string.

Returns

StringHelper

Definition at line 99 of file Event.php.

getType()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::getType

(

)

Returns the event type string.

Returns

StringHelper

Definition at line 79 of file Event.php.

offsetExists()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::offsetExists

(

$offset

)

@ignore

Definition at line 107 of file Event.php.

offsetGet()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::offsetGet

(

$offset

)

Exceptions

ServerQueryException

@ignore

Definition at line 116 of file Event.php.

offsetSet()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::offsetSet	(		$offset,
			$value )

Exceptions

NodeException

@ignore

Definition at line 129 of file Event.php.

offsetUnset()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::offsetUnset

(

$offset

)

@ignore

Definition at line 137 of file Event.php.

Member Data Documentation

$data

array PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::$data

protected

Definition at line 34 of file Event.php.

$mesg

StringHelper PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::$mesg

protected

Definition at line 41 of file Event.php.

$type

StringHelper PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery\Event::$type

protected

Definition at line 27 of file Event.php.

---

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

• src/Adapter/ServerQuery/Event.php