Skip to content

Latest commit

 

History

History
713 lines (470 loc) · 12.9 KB

API_DOCUMENTATION.md

File metadata and controls

713 lines (470 loc) · 12.9 KB

Coordinates for Php

GitHub Workflow Status (master) Total Downloads Latest Version License

Enum: Powlam\Coordinates\Enums\Heading

Values

  • NORTH
  • SOUTH
  • EAST
  • WEST
  • UP
  • DOWN

Enum: Powlam\Coordinates\Enums\Place

Values

  • EARTH_CENTER
  • NORTH_POLE
  • NORTHERN_HEMISPHERE
  • EQUATOR
  • SOUTHERN_HEMISPHERE
  • SOUTH_POLE
  • ARCTIC
  • ARCTIC_CIRCLE
  • NORTH_TEMPERATE_ZONE
  • TROPIC_OF_CANCER
  • TROPICS
  • TROPIC_OF_CAPRICORN
  • SOUTH_TEMPERATE_ZONE
  • ANTARCTIC_CIRCLE
  • ANTARCTIC
  • PRIME_MERIDIAN
  • INTERNATIONAL_DATE_LINE
  • WESTERN_HEMISPHERE
  • EASTERN_HEMISPHERE

Method: name

Powlam\Coordinates\Enums\Place::name(): string

Method: get

Powlam\Coordinates\Enums\Place::get(): Powlam\Coordinates\LatLng|Powlam\Coordinates\LatLngAltitude|Powlam\Coordinates\LatLngBounds

Enum: Powlam\Coordinates\Enums\Units

Values

  • DEGREES
  • METERS
  • KILOMETERS

Interface: Powlam\Coordinates\Interfaces\KnowsPlaces

Method: isPlace

Powlam\Coordinates\Interfaces\KnowsPlaces::isPlace(Powlam\Coordinates\Enums\Place $place): bool

Interface: Powlam\Coordinates\Interfaces\Movable

Method: move

Powlam\Coordinates\Interfaces\Movable::move(Powlam\Coordinates\Enums\Heading $heading, float $distance, Powlam\Coordinates\Enums\Units $units = \Powlam\Coordinates\Enums\Units::DEGREES): static

Class: Powlam\Coordinates\LatLng

/**
 * @internal
 */

Implements

  • Stringable
  • Powlam\Coordinates\Interfaces\KnowsPlaces
  • Powlam\Coordinates\Interfaces\Movable

Uses Traits

  • Powlam\Coordinates\Traits\IsPlace

Method: __construct

Powlam\Coordinates\LatLng::__construct(float $latitude, float $longitude)

Method: getLatitude

Powlam\Coordinates\LatLng::getLatitude(): float

Method: getLongitude

Powlam\Coordinates\LatLng::getLongitude(): float

Method: equals

Powlam\Coordinates\LatLng::equals(self $other): bool

Method: __toString

Powlam\Coordinates\LatLng::__toString(): string

Method: toArray

/**
 * @return array{latitude: float, longitude: float}
 */
Powlam\Coordinates\LatLng::toArray(): array

Method: toUrlValue

Powlam\Coordinates\LatLng::toUrlValue(int $precision = 6): string

Method: toJson

Powlam\Coordinates\LatLng::toJson(): string|false

Method: toGeoJson

Powlam\Coordinates\LatLng::toGeoJson(): string|false

Method: fromArray

/**
 * @param  array{latitude: float, longitude: float}  $data
 */
Powlam\Coordinates\LatLng::fromArray(array $data): self

Method: move

Powlam\Coordinates\LatLng::move(Powlam\Coordinates\Enums\Heading $heading, float $distance, Powlam\Coordinates\Enums\Units $units = \Powlam\Coordinates\Enums\Units::DEGREES): static

Method: isPlace

Powlam\Coordinates\LatLng::isPlace(Powlam\Coordinates\Enums\Place $place): bool

Class: Powlam\Coordinates\LatLngAltitude

/**
 * @internal
 */

Implements

  • Stringable
  • Powlam\Coordinates\Interfaces\KnowsPlaces
  • Powlam\Coordinates\Interfaces\Movable

Uses Traits

  • Powlam\Coordinates\Traits\IsPlace

Constants

  • EARTH_RADIUS = 6371000.0

Method: __construct

/**
 * @param  float  $altitude  The altitude in meters. Zero is sea level.
 */
Powlam\Coordinates\LatLngAltitude::__construct(float $latitude, float $longitude, float $altitude)

Method: getLatitude

Powlam\Coordinates\LatLngAltitude::getLatitude(): float

Method: getLongitude

Powlam\Coordinates\LatLngAltitude::getLongitude(): float

