Documentation du code de SPIP et de ses plugins

MediaBox

Documentation

Table of Contents

Packages

Application

Functions

formulaires_configurer_mediabox_charger_dist()  : mixed
formulaires_configurer_mediabox_traiter_dist()  : mixed
mediabox_lister_skin_files()  : array<string|int, mixed>
Rechercher les fichiers css de skin mediabox disponibles dans un sous repertoire du chemin()
mediabox_lister_skins()  : array<string|int, array<string|int, mixed>>
lister les skins d'une box donnee
mediabox_presenter_selection_skins()  : string
Presenter le choix de skin d'une box parmi uns liste genereee par la fonction mediabox_lister_skins()
mediabox_ieconfig_metas()  : mixed
mediabox_lity_config()  : mixed
Definir la config de la box lity qui est la box par defaut
mediabox_config()  : array<string|int, mixed>
Calculer la config mediabox en fonction de l'espace prive/public ou l'on se trouve et de la config definie via le formulaire
mediabox_insert_head_css()  : string
Injecter les CSS + le JS inline (qui doit arriver avant les css pour des raisons de chargement non bloquant)
mediabox_echappe_js_config()  : array<string|int, mixed>|mixed|string|array<string|int, string>
Encoder/echapper les arguments de la config JS injectee dans le html
mediabox_insert_head()  : string
Injecter les scripts js
mediabox_jquery_plugins()  : mixed
Activer le plugin js cookie.js si on a configurer la splasg url

Functions

mediabox_lister_skin_files()

Rechercher les fichiers css de skin mediabox disponibles dans un sous repertoire du chemin()

mediabox_lister_skin_files( $dir,  $fichier_cherche) : array<string|int, mixed>
Parameters
$dir :
$fichier_cherche :
Return values
array<string|int, mixed>

mediabox_lister_skins()

lister les skins d'une box donnee

mediabox_lister_skins(string $box_name[, string $sous_repertoire = 'skins' ]) : array<string|int, array<string|int, mixed>>
Parameters
$box_name : string
$sous_repertoire : string = 'skins'
Return values
array<string|int, array<string|int, mixed>>

mediabox_presenter_selection_skins()

Presenter le choix de skin d'une box parmi uns liste genereee par la fonction mediabox_lister_skins()

mediabox_presenter_selection_skins( $skins,  $selected[, string $name = 'skin' ]) : string
Parameters
$skins :
$selected :
$name : string = 'skin'
Return values
string

mediabox_lity_config()

Definir la config de la box lity qui est la box par defaut

mediabox_lity_config( $config) : mixed
Parameters
$config :

mediabox_config()

Calculer la config mediabox en fonction de l'espace prive/public ou l'on se trouve et de la config definie via le formulaire

mediabox_config([null|bool $public = null ]) : array<string|int, mixed>
Parameters
$public : null|bool = null
Return values
array<string|int, mixed>

mediabox_insert_head_css()

Injecter les CSS + le JS inline (qui doit arriver avant les css pour des raisons de chargement non bloquant)

mediabox_insert_head_css(string $flux) : string
Parameters
$flux : string
Return values
string

mediabox_echappe_js_config()

Encoder/echapper les arguments de la config JS injectee dans le html

mediabox_echappe_js_config( $config) : array<string|int, mixed>|mixed|string|array<string|int, string>
Parameters
$config :
Return values
array<string|int, mixed>|mixed|string|array<string|int, string>

mediabox_insert_head()

Injecter les scripts js

mediabox_insert_head(string $flux) : string
Parameters
$flux : string
Return values
string

mediabox_jquery_plugins()

Activer le plugin js cookie.js si on a configurer la splasg url

mediabox_jquery_plugins( $plugins) : mixed
Parameters
$plugins :

Search results