phpDocumentor

lib

Table of Contents

Classes

Access
Regroupe la logique du contrôle d'accès
Cache
classe statique implémentant la gestion du cache des tuiles
EnvVar
gestion des variables d'environnement et de leur valeur par défaut
GeoJsonPolygon
GeoJSON Polygon transformé en GBox
GdalInfo
extrait des infos d'un fichier JSON généré par gdalinfo
GeoTiff
un GéoTiff Shom qui sait notamment se décomposer en dalles
Http
classe portant le méthode getHttpError()
Style
Définition d'un Style de représentation graphique des objets vecteurs inspiré de celui utilisé par Leaflet
GeoRefImage
représente une image géo-référencée
IsoMd
Récupération de MD ISO d'un GéoTiff
Layer
classe abstraite correspondant à une couche du serveur de cartes
PyrLayer
couche Pyramide
LabelLayer
couche d'étiquettes, permet de dessiner les étiquettes associées aux GéoTiffs
TiffLayer
couche correspondant à un ensemble de GéoTiff juxtaposés
TempMapCat
charge le catalogue de cartes et sait retourner pour un gtname les infos correspondantes
SExcept
Exception avec code string
StyleLib
Gestion de la bibliothèque des styles stockée dans le fichier yaml
VectorLayer
Couche d'objets vecteur + dictionnaire de ces couches
WmsServer
classe abstraite WmsServer de gestion du dialogue du serveur avec le client
WmsServerTest
Test d'utilisation de la classe WmsServer
Zoom
classe regroupant l'intelligence autour du tuilage et des niveaux de zoom

Constants

COOKIE_NAME  = 'shomusrpwd'
nom du cookie utilisé pour le login
HTTP_ERROR_CODES  = [ 204 => 'No Content', // Requête traitée avec succès mais pas d’information à renvoyer. 400 => 'Bad Request', // paramètres en entrée incorrects 401 => 'Unauthorized', // Une authentification est nécessaire pour accéder à la ressource. 403 => 'Forbidden', // accès interdit 404 => 'File Not Found', // ressource demandée non disponible 410 => 'Gone', // La ressource n'est plus disponible et aucune adresse de redirection n’est connue 500 => 'Internal Server Error', ]
liste de qqs codes d'erreur Http avec leur label

Functions

config()  : string|array<string, mixed>
error()  : never
en cas d'erreur dans la génération
sendErrorTile()  : never
Création et affichage d'une image d'erreur
execCmde()  : array<string, string|int>
execCmde - exécute une commande Linux - enrobage de exec()
download()  : int
téléchargement d'un fichier en utilisant la commande wget
geotiffs()  : array<int, string>
liste des GeoTiffs
log_table_schema()  : string
retourne la commande SQL de création de la table
write_log()  : bool
enregistrement d'un log
readMapVersion()  : array{version: string, dateStamp: string}
extrait du fichier MD ISO dont le path est fourni la version de la carte et la date dateStamp

Constants

COOKIE_NAME

nom du cookie utilisé pour le login

public mixed COOKIE_NAME = 'shomusrpwd'

HTTP_ERROR_CODES

liste de qqs codes d'erreur Http avec leur label

public mixed HTTP_ERROR_CODES = [ 204 => 'No Content', // Requête traitée avec succès mais pas d’information à renvoyer. 400 => 'Bad Request', // paramètres en entrée incorrects 401 => 'Unauthorized', // Une authentification est nécessaire pour accéder à la ressource. 403 => 'Forbidden', // accès interdit 404 => 'File Not Found', // ressource demandée non disponible 410 => 'Gone', // La ressource n'est plus disponible et aucune adresse de redirection n’est connue 500 => 'Internal Server Error', ]

Functions

config()

config(string $rubrique) : string|array<string, mixed>
Parameters
$rubrique : string
Return values
string|array<string, mixed>

error()

en cas d'erreur dans la génération

error(string $message) : never
Parameters
$message : string
Return values
never

sendErrorTile()

Création et affichage d'une image d'erreur

sendErrorTile(string $tileid, string $message[, string $symbol = 'undef' ][, string $color = 'FF0000' ][, int $width = 128 ][, int $height = 128 ]) : never
Parameters
$tileid : string
$message : string
$symbol : string = 'undef'
$color : string = 'FF0000'
$width : int = 128
$height : int = 128
Return values
never

execCmde()

execCmde - exécute une commande Linux - enrobage de exec()

execCmde(string $cmde, int $verbose) : array<string, string|int>

retourne [] ssi tout est ok, cad le retour d'exec() !== false && $result_code == 0 sinon retourne ['result_code'=> {result_code}, 'output'=> {output}]

Parameters
$cmde : string
  • commande linux à exécuter
$verbose : int
  • degré de verbosité
Return values
array<string, string|int>

download()

téléchargement d'un fichier en utilisant la commande wget

download(string $url, string $outputFile, int $verbose) : int

effectue un wget sur l'url et stocke le résultat dans $outputFile ; retourne le code http ; si code<>200 le fichier est vide Utilise les variables d'environnement http_proxy: et https_proxy si elles sont définies ainsi que le login/passwd défini dans l'URL du serveur

Parameters
$url : string
$outputFile : string
$verbose : int
Return values
int

geotiffs()

liste des GeoTiffs

geotiffs() : array<int, string>
Return values
array<int, string>

log_table_schema()

retourne la commande SQL de création de la table

log_table_schema() : string
Return values
string

write_log()

enregistrement d'un log

write_log(bool $access) : bool
Parameters
$access : bool
Return values
bool

readMapVersion()

extrait du fichier MD ISO dont le path est fourni la version de la carte et la date dateStamp

readMapVersion(string $path) : array{version: string, dateStamp: string}

La version est fournie sous la forme d'une chaine "${anneeEdition}c${lastUpdate}"

Parameters
$path : string
Return values
array{version: string, dateStamp: string} 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results