PHP Classes
elePHPant
Icontem

File: docs/phpGPX-Models-Collection.md

Recommend this page to a friend!
  Classes of Jakub Dubec  >  PHP GPX Library  >  docs/phpGPX-Models-Collection.md  >  Download  
File: docs/phpGPX-Models-Collection.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: PHP GPX Library
Parser and generator of GPS Exchange files
Author: By
Last change:
Date: 1 year ago
Size: 2,478 bytes
 

Contents

Class file image Download

phpGPX\Models\Collection

Class Collection

Properties

$name

public string $name

GPS name of route / track.

An original GPX 1.1 attribute.

  • Visibility: public

$comment

public string $comment

GPS comment for route.

An original GPX 1.1 attribute.

  • Visibility: public

$description

public string $description

Text description of route/track for user. Not sent to GPS.

An original GPX 1.1 attribute.

  • Visibility: public

$source

public string $source

Source of data. Included to give user some idea of reliability and accuracy of data.

An original GPX 1.1 attribute.

  • Visibility: public

$links

public array<mixed,\phpGPX\Models\Link> $links

Links to external information about the route/track.

An original GPX 1.1 attribute.

  • Visibility: public

$number

public integer $number

GPS route/track number.

An original GPX 1.1 attribute.

  • Visibility: public

$type

public string $type

Type (classification) of route/track.

An original GPX 1.1 attribute.

  • Visibility: public

$extensions

public \phpGPX\Models\Extensions $extensions

You can add extend GPX by adding your own elements from another schema here.

An original GPX 1.1 attribute.

  • Visibility: public

$stats

public \phpGPX\Models\Stats $stats

Objects contains calculated statistics for collection.

  • Visibility: public

Methods

__construct

mixed phpGPX\Models\Collection::__construct()

Collection constructor.

  • Visibility: public

getPoints

array<mixed,\phpGPX\Models\Point> phpGPX\Models\Collection::getPoints()

Return all points in collection.

  • Visibility: public
  • This method is abstract.

toArray

array phpGPX\Models\Summarizable::toArray()

Serialize object to array

recalculateStats

void phpGPX\Models\StatsCalculator::recalculateStats()

Recalculate stats objects.