Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250530) (c39b7370636)
GeoIp2\Model\Insights Class Reference
Inheritance diagram for GeoIp2\Model\Insights:
GeoIp2\Model\City GeoIp2\Model\Country

Public Member Functions

 jsonSerialize ()
 

Public Attributes

CityRecord readonly CityRecord $city
 city data for the requested IP address
 
Continent readonly Continent $continent
 continent data for the requested IP address
 
CountryRecord readonly CountryRecord $country
 Country data for the requested IP address.
 
Location readonly Location $location
 location data for the requested IP address
 
MaxMind readonly MaxMind $maxmind
 data related to your MaxMind account
 
Subdivision readonly Subdivision $mostSpecificSubdivision
 An object representing the most specific subdivision returned.
 
Postal readonly Postal $postal
 postal data for the requested IP address
 
CountryRecord readonly CountryRecord $registeredCountry
 Registered country data for the requested IP address.
 
RepresentedCountry readonly RepresentedCountry $representedCountry
 Represented country data for the requested IP address.
 
array<\GeoIp2\Record\Subdivision > readonly array $subdivisions
 An array of GeoIp2\Record\Subdivision objects representing the country subdivisions for the requested IP address.
 
Traits readonly Traits $traits
 data for the traits of the requested IP address
 

Member Function Documentation

◆ jsonSerialize()

GeoIp2\Model\City::jsonSerialize ( )
inherited
Return values
array<string,mixed>|null

Reimplemented from GeoIp2\Model\Country.

Member Data Documentation

◆ $country

CountryRecord readonly CountryRecord GeoIp2\Model\Country::$country
inherited

Country data for the requested IP address.

This object represents the country where MaxMind believes the end user is located.

◆ $mostSpecificSubdivision

Subdivision readonly Subdivision GeoIp2\Model\City::$mostSpecificSubdivision
inherited

An object representing the most specific subdivision returned.

If the response did not contain any subdivisions, this method returns an empty GeoIp2\Record\Subdivision object.

◆ $registeredCountry

CountryRecord readonly CountryRecord GeoIp2\Model\Country::$registeredCountry
inherited

Registered country data for the requested IP address.

This record represents the country where the ISP has registered a given IP block and may differ from the user's country.

◆ $representedCountry

RepresentedCountry readonly RepresentedCountry GeoIp2\Model\Country::$representedCountry
inherited

Represented country data for the requested IP address.

The represented country is used for things like military bases. It is only present when the represented country differs from the country.

◆ $subdivisions

array<\GeoIp2\Record\Subdivision> readonly array GeoIp2\Model\City::$subdivisions
inherited

An array of GeoIp2\Record\Subdivision objects representing the country subdivisions for the requested IP address.

The number and type of subdivisions varies by country, but a subdivision is typically a state, province, county, etc. Subdivisions are ordered from most general (largest) to most specific (smallest). If the response did not contain any subdivisions, this method returns an empty array.


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