MapArchive
in package
analyse les fichiers d'une archive d'une carte pour évaluer sa validité et afficher le contenu
Table of Contents
Properties
- $mapCat : MapCatItem|null
- enregistrement dans MapCat correspondant à la carte ou null
- $mapNum : string
- no sur 4 chiffres
- $rpathOf7z : string
- chemin du fichier .7z relativement à $PF_PATH et commencant par '/'
- $insets : array<string, GeoRefImage>
- les cartouches [{name}=> GeoRefImage]
- $main : GeoRefImage
- les caractéristiques de l'image principale et les MD de la carte
- $suppls : array<string, int>
- liste de noms de fichiers hors specs sous la forme [{name} => 1]
- $thumbnail : string|null
- chemin de la vignette dans l'archive
- $type : string
- 'undefined'|'normal'|'special'
Methods
- __construct() : mixed
- fabrique un MapArchive
- check() : void
- georefBox() : GBox|null
- Retourne le GBox de géoréférencement de la carte.
- gtiffs() : array<int, string>
- retourne la liste des GéoTiffs géoréférencés
- invalid() : array<string, array<int, string>>
- Teste la conformité à la spec et au catalogue.
- main() : GeoRefImage
- mappingInsetsWithMapCat() : array<string, string>
- construit la correspondance des cartouches de l'archive avec ceux de MapCat.
- showAsHtml() : void
- affiche le contenu de l'archive en Html comme table Html sans les balises <table> et </table> Si $mapCatUpdateOrCreate alors affiche la possibilité de modifier/créer l'enregistrement MapCat Cela est fait en rappellant le script avec l'action updateMapCat ou insertMapCat et le num de la carte
- showAsYaml() : void
- Affichage limité utilisé par la version CLI
- showWithOptions() : void
- Affichage avec options utilisé par la version CLI
Properties
$mapCat read-only
enregistrement dans MapCat correspondant à la carte ou null
public
MapCatItem|null
$mapCat
$mapNum read-only
no sur 4 chiffres
public
string
$mapNum
$rpathOf7z read-only
chemin du fichier .7z relativement à $PF_PATH et commencant par '/'
public
string
$rpathOf7z
$insets
les cartouches [{name}=> GeoRefImage]
protected
array<string, GeoRefImage>
$insets
= []
$main
les caractéristiques de l'image principale et les MD de la carte
protected
GeoRefImage
$main
$suppls
liste de noms de fichiers hors specs sous la forme [{name} => 1]
protected
array<string, int>
$suppls
= []
$thumbnail
chemin de la vignette dans l'archive
protected
string|null
$thumbnail
= null
$type
'undefined'|'normal'|'special'
protected
string
$type
= 'undefined'
Methods
__construct()
fabrique un MapArchive
public
__construct(string $rpathOf7z) : mixed
Parameters
- $rpathOf7z : string
-
le chemin relatif du fichier .7z
check()
public
static check(string $path, array<string, mixed> $options) : void
Parameters
- $path : string
- $options : array<string, mixed>
georefBox()
Retourne le GBox de géoréférencement de la carte.
public
georefBox() : GBox|null
retourne le géoréférencement de l'image principale SI elle existe et est géoréférencée SINON S'il n'y a pas d'image principale ALORS retourne null // cas d'erreur SINON // il y a une image principale et elle n'est pas géoréférencée S'il y a des cartouches ALORS retourne l'union des cartouches SINON retourne null // cas d'erreur, evt carte spéciale
Return values
GBox|nullgtiffs()
retourne la liste des GéoTiffs géoréférencés
public
gtiffs() : array<int, string>
Return values
array<int, string>invalid()
Teste la conformité à la spec et au catalogue.
public
invalid() : array<string, array<int, string>>
retourne [] si la carte est valide et conforme à sa description dans le catalogue et sans alertes sinon un array comportant un au moins des 2 champs:
- errors listant les erreurs
- warnings listant les alertes
Return values
array<string, array<int, string>>main()
public
main() : GeoRefImage
Return values
GeoRefImagemappingInsetsWithMapCat()
construit la correspondance des cartouches de l'archive avec ceux de MapCat.
public
mappingInsetsWithMapCat([bool $show = false ]) : array<string, string>
Le résultat est un array avec en clés les noms des cartouches dans l'archive et en valeurs les titres des cartouches dans MapCat
Parameters
- $show : bool = false
Return values
array<string, string>showAsHtml()
affiche le contenu de l'archive en Html comme table Html sans les balises <table> et </table> Si $mapCatUpdateOrCreate alors affiche la possibilité de modifier/créer l'enregistrement MapCat Cela est fait en rappellant le script avec l'action updateMapCat ou insertMapCat et le num de la carte
public
showAsHtml([bool $mapCatUpdateOrCreate = false ]) : void
Parameters
- $mapCatUpdateOrCreate : bool = false
showAsYaml()
Affichage limité utilisé par la version CLI
public
showAsYaml() : void
showWithOptions()
Affichage avec options utilisé par la version CLI
public
showWithOptions(array<string, mixed> $options) : void
Parameters
- $options : array<string, mixed>