Class GameQ\GameQ

Base GameQ Class This class should be the only one that is included when you use GameQ to query any games servers. Requirements: See wiki or README for more information on the requirements

PHP 5.4.14+
- Bzip2 - http://www.php.net/manual/en/book.bzip2.php

Located at GameQ/GameQ.php

Methods


					
	public
					static

factory(): GameQ

Create a new instance of this class


					
	public

__get(mixed $option): mixed|null

Get an option's value


					
	public

__set(mixed $option, mixed $value): bool

Set an option's value


					
	public

getServers()


					
	public

getOptions()


					
	public

setOption(mixed $var, mixed $value): $this

Chainable call to __set, uses set as the actual setter


					
	public

addServer(array $server_info = []): $this

Add a single server


					
	public

addServers(array $servers = []): $this

Add multiple servers in a single call


					
	public

addServersFromFiles(array $files = []): $this

Add a set of servers from a file or an array of files. Supported formats: JSON

Throws

Exception


					
	public

clearServers(): $this

Clear all of the defined servers


					
	public

addFilter(string $filterName, array $options = []): $this

Add a filter to the processing list


					
	public

removeFilter(string $filterHash): $this

Remove an added filter


					
	public

listFilters(): array

Return the list of applied filters


					
	public

process(): array

Main method used to actually process all of the added servers and return the information

Throws

Exception


					
	protected

doChallenges()

Do server challenges, where required


					
	protected

doQueries()

Run the actual queries and get the response(s)


					
	protected

doParseResponse(Server $server): array

Parse the response for a specific server

Throws

Exception


					
	protected

doApplyFilters(array $results, Server $server): array

Apply any filters to the results

Constants
`public`		`PROTOCOLS_DIRECTORY = __DIR__ . '/Protocols'`	#

Properties
`protected static`	`self`	`$instance = null`	#
`protected`	`array`	`$options = [ 'debug' => false, 'timeout' => 3, 'filters' => ['normalize_d751713988987e9331980363e24189ce' => ['filter' => 'normalize', 'options' => []]], 'stream_timeout' => 200000, 'write_wait' => 500, 'capture_packets_file' => null, ]`	#
`protected`	`array`	`$servers = []`	#
`protected`	`string`	`$queryLibrary = 'GameQ\\Query\\Native'`	#
`protected`	`Core\|null`	`$query = null`	#
`public`	`bool`	`$debug`	#
`public`	`string`	`$capture_packets_file`	#
`public`	`int`	`$stream_timeout`	#
`public`	`int`	`$timeout`	#
`public`	`int`	`$write_wait`	#

Namespaces

Classes

Class GameQ\GameQ

Throws

Throws

Throws