Method: getAltitude

Powlam\Coordinates\LatLngAltitude::getAltitude(): float

Method: equals

Powlam\Coordinates\LatLngAltitude::equals(self $other): bool

Method: __toString

Powlam\Coordinates\LatLngAltitude::__toString(): string

Method: toArray

/**
 * @return array{latitude: float, longitude: float, altitude: float}
 */
Powlam\Coordinates\LatLngAltitude::toArray(): array

Method: toUrlValue

Powlam\Coordinates\LatLngAltitude::toUrlValue(int $precision = 6): string

Method: toJson

Powlam\Coordinates\LatLngAltitude::toJson(): string|false

Method: toGeoJson

Powlam\Coordinates\LatLngAltitude::toGeoJson(): string|false

Method: fromArray

/**
 * @param  array{latitude: float, longitude: float, altitude: float}  $data
 */
Powlam\Coordinates\LatLngAltitude::fromArray(array $data): self

Method: move

Powlam\Coordinates\LatLngAltitude::move(Powlam\Coordinates\Enums\Heading $heading, float $distance, Powlam\Coordinates\Enums\Units $units = \Powlam\Coordinates\Enums\Units::DEGREES): static

Method: isPlace

Powlam\Coordinates\LatLngAltitude::isPlace(Powlam\Coordinates\Enums\Place $place): bool

Class: Powlam\Coordinates\LatLngBounds

/**
 * @internal
 */

Implements

  • Stringable
  • Powlam\Coordinates\Interfaces\KnowsPlaces
  • Powlam\Coordinates\Interfaces\Movable

Uses Traits

  • Powlam\Coordinates\Traits\IsPlace

Method: __construct

Powlam\Coordinates\LatLngBounds::__construct(Powlam\Coordinates\LatLng $southwest, Powlam\Coordinates\LatLng $northeast)

Method: getSouthwest

Powlam\Coordinates\LatLngBounds::getSouthwest(): Powlam\Coordinates\LatLng

Method: getNortheast

Powlam\Coordinates\LatLngBounds::getNortheast(): Powlam\Coordinates\LatLng

Method: getSouthEast

Powlam\Coordinates\LatLngBounds::getSouthEast(): Powlam\Coordinates\LatLng

Method: getNorthWest

Powlam\Coordinates\LatLngBounds::getNorthWest(): Powlam\Coordinates\LatLng

Method: getNorth

Powlam\Coordinates\LatLngBounds::getNorth(): float

Method: getSouth

Powlam\Coordinates\LatLngBounds::getSouth(): float

Method: getEast

Powlam\Coordinates\LatLngBounds::getEast(): float

Method: getWest

Powlam\Coordinates\LatLngBounds::getWest(): float

Method: includes180thMeridian

Powlam\Coordinates\LatLngBounds::includes180thMeridian(): bool

Method: includes0thMeridian

Powlam\Coordinates\LatLngBounds::includes0thMeridian(): bool

Method: includesNthMeridian

Powlam\Coordinates\LatLngBounds::includesNthMeridian(float $n): bool

Method: includesAPole

Powlam\Coordinates\LatLngBounds::includesAPole(): bool

Method: includesBothPoles

Powlam\Coordinates\LatLngBounds::includesBothPoles(): bool

Method: includesNorthPole

Powlam\Coordinates\LatLngBounds::includesNorthPole(): bool

Method: includesSouthPole

Powlam\Coordinates\LatLngBounds::includesSouthPole(): bool

Method: includesEquator

Powlam\Coordinates\LatLngBounds::includesEquator(): bool

Method: isLine

Powlam\Coordinates\LatLngBounds::isLine(): bool

Method: isMeridian

Powlam\Coordinates\LatLngBounds::isMeridian(): bool

Method: isParallel

Powlam\Coordinates\LatLngBounds::isParallel(): bool

Method: isPoint

Powlam\Coordinates\LatLngBounds::isPoint(): bool

Method: getCenter

Powlam\Coordinates\LatLngBounds::getCenter(): Powlam\Coordinates\LatLng

Method: equals

Powlam\Coordinates\LatLngBounds::equals(self $other): bool

Method: __toString

Powlam\Coordinates\LatLngBounds::__toString(): string

Method: toArray

/**
 * @return array{southwest: array{latitude: float, longitude: float}, northeast: array{latitude: float, longitude: float}}
 */
Powlam\Coordinates\LatLngBounds::toArray(): array

Method: toSpan

/**
 * @return array{latitude: float, longitude: float}
 */
Powlam\Coordinates\LatLngBounds::toSpan(): array

Method: toUrlValue

