territoire.php
API spécifique des objets territoire.
Complète l'API standard de spip comme objet_créer(), objet_modifier(), objet_lire().
Table of Contents
Constants
- _EXTRAIRE_MULTI = '@<multi>(.*?)</multi>@sS'
- Restaure cette constante à partir de SPIP 4.2.
Functions
- territoire_repertorier() : array<string|int, mixed>
- Renvoie, une liste de descriptions de territoires éventuellement filtrée sur certains champs.
- territoire_lire_ascendance() : array<string|int, mixed>
- Fournit l'ascendance géographique d'un territoire, par consultation dans la base de données.
- territoire_lire_extras() : array<string|int, mixed>|string
- Fournit, pour un territoire donné, tout ou partie des informations extras disponibles dans la table spip_territoires_extras.
Constants
_EXTRAIRE_MULTI
Restaure cette constante à partir de SPIP 4.2.
public
mixed
_EXTRAIRE_MULTI
= '@<multi>(.*?)</multi>@sS'
Functions
territoire_repertorier()
Renvoie, une liste de descriptions de territoires éventuellement filtrée sur certains champs.
territoire_repertorier([null|array<string|int, mixed> $filtres = [] ]) : array<string|int, mixed>
Parameters
- $filtres : null|array<string|int, mixed> = []
-
Tableau associatif
[champ] = valeurde critères de filtres sur les descriptions de feed. Les opérateurs possibles sont l'égalité, l'appartenance et leurs négation.
Tags
Return values
array<string|int, mixed> —Tableau des descriptions des feeds indexé par l'id du feed ou tableau vide sinon.
territoire_lire_ascendance()
Fournit l'ascendance géographique d'un territoire, par consultation dans la base de données.
territoire_lire_ascendance(string $iso_territoire[, null|string $iso_parent = null ][, null|string $ordre = 'descendant' ]) : array<string|int, mixed>
Parameters
- $iso_territoire : string
-
Code ISO principal du territoire
- $iso_parent : null|string = null
-
Code ISO principal du parent direct du territoire concerné ou chaine vide sinon
- $ordre : null|string = 'descendant'
-
Classement de la liste :
descendant(défaut) ouascendant.
Return values
array<string|int, mixed> —Liste des territoires ascendants.
territoire_lire_extras()
Fournit, pour un territoire donné, tout ou partie des informations extras disponibles dans la table spip_territoires_extras.
territoire_lire_extras(string $iso_territoire[, null|string $information = '' ]) : array<string|int, mixed>|string
Cette fonction ne renvoie pas les champs du territoire lui-même (table spip_territoires).
Parameters
- $iso_territoire : string
-
Code ISO principal du territoire
- $information : null|string = ''
-
Type d'information à renvoyer depuis la table spip_territoires_extras ou vide si on veut toutes les informations.
Return values
array<string|int, mixed>|string —Information ou liste des informations.