Fichier ecrire/public/fonctions.php

Des fonctions diverses utilisees lors du calcul d'une page ; ces fonctions bien pratiques n'ont guere de logique organisationnelle ; elles sont appelees par certaines balises ou criteres au moment du calcul des pages. (Peut-on trouver un modele de donnees qui les associe physiquement au fichier definissant leur balise ???)

Ce ne sont pas des filtres à part entière, il n'est donc pas logique de les retrouver dans inc/filtres

Source

Liste des constantes

Liste des fonctions

appliquer_filtre_sinon()

Applique un filtre s'il existe, sinon retourne la valeur par défaut indiquée
string appliquer_filtre_sinon( mixed $arg , string $filtre , array $args , mixed $defaut = '' )

Paramètres

  1. mixed $arg

    Texte (le plus souvent) sur lequel appliquer le filtre

  2. string $filtre

    Nom du filtre à appliquer

  3. array $args

    Arguments reçus par la fonction parente (appliquer_filtre ou appliquer_si_filtre).

  4. mixed $defaut = ''

    Valeur par défaut à retourner en cas d'absence du filtre.

Retour

  • string

    Texte traité par le filtre si le filtre existe, Valeur $defaut sinon.

Utilise

  • trouver_filtre_matrice()
  • chercher_filtre()

Package

Internal

Source

calculer_notes()

Renvoie l'état courant des notes, le purge et en prépare un nouveau

Fonction appelée par la balise #NOTES

string calculer_notes( )

Retour

  • string

    Code HTML des notes

Voir également

Utilise

Package

Source

calculer_rang_smart()

Calculer la balise #RANG quand ce n'est pas un champ rang : peut etre le num titre, le champ rang_lien ou le rang du lien en edition des liens, a retrouver avec les infos du formulaire
integer | string calculer_rang_smart( $titre , $objet_source , $id , $env )

Paramètres

  1. $titre
  2. $objet_source
  3. $id
  4. $env

Retour

  • integer | string

Package

Source

filtre_bornes_pagination_dist()

Calcule les bornes d'une pagination
array<mixed,integer> filtre_bornes_pagination_dist( integer $courante , integer $nombre , integer $max = 10 )

Paramètres

  1. integer $courante

    Page courante

  2. integer $nombre

    Nombre de pages

  3. integer $max = 10

    Nombre d'éléments par page

Retour

  • array<mixed,integer>

    Liste (première page, dernière page).

Package

Filtre

  • bornes_pagination

Source

filtre_introduction_dist()

Calcul d'une introduction

L'introduction est prise dans le descriptif s'il est renseigné, sinon elle est calculée depuis le texte : à ce moment là, l'introduction est prise dans le contenu entre les balises <intro> et </intro> si présentes, sinon en coupant le texte à la taille indiquée.

Cette fonction est utilisée par la balise #INTRODUCTION

string filtre_introduction_dist( string $descriptif , string $texte , string $longueur , string $connect , string $suite = null )

