API Documentation
\

\Hd3Test

Summary

Methods
Properties
Constants
testUsernameRequired()
testSecretRequired()
testPassedConfig()
testDefaultFileConfig()
testDefaultSetup()
testManualSetup()
testInvalidCredentials()
deviceVendors()
deviceModels()
deviceView()
deviceWhatHas()
siteDetect()
testCloudApiCalls()
testCloudProxyApiCalls()
testUltimateFetchTrees()
testUltimateFetchTreesFail()
testUltimateFetchSpecs()
testUltimateFetchSpecsFail()
testUltimateFetchArchive()
testUltimateApiCalls()
$devices
$notFoundHeaders
$deviceHeaders
$fileDevice10
No constants found
setUp()
tearDown()
No protected properties found
N/A
_compareDevices()
_rmDirFiles()
No private properties found
N/A

Properties

$devices

$devices :

Type

$notFoundHeaders

$notFoundHeaders :

Type

$deviceHeaders

$deviceHeaders :

Type

$fileDevice10

$fileDevice10 :

Type

Methods

testUsernameRequired()

testUsernameRequired()

Test for runtime exception

testSecretRequired()

testSecretRequired()

Test for runtime exception

testPassedConfig()

testPassedConfig()

Test for a config passed to the constructor

testDefaultFileConfig()

testDefaultFileConfig()

Test for default config readon from config file

testDefaultSetup()

testDefaultSetup()

Test for default http headers read when a new object is instantiated

testManualSetup()

testManualSetup()

Test for manual setting of http headers

testInvalidCredentials()

testInvalidCredentials()

Test for invalis API credentials

deviceVendors()

deviceVendors(boolean  $local = false, boolean  $proxy = false) : void

Test for deviceVendors

The list is continually growing so ensure its a min length and common vendors are present

Parameters

boolean $local

: True if running in local mode, false otherwise
boolean $proxy

: True if using proxy for API queries

deviceModels()

deviceModels(boolean  $local = false, boolean  $proxy = false) : void

Test for deviceModels

This list is also continually growing so ensure its a minimum length

Parameters

boolean $local

: True if running in local mode, false otherwise
boolean $proxy

: True if using proxy for API queries

deviceView()

deviceView(boolean  $local = false, boolean  $proxy = false) : void

Test for deviceView

View detailed information about one device

Parameters

boolean $local

: True if running in local mode, false otherwise
boolean $proxy

: True if using proxy for API queries

deviceWhatHas()

deviceWhatHas(boolean  $local = false, boolean  $proxy = false) : void

Test for deviceWhatHas

Find which devices have a specific property

Parameters

boolean $local

: True if running in local mode, false otherwise
boolean $proxy

: True if using proxy for API queries

siteDetect()

siteDetect(boolean  $local = false, boolean  $proxy = false) : void

Perform a battery of detection tests

Uses the headers in $this->notFoundHeaders and $this->deviceHeaders to test for common detection replys

Parameters

boolean $local

: True if running in local mode, false otherwise
boolean $proxy

: True if using proxy for API queries

testCloudApiCalls()

testCloudApiCalls() : void

Runs the Api tests against the Cloud web service

testCloudProxyApiCalls()

testCloudProxyApiCalls() : void

Runs the same tests as testCloudApiCalls() but through a proxy

testUltimateFetchTrees()

testUltimateFetchTrees() : void

Test fetching the detection trees

Deprecated in 4.0 : Replaced by testUltimateFetchArchive

testUltimateFetchTreesFail()

testUltimateFetchTreesFail() : void

Test invalid credentials for accessing fetchTrees

Deprecated in 4.0 : Replaced by testUltimateFetchArchive

testUltimateFetchSpecs()

testUltimateFetchSpecs() : void

Fetch the device specs

Deprecated in 4.0 : Replaced by testUltimateFetchArchive

testUltimateFetchSpecsFail()

testUltimateFetchSpecsFail() : void

Test invalid credentials for accessing fetchSpecs

Deprecated in 4.0 : Replaced by testUltimateFetchArchive

testUltimateFetchArchive()

testUltimateFetchArchive() : void

Test fetchArchive

testUltimateApiCalls()

testUltimateApiCalls()

Test Ultimate mode for API calls

setUp()

setUp()

tearDown()

tearDown()

_compareDevices()

_compareDevices(array  $check, array  $fetch,   $string = '') : void

Compare a device to our static boilerplate

Parameters

array $check

The reference boilerplate device (see $this->devices)
array $fetch

The fetched device
$string

_rmDirFiles()

_rmDirFiles(string  $dir) : void

Helper function to remove all files from a directory http://php.net/manual/en/function.rmdir.php

Parameters

string $dir

Directory name