Fichier plugins-dist/medias/medias_fonctions.php

Fonctions utiles pour les squelettes et déclarations de boucle pour le compilateur

Source

Liste des fonctions

<BOUCLE(DOCUMENTS)>

string boucle_DOCUMENTS( string $id_boucle , array & $boucles )

Paramètres

  1. string $id_boucle

    Identifiant de la boucle

  2. array & $boucles

    AST du squelette

Retour

  • string

    Code PHP compilé de la boucle

Package

Boucle

  • DOCUMENTS

{!carre} exclus ces documents

void critere_DOCUMENTS_carre_dist( string $idb , object & $boucles , object $crit )

Paramètres

  1. string $idb
  2. object & $boucles
  3. object $crit

Package

Critere

  • DOCUMENTS_carre
void critere_DOCUMENTS_orphelins_dist( string $idb , object & $boucles , object $crit )

Paramètres

  1. string $idb
  2. object & $boucles
  3. object $crit

Package

Critere

  • DOCUMENTS_orphelins

{!paysage} exclus ces documents

void critere_DOCUMENTS_paysage_dist( string $idb , object & $boucles , object $crit )

Paramètres

  1. string $idb
  2. object & $boucles
  3. object $crit

Package

Critere

  • DOCUMENTS_paysage

{!portrait} exclus ces documents

void critere_DOCUMENTS_portrait_dist( string $idb , object & $boucles , object $crit )

Paramètres

  1. string $idb
  2. object & $boucles
  3. object $crit

Package

Critere

  • DOCUMENTS_portrait
void duree_en_secondes( $duree , $precis = false )

Paramètres

  1. $duree
  2. $precis = false

Package

string filtre_medias_modele_document_standard_attributs_dist( $Pile , integer $id_document , string $media )

Paramètres

  1. $Pile
  2. integer $id_document
  3. string $media

Retour

  • string

Package

Filtre

  • medias_modele_document_standard_attributs
string filtre_medias_modele_document_standard_classes_dist( $Pile , integer $id_document , string $media )

Paramètres

  1. $Pile
  2. integer $id_document
  3. string $media

Retour

  • string

Package

Note

  • le nomage au pluriel est historique. préférer au singulier pour toute nouvelle classe.

Filtre

  • medias_modele_document_standard_classes

