Fichier noizetier_fonctions.php

Source

Liste des constantes

Valeur

  • _DIR_CACHE . 'noisettes_ajax.php'

Package

Valeur

  • _DIR_CACHE . 'noisettes_contextes.php'

Package

Valeur

  • _DIR_CACHE . 'noisettes_inclusions.php'

Package

Liste des fonctions

APIs

array noizetier_bloc_compter_noisettes( string $identifiant )

Paramètres

  1. string $identifiant

    L'identifiant de la page, de la composition ou de l'objet au format:

    • pour une page : type
    • pour une composition : type-composition
    • pour un objet : type_objet-id_objet

Retour

  • array

API

Package

Filtre

  • noizetier_bloc_compter_noisettes

La description est disponible dans un fichier YAML.

array | string noizetier_bloc_informer( $bloc = '' , $information = '' )

Paramètres

  1. $bloc = ''
  2. $information = ''

Retour

  • array | string

API

Package

La fonction vérifie d'abord que l'icone est dans le thème du privé (chemin_image), sinon cherche dans le path SPIP (find_in_path).

string noizetier_icone_chemin( string $icone )

Paramètres

  1. string $icone

Retour

  • string

API

Package

Filtre

  • noizetier_icone_chemin
array noizetier_icone_repertorier( $taille = 24 )

Paramètres

  1. $taille = 24

    int Taille en pixels des icones à répertorier.

Retour

  • array

    Tableau des chemins complets des icones trouvés dans le path SPIP.

API

Package

Filtre

  • noizetier_icone_repertorier
array | string noizetier_objet_lire( $type_objet , string $id_objet , string $information = '' )

Paramètres

  1. $type_objet
  2. string $id_objet

    Id de l'objet ou 0.

  3. string $information = ''

    Champ précis à renvoyer ou chaine vide pour renvoyer toutes les champs de l'objet.

Retour

  • array | string

    Si le type et l'id du contenu sont fournis, on renvoie la description de la page de ce contenu. Sinon, on renvoie le tableau des descriptions des pages de tous les contenus indexés par [type_objet][id_objet].

API

Package

Filtre

  • noizetier_objet_lire
array | null noizetier_objet_lister_exclusions( )

Retour

  • array | null

API

Package

Filtre

  • noizetier_objet_lister_exclusions
array | string noizetier_objet_repertorier( $filtres = array() )

Paramètres

  1. $filtres = array()

Retour

  • array | string

    Si le type et l'id du contenu sont fournis, on renvoie la description de la page de ce contenu. Sinon, on renvoie le tableau des descriptions des pages de tous les contenus indexés par [type_objet][id_objet].

API

Package

Filtre

  • noizetier_objet_repertorier

Si oui, ses objets peuvent recevoir une configuration de noisettes.

boolean noizetier_objet_type_active( string $type_objet )

Paramètres

  1. string $type_objet

    Type d'objet SPIP comme article, rubrique...

Retour

  • boolean

    True si le type d'objet est activé, false sinon.

API

Package

Filtre

  • noizetier_objet_type_active
string noizetier_page_composition( string $page )

Paramètres

  1. string $page

    L'identifiant de la page.

Retour

  • string

    La composition de la page choisie, à savoir, le mot suivant le tiret, ou la chaine vide sinon.

API

Package

Filtre

  • noizetier_page_composition
boolean noizetier_page_composition_activee( string $type )

Paramètres

  1. string $type

    Identifiant du type de page.

Retour

  • boolean

    True si les compositions sont autorisées, false sinon.

API

Package

Filtre

  • noizetier_page_composition_activee
boolean noizetier_page_est_composition( string $page )

Paramètres

  1. string $page

    L'identifiant de la page.

Retour

  • boolean

    true si la page est une composition, false sinon.

API

Package

Filtre

  • noizetier_page_est_composition

La configuration est stockée en base de données, certains champs sont recalculés avant d'être fournis.

array noizetier_page_informer( string $page , boolean $traitement_typo = true )

