Documentation du code de SPIP et de ses plugins

Boussole

boussole_phraser.php

Ce fichier contient les fonctions de phrasage des fichiers XML, JSON ou YAML de description de boussole.

Table of Contents

Constants

_BOUSSOLE_FICHIER_EXTENSIONS_DEFAUT  = ['xml', 'json']
Extensions possibles pour le fichier de description d'une boussole.

Functions

xml_boussole_extraire_attributs()  : array<string|int, mixed>
Extraire les attributs d'une balise XML.
logo_boussole_identifier()  : string
Identifier le logo de la boussole.
boussole_compiler_traductions()  : array<string|int, mixed>
Compile les traductions du nom, slogan et description d'une boussole, d'un groupe ou d'uns site.

Constants

_BOUSSOLE_FICHIER_EXTENSIONS_DEFAUT

Extensions possibles pour le fichier de description d'une boussole.

public mixed _BOUSSOLE_FICHIER_EXTENSIONS_DEFAUT = ['xml', 'json']

L'extension yaml nécessite l'utilisation du plugin YAML.

Functions

xml_boussole_extraire_attributs()

Extraire les attributs d'une balise XML.

xml_boussole_extraire_attributs(SimpleXMLElement $xml_element) : array<string|int, mixed>
Parameters
$xml_element : SimpleXMLElement

Contenu XML décodé sous la forme d'un objet.

Return values
array<string|int, mixed>

Liste des attributs sous la forme [attribut] = valeur.

logo_boussole_identifier()

Identifier le logo de la boussole.

logo_boussole_identifier(string $boussole, string $type_objet[, null|string $objet = '' ]) : string
Parameters
$boussole : string

Identifiant de la boussole

$type_objet : string

Type d'objet pour lequel on veut récupérer le logo (boussole, site)

$objet : null|string = ''

Identifiant de l'objet (uniquement pour une site)

Return values
string

URL Absolue du logo de l'objet concerné (boussole ou site)

boussole_compiler_traductions()

Compile les traductions du nom, slogan et description d'une boussole, d'un groupe ou d'uns site.

boussole_compiler_traductions(string $boussole, string $type_objet, string $objet) : array<string|int, mixed>

La fonction renvoie une balise pour chaque traduction.

Parameters
$boussole : string

Identifiant de la boussole

$type_objet : string

Type d'objet pour lequel on veut récupérer le logo (boussole, site)

$objet : string

Identifiant de l'objet (boussole, site)

Tags
used-by
boussole_lister_disponibilites()
Return values
array<string|int, mixed>

Tableau des traductions


        
On this page

Search results