Utile dans une boucle DOCUMENTS pour afficher une vignette du type du document (balise #EXTENSION) alors que ce document a déjà une vignette personnalisée (affichable par #LOGO_DOCUMENT).

string filtre_vignette_dist( string $extension = 'defaut' , boolean $get_chemin = false )

Paramètres

  1. string $extension = 'defaut'

    L'extension du fichier, exemple : png ou pdf

  2. boolean $get_chemin = false

    false pour obtenir une balise img de l'image, true pour obtenir seulement le chemin du fichier

Retour

  • string

    Balise HTML ou chemin du fichier

Exemples

  • [(#EXTENSION|vignette)] produit une balise <img ... /> [(#EXTENSION|vignette{true})] retourne le chemin de l'image

Package

Filtre

  • vignette
integer | string medias_inigetoctets( string $var )

Paramètres

  1. string $var

    Clé de configuration ; valeur récupérée par ini_get(). Exemple post_max_size

Retour

  • integer | string

    Taille en octet, sinon chaine vide.

Package

array medias_lister_methodes_upload( string | array $env )

Paramètres

  1. string | array $env

Retour

  • array

Package

string medias_puce_statut_document( integer $id_document , string $statut )

Paramètres

  1. integer $id_document

    Identifiant du document

  2. string $statut

    Statut du document

Retour

  • string

    Code HTML de l'image de puce

Package

string medias_str_repeat_log( float $num , $base = 2 , $string = "x" , integer $remove )

Paramètres

  1. float $num
  2. $base = 2
  3. $string = "x"
  4. integer $remove

    : Nombre de caractères à enlever.

Retour

  • string

    Des x

Exemples

  • medias_str_repeat_log(124, 2 )
    
    Avec $base = 2 et $remove = 0
    
    0 =>
    2 => x
    4 => xx
    8 => xxx
    16 => xxxx
    32 => xxxxx
    64 => xxxxxx
  • medias_str_repeat_log(124, 2 , "x", 4)
    
    Avec $base = 2 et $remove = 4
    
    0 =>
    2 =>
    4 =>
    8 =>
    16 =>
    32 => x
    64 => xx

Package

Note

  • L'inverse (nb caractères => valeur) est donc pow($base, $nb_char)
    En partant du nombre de "x" on retrouve la fourchette du nombre de départ.
    Si $base = 2 et $remove = 4 :
    • "xxx" = 2 ^ (strlen("xxx") + 4) = 2 ^ (3 + 4) = 128

    • "xxxxx" = 2 ^ (5 + 4) = 512
      x = 32, xx = 64 xxx = 128 xxxx = 256 xxxxx = 512 ...
      Ce qui veut dire que "xxx" provient d'une valeur entre 128 et 255.
  • C'est surtout utile pour une sélection en CSS (car CSS ne permet pas de sélecteur "lower than" ou "greater than") :
    spip
    ...
    ` css .demo[data-demo-lenx^="xxxx"] { // le contenu fait au moins 256 caractères } .demo:not([data-demo-lenx^="xxxx"]) { // le contenu fait au moins 256 caractères }

=> modeles/{modele_base}_emb_html.html si il existe => modeles/{modele_base}_text_html.html si il existe, => modeles/{modele_base}_text.html si il existe, => modeles/{modele_base}.html sinon

mixed medias_trouver_modele_emb( $extension , $mime_type , $modele_base = 'file' )

Paramètres

  1. $extension
  2. $mime_type
  3. $modele_base = 'file'

Retour

  • mixed

Package

Liste des erreurs

GravitéLigneDescription
Erreur 343
  • Argument $duree is missing from the Docblock of duree_en_secondes
  • Argument $precis is missing from the Docblock of duree_en_secondes
  • No summary for function \duree_en_secondes()
Erreur 383
  • Argument $modele_base is missing from the Docblock of medias_trouver_modele_emb
  • Name of argument $modele_base does not match with the DocBlock's name $mime_type in \medias_trouver_modele_emb()
Erreur 415
  • Name of argument $Pile does not match with the DocBlock's name $id_document in \filtre_medias_modele_document_standard_classes_dist()
  • Name of argument $id_document does not match with the DocBlock's name $media in \filtre_medias_modele_document_standard_classes_dist()
  • The type hint of the argument is incorrect for the type definition of the @param tag with argument $id_document in \filtre_medias_modele_document_standard_classes_dist()
  • Name of argument $media does not match with the DocBlock's name $env in \filtre_medias_modele_document_standard_classes_dist()
  • The type hint of the argument is incorrect for the type definition of the @param tag with argument $media in \filtre_medias_modele_document_standard_classes_dist()
Notice 415
  • Parameter $get could not be found in \filtre_medias_modele_document_standard_classes_dist()
  • Parameter $env could not be found in \filtre_medias_modele_document_standard_classes_dist()
Erreur 450
  • Name of argument $Pile does not match with the DocBlock's name $id_document in \filtre_medias_modele_document_standard_attributs_dist()
  • Name of argument $id_document does not match with the DocBlock's name $media in \filtre_medias_modele_document_standard_attributs_dist()
  • The type hint of the argument is incorrect for the type definition of the @param tag with argument $id_document in \filtre_medias_modele_document_standard_attributs_dist()
  • Name of argument $media does not match with the DocBlock's name $env in \filtre_medias_modele_document_standard_attributs_dist()
  • The type hint of the argument is incorrect for the type definition of the @param tag with argument $media in \filtre_medias_modele_document_standard_attributs_dist()
Notice 450
  • Parameter $env could not be found in \filtre_medias_modele_document_standard_attributs_dist()
  • Parameter $get could not be found in \filtre_medias_modele_document_standard_attributs_dist()
Erreur 538
  • Name of argument $base does not match with the DocBlock's name $log in \medias_str_repeat_log()
  • Name of argument $string does not match with the DocBlock's name $pad_string in \medias_str_repeat_log()
Notice 538
  • Parameter $log could not be found in \medias_str_repeat_log()
  • Parameter $pad_string could not be found in \medias_str_repeat_log()