osm-labo/docs/export-stats-command.md

142 lines
No EOL
3.6 KiB
Markdown

# Commande d'export des objets Stats
## Description
La commande `app:export-stats` permet d'exporter les objets Stats au format JSON avec leurs propriétés de nom et de décomptes.
## Utilisation
### Export de tous les objets Stats
```bash
php bin/console app:export-stats
```
### Export avec formatage JSON
```bash
php bin/console app:export-stats --pretty
```
### Export vers un fichier spécifique
```bash
php bin/console app:export-stats --output=mon_export.json
```
### Export d'une zone spécifique
```bash
php bin/console app:export-stats --zone=75056
```
### Export avec toutes les options
```bash
php bin/console app:export-stats --output=paris_stats.json --zone=75056 --pretty
```
### Export avec mode verbeux
```bash
php bin/console app:export-stats -v
```
## Options disponibles
- `--output, -o` : Fichier de sortie (défaut: `stats_export.json`)
- `--zone, -z` : Code INSEE spécifique à exporter (optionnel)
- `--pretty, -p` : Formater le JSON avec indentation
- `-v, --verbose` : Mode verbeux pour afficher un aperçu des données
## Structure des données exportées
Le fichier JSON contient un tableau d'objets avec la structure suivante :
```json
[
{
"id": 1,
"zone": "75056",
"name": "Paris",
"dateCreated": "2024-01-15 10:30:00",
"dateModified": "2024-01-20 14:45:00",
"population": 2161000,
"budgetAnnuel": "8500000000",
"siren": "200054781",
"codeEpci": "200054781",
"codesPostaux": "75001;75002;75003;...",
"decomptes": {
"placesCount": 1250,
"avecHoraires": 980,
"avecAdresse": 1200,
"avecSite": 850,
"avecAccessibilite": 450,
"avecNote": 320,
"completionPercent": 75,
"placesCountReal": 1250
},
"followups": [
{
"name": "fire_hydrant_count",
"measure": 1250,
"date": "2024-01-20 14:45:00"
},
{
"name": "fire_hydrant_completion",
"measure": 85.5,
"date": "2024-01-20 14:45:00"
}
]
}
]
```
## Propriétés exportées
### Informations générales
- `id` : Identifiant unique de l'objet Stats
- `zone` : Code INSEE de la zone
- `name` : Nom de la ville/zone
- `dateCreated` : Date de création
- `dateModified` : Date de dernière modification
### Données démographiques et administratives
- `population` : Population de la zone
- `budgetAnnuel` : Budget annuel de la collectivité
- `siren` : Code SIREN
- `codeEpci` : Code EPCI
- `codesPostaux` : Codes postaux de la zone
### Décomptes
- `placesCount` : Nombre de lieux enregistrés
- `avecHoraires` : Nombre de lieux avec horaires d'ouverture
- `avecAdresse` : Nombre de lieux avec adresse complète
- `avecSite` : Nombre de lieux avec site web
- `avecAccessibilite` : Nombre de lieux avec accessibilité PMR
- `avecNote` : Nombre de lieux avec note
- `completionPercent` : Pourcentage de complétion global
- `placesCountReal` : Nombre réel de lieux (comptage direct)
### Followups
- `followups` : Tableau des mesures de suivi (CityFollowUp)
- `name` : Nom de la mesure
- `measure` : Valeur de la mesure
- `date` : Date de la mesure
## Exemples d'utilisation
### Export pour analyse
```bash
# Export de toutes les villes avec formatage
php bin/console app:export-stats --pretty --output=analyse_villes.json
# Export d'une ville spécifique
php bin/console app:export-stats --zone=75056 --pretty --output=paris.json
```
### Export pour traitement automatisé
```bash
# Export compact pour traitement par script
php bin/console app:export-stats --output=stats_compact.json
```
### Vérification des données
```bash
# Export avec aperçu des données
php bin/console app:export-stats --pretty -v
```