Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?php

> declare(strict_types=1); namespace GeoIp2\Model; >
/**
< * Model class for the data returned by GeoIP2 City web service and database.
> * Model class for the data returned by City Plus web service and City > * database.
*
< * The only difference between the City and Insights model classes is which < * fields in each record may be populated. See < * https://dev.maxmind.com/geoip/geoip2/web-services for more details.
> * See https://dev.maxmind.com/geoip/docs/web-services?lang=en for more > * details.
* * @property-read \GeoIp2\Record\City $city City data for the requested IP * address. * @property-read \GeoIp2\Record\Location $location Location data for the * requested IP address. * @property-read \GeoIp2\Record\Postal $postal Postal data for the * requested IP address. * @property-read array $subdivisions An array \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. * @property-read \GeoIp2\Record\Subdivision $mostSpecificSubdivision 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. */ class City extends Country { /** * @ignore
> * */ > * @var \GeoIp2\Record\City
protected $city;
>
/** * @ignore
> * */ > * @var \GeoIp2\Record\Location
protected $location;
>
/** * @ignore
> * */ > * @var \GeoIp2\Record\Postal
protected $postal;
>
/** * @ignore
> * */ > * @var array<\GeoIp2\Record\Subdivision>
protected $subdivisions = []; /** * @ignore
< * < * @param mixed $raw < * @param mixed $locales
*/
< public function __construct($raw, $locales = ['en'])
> public function __construct(array $raw, array $locales = ['en'])
{ parent::__construct($raw, $locales); $this->city = new \GeoIp2\Record\City($this->get('city'), $locales); $this->location = new \GeoIp2\Record\Location($this->get('location')); $this->postal = new \GeoIp2\Record\Postal($this->get('postal')); $this->createSubdivisions($raw, $locales); }
< private function createSubdivisions($raw, $locales)
> private function createSubdivisions(array $raw, array $locales): void
{ if (!isset($raw['subdivisions'])) { return; } foreach ($raw['subdivisions'] as $sub) {
< array_push( < $this->subdivisions,
> $this->subdivisions[] =
new \GeoIp2\Record\Subdivision($sub, $locales)
< );
> ;
} } /** * @ignore *
< * @param mixed $attr
> * @return mixed
*/
< public function __get($attr)
> public function __get(string $attr)
{ if ($attr === 'mostSpecificSubdivision') {
< return $this->$attr();
> return $this->{$attr}();
} return parent::__get($attr); } /** * @ignore
< * < * @param mixed $attr
*/
< public function __isset($attr)
> public function __isset(string $attr): bool
{ if ($attr === 'mostSpecificSubdivision') { // We always return a mostSpecificSubdivision, even if it is the // empty subdivision return true; } return parent::__isset($attr); }
< private function mostSpecificSubdivision()
> private function mostSpecificSubdivision(): \GeoIp2\Record\Subdivision
{ return empty($this->subdivisions) ? new \GeoIp2\Record\Subdivision([], $this->locales) : end($this->subdivisions); } }