PHP Класс Piwik\Plugins\UserCountry\LocationProvider\GeoIp

Наследование: extends Piwik\Plugins\UserCountry\LocationProvider

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$dbNames	array	Stores possible database file names categorized by the type of information GeoIP databases hold.
$geoIPDatabaseDir

Открытые методы

Метод	Описание
completeLocationResult ( array &$location )	Attempts to fill in some missing information in a GeoIP location.
getGeoIPDatabaseTypeFromFilename ( string $filename ) : string \| false	Returns the type of GeoIP database ('loc', 'isp' or 'org') based on the filename (eg, 'GeoLiteCity.dat', 'GeoIPISP.dat', etc).
getPathForGeoIpDatabase ( string $filename ) : string	Returns full path for a GeoIP database managed by Piwik.
getPathToGeoIpDatabase ( array $possibleFileNames ) : string \| false	Returns the path of an existing GeoIP database or false if none can be found.
getRegionNameFromCodes ( string $countryCode, string $regionCode ) : string	Returns a region name for a country code + region code.
getRegionNames ( ) : array	Returns an array of region names mapped by country code & region code.
isDatabaseInstalled ( ) : boolean	Returns true if there is a GeoIP database in the 'misc' directory.
isWorking ( ) : boolean \| string	Returns true if this provider has been setup correctly, the error message if otherwise.

Защищенные методы

Метод	Описание
fixupLocation ( &$location )	Fix up data to work with our SVG maps which include 'Tib' boundaries

Приватные методы

Метод	Описание
getTestIpAndResult ( ) : array	Returns test IP used by isWorking and expected result.

Описание методов

completeLocationResult() публичный Метод

This method will call LocationProvider::completeLocationResult and then try to set the region name of the location if the country code & region code are set.

public completeLocationResult ( array &$location )
$location	array	The location information to modify.

fixupLocation() защищенный Метод

Fix up data to work with our SVG maps which include 'Tib' boundaries

protected fixupLocation ( &$location )

getGeoIPDatabaseTypeFromFilename() публичный статический Метод

Returns the type of GeoIP database ('loc', 'isp' or 'org') based on the filename (eg, 'GeoLiteCity.dat', 'GeoIPISP.dat', etc).

public static getGeoIPDatabaseTypeFromFilename ( string $filename ) : string \| false
$filename	string
Результат	string \| false	'loc', 'isp', 'org', or false if cannot find a database type.

getPathForGeoIpDatabase() публичный статический Метод

Returns full path for a GeoIP database managed by Piwik.

public static getPathForGeoIpDatabase ( string $filename ) : string
$filename	string	Name of the .dat file.
Результат	string

getPathToGeoIpDatabase() публичный статический Метод

Returns the path of an existing GeoIP database or false if none can be found.

public static getPathToGeoIpDatabase ( array $possibleFileNames ) : string \| false
$possibleFileNames	array	The list of possible file names for the GeoIP database.
Результат	string \| false

getRegionNameFromCodes() публичный статический Метод

Returns a region name for a country code + region code.

public static getRegionNameFromCodes ( string $countryCode, string $regionCode ) : string
$countryCode	string
$regionCode	string
Результат	string	The region name or 'Unknown' (translated).

getRegionNames() публичный статический Метод

Returns an array of region names mapped by country code & region code.

public static getRegionNames ( ) : array
Результат	array

isDatabaseInstalled() публичный статический Метод

Returns true if there is a GeoIP database in the 'misc' directory.

public static isDatabaseInstalled ( ) : boolean
Результат	boolean

isWorking() публичный Метод

Returns true if this provider has been setup correctly, the error message if otherwise.

public isWorking ( ) : boolean \| string
Результат	boolean \| string

Описание свойств

$dbNames публичное статическое свойство

Stores possible database file names categorized by the type of information GeoIP databases hold.

public static array $dbNames
Результат	array

$geoIPDatabaseDir публичное статическое свойство

public static $geoIPDatabaseDir