Paramètres

  1. string $descriptif

    Descriptif de l'introduction

  2. string $texte

    Texte à utiliser en absence de descriptif

  3. string $longueur

    Longueur de l'introduction

  4. string $connect

    Nom du connecteur à la base de données

  5. string $suite = null

    points de suite si on coupe (par defaut _INTRODUCTION_SUITE et sinon  (...)

Retour

  • string

    Introduction calculée

Package

Source

Filtre

  • introduction
filtre_pagination_affiche_texte_lien_page_dist()
void filtre_pagination_affiche_texte_lien_page_dist( $type_pagination , $numero_page , $rang_item )

Paramètres

  1. $type_pagination
  2. $numero_page
  3. $rang_item

Package

Source

Filtre

  • pagination_affiche_texte_lien_page
filtre_pagination_dist()

Filtre calculant une pagination, utilisé par la balise #PAGINATION

Le filtre cherche le modèle pagination.html par défaut, mais peut chercher un modèle de pagination particulier avec l'argument $modele. S'il $modele='prive', le filtre cherchera le modèle pagination_prive.html.

string filtre_pagination_dist( integer $total , string $nom , integer $position , integer $pas , boolean $liste = true , string $modele = '' , string $connect = '' , array $env = array() )

Paramètres

  1. integer $total

    Nombre total d'éléments

  2. string $nom

    Nom identifiant la pagination

  3. integer $position

    Page à afficher (tel que la 3è page)

  4. integer $pas

    Nombre d'éléments par page

  5. boolean $liste = true
    • True pour afficher toute la liste des éléments,
    • False pour n'afficher que l'ancre
  6. string $modele = ''

    Nom spécifique du modèle de pagination

  7. string $connect = ''

    Nom du connecteur à la base de données

  8. array $env = array()

    Environnement à transmettre au modèle

Retour

  • string

    Code HTML de la pagination

Voir également

Package

Filtre

  • pagination

Source

formate_liste_critere_par_ordre_liste()

Fonction de mise en forme utilisee par le critere {par_ordre_liste.

.}

string formate_liste_critere_par_ordre_liste( array $valeurs , string $serveur = '' )

Paramètres

  1. array $valeurs
  2. string $serveur = ''

Retour

  • string

Voir également

Package

Source

lister_objets_avec_logos()

Retourne pour une clé primaire d'objet donnée les identifiants ayant un logo
string lister_objets_avec_logos( string $type )

Paramètres

  1. string $type

    Nom de la clé primaire de l'objet

Retour

  • string

    Liste des identifiants ayant un logo (séparés par une virgule)

Utilisé par

Package

Source

lister_objets_liens()

Lister les liens en le memoizant dans une static pour utilisation commune par lister_objets_lies et retrouver_rang_lien dans un formuluaire d'edition de liens (evite de multiplier les requetes)
mixed lister_objets_liens( $objet_source , $objet , $id_objet , $objet_lien )

Paramètres

  1. $objet_source
  2. $objet
  3. $id_objet
  4. $objet_lien

Retour

  • mixed

Package

Private

Source

tri_champ_order()

Interpreter les multi xxx et num xxx utilise comme tri pour la clause order 'multi xxx' devient simplement 'multi' qui est calcule dans le select
string tri_champ_order( string $t , array $from = null , $senstri = '' )

Paramètres

  1. string $t
  2. array $from = null
  3. $senstri = ''

Retour

  • string

Package

Source

tri_champ_select()

Interpreter les multi xxx et num xxx utilise comme tri pour la clause select 'multi xxx' devient select ".

..." as multi les autres cas ne produisent qu'une chaine vide '' en select 'hasard' devient 'rand() AS hasard' dans le select

string tri_champ_select( string $t )

Paramètres

  1. string $t

Retour

  • string

Package

Source

tri_protege_champ()

Proteger les champs passes dans l'url et utiliser dans {tri .

..} preserver l'espace pour interpreter ensuite num xxx et multi xxx on permet d'utiliser les noms de champ prefixes articles.titre et les propriete json properties.gis[0].ville

string tri_protege_champ( string $t )

Paramètres

  1. string $t

Retour

  • string

Package

Source

Liste des erreurs

GravitéLigneDescription
Erreur 257
  • Argument $type_pagination is missing from the Docblock of filtre_pagination_affiche_texte_lien_page_dist
  • Argument $numero_page is missing from the Docblock of filtre_pagination_affiche_texte_lien_page_dist
  • Argument $rang_item is missing from the Docblock of filtre_pagination_affiche_texte_lien_page_dist
  • No summary for function \filtre_pagination_affiche_texte_lien_page_dist()
Erreur 432
  • Argument $senstri is missing from the Docblock of tri_champ_order
  • Name of argument $senstri does not match with the DocBlock's name $from in \tri_champ_order()
Notice 537
  • Référence de @uses introuvable dans appliquer_filtre_sinon : \trouver_filtre_matrice()
  • Référence de @uses introuvable dans appliquer_filtre_sinon : \chercher_filtre()