Powlam\Coordinates\LatLngBounds::toUrlValue(int $precision = 6): string

Method: toJson

Powlam\Coordinates\LatLngBounds::toJson(): string|false

Method: toGeoJson

Powlam\Coordinates\LatLngBounds::toGeoJson(): string|false

Method: fromArrays

/**
 * @param  array{latitude: float, longitude: float}  $southwest
 * @param  array{latitude: float, longitude: float}  $northeast
 */
Powlam\Coordinates\LatLngBounds::fromArrays(array $southwest, array $northeast): static

Method: move

Powlam\Coordinates\LatLngBounds::move(Powlam\Coordinates\Enums\Heading $heading, float $distance, Powlam\Coordinates\Enums\Units $units = \Powlam\Coordinates\Enums\Units::DEGREES): static

Method: contains

Powlam\Coordinates\LatLngBounds::contains(Powlam\Coordinates\LatLng $latLng): bool

Method: intersects

Powlam\Coordinates\LatLngBounds::intersects(Powlam\Coordinates\LatLngBounds $bounds): bool

Method: extend

/**
 * Extends this bounds to contain the given point.
 * The extension will head west or east depending on the closest side, or east in case of a tie.
 */
Powlam\Coordinates\LatLngBounds::extend(Powlam\Coordinates\LatLng $point): static

Method: union

Powlam\Coordinates\LatLngBounds::union(Powlam\Coordinates\LatLngBounds $bounds): static

Method: isPlace

Powlam\Coordinates\LatLngBounds::isPlace(Powlam\Coordinates\Enums\Place $place): bool

Trait: Powlam\Coordinates\Traits\IsPlace

Method: isPlace

Powlam\Coordinates\Traits\IsPlace::isPlace(Powlam\Coordinates\Enums\Place $place): bool

Class: Powlam\Coordinates\Utils\FloatCompare

Constants

  • COMPARISON_TOLERANCE = 1.0E-6

Method: equals

Powlam\Coordinates\Utils\FloatCompare::equals(float $a, float $b): bool

Method: equalOrGreaterThan

Powlam\Coordinates\Utils\FloatCompare::equalOrGreaterThan(float $a, float $b): bool

Method: equalOrLessThan

Powlam\Coordinates\Utils\FloatCompare::equalOrLessThan(float $a, float $b): bool

Method: greaterThan

Powlam\Coordinates\Utils\FloatCompare::greaterThan(float $a, float $b): bool

Method: lessThan

Powlam\Coordinates\Utils\FloatCompare::lessThan(float $a, float $b): bool

Class: Powlam\Coordinates\Utils\Latitude

Constants

  • METERS_PER_DEGREE = 111319.9
  • KILOMETERS_PER_DEGREE = 111.3199

Method: degreesFromMeters

Powlam\Coordinates\Utils\Latitude::degreesFromMeters(float $meters): float

Method: degreesFromKilometers

Powlam\Coordinates\Utils\Latitude::degreesFromKilometers(float $kilometers): float

Method: metersPerDegree

Powlam\Coordinates\Utils\Latitude::metersPerDegree(): float

Method: kilometersPerDegree

Powlam\Coordinates\Utils\Latitude::kilometersPerDegree(): float

Method: metersFromDegrees

Powlam\Coordinates\Utils\Latitude::metersFromDegrees(float $degrees): float

Method: kilometersFromDegrees

Powlam\Coordinates\Utils\Latitude::kilometersFromDegrees(float $degrees): float

Class: Powlam\Coordinates\Utils\Longitude

Constants

  • METERS_PER_DEGREE_AT_EQUATOR = 111319.9
  • KILOMETERS_PER_DEGREE_AT_EQUATOR = 111.3199

Method: degreesFromMeters

Powlam\Coordinates\Utils\Longitude::degreesFromMeters(float $meters, float $latitudeDegrees): float

Method: degreesFromKilometers

Powlam\Coordinates\Utils\Longitude::degreesFromKilometers(float $kilometers, float $latitudeDegrees): float

Method: metersPerDegree

Powlam\Coordinates\Utils\Longitude::metersPerDegree(float $latitudeDegrees): float

Method: kilometersPerDegree

Powlam\Coordinates\Utils\Longitude::kilometersPerDegree(float $latitudeDegrees): float

Method: metersFromDegrees

Powlam\Coordinates\Utils\Longitude::metersFromDegrees(float $degrees, float $latitudeDegrees): float

Method: kilometersFromDegrees

Powlam\Coordinates\Utils\Longitude::kilometersFromDegrees(float $degrees, float $latitudeDegrees): float

Coordinates for PHP was created by Paul Albandoz under the MIT license.