phpDocumentor

FeaturesApi extends WfsGeoJson
in package

Classe permettant d'interroger un serveur WFS comme une Api OGC Features

Table of Contents

Constants

CAP_CACHE  = __DIR__ . '/wfscapcache'
chemin du répertoire dans lequel sont stockés les fichiers XML de capacités ainsi que les DescribeFeatureType en json
LOG  = __DIR__ . '/wfsserver.log.yaml'
chemin du fichier de log ou false pour pas de log

Properties

$options  : array<string, mixed>
sous la forme ['option'=> valeur]
$serverUrl  : string
URL du serveur

Methods

__construct()  : mixed
collection()  : array<string, mixed>
retourne la description du FeatureType de la collection
collections()  : array<int, array{id: string, title: string}>
retourne la liste des collections exposées définies par leur id et leur titre
describeFeatureType()  : array<string, mixed>
featureTypeList()  : array<string, array<string, string>>
liste les couches exposées evt filtré par l'URL des MD
geomPropertyName()  : string|null
nom de la propriété géométrique du featureType
getCapabilities()  : string
effectue un GetCapabities et retourne le XML. Utilise le cache sauf si force=true
getFeature()  : string
retourne le résultat de la requête en GeoJSON
getFeatureAsArray()  : TGeoJsonFeatureCollection
retourne le résultat de la requête en GeoJSON encodé en array Php
getNumberMatched()  : int
retourne le nbre d'objets correspondant au résultat de la requête
items()  : TGeoJsonFeatureCollection
retourne les items de la collection comme array Php
output()  : never
génère un affichage en JSON ou Yaml en fonction du paramètre $f
printAllFeatures()  : void
affiche le résultat de la requête en GeoJSON
query()  : string
envoi une requête et récupère la réponse sous la forme d'un texte
url()  : string
construit l'URL de la requête à partir des paramètres

Constants

CAP_CACHE

chemin du répertoire dans lequel sont stockés les fichiers XML de capacités ainsi que les DescribeFeatureType en json

public mixed CAP_CACHE = __DIR__ . '/wfscapcache'

LOG

chemin du fichier de log ou false pour pas de log

public mixed LOG = __DIR__ . '/wfsserver.log.yaml'

Properties

$options

sous la forme ['option'=> valeur]

protected array<string, mixed> $options

Methods

__construct()

public __construct(string $serverUrl[, array<string, mixed> $options = [] ]) : mixed
Parameters
$serverUrl : string
$options : array<string, mixed> = []

collection()

retourne la description du FeatureType de la collection

public collection(string $id) : array<string, mixed>
Parameters
$id : string
Return values
array<string, mixed>

collections()

retourne la liste des collections exposées définies par leur id et leur titre

public collections() : array<int, array{id: string, title: string}>
Return values
array<int, array{id: string, title: string}>

describeFeatureType()

public abstract describeFeatureType(string $typeName) : array<string, mixed>
Parameters
$typeName : string
Return values
array<string, mixed>

featureTypeList()

liste les couches exposées evt filtré par l'URL des MD

public featureTypeList([string $metadataUrl = null ]) : array<string, array<string, string>>
Parameters
$metadataUrl : string = null
Return values
array<string, array<string, string>>

geomPropertyName()

nom de la propriété géométrique du featureType

public abstract geomPropertyName(string $typeName) : string|null
Parameters
$typeName : string
Return values
string|null

getCapabilities()

effectue un GetCapabities et retourne le XML. Utilise le cache sauf si force=true

public getCapabilities([bool $force = false ]) : string
Parameters
$force : bool = false
Return values
string

getFeature()

retourne le résultat de la requête en GeoJSON

public abstract getFeature(string $typename[, int $zoom = -1 ][, string $where = '' ][, int $count = 100 ][, int $startindex = 0 ]) : string
Parameters
$typename : string
$zoom : int = -1
$where : string = ''
$count : int = 100
$startindex : int = 0
Return values
string

getFeatureAsArray()

retourne le résultat de la requête en GeoJSON encodé en array Php

public abstract getFeatureAsArray(string $typename[, int $zoom = -1 ][, string $where = '' ][, int $count = 100 ][, int $startindex = 0 ]) : TGeoJsonFeatureCollection
Parameters
$typename : string
$zoom : int = -1
$where : string = ''
$count : int = 100
$startindex : int = 0
Return values
TGeoJsonFeatureCollection

getNumberMatched()

retourne le nbre d'objets correspondant au résultat de la requête

public abstract getNumberMatched(string $typename[, string $where = '' ]) : int
Parameters
$typename : string
$where : string = ''
Return values
int

items()

retourne les items de la collection comme array Php

public items(string $collId[, int $count = 100 ][, int $startindex = 0 ]) : TGeoJsonFeatureCollection
Parameters
$collId : string
$count : int = 100
$startindex : int = 0
Return values
TGeoJsonFeatureCollection

output()

génère un affichage en JSON ou Yaml en fonction du paramètre $f

public static output(string $f, array<string|int, mixed> $array[, int $levels = 3 ]) : never
Parameters
$f : string
$array : array<string|int, mixed>
$levels : int = 3
Return values
never

printAllFeatures()

affiche le résultat de la requête en GeoJSON

public abstract printAllFeatures(string $typename[, int $zoom = -1 ][, string $where = '' ]) : void
Parameters
$typename : string
$zoom : int = -1
$where : string = ''

query()

envoi une requête et récupère la réponse sous la forme d'un texte

public query(array<string, mixed> $params) : string
Parameters
$params : array<string, mixed>
Return values
string

url()

construit l'URL de la requête à partir des paramètres

public url(array<string, mixed> $params) : string
Parameters
$params : array<string, mixed>
Return values
string

        
On this page

Search results