Paramètres

  1. string $page

    Identifiant de la page ou de la composition.

  2. boolean $traitement_typo = true

    Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées en utilisant la fonction _T_ou_typo. Les champs sérialisés sont toujours désérialisés.

Retour

  • array

API

Package

Filtre

  • noizetier_page_informer
string noizetier_page_repertoire( )

Retour

  • string

    Le répertoire des pages sous la forme dossier/.

API

Utilisé par

Package

Filtre

  • noizetier_page_repertoire
string noizetier_page_type( string $page )

Paramètres

  1. string $page

    L'identifiant de la page.

Retour

  • string

    Le type de la page choisie, c'est-à-dire:

    • soit l'identifiant complet de la page,
    • soit le mot précédent le tiret dans le cas d'une composition.

API

Package

Filtre

  • noizetier_page_type

Internes

noizetier_choisir_contexte( $noisette , $contexte_entrant , $id_noisette )

Paramètres

  1. $noisette
  2. $contexte_entrant
  3. $id_noisette

Retour

Package

boolean noizetier_configuration_est_modifiee( string $entite , string $identifiant )

Paramètres

  1. string $entite
  2. string $identifiant

Retour

  • boolean

Package

L'ordre est renvoyé pour l'ensemble des noisettes du bloc. Si l'index à partir duquel les noisettes sont réordonnées n'est pas fourni ou est égal à 0 la fonction réordonne toutes les noisettes.

boolean noizetier_noisette_ordonner( array $ordre , integer $index_initial )

Paramètres

  1. array $ordre
  2. integer $index_initial

Retour

  • boolean

Package

boolean noizetier_page_charger( boolean $recharger = false )

Paramètres

  1. boolean $recharger = false

Retour

  • boolean

Package

array noizetier_page_lister_blocs( $page , array $blocs_exclus = array() )

Paramètres

  1. $page
  2. array $blocs_exclus = array()

Retour

  • array

Package

array noizetier_type_noisette_compter( $page )

Paramètres

  1. $page

Retour

  • array

Package

Filtre

  • noizetier_type_noisette_compter

Liste des marqueurs

Type Ligne Description
TODO 170 : faut-il garder cette fonction ou simplifier en utilisant uniquement chemin_image() ?
TODO 378 : en attente de voir si on rajoute un var_mode=vider_noizetier
TODO 921 : a voir si cette fonction n'est pas utilisée pour les noisettes on la renommera en noizetier_page_modifiee()

Liste des erreurs

GravitéLigneDescription
Erreur 0
  • No summary was found for this file
Erreur 24
  • No summary for function \noizetier_type_noisette_compter()
Erreur 87
  • Name of argument $id_noisette does not match with the DocBlock's name $noisette in \noizetier_choisir_contexte()
  • Argument $id_noisette is missing from the Docblock of noizetier_choisir_contexte
  • Argument $contexte_entrant is missing from the Docblock of noizetier_choisir_contexte
  • Name of argument $contexte_entrant does not match with the DocBlock's name $noisette in \noizetier_choisir_contexte()
Erreur 246
  • Argument $information is missing from the Docblock of noizetier_bloc_informer
  • Argument $bloc is missing from the Docblock of noizetier_bloc_informer
Erreur 366
  • No summary for function \noizetier_page_charger()
Erreur 506
  • No summary for function \noizetier_page_lister_blocs()
Erreur 721
  • Name of argument $type_objet does not match with the DocBlock's name $objet in \noizetier_objet_lire()
Notice 721
  • Parameter $objet could not be found in \noizetier_objet_lire()
Erreur 791
  • Name of argument $filtres does not match with the DocBlock's name $objet in \noizetier_objet_repertorier()
Notice 791
  • Parameter $id_objet could not be found in \noizetier_objet_repertorier()
  • Parameter $objet could not be found in \noizetier_objet_repertorier()
Erreur 928
  • No summary for function \noizetier_configuration_est_